compute.azure.com/v1api20210701

Package v1api20210701 contains API Schema definitions for the compute v1api20210701 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2021-07-01"

ExtendedLocation

(Appears on:Image_Spec)

The complex type of the extended location.

Field	Description
`name` string	Name: The name of the extended location.
`type` ExtendedLocationType	Type: The type of the extended location.

ExtendedLocationType (`string` alias)

(Appears on:ExtendedLocation, ExtendedLocation_ARM)

The type of extendedLocation.

Value	Description
"EdgeZone"

ExtendedLocationType_STATUS (`string` alias)

(Appears on:ExtendedLocation_STATUS, ExtendedLocation_STATUS_ARM)

The type of extendedLocation.

Value	Description
"EdgeZone"

ExtendedLocation_ARM

(Appears on:Image_Spec_ARM)

The complex type of the extended location.

Field	Description
`name` string	Name: The name of the extended location.
`type` ExtendedLocationType	Type: The type of the extended location.

ExtendedLocation_STATUS

(Appears on:Image_STATUS)

The complex type of the extended location.

Field	Description
`name` string	Name: The name of the extended location.
`type` ExtendedLocationType_STATUS	Type: The type of the extended location.

ExtendedLocation_STATUS_ARM

(Appears on:Image_STATUS_ARM)

The complex type of the extended location.

Field	Description
`name` string	Name: The name of the extended location.
`type` ExtendedLocationType_STATUS	Type: The type of the extended location.

HyperVGenerationType (`string` alias)

(Appears on:ImageProperties_ARM, Image_Spec)

Specifies the HyperVGeneration Type

Value	Description
"V1"
"V2"

HyperVGenerationType_STATUS (`string` alias)

(Appears on:ImageProperties_STATUS_ARM, Image_STATUS)

Specifies the HyperVGeneration Type

Value	Description
"V1"
"V2"

Image

Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2021-07-01/compute.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Image_Spec

`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`extendedLocation` ExtendedLocation	ExtendedLocation: The extended location of the Image.
`hyperVGeneration` HyperVGenerationType	HyperVGeneration: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.
`location` string	Location: Resource location
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`sourceVirtualMachine` SubResource	SourceVirtualMachine: The source virtual machine from which Image is created.
`storageProfile` ImageStorageProfile	StorageProfile: Specifies the storage settings for the virtual machine disks.
`tags` map[string]string	Tags: Resource tags

status
Image_STATUS

ImageDataDisk

(Appears on:ImageStorageProfile)

Describes a data disk.

Field	Description
`blobUri` string	BlobUri: The Virtual Hard Disk.
`caching` ImageDataDisk_Caching	Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage
`diskEncryptionSet` SubResource	DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed image disk.
`diskSizeGB` int	DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB
`lun` int	Lun: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
`managedDisk` SubResource	ManagedDisk: The managedDisk.
`snapshot` SubResource	Snapshot: The snapshot.
`storageAccountType` StorageAccountType	StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

ImageDataDisk_ARM

(Appears on:ImageStorageProfile_ARM)

Describes a data disk.

Field	Description
`blobUri` string	BlobUri: The Virtual Hard Disk.
`caching` ImageDataDisk_Caching	Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage
`diskEncryptionSet` SubResource_ARM	DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed image disk.
`diskSizeGB` int	DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB
`lun` int	Lun: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
`managedDisk` SubResource_ARM	ManagedDisk: The managedDisk.
`snapshot` SubResource_ARM	Snapshot: The snapshot.
`storageAccountType` StorageAccountType	StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

ImageDataDisk_Caching (`string` alias)

(Appears on:ImageDataDisk, ImageDataDisk_ARM)

Value	Description
"None"
"ReadOnly"
"ReadWrite"

ImageDataDisk_Caching_STATUS (`string` alias)

(Appears on:ImageDataDisk_STATUS, ImageDataDisk_STATUS_ARM)

Value	Description
"None"
"ReadOnly"
"ReadWrite"

ImageDataDisk_STATUS

(Appears on:ImageStorageProfile_STATUS)

Describes a data disk.

Field	Description
`blobUri` string	BlobUri: The Virtual Hard Disk.
`caching` ImageDataDisk_Caching_STATUS	Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage
`diskEncryptionSet` SubResource_STATUS	DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed image disk.
`diskSizeGB` int	DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB
`lun` int	Lun: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
`managedDisk` SubResource_STATUS	ManagedDisk: The managedDisk.
`snapshot` SubResource_STATUS	Snapshot: The snapshot.
`storageAccountType` StorageAccountType_STATUS	StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

ImageDataDisk_STATUS_ARM

(Appears on:ImageStorageProfile_STATUS_ARM)

Describes a data disk.

Field	Description
`blobUri` string	BlobUri: The Virtual Hard Disk.
`caching` ImageDataDisk_Caching_STATUS	Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage
`diskEncryptionSet` SubResource_STATUS_ARM	DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed image disk.
`diskSizeGB` int	DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB
`lun` int	Lun: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
`managedDisk` SubResource_STATUS_ARM	ManagedDisk: The managedDisk.
`snapshot` SubResource_STATUS_ARM	Snapshot: The snapshot.
`storageAccountType` StorageAccountType_STATUS	StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

ImageOSDisk

(Appears on:ImageStorageProfile)

Describes an Operating System disk.

Field	Description
`blobUri` string	BlobUri: The Virtual Hard Disk.
`caching` ImageOSDisk_Caching	Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage
`diskEncryptionSet` SubResource	DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed image disk.
`diskSizeGB` int	DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB
`managedDisk` SubResource	ManagedDisk: The managedDisk.
`osState` ImageOSDisk_OsState	OsState: The OS State.
`osType` ImageOSDisk_OsType	OsType: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows Linux
`snapshot` SubResource	Snapshot: The snapshot.
`storageAccountType` StorageAccountType	StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

ImageOSDisk_ARM

(Appears on:ImageStorageProfile_ARM)

Describes an Operating System disk.

Field	Description
`blobUri` string	BlobUri: The Virtual Hard Disk.
`caching` ImageOSDisk_Caching	Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage
`diskEncryptionSet` SubResource_ARM	DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed image disk.
`diskSizeGB` int	DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB
`managedDisk` SubResource_ARM	ManagedDisk: The managedDisk.
`osState` ImageOSDisk_OsState	OsState: The OS State.
`osType` ImageOSDisk_OsType	OsType: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows Linux
`snapshot` SubResource_ARM	Snapshot: The snapshot.
`storageAccountType` StorageAccountType	StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

ImageOSDisk_Caching (`string` alias)

(Appears on:ImageOSDisk, ImageOSDisk_ARM)

Value	Description
"None"
"ReadOnly"
"ReadWrite"

ImageOSDisk_Caching_STATUS (`string` alias)

(Appears on:ImageOSDisk_STATUS, ImageOSDisk_STATUS_ARM)

Value	Description
"None"
"ReadOnly"
"ReadWrite"

ImageOSDisk_OsState (`string` alias)

(Appears on:ImageOSDisk, ImageOSDisk_ARM)

Value	Description
"Generalized"
"Specialized"

ImageOSDisk_OsState_STATUS (`string` alias)

(Appears on:ImageOSDisk_STATUS, ImageOSDisk_STATUS_ARM)

Value	Description
"Generalized"
"Specialized"

ImageOSDisk_OsType (`string` alias)

(Appears on:ImageOSDisk, ImageOSDisk_ARM)

Value	Description
"Linux"
"Windows"

ImageOSDisk_OsType_STATUS (`string` alias)

(Appears on:ImageOSDisk_STATUS, ImageOSDisk_STATUS_ARM)

Value	Description
"Linux"
"Windows"

ImageOSDisk_STATUS

(Appears on:ImageStorageProfile_STATUS)

Describes an Operating System disk.

Field	Description
`blobUri` string	BlobUri: The Virtual Hard Disk.
`caching` ImageOSDisk_Caching_STATUS	Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage
`diskEncryptionSet` SubResource_STATUS	DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed image disk.
`diskSizeGB` int	DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB
`managedDisk` SubResource_STATUS	ManagedDisk: The managedDisk.
`osState` ImageOSDisk_OsState_STATUS	OsState: The OS State.
`osType` ImageOSDisk_OsType_STATUS	OsType: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows Linux
`snapshot` SubResource_STATUS	Snapshot: The snapshot.
`storageAccountType` StorageAccountType_STATUS	StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

ImageOSDisk_STATUS_ARM

(Appears on:ImageStorageProfile_STATUS_ARM)

Describes an Operating System disk.

Field	Description
`blobUri` string	BlobUri: The Virtual Hard Disk.
`caching` ImageOSDisk_Caching_STATUS	Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage
`diskEncryptionSet` SubResource_STATUS_ARM	DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed image disk.
`diskSizeGB` int	DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB
`managedDisk` SubResource_STATUS_ARM	ManagedDisk: The managedDisk.
`osState` ImageOSDisk_OsState_STATUS	OsState: The OS State.
`osType` ImageOSDisk_OsType_STATUS	OsType: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows Linux
`snapshot` SubResource_STATUS_ARM	Snapshot: The snapshot.
`storageAccountType` StorageAccountType_STATUS	StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

ImageProperties_ARM

(Appears on:Image_Spec_ARM)

Describes the properties of an Image.

Field	Description
`hyperVGeneration` HyperVGenerationType	HyperVGeneration: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.
`sourceVirtualMachine` SubResource_ARM	SourceVirtualMachine: The source virtual machine from which Image is created.
`storageProfile` ImageStorageProfile_ARM	StorageProfile: Specifies the storage settings for the virtual machine disks.

ImageProperties_STATUS_ARM

(Appears on:Image_STATUS_ARM)

Describes the properties of an Image.

Field	Description
`hyperVGeneration` HyperVGenerationType_STATUS	HyperVGeneration: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.
`provisioningState` string	ProvisioningState: The provisioning state.
`sourceVirtualMachine` SubResource_STATUS_ARM	SourceVirtualMachine: The source virtual machine from which Image is created.
`storageProfile` ImageStorageProfile_STATUS_ARM	StorageProfile: Specifies the storage settings for the virtual machine disks.

ImageStorageProfile

(Appears on:Image_Spec)

Describes a storage profile.

Field	Description
`dataDisks` []ImageDataDisk	DataDisks: Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
`osDisk` ImageOSDisk	OsDisk: Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
`zoneResilient` bool	ZoneResilient: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).

ImageStorageProfile_ARM

(Appears on:ImageProperties_ARM)

Describes a storage profile.

Field	Description
`dataDisks` []ImageDataDisk_ARM	DataDisks: Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
`osDisk` ImageOSDisk_ARM	OsDisk: Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
`zoneResilient` bool	ZoneResilient: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).

ImageStorageProfile_STATUS

(Appears on:Image_STATUS)

Describes a storage profile.

Field	Description
`dataDisks` []ImageDataDisk_STATUS	DataDisks: Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
`osDisk` ImageOSDisk_STATUS	OsDisk: Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
`zoneResilient` bool	ZoneResilient: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).

ImageStorageProfile_STATUS_ARM

(Appears on:ImageProperties_STATUS_ARM)

Describes a storage profile.

Field	Description
`dataDisks` []ImageDataDisk_STATUS_ARM	DataDisks: Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
`osDisk` ImageOSDisk_STATUS_ARM	OsDisk: Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
`zoneResilient` bool	ZoneResilient: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).

Image_STATUS

(Appears on:Image)

The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.

Field	Description
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`extendedLocation` ExtendedLocation_STATUS	ExtendedLocation: The extended location of the Image.
`hyperVGeneration` HyperVGenerationType_STATUS	HyperVGeneration: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.
`id` string	Id: Resource Id
`location` string	Location: Resource location
`name` string	Name: Resource name
`provisioningState` string	ProvisioningState: The provisioning state.
`sourceVirtualMachine` SubResource_STATUS	SourceVirtualMachine: The source virtual machine from which Image is created.
`storageProfile` ImageStorageProfile_STATUS	StorageProfile: Specifies the storage settings for the virtual machine disks.
`tags` map[string]string	Tags: Resource tags
`type` string	Type: Resource type

Image_STATUS_ARM

Field	Description
`extendedLocation` ExtendedLocation_STATUS_ARM	ExtendedLocation: The extended location of the Image.
`id` string	Id: Resource Id
`location` string	Location: Resource location
`name` string	Name: Resource name
`properties` ImageProperties_STATUS_ARM	Properties: Describes the properties of an Image.
`tags` map[string]string	Tags: Resource tags
`type` string	Type: Resource type

Image_Spec

(Appears on:Image)

Field	Description
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`extendedLocation` ExtendedLocation	ExtendedLocation: The extended location of the Image.
`hyperVGeneration` HyperVGenerationType	HyperVGeneration: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.
`location` string	Location: Resource location
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`sourceVirtualMachine` SubResource	SourceVirtualMachine: The source virtual machine from which Image is created.
`storageProfile` ImageStorageProfile	StorageProfile: Specifies the storage settings for the virtual machine disks.
`tags` map[string]string	Tags: Resource tags

Image_Spec_ARM

Field	Description
`extendedLocation` ExtendedLocation_ARM	ExtendedLocation: The extended location of the Image.
`location` string	Location: Resource location
`name` string
`properties` ImageProperties_ARM	Properties: Describes the properties of an Image.
`tags` map[string]string	Tags: Resource tags

StorageAccountType (`string` alias)

(Appears on:ImageDataDisk, ImageDataDisk_ARM, ImageOSDisk, ImageOSDisk_ARM)

Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types

Value	Description
"Premium_LRS"
"Premium_ZRS"
"StandardSSD_LRS"
"StandardSSD_ZRS"
"Standard_LRS"
"UltraSSD_LRS"

StorageAccountType_STATUS (`string` alias)

(Appears on:ImageDataDisk_STATUS, ImageDataDisk_STATUS_ARM, ImageOSDisk_STATUS, ImageOSDisk_STATUS_ARM)

Value	Description
"Premium_LRS"
"Premium_ZRS"
"StandardSSD_LRS"
"StandardSSD_ZRS"
"Standard_LRS"
"UltraSSD_LRS"

SubResource

(Appears on:ImageDataDisk, ImageOSDisk, Image_Spec)

Field	Description
`reference` genruntime.ResourceReference	Reference: Resource Id

SubResource_ARM

(Appears on:ImageDataDisk_ARM, ImageOSDisk_ARM, ImageProperties_ARM)

Field	Description
`id` string

SubResource_STATUS

(Appears on:ImageDataDisk_STATUS, ImageOSDisk_STATUS, Image_STATUS)

Field	Description
`id` string	Id: Resource Id

SubResource_STATUS_ARM

(Appears on:ImageDataDisk_STATUS_ARM, ImageOSDisk_STATUS_ARM, ImageProperties_STATUS_ARM)

Field	Description
`id` string	Id: Resource Id

compute.azure.com/v1api20210701