compute.azure.com/v1beta20210701
compute.azure.com/v1beta20210701
Package v1beta20210701 contains API Schema definitions for the compute v1beta20210701 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2021-07-01" |
DiskEncryptionSetParameters
(Appears on:ImageDataDisk, ImageOSDisk)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.Compute.json#/definitions/DiskEncryptionSetParameters
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource Id |
DiskEncryptionSetParametersARM
(Appears on:ImageDataDiskARM, ImageOSDiskARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.Compute.json#/definitions/DiskEncryptionSetParameters
Field | Description |
---|---|
id string |
ExtendedLocation
(Appears on:Images_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.Compute.json#/definitions/ExtendedLocation
Field | Description |
---|---|
name string |
Name: The name of the extended location. |
type ExtendedLocationType |
Type: The type of the extended location. |
ExtendedLocationARM
(Appears on:Images_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.Compute.json#/definitions/ExtendedLocation
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, ExtendedLocationARM)
Value | Description |
---|---|
"EdgeZone" |
ExtendedLocationType_Status
(string
alias)
(Appears on:ExtendedLocation_Status, ExtendedLocation_StatusARM)
Value | Description |
---|---|
"EdgeZone" |
ExtendedLocation_Status
(Appears on:Image_Status)
Field | Description |
---|---|
name string |
Name: The name of the extended location. |
type ExtendedLocationType_Status |
Type: The type of the extended location. |
ExtendedLocation_StatusARM
(Appears on:Image_StatusARM)
Field | Description |
---|---|
name string |
Name: The name of the extended location. |
type ExtendedLocationType_Status |
Type: The type of the extended location. |
HyperVGenerationType_Status
(string
alias)
(Appears on:ImageProperties_StatusARM, Image_Status)
Value | Description |
---|---|
"V1" |
|
"V2" |
Image
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.Compute.json#/resourceDefinitions/images
Field | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||
spec Images_Spec |
|
||||||||||||||||
status Image_Status |
ImageDataDisk
(Appears on:ImageStorageProfile)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.Compute.json#/definitions/ImageDataDisk
Field | Description |
---|---|
blobUri string |
BlobUri: The Virtual Hard Disk. |
caching ImageDataDiskCaching |
Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage. |
diskEncryptionSet DiskEncryptionSetParameters |
DiskEncryptionSet: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. |
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 |
|
snapshot SubResource |
|
storageAccountType ImageDataDiskStorageAccountType |
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. |
ImageDataDiskARM
(Appears on:ImageStorageProfileARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.Compute.json#/definitions/ImageDataDisk
Field | Description |
---|---|
blobUri string |
BlobUri: The Virtual Hard Disk. |
caching ImageDataDiskCaching |
Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage. |
diskEncryptionSet DiskEncryptionSetParametersARM |
DiskEncryptionSet: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. |
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 SubResourceARM |
|
snapshot SubResourceARM |
|
storageAccountType ImageDataDiskStorageAccountType |
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. |
ImageDataDiskCaching
(string
alias)
(Appears on:ImageDataDisk, ImageDataDiskARM)
Value | Description |
---|---|
"None" |
|
"ReadOnly" |
|
"ReadWrite" |
ImageDataDiskStatusCaching
(string
alias)
(Appears on:ImageDataDisk_Status, ImageDataDisk_StatusARM)
Value | Description |
---|---|
"None" |
|
"ReadOnly" |
|
"ReadWrite" |
ImageDataDiskStorageAccountType
(string
alias)
(Appears on:ImageDataDisk, ImageDataDiskARM)
Value | Description |
---|---|
"Premium_LRS" |
|
"Premium_ZRS" |
|
"Standard_LRS" |
|
"StandardSSD_LRS" |
|
"StandardSSD_ZRS" |
|
"UltraSSD_LRS" |
ImageDataDisk_Status
(Appears on:ImageStorageProfile_Status)
Field | Description |
---|---|
blobUri string |
BlobUri: The Virtual Hard Disk. |
caching ImageDataDiskStatusCaching |
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_StatusARM
(Appears on:ImageStorageProfile_StatusARM)
Field | Description |
---|---|
blobUri string |
BlobUri: The Virtual Hard Disk. |
caching ImageDataDiskStatusCaching |
Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage |
diskEncryptionSet SubResource_StatusARM |
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_StatusARM |
ManagedDisk: The managedDisk. |
snapshot SubResource_StatusARM |
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)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.Compute.json#/definitions/ImageOSDisk
Field | Description |
---|---|
blobUri string |
BlobUri: The Virtual Hard Disk. |
caching ImageOSDiskCaching |
Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage. |
diskEncryptionSet DiskEncryptionSetParameters |
DiskEncryptionSet: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. |
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 |
|
osState ImageOSDiskOsState |
OsState: The OS State. |
osType ImageOSDiskOsType |
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 |
|
storageAccountType ImageOSDiskStorageAccountType |
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. |
ImageOSDiskARM
(Appears on:ImageStorageProfileARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.Compute.json#/definitions/ImageOSDisk
Field | Description |
---|---|
blobUri string |
BlobUri: The Virtual Hard Disk. |
caching ImageOSDiskCaching |
Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage. |
diskEncryptionSet DiskEncryptionSetParametersARM |
DiskEncryptionSet: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. |
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 SubResourceARM |
|
osState ImageOSDiskOsState |
OsState: The OS State. |
osType ImageOSDiskOsType |
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 SubResourceARM |
|
storageAccountType ImageOSDiskStorageAccountType |
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. |
ImageOSDiskCaching
(string
alias)
(Appears on:ImageOSDisk, ImageOSDiskARM)
Value | Description |
---|---|
"None" |
|
"ReadOnly" |
|
"ReadWrite" |
ImageOSDiskOsState
(string
alias)
(Appears on:ImageOSDisk, ImageOSDiskARM)
Value | Description |
---|---|
"Generalized" |
|
"Specialized" |
ImageOSDiskOsType
(string
alias)
(Appears on:ImageOSDisk, ImageOSDiskARM)
Value | Description |
---|---|
"Linux" |
|
"Windows" |
ImageOSDiskStatusCaching
(string
alias)
(Appears on:ImageOSDisk_Status, ImageOSDisk_StatusARM)
Value | Description |
---|---|
"None" |
|
"ReadOnly" |
|
"ReadWrite" |
ImageOSDiskStatusOsState
(string
alias)
(Appears on:ImageOSDisk_Status, ImageOSDisk_StatusARM)
Value | Description |
---|---|
"Generalized" |
|
"Specialized" |
ImageOSDiskStatusOsType
(string
alias)
(Appears on:ImageOSDisk_Status, ImageOSDisk_StatusARM)
Value | Description |
---|---|
"Linux" |
|
"Windows" |
ImageOSDiskStorageAccountType
(string
alias)
(Appears on:ImageOSDisk, ImageOSDiskARM)
Value | Description |
---|---|
"Premium_LRS" |
|
"Premium_ZRS" |
|
"Standard_LRS" |
|
"StandardSSD_LRS" |
|
"StandardSSD_ZRS" |
|
"UltraSSD_LRS" |
ImageOSDisk_Status
(Appears on:ImageStorageProfile_Status)
Field | Description |
---|---|
blobUri string |
BlobUri: The Virtual Hard Disk. |
caching ImageOSDiskStatusCaching |
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 ImageOSDiskStatusOsState |
OsState: The OS State. |
osType ImageOSDiskStatusOsType |
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_StatusARM
(Appears on:ImageStorageProfile_StatusARM)
Field | Description |
---|---|
blobUri string |
BlobUri: The Virtual Hard Disk. |
caching ImageOSDiskStatusCaching |
Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage |
diskEncryptionSet SubResource_StatusARM |
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_StatusARM |
ManagedDisk: The managedDisk. |
osState ImageOSDiskStatusOsState |
OsState: The OS State. |
osType ImageOSDiskStatusOsType |
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_StatusARM |
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. |
ImagePropertiesARM
(Appears on:Images_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.Compute.json#/definitions/ImageProperties
Field | Description |
---|---|
hyperVGeneration ImagePropertiesHyperVGeneration |
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 SubResourceARM |
|
storageProfile ImageStorageProfileARM |
StorageProfile: Describes a storage profile. |
ImagePropertiesHyperVGeneration
(string
alias)
(Appears on:ImagePropertiesARM, Images_Spec)
Value | Description |
---|---|
"V1" |
|
"V2" |
ImageProperties_StatusARM
(Appears on:Image_StatusARM)
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_StatusARM |
SourceVirtualMachine: The source virtual machine from which Image is created. |
storageProfile ImageStorageProfile_StatusARM |
StorageProfile: Specifies the storage settings for the virtual machine disks. |
ImageStorageProfile
(Appears on:Images_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.Compute.json#/definitions/ImageStorageProfile
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: Describes an Operating System disk. |
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). |
ImageStorageProfileARM
(Appears on:ImagePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.Compute.json#/definitions/ImageStorageProfile
Field | Description |
---|---|
dataDisks []ImageDataDiskARM |
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 ImageOSDiskARM |
OsDisk: Describes an Operating System disk. |
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)
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_StatusARM
(Appears on:ImageProperties_StatusARM)
Field | Description |
---|---|
dataDisks []ImageDataDisk_StatusARM |
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_StatusARM |
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)
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_StatusARM
Field | Description |
---|---|
extendedLocation ExtendedLocation_StatusARM |
ExtendedLocation: The extended location of the Image. |
id string |
Id: Resource Id |
location string |
Location: Resource location |
name string |
Name: Resource name |
properties ImageProperties_StatusARM |
|
tags map[string]string |
Tags: Resource tags |
type string |
Type: Resource type |
Images_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 complex type of the extended location. |
hyperVGeneration ImagePropertiesHyperVGeneration |
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: Location to deploy resource to |
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 |
|
storageProfile ImageStorageProfile |
StorageProfile: Describes a storage profile. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
Images_SpecARM
Field | Description |
---|---|
extendedLocation ExtendedLocationARM |
ExtendedLocation: The complex type of the extended location. |
location string |
Location: Location to deploy resource to |
name string |
Name: The name of the image. |
properties ImagePropertiesARM |
Properties: Describes the properties of an Image. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
StorageAccountType_Status
(string
alias)
(Appears on:ImageDataDisk_Status, ImageDataDisk_StatusARM, ImageOSDisk_Status, ImageOSDisk_StatusARM)
Value | Description |
---|---|
"Premium_LRS" |
|
"Premium_ZRS" |
|
"Standard_LRS" |
|
"StandardSSD_LRS" |
|
"StandardSSD_ZRS" |
|
"UltraSSD_LRS" |
SubResource
(Appears on:ImageDataDisk, ImageOSDisk, Images_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.Compute.json#/definitions/SubResource
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource Id |
SubResourceARM
(Appears on:ImageDataDiskARM, ImageOSDiskARM, ImagePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.Compute.json#/definitions/SubResource
Field | Description |
---|---|
id string |
SubResource_Status
(Appears on:ImageDataDisk_Status, ImageOSDisk_Status, Image_Status)
Field | Description |
---|---|
id string |
Id: Resource Id |
SubResource_StatusARM
(Appears on:ImageDataDisk_StatusARM, ImageOSDisk_StatusARM, ImageProperties_StatusARM)
Field | Description |
---|---|
id string |
Id: Resource Id |