compute.azure.com/v1api20210701
APIVersion
| Value | Description |
|---|---|
| “2021-07-01” |
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}
Used by: ImageList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Image_Spec Optional |
|
| status | Image_STATUS Optional |
Image_Spec
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| extendedLocation | The extended location of the Image. | ExtendedLocation Optional |
| 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. | HyperVGenerationType Optional |
| location | Resource location | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ImageOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| sourceVirtualMachine | The source virtual machine from which Image is created. | SubResource Optional |
| storageProfile | Specifies the storage settings for the virtual machine disks. | ImageStorageProfile Optional |
| tags | Resource tags | map[string]string Optional |
Image_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| extendedLocation | The extended location of the Image. | ExtendedLocation_STATUS Optional |
| 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. | HyperVGenerationType_STATUS Optional |
| id | Resource Id | string Optional |
| location | Resource location | string Optional |
| name | Resource name | string Optional |
| provisioningState | The provisioning state. | string Optional |
| sourceVirtualMachine | The source virtual machine from which Image is created. | SubResource_STATUS Optional |
| storageProfile | Specifies the storage settings for the virtual machine disks. | ImageStorageProfile_STATUS Optional |
| tags | Resource tags | map[string]string Optional |
| type | Resource type | string Optional |
ImageList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Image[] Optional |
Image_Spec
Used by: Image.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| extendedLocation | The extended location of the Image. | ExtendedLocation Optional |
| 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. | HyperVGenerationType Optional |
| location | Resource location | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ImageOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| sourceVirtualMachine | The source virtual machine from which Image is created. | SubResource Optional |
| storageProfile | Specifies the storage settings for the virtual machine disks. | ImageStorageProfile Optional |
| tags | Resource tags | map[string]string Optional |
Image_STATUS
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.
Used by: Image.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| extendedLocation | The extended location of the Image. | ExtendedLocation_STATUS Optional |
| 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. | HyperVGenerationType_STATUS Optional |
| id | Resource Id | string Optional |
| location | Resource location | string Optional |
| name | Resource name | string Optional |
| provisioningState | The provisioning state. | string Optional |
| sourceVirtualMachine | The source virtual machine from which Image is created. | SubResource_STATUS Optional |
| storageProfile | Specifies the storage settings for the virtual machine disks. | ImageStorageProfile_STATUS Optional |
| tags | Resource tags | map[string]string Optional |
| type | Resource type | string Optional |
ExtendedLocation
The complex type of the extended location.
Used by: Image_Spec.
| Property | Description | Type |
|---|---|---|
| name | The name of the extended location. | string Optional |
| type | The type of the extended location. | ExtendedLocationType Optional |
ExtendedLocation_STATUS
The complex type of the extended location.
Used by: Image_STATUS.
| Property | Description | Type |
|---|---|---|
| name | The name of the extended location. | string Optional |
| type | The type of the extended location. | ExtendedLocationType_STATUS Optional |
HyperVGenerationType
Specifies the HyperVGeneration Type
Used by: Image_Spec.
| Value | Description |
|---|---|
| “V1” | |
| “V2” |
HyperVGenerationType_STATUS
Specifies the HyperVGeneration Type
Used by: Image_STATUS.
| Value | Description |
|---|---|
| “V1” | |
| “V2” |
ImageOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Image_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
ImageStorageProfile
Describes a storage profile.
Used by: Image_Spec.
| Property | Description | Type |
|---|---|---|
| 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. | ImageDataDisk[] Optional |
| 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. | ImageOSDisk Optional |
| 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). | bool Optional |
ImageStorageProfile_STATUS
Describes a storage profile.
Used by: Image_STATUS.
| Property | Description | Type |
|---|---|---|
| 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. | ImageDataDisk_STATUS[] Optional |
| 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. | ImageOSDisk_STATUS Optional |
| 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). | bool Optional |
SubResource
Used by: Image_Spec, ImageDataDisk, ImageDataDisk, ImageDataDisk, ImageOSDisk, ImageOSDisk, and ImageOSDisk.
| Property | Description | Type |
|---|---|---|
| reference | Resource Id | genruntime.ResourceReference Optional |
SubResource_STATUS
Used by: Image_STATUS, ImageDataDisk_STATUS, ImageDataDisk_STATUS, ImageDataDisk_STATUS, ImageOSDisk_STATUS, ImageOSDisk_STATUS, and ImageOSDisk_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Resource Id | string Optional |
ExtendedLocationType
The type of extendedLocation.
Used by: ExtendedLocation.
| Value | Description |
|---|---|
| “EdgeZone” |
ExtendedLocationType_STATUS
The type of extendedLocation.
Used by: ExtendedLocation_STATUS.
| Value | Description |
|---|---|
| “EdgeZone” |
ImageDataDisk
Describes a data disk.
Used by: ImageStorageProfile.
| Property | Description | Type |
|---|---|---|
| blobUri | The Virtual Hard Disk. | string Optional |
| caching | Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage | ImageDataDisk_Caching Optional |
| diskEncryptionSet | Specifies the customer managed disk encryption set resource id for the managed image disk. | SubResource Optional |
| 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 | int Optional |
| 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. | int Required |
| managedDisk | The managedDisk. | SubResource Optional |
| snapshot | The snapshot. | SubResource Optional |
| 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. | StorageAccountType Optional |
ImageDataDisk_STATUS
Describes a data disk.
Used by: ImageStorageProfile_STATUS.
| Property | Description | Type |
|---|---|---|
| blobUri | The Virtual Hard Disk. | string Optional |
| caching | Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage | ImageDataDisk_Caching_STATUS Optional |
| diskEncryptionSet | Specifies the customer managed disk encryption set resource id for the managed image disk. | SubResource_STATUS Optional |
| 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 | int Optional |
| 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. | int Optional |
| managedDisk | The managedDisk. | SubResource_STATUS Optional |
| snapshot | The snapshot. | SubResource_STATUS Optional |
| 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. | StorageAccountType_STATUS Optional |
ImageOSDisk
Describes an Operating System disk.
Used by: ImageStorageProfile.
| Property | Description | Type |
|---|---|---|
| blobUri | The Virtual Hard Disk. | string Optional |
| caching | Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage | ImageOSDisk_Caching Optional |
| diskEncryptionSet | Specifies the customer managed disk encryption set resource id for the managed image disk. | SubResource Optional |
| 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 | int Optional |
| managedDisk | The managedDisk. | SubResource Optional |
| osState | The OS State. | ImageOSDisk_OsState Required |
| 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 | ImageOSDisk_OsType Required |
| snapshot | The snapshot. | SubResource Optional |
| 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. | StorageAccountType Optional |
ImageOSDisk_STATUS
Describes an Operating System disk.
Used by: ImageStorageProfile_STATUS.
| Property | Description | Type |
|---|---|---|
| blobUri | The Virtual Hard Disk. | string Optional |
| caching | Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage | ImageOSDisk_Caching_STATUS Optional |
| diskEncryptionSet | Specifies the customer managed disk encryption set resource id for the managed image disk. | SubResource_STATUS Optional |
| 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 | int Optional |
| managedDisk | The managedDisk. | SubResource_STATUS Optional |
| osState | The OS State. | ImageOSDisk_OsState_STATUS Optional |
| 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 | ImageOSDisk_OsType_STATUS Optional |
| snapshot | The snapshot. | SubResource_STATUS Optional |
| 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. | StorageAccountType_STATUS Optional |
ImageDataDisk_Caching
Used by: ImageDataDisk.
| Value | Description |
|---|---|
| “None” | |
| “ReadOnly” | |
| “ReadWrite” |
ImageDataDisk_Caching_STATUS
Used by: ImageDataDisk_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “ReadOnly” | |
| “ReadWrite” |
ImageOSDisk_Caching
Used by: ImageOSDisk.
| Value | Description |
|---|---|
| “None” | |
| “ReadOnly” | |
| “ReadWrite” |
ImageOSDisk_Caching_STATUS
Used by: ImageOSDisk_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “ReadOnly” | |
| “ReadWrite” |
ImageOSDisk_OsState
Used by: ImageOSDisk.
| Value | Description |
|---|---|
| “Generalized” | |
| “Specialized” |
ImageOSDisk_OsState_STATUS
Used by: ImageOSDisk_STATUS.
| Value | Description |
|---|---|
| “Generalized” | |
| “Specialized” |
ImageOSDisk_OsType
Used by: ImageOSDisk.
| Value | Description |
|---|---|
| “Linux” | |
| “Windows” |
ImageOSDisk_OsType_STATUS
Used by: ImageOSDisk_STATUS.
| Value | Description |
|---|---|
| “Linux” | |
| “Windows” |
StorageAccountType
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
Used by: ImageDataDisk, and ImageOSDisk.
| Value | Description |
|---|---|
| “Premium_LRS” | |
| “Premium_ZRS” | |
| “StandardSSD_LRS” | |
| “StandardSSD_ZRS” | |
| “Standard_LRS” | |
| “UltraSSD_LRS” |
StorageAccountType_STATUS
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
Used by: ImageDataDisk_STATUS, and ImageOSDisk_STATUS.
| Value | Description |
|---|---|
| “Premium_LRS” | |
| “Premium_ZRS” | |
| “StandardSSD_LRS” | |
| “StandardSSD_ZRS” | |
| “Standard_LRS” | |
| “UltraSSD_LRS” |