Share via

Image interface

Package:
@azure/arm-labservices

Lab services virtual machine image

Extends
ProxyResource

Properties

author

The image author. NOTE: This property will not be serialized. It can only be populated by the server.
availableRegions

The available regions of the image in the shared gallery.
description

A description of the image. NOTE: This property will not be serialized. It can only be populated by the server.
displayName

The image display name. NOTE: This property will not be serialized. It can only be populated by the server.
enabledState

Is the image enabled
iconUrl

URL of the image icon. NOTE: This property will not be serialized. It can only be populated by the server.
offer

The ID of an offer associated with the image. NOTE: This property will not be serialized. It can only be populated by the server.
osState

The OS State of the image. NOTE: This property will not be serialized. It can only be populated by the server.
osType

The OS Type of the image. NOTE: This property will not be serialized. It can only be populated by the server.
plan

The ID of marketplace plan associated with the image (optional). NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

Current provisioning state of the image. NOTE: This property will not be serialized. It can only be populated by the server.
publisher

The ID of the publisher of the image. NOTE: This property will not be serialized. It can only be populated by the server.
sharedGalleryId

The ID for the image in the shared gallery. NOTE: This property will not be serialized. It can only be populated by the server.
sku

The image SKU. NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Metadata pertaining to creation and last modification of the image. NOTE: This property will not be serialized. It can only be populated by the server.
termsStatus

The status of image terms of use (enabled = accepted, disabled = not accepted). NOTE: This property will not be serialized. It can only be populated by the server.
version

The image version. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

author

The image author. NOTE: This property will not be serialized. It can only be populated by the server.

author?: string

Property Value

string

availableRegions

The available regions of the image in the shared gallery.

availableRegions?: string[]

Property Value

string[]

description

A description of the image. NOTE: This property will not be serialized. It can only be populated by the server.

description?: string

Property Value

string

displayName

The image display name. NOTE: This property will not be serialized. It can only be populated by the server.

displayName?: string

Property Value

string

enabledState

Is the image enabled

enabledState?: EnableState

Property Value

EnableState

iconUrl

URL of the image icon. NOTE: This property will not be serialized. It can only be populated by the server.

iconUrl?: string

Property Value

string

offer

The ID of an offer associated with the image. NOTE: This property will not be serialized. It can only be populated by the server.

offer?: string

Property Value

string

osState

The OS State of the image. NOTE: This property will not be serialized. It can only be populated by the server.

osState?: OsState

Property Value

OsState

osType

The OS Type of the image. NOTE: This property will not be serialized. It can only be populated by the server.

osType?: OsType

Property Value

OsType

plan

The ID of marketplace plan associated with the image (optional). NOTE: This property will not be serialized. It can only be populated by the server.

plan?: string

Property Value

string

provisioningState

Current provisioning state of the image. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: ProvisioningState

Property Value

ProvisioningState

publisher

The ID of the publisher of the image. NOTE: This property will not be serialized. It can only be populated by the server.

publisher?: string

Property Value

string

sharedGalleryId

The ID for the image in the shared gallery. NOTE: This property will not be serialized. It can only be populated by the server.

sharedGalleryId?: string

Property Value

string

sku

The image SKU. NOTE: This property will not be serialized. It can only be populated by the server.

sku?: string

Property Value

string

systemData

Metadata pertaining to creation and last modification of the image. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

termsStatus

The status of image terms of use (enabled = accepted, disabled = not accepted). NOTE: This property will not be serialized. It can only be populated by the server.

termsStatus?: EnableState

Property Value

EnableState

version

The image version. NOTE: This property will not be serialized. It can only be populated by the server.

version?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type