Image interface
Represents an image.
- Extends
Properties
description | The description of the image. NOTE: This property will not be serialized. It can only be populated by the server. |
hibernate |
Indicates whether this image has hibernate enabled. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate NOTE: This property will not be serialized. It can only be populated by the server. |
offer | The name of the image offer. NOTE: This property will not be serialized. It can only be populated by the server. |
provisioning |
The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server. |
publisher | The publisher of the image. NOTE: This property will not be serialized. It can only be populated by the server. |
recommended |
The recommended machine configuration to use with the image. NOTE: This property will not be serialized. It can only be populated by the server. |
sku | The SKU name for the image. 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. E.g. "/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. |
system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. 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
description
The description of the image. NOTE: This property will not be serialized. It can only be populated by the server.
description?: string
Property Value
string
hibernateSupport
Indicates whether this image has hibernate enabled. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate NOTE: This property will not be serialized. It can only be populated by the server.
hibernateSupport?: string
Property Value
string
offer
The name of the image offer. NOTE: This property will not be serialized. It can only be populated by the server.
offer?: string
Property Value
string
provisioningState
The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState?: string
Property Value
string
publisher
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
recommendedMachineConfiguration
The recommended machine configuration to use with the image. NOTE: This property will not be serialized. It can only be populated by the server.
recommendedMachineConfiguration?: RecommendedMachineConfiguration
Property Value
sku
The SKU name for the image. NOTE: This property will not be serialized. It can only be populated by the server.
sku?: string
Property Value
string
Inherited Property Details
id
Fully qualified resource ID for the resource. E.g. "/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
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
systemData?: SystemData
Property Value
Inherited From ProxyResource.systemData
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