compute.azure.com/v1api20240302

APIVersion

Value	Description
“2024-03-02”

Disk

Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/disk.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}

Used by: DiskList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		Disk_Spec Optional
status		Disk_STATUS Optional

Disk_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
burstingEnabled	Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.	bool Optional
completionPercent	Percentage complete for the background copy when a resource is created via the CopyStart operation.	float64 Optional
creationData	Disk source information. CreationData information cannot be changed after the disk has been created.	CreationData Required
dataAccessAuthMode	Additional authentication requirements when exporting or uploading to a disk or snapshot.	DataAccessAuthMode Optional
diskAccessReference	ARM id of the DiskAccess resource for using private endpoints on disks.	genruntime.ResourceReference Optional
diskIOPSReadOnly	The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.	int Optional
diskIOPSReadWrite	The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.	int Optional
diskMBpsReadOnly	The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.	int Optional
diskMBpsReadWrite	The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.	int Optional
diskSizeGB	If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.	int Optional
encryption	Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.	Encryption Optional
encryptionSettingsCollection	Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.	EncryptionSettingsCollection Optional
extendedLocation	The extended location where the disk will be created. Extended location cannot be changed.	ExtendedLocation Optional
hyperVGeneration	The hypervisor generation of the Virtual Machine. Applicable to OS disks only.	DiskProperties_HyperVGeneration Optional
location	Resource location	string Required
maxShares	The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.	int Optional
networkAccessPolicy	Policy for accessing the disk via network.	NetworkAccessPolicy Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	DiskOperatorSpec Optional
optimizedForFrequentAttach	Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine.	bool Optional
osType	The Operating System type.	DiskProperties_OsType 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
publicNetworkAccess	Policy for controlling export on the disk.	PublicNetworkAccess Optional
purchasePlan	Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}	PurchasePlan Optional
securityProfile	Contains the security related information for the resource.	DiskSecurityProfile Optional
sku	The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.	DiskSku Optional
supportedCapabilities	List of supported capabilities for the image from which the OS disk was created.	SupportedCapabilities Optional
supportsHibernation	Indicates the OS on a disk supports hibernation.	bool Optional
tags	Resource tags	map[string]string Optional
tier	Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks.	string Optional
zones	The Logical zone list for Disk.	string[] Optional

Disk_STATUS

Property	Description	Type
burstingEnabled	Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.	bool Optional
burstingEnabledTime	Latest time when bursting was last enabled on a disk.	string Optional
completionPercent	Percentage complete for the background copy when a resource is created via the CopyStart operation.	float64 Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
creationData	Disk source information. CreationData information cannot be changed after the disk has been created.	CreationData_STATUS Optional
dataAccessAuthMode	Additional authentication requirements when exporting or uploading to a disk or snapshot.	DataAccessAuthMode_STATUS Optional
diskAccessId	ARM id of the DiskAccess resource for using private endpoints on disks.	string Optional
diskIOPSReadOnly	The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.	int Optional
diskIOPSReadWrite	The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.	int Optional
diskMBpsReadOnly	The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.	int Optional
diskMBpsReadWrite	The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.	int Optional
diskSizeBytes	The size of the disk in bytes. This field is read only.	int Optional
diskSizeGB	If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.	int Optional
diskState	The state of the disk.	DiskState_STATUS Optional
encryption	Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.	Encryption_STATUS Optional
encryptionSettingsCollection	Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.	EncryptionSettingsCollection_STATUS Optional
extendedLocation	The extended location where the disk will be created. Extended location cannot be changed.	ExtendedLocation_STATUS Optional
hyperVGeneration	The hypervisor generation of the Virtual Machine. Applicable to OS disks only.	DiskProperties_HyperVGeneration_STATUS Optional
id	Resource Id	string Optional
LastOwnershipUpdateTime	The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started.	string Optional
location	Resource location	string Optional
managedBy	A relative URI containing the ID of the VM that has the disk attached.	string Optional
managedByExtended	List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.	string[] Optional
maxShares	The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.	int Optional
name	Resource name	string Optional
networkAccessPolicy	Policy for accessing the disk via network.	NetworkAccessPolicy_STATUS Optional
optimizedForFrequentAttach	Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine.	bool Optional
osType	The Operating System type.	DiskProperties_OsType_STATUS Optional
propertyUpdatesInProgress	Properties of the disk for which update is pending.	PropertyUpdatesInProgress_STATUS Optional
provisioningState	The disk provisioning state.	string Optional
publicNetworkAccess	Policy for controlling export on the disk.	PublicNetworkAccess_STATUS Optional
purchasePlan	Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}	PurchasePlan_STATUS Optional
securityProfile	Contains the security related information for the resource.	DiskSecurityProfile_STATUS Optional
shareInfo	Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.	ShareInfoElement_STATUS[] Optional
sku	The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.	DiskSku_STATUS Optional
supportedCapabilities	List of supported capabilities for the image from which the OS disk was created.	SupportedCapabilities_STATUS Optional
supportsHibernation	Indicates the OS on a disk supports hibernation.	bool Optional
tags	Resource tags	map[string]string Optional
tier	Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks.	string Optional
timeCreated	The time when the disk was created.	string Optional
type	Resource type	string Optional
uniqueId	Unique Guid identifying the resource.	string Optional
zones	The Logical zone list for Disk.	string[] Optional

DiskAccess

Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/diskAccess.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}

Used by: DiskAccessList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		DiskAccess_Spec Optional
status		DiskAccess_STATUS Optional

DiskAccess_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 where the disk access will be created. Extended location cannot be changed.	ExtendedLocation 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	DiskAccessOperatorSpec 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
tags	Resource tags	map[string]string Optional

DiskAccess_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
extendedLocation	The extended location where the disk access will be created. Extended location cannot be changed.	ExtendedLocation_STATUS Optional
id	Resource Id	string Optional
location	Resource location	string Optional
name	Resource name	string Optional
privateEndpointConnections	A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported.	PrivateEndpointConnection_STATUS[] Optional
provisioningState	The disk access resource provisioning state.	string Optional
tags	Resource tags	map[string]string Optional
timeCreated	The time when the disk access was created.	string Optional
type	Resource type	string Optional

DiskAccessList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		DiskAccess[] Optional

DiskEncryptionSet

Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/diskEncryptionSet.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}

Used by: DiskEncryptionSetList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		DiskEncryptionSet_Spec Optional
status		DiskEncryptionSet_STATUS Optional

DiskEncryptionSet_Spec

Property	Description	Type
activeKey	The key vault key which is currently used by this disk encryption set.	KeyForDiskEncryptionSet Optional
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
encryptionType	The type of key used to encrypt the data of the disk.	DiskEncryptionSetType Optional
federatedClientId	Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.	string Optional
federatedClientIdFromConfig	Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.	genruntime.ConfigMapReference Optional
identity	The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.	EncryptionSetIdentity 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	DiskEncryptionSetOperatorSpec 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
rotationToLatestKeyVersionEnabled	Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.	bool Optional
tags	Resource tags	map[string]string Optional

DiskEncryptionSet_STATUS

Property	Description	Type
activeKey	The key vault key which is currently used by this disk encryption set.	KeyForDiskEncryptionSet_STATUS Optional
autoKeyRotationError	The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed.	ApiError_STATUS Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
encryptionType	The type of key used to encrypt the data of the disk.	DiskEncryptionSetType_STATUS Optional
federatedClientId	Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.	string Optional
id	Resource Id	string Optional
identity	The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.	EncryptionSetIdentity_STATUS Optional
lastKeyRotationTimestamp	The time when the active key of this disk encryption set was updated.	string Optional
location	Resource location	string Optional
name	Resource name	string Optional
previousKeys	A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation.	KeyForDiskEncryptionSet_STATUS[] Optional
provisioningState	The disk encryption set provisioning state.	string Optional
rotationToLatestKeyVersionEnabled	Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.	bool Optional
tags	Resource tags	map[string]string Optional
type	Resource type	string Optional

DiskEncryptionSetList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		DiskEncryptionSet[] Optional

DiskList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		Disk[] Optional

Snapshot

Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/snapshot.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}

Used by: SnapshotList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		Snapshot_Spec Optional
status		Snapshot_STATUS Optional

Snapshot_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
completionPercent	Percentage complete for the background copy when a resource is created via the CopyStart operation.	float64 Optional
copyCompletionError	Indicates the error details if the background copy of a resource created via the CopyStart operation fails.	CopyCompletionError Optional
creationData	Disk source information. CreationData information cannot be changed after the disk has been created.	CreationData Required
dataAccessAuthMode	Additional authentication requirements when exporting or uploading to a disk or snapshot.	DataAccessAuthMode Optional
diskAccessReference	ARM id of the DiskAccess resource for using private endpoints on disks.	genruntime.ResourceReference Optional
diskSizeGB	If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.	int Optional
diskState	The state of the snapshot.	DiskState Optional
encryption	Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.	Encryption Optional
encryptionSettingsCollection	Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.	EncryptionSettingsCollection Optional
extendedLocation	The extended location where the snapshot will be created. Extended location cannot be changed.	ExtendedLocation Optional
hyperVGeneration	The hypervisor generation of the Virtual Machine. Applicable to OS disks only.	SnapshotProperties_HyperVGeneration Optional
incremental	Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.	bool Optional
location	Resource location	string Required
networkAccessPolicy	Policy for accessing the disk via network.	NetworkAccessPolicy Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SnapshotOperatorSpec Optional
osType	The Operating System type.	SnapshotProperties_OsType 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
publicNetworkAccess	Policy for controlling export on the disk.	PublicNetworkAccess Optional
purchasePlan	Purchase plan information for the image from which the source disk for the snapshot was originally created.	PurchasePlan Optional
securityProfile	Contains the security related information for the resource.	DiskSecurityProfile Optional
sku	The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot	SnapshotSku Optional
supportedCapabilities	List of supported capabilities for the image from which the source disk from the snapshot was originally created.	SupportedCapabilities Optional
supportsHibernation	Indicates the OS on a snapshot supports hibernation.	bool Optional
tags	Resource tags	map[string]string Optional

Snapshot_STATUS

Property	Description	Type
completionPercent	Percentage complete for the background copy when a resource is created via the CopyStart operation.	float64 Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
copyCompletionError	Indicates the error details if the background copy of a resource created via the CopyStart operation fails.	CopyCompletionError_STATUS Optional
creationData	Disk source information. CreationData information cannot be changed after the disk has been created.	CreationData_STATUS Optional
dataAccessAuthMode	Additional authentication requirements when exporting or uploading to a disk or snapshot.	DataAccessAuthMode_STATUS Optional
diskAccessId	ARM id of the DiskAccess resource for using private endpoints on disks.	string Optional
diskSizeBytes	The size of the disk in bytes. This field is read only.	int Optional
diskSizeGB	If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.	int Optional
diskState	The state of the snapshot.	DiskState_STATUS Optional
encryption	Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.	Encryption_STATUS Optional
encryptionSettingsCollection	Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.	EncryptionSettingsCollection_STATUS Optional
extendedLocation	The extended location where the snapshot will be created. Extended location cannot be changed.	ExtendedLocation_STATUS Optional
hyperVGeneration	The hypervisor generation of the Virtual Machine. Applicable to OS disks only.	SnapshotProperties_HyperVGeneration_STATUS Optional
id	Resource Id	string Optional
incremental	Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.	bool Optional
incrementalSnapshotFamilyId	Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.	string Optional
location	Resource location	string Optional
managedBy	Unused. Always Null.	string Optional
name	Resource name	string Optional
networkAccessPolicy	Policy for accessing the disk via network.	NetworkAccessPolicy_STATUS Optional
osType	The Operating System type.	SnapshotProperties_OsType_STATUS Optional
provisioningState	The disk provisioning state.	string Optional
publicNetworkAccess	Policy for controlling export on the disk.	PublicNetworkAccess_STATUS Optional
purchasePlan	Purchase plan information for the image from which the source disk for the snapshot was originally created.	PurchasePlan_STATUS Optional
securityProfile	Contains the security related information for the resource.	DiskSecurityProfile_STATUS Optional
sku	The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot	SnapshotSku_STATUS Optional
supportedCapabilities	List of supported capabilities for the image from which the source disk from the snapshot was originally created.	SupportedCapabilities_STATUS Optional
supportsHibernation	Indicates the OS on a snapshot supports hibernation.	bool Optional
tags	Resource tags	map[string]string Optional
timeCreated	The time when the snapshot was created.	string Optional
type	Resource type	string Optional
uniqueId	Unique Guid identifying the resource.	string Optional

SnapshotList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		Snapshot[] Optional

Disk_Spec

Used by: Disk.

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
burstingEnabled	Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.	bool Optional
completionPercent	Percentage complete for the background copy when a resource is created via the CopyStart operation.	float64 Optional
creationData	Disk source information. CreationData information cannot be changed after the disk has been created.	CreationData Required
dataAccessAuthMode	Additional authentication requirements when exporting or uploading to a disk or snapshot.	DataAccessAuthMode Optional
diskAccessReference	ARM id of the DiskAccess resource for using private endpoints on disks.	genruntime.ResourceReference Optional
diskIOPSReadOnly	The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.	int Optional
diskIOPSReadWrite	The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.	int Optional
diskMBpsReadOnly	The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.	int Optional
diskMBpsReadWrite	The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.	int Optional
diskSizeGB	If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.	int Optional
encryption	Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.	Encryption Optional
encryptionSettingsCollection	Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.	EncryptionSettingsCollection Optional
extendedLocation	The extended location where the disk will be created. Extended location cannot be changed.	ExtendedLocation Optional
hyperVGeneration	The hypervisor generation of the Virtual Machine. Applicable to OS disks only.	DiskProperties_HyperVGeneration Optional
location	Resource location	string Required
maxShares	The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.	int Optional
networkAccessPolicy	Policy for accessing the disk via network.	NetworkAccessPolicy Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	DiskOperatorSpec Optional
optimizedForFrequentAttach	Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine.	bool Optional
osType	The Operating System type.	DiskProperties_OsType 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
publicNetworkAccess	Policy for controlling export on the disk.	PublicNetworkAccess Optional
purchasePlan	Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}	PurchasePlan Optional
securityProfile	Contains the security related information for the resource.	DiskSecurityProfile Optional
sku	The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.	DiskSku Optional
supportedCapabilities	List of supported capabilities for the image from which the OS disk was created.	SupportedCapabilities Optional
supportsHibernation	Indicates the OS on a disk supports hibernation.	bool Optional
tags	Resource tags	map[string]string Optional
tier	Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks.	string Optional
zones	The Logical zone list for Disk.	string[] Optional

Disk_STATUS

Disk resource.

Used by: Disk.

Property	Description	Type
burstingEnabled	Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.	bool Optional
burstingEnabledTime	Latest time when bursting was last enabled on a disk.	string Optional
completionPercent	Percentage complete for the background copy when a resource is created via the CopyStart operation.	float64 Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
creationData	Disk source information. CreationData information cannot be changed after the disk has been created.	CreationData_STATUS Optional
dataAccessAuthMode	Additional authentication requirements when exporting or uploading to a disk or snapshot.	DataAccessAuthMode_STATUS Optional
diskAccessId	ARM id of the DiskAccess resource for using private endpoints on disks.	string Optional
diskIOPSReadOnly	The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.	int Optional
diskIOPSReadWrite	The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.	int Optional
diskMBpsReadOnly	The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.	int Optional
diskMBpsReadWrite	The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.	int Optional
diskSizeBytes	The size of the disk in bytes. This field is read only.	int Optional
diskSizeGB	If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.	int Optional
diskState	The state of the disk.	DiskState_STATUS Optional
encryption	Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.	Encryption_STATUS Optional
encryptionSettingsCollection	Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.	EncryptionSettingsCollection_STATUS Optional
extendedLocation	The extended location where the disk will be created. Extended location cannot be changed.	ExtendedLocation_STATUS Optional
hyperVGeneration	The hypervisor generation of the Virtual Machine. Applicable to OS disks only.	DiskProperties_HyperVGeneration_STATUS Optional
id	Resource Id	string Optional
LastOwnershipUpdateTime	The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started.	string Optional
location	Resource location	string Optional
managedBy	A relative URI containing the ID of the VM that has the disk attached.	string Optional
managedByExtended	List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.	string[] Optional
maxShares	The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.	int Optional
name	Resource name	string Optional
networkAccessPolicy	Policy for accessing the disk via network.	NetworkAccessPolicy_STATUS Optional
optimizedForFrequentAttach	Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine.	bool Optional
osType	The Operating System type.	DiskProperties_OsType_STATUS Optional
propertyUpdatesInProgress	Properties of the disk for which update is pending.	PropertyUpdatesInProgress_STATUS Optional
provisioningState	The disk provisioning state.	string Optional
publicNetworkAccess	Policy for controlling export on the disk.	PublicNetworkAccess_STATUS Optional
purchasePlan	Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}	PurchasePlan_STATUS Optional
securityProfile	Contains the security related information for the resource.	DiskSecurityProfile_STATUS Optional
shareInfo	Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.	ShareInfoElement_STATUS[] Optional
sku	The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.	DiskSku_STATUS Optional
supportedCapabilities	List of supported capabilities for the image from which the OS disk was created.	SupportedCapabilities_STATUS Optional
supportsHibernation	Indicates the OS on a disk supports hibernation.	bool Optional
tags	Resource tags	map[string]string Optional
tier	Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks.	string Optional
timeCreated	The time when the disk was created.	string Optional
type	Resource type	string Optional
uniqueId	Unique Guid identifying the resource.	string Optional
zones	The Logical zone list for Disk.	string[] Optional

DiskAccess_Spec

Used by: DiskAccess.

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 where the disk access will be created. Extended location cannot be changed.	ExtendedLocation 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	DiskAccessOperatorSpec 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
tags	Resource tags	map[string]string Optional

DiskAccess_STATUS

disk access resource.

Used by: DiskAccess.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
extendedLocation	The extended location where the disk access will be created. Extended location cannot be changed.	ExtendedLocation_STATUS Optional
id	Resource Id	string Optional
location	Resource location	string Optional
name	Resource name	string Optional
privateEndpointConnections	A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported.	PrivateEndpointConnection_STATUS[] Optional
provisioningState	The disk access resource provisioning state.	string Optional
tags	Resource tags	map[string]string Optional
timeCreated	The time when the disk access was created.	string Optional
type	Resource type	string Optional

DiskEncryptionSet_Spec

Used by: DiskEncryptionSet.

Property	Description	Type
activeKey	The key vault key which is currently used by this disk encryption set.	KeyForDiskEncryptionSet Optional
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
encryptionType	The type of key used to encrypt the data of the disk.	DiskEncryptionSetType Optional
federatedClientId	Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.	string Optional
federatedClientIdFromConfig	Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.	genruntime.ConfigMapReference Optional
identity	The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.	EncryptionSetIdentity 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	DiskEncryptionSetOperatorSpec 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
rotationToLatestKeyVersionEnabled	Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.	bool Optional
tags	Resource tags	map[string]string Optional

DiskEncryptionSet_STATUS

disk encryption set resource.

Used by: DiskEncryptionSet.

Property	Description	Type
activeKey	The key vault key which is currently used by this disk encryption set.	KeyForDiskEncryptionSet_STATUS Optional
autoKeyRotationError	The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed.	ApiError_STATUS Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
encryptionType	The type of key used to encrypt the data of the disk.	DiskEncryptionSetType_STATUS Optional
federatedClientId	Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.	string Optional
id	Resource Id	string Optional
identity	The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.	EncryptionSetIdentity_STATUS Optional
lastKeyRotationTimestamp	The time when the active key of this disk encryption set was updated.	string Optional
location	Resource location	string Optional
name	Resource name	string Optional
previousKeys	A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation.	KeyForDiskEncryptionSet_STATUS[] Optional
provisioningState	The disk encryption set provisioning state.	string Optional
rotationToLatestKeyVersionEnabled	Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.	bool Optional
tags	Resource tags	map[string]string Optional
type	Resource type	string Optional

Snapshot_Spec

Used by: Snapshot.

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
completionPercent	Percentage complete for the background copy when a resource is created via the CopyStart operation.	float64 Optional
copyCompletionError	Indicates the error details if the background copy of a resource created via the CopyStart operation fails.	CopyCompletionError Optional
creationData	Disk source information. CreationData information cannot be changed after the disk has been created.	CreationData Required
dataAccessAuthMode	Additional authentication requirements when exporting or uploading to a disk or snapshot.	DataAccessAuthMode Optional
diskAccessReference	ARM id of the DiskAccess resource for using private endpoints on disks.	genruntime.ResourceReference Optional
diskSizeGB	If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.	int Optional
diskState	The state of the snapshot.	DiskState Optional
encryption	Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.	Encryption Optional
encryptionSettingsCollection	Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.	EncryptionSettingsCollection Optional
extendedLocation	The extended location where the snapshot will be created. Extended location cannot be changed.	ExtendedLocation Optional
hyperVGeneration	The hypervisor generation of the Virtual Machine. Applicable to OS disks only.	SnapshotProperties_HyperVGeneration Optional
incremental	Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.	bool Optional
location	Resource location	string Required
networkAccessPolicy	Policy for accessing the disk via network.	NetworkAccessPolicy Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	SnapshotOperatorSpec Optional
osType	The Operating System type.	SnapshotProperties_OsType 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
publicNetworkAccess	Policy for controlling export on the disk.	PublicNetworkAccess Optional
purchasePlan	Purchase plan information for the image from which the source disk for the snapshot was originally created.	PurchasePlan Optional
securityProfile	Contains the security related information for the resource.	DiskSecurityProfile Optional
sku	The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot	SnapshotSku Optional
supportedCapabilities	List of supported capabilities for the image from which the source disk from the snapshot was originally created.	SupportedCapabilities Optional
supportsHibernation	Indicates the OS on a snapshot supports hibernation.	bool Optional
tags	Resource tags	map[string]string Optional

Snapshot_STATUS

Snapshot resource.

Used by: Snapshot.

Property	Description	Type
completionPercent	Percentage complete for the background copy when a resource is created via the CopyStart operation.	float64 Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
copyCompletionError	Indicates the error details if the background copy of a resource created via the CopyStart operation fails.	CopyCompletionError_STATUS Optional
creationData	Disk source information. CreationData information cannot be changed after the disk has been created.	CreationData_STATUS Optional
dataAccessAuthMode	Additional authentication requirements when exporting or uploading to a disk or snapshot.	DataAccessAuthMode_STATUS Optional
diskAccessId	ARM id of the DiskAccess resource for using private endpoints on disks.	string Optional
diskSizeBytes	The size of the disk in bytes. This field is read only.	int Optional
diskSizeGB	If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk’s size.	int Optional
diskState	The state of the snapshot.	DiskState_STATUS Optional
encryption	Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.	Encryption_STATUS Optional
encryptionSettingsCollection	Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.	EncryptionSettingsCollection_STATUS Optional
extendedLocation	The extended location where the snapshot will be created. Extended location cannot be changed.	ExtendedLocation_STATUS Optional
hyperVGeneration	The hypervisor generation of the Virtual Machine. Applicable to OS disks only.	SnapshotProperties_HyperVGeneration_STATUS Optional
id	Resource Id	string Optional
incremental	Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.	bool Optional
incrementalSnapshotFamilyId	Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.	string Optional
location	Resource location	string Optional
managedBy	Unused. Always Null.	string Optional
name	Resource name	string Optional
networkAccessPolicy	Policy for accessing the disk via network.	NetworkAccessPolicy_STATUS Optional
osType	The Operating System type.	SnapshotProperties_OsType_STATUS Optional
provisioningState	The disk provisioning state.	string Optional
publicNetworkAccess	Policy for controlling export on the disk.	PublicNetworkAccess_STATUS Optional
purchasePlan	Purchase plan information for the image from which the source disk for the snapshot was originally created.	PurchasePlan_STATUS Optional
securityProfile	Contains the security related information for the resource.	DiskSecurityProfile_STATUS Optional
sku	The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot	SnapshotSku_STATUS Optional
supportedCapabilities	List of supported capabilities for the image from which the source disk from the snapshot was originally created.	SupportedCapabilities_STATUS Optional
supportsHibernation	Indicates the OS on a snapshot supports hibernation.	bool Optional
tags	Resource tags	map[string]string Optional
timeCreated	The time when the snapshot was created.	string Optional
type	Resource type	string Optional
uniqueId	Unique Guid identifying the resource.	string Optional

ApiError_STATUS

Api error.

Used by: DiskEncryptionSet_STATUS.

Property	Description	Type
code	The error code.	string Optional
details	The Api error details	ApiErrorBase_STATUS[] Optional
innererror	The Api inner error	InnerError_STATUS Optional
message	The error message.	string Optional
target	The target of the particular error.	string Optional

CopyCompletionError

Indicates the error details if the background copy of a resource created via the CopyStart operation fails.

Used by: Snapshot_Spec.

Property	Description	Type
errorCode	Indicates the error code if the background copy of a resource created via the CopyStart operation fails.	CopyCompletionError_ErrorCode Required
errorMessage	Indicates the error message if the background copy of a resource created via the CopyStart operation fails.	string Required

CopyCompletionError_STATUS

Indicates the error details if the background copy of a resource created via the CopyStart operation fails.

Used by: Snapshot_STATUS.

Property	Description	Type
errorCode	Indicates the error code if the background copy of a resource created via the CopyStart operation fails.	CopyCompletionError_ErrorCode_STATUS Optional
errorMessage	Indicates the error message if the background copy of a resource created via the CopyStart operation fails.	string Optional

CreationData

Data used when creating a disk.

Used by: Disk_Spec, and Snapshot_Spec.

Property	Description	Type
createOption	This enumerates the possible sources of a disk’s creation.	CreationData_CreateOption Required
elasticSanResourceReference	Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.	genruntime.ResourceReference Optional
galleryImageReference	Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.	ImageDiskReference Optional
imageReference	Disk source information for PIR or user images.	ImageDiskReference Optional
logicalSectorSize	Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.	int Optional
performancePlus	Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.	bool Optional
provisionedBandwidthCopySpeed	If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.	CreationData_ProvisionedBandwidthCopySpeed Optional
securityDataUri	If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.	string Optional
sourceResourceReference	If createOption is Copy, this is the ARM id of the source snapshot or disk.	genruntime.ResourceReference Optional
sourceUri	If createOption is Import, this is the URI of a blob to be imported into a managed disk.	string Optional
storageAccountId	Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.	string Optional
uploadSizeBytes	If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).	int Optional

CreationData_STATUS

Data used when creating a disk.

Used by: Disk_STATUS, and Snapshot_STATUS.

Property	Description	Type
createOption	This enumerates the possible sources of a disk’s creation.	CreationData_CreateOption_STATUS Optional
elasticSanResourceId	Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.	string Optional
galleryImageReference	Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.	ImageDiskReference_STATUS Optional
imageReference	Disk source information for PIR or user images.	ImageDiskReference_STATUS Optional
logicalSectorSize	Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.	int Optional
performancePlus	Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.	bool Optional
provisionedBandwidthCopySpeed	If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.	CreationData_ProvisionedBandwidthCopySpeed_STATUS Optional
securityDataUri	If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.	string Optional
sourceResourceId	If createOption is Copy, this is the ARM id of the source snapshot or disk.	string Optional
sourceUniqueId	If this field is set, this is the unique id identifying the source of this resource.	string Optional
sourceUri	If createOption is Import, this is the URI of a blob to be imported into a managed disk.	string Optional
storageAccountId	Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.	string Optional
uploadSizeBytes	If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).	int Optional

DataAccessAuthMode

Additional authentication requirements when exporting or uploading to a disk or snapshot.

Used by: Disk_Spec, and Snapshot_Spec.

Value	Description
“AzureActiveDirectory”
“None”

DataAccessAuthMode_STATUS

Additional authentication requirements when exporting or uploading to a disk or snapshot.

Used by: Disk_STATUS, and Snapshot_STATUS.

Value	Description
“AzureActiveDirectory”
“None”

DiskAccessOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: DiskAccess_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

DiskEncryptionSetOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: DiskEncryptionSet_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

DiskEncryptionSetType

The type of key used to encrypt the data of the disk.

Used by: DiskEncryptionSet_Spec.

Value	Description
“ConfidentialVmEncryptedWithCustomerKey”
“EncryptionAtRestWithCustomerKey”
“EncryptionAtRestWithPlatformAndCustomerKeys”

DiskEncryptionSetType_STATUS

The type of key used to encrypt the data of the disk.

Used by: DiskEncryptionSet_STATUS.

Value	Description
“ConfidentialVmEncryptedWithCustomerKey”
“EncryptionAtRestWithCustomerKey”
“EncryptionAtRestWithPlatformAndCustomerKeys”

DiskOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: Disk_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

DiskProperties_HyperVGeneration

Used by: Disk_Spec.

Value	Description
“V1”
“V2”

DiskProperties_HyperVGeneration_STATUS

Used by: Disk_STATUS.

Value	Description
“V1”
“V2”

DiskProperties_OsType

Used by: Disk_Spec.

Value	Description
“Linux”
“Windows”

DiskProperties_OsType_STATUS

Used by: Disk_STATUS.

Value	Description
“Linux”
“Windows”

DiskSecurityProfile

Contains the security related information for the resource.

Used by: Disk_Spec, and Snapshot_Spec.

Property	Description	Type
secureVMDiskEncryptionSetReference	ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key	genruntime.ResourceReference Optional
securityType	Specifies the SecurityType of the VM. Applicable for OS disks only.	DiskSecurityType Optional

DiskSecurityProfile_STATUS

Contains the security related information for the resource.

Used by: Disk_STATUS, and Snapshot_STATUS.

Property	Description	Type
secureVMDiskEncryptionSetId	ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key	string Optional
securityType	Specifies the SecurityType of the VM. Applicable for OS disks only.	DiskSecurityType_STATUS Optional

DiskSku

The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.

Used by: Disk_Spec.

Property	Description	Type
name	The sku name.	DiskSku_Name Optional

DiskSku_STATUS

The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.

Used by: Disk_STATUS.

Property	Description	Type
name	The sku name.	DiskSku_Name_STATUS Optional
tier	The sku tier.	string Optional

DiskState

This enumerates the possible state of the disk.

Used by: Snapshot_Spec.

Value	Description
“ActiveSAS”
“ActiveSASFrozen”
“ActiveUpload”
“Attached”
“Frozen”
“ReadyToUpload”
“Reserved”
“Unattached”

DiskState_STATUS

This enumerates the possible state of the disk.

Used by: Disk_STATUS, and Snapshot_STATUS.

Value	Description
“ActiveSAS”
“ActiveSASFrozen”
“ActiveUpload”
“Attached”
“Frozen”
“ReadyToUpload”
“Reserved”
“Unattached”

Encryption

Encryption at rest settings for disk or snapshot

Used by: Disk_Spec, and Snapshot_Spec.

Property	Description	Type
diskEncryptionSetReference	ResourceId of the disk encryption set to use for enabling encryption at rest.	genruntime.ResourceReference Optional
type	The type of key used to encrypt the data of the disk.	EncryptionType Optional

Encryption_STATUS

Encryption at rest settings for disk or snapshot

Used by: Disk_STATUS, and Snapshot_STATUS.

Property	Description	Type
diskEncryptionSetId	ResourceId of the disk encryption set to use for enabling encryption at rest.	string Optional
type	The type of key used to encrypt the data of the disk.	EncryptionType_STATUS Optional

EncryptionSetIdentity

The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.

Used by: DiskEncryptionSet_Spec.

Property	Description	Type
type	The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys.	EncryptionSetIdentity_Type Optional
userAssignedIdentities	The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.	UserAssignedIdentityDetails[] Optional

EncryptionSetIdentity_STATUS

The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.

Used by: DiskEncryptionSet_STATUS.

Property	Description	Type
principalId	The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity	string Optional
tenantId	The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity	string Optional
type	The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys.	EncryptionSetIdentity_Type_STATUS Optional
userAssignedIdentities	The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.	map[string]EncryptionSetIdentity_UserAssignedIdentities_STATUS Optional

EncryptionSettingsCollection

Encryption settings for disk or snapshot

Used by: Disk_Spec, and Snapshot_Spec.

Property	Description	Type
enabled	Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.	bool Required
encryptionSettings	A collection of encryption settings, one for each disk volume.	EncryptionSettingsElement[] Optional
encryptionSettingsVersion	Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. ‘1.0’ corresponds to Azure Disk Encryption with AAD app.‘1.1’ corresponds to Azure Disk Encryption.	string Optional

EncryptionSettingsCollection_STATUS

Encryption settings for disk or snapshot

Used by: Disk_STATUS, and Snapshot_STATUS.

Property	Description	Type
enabled	Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.	bool Optional
encryptionSettings	A collection of encryption settings, one for each disk volume.	EncryptionSettingsElement_STATUS[] Optional
encryptionSettingsVersion	Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. ‘1.0’ corresponds to Azure Disk Encryption with AAD app.‘1.1’ corresponds to Azure Disk Encryption.	string Optional

ExtendedLocation

The complex type of the extended location.

Used by: Disk_Spec, DiskAccess_Spec, and Snapshot_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: Disk_STATUS, DiskAccess_STATUS, and Snapshot_STATUS.

Property	Description	Type
name	The name of the extended location.	string Optional
type	The type of the extended location.	ExtendedLocationType_STATUS Optional

KeyForDiskEncryptionSet

Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots

Used by: DiskEncryptionSet_Spec.

Property	Description	Type
keyUrl	Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value.	string Optional
keyUrlFromConfig	Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value.	genruntime.ConfigMapReference Optional
sourceVault	Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription.	SourceVault Optional

KeyForDiskEncryptionSet_STATUS

Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots

Used by: DiskEncryptionSet_STATUS, and DiskEncryptionSet_STATUS.

Property	Description	Type
keyUrl	Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value.	string Optional
sourceVault	Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription.	SourceVault_STATUS Optional

NetworkAccessPolicy

Policy for accessing the disk via network.

Used by: Disk_Spec, and Snapshot_Spec.

Value	Description
“AllowAll”
“AllowPrivate”
“DenyAll”

NetworkAccessPolicy_STATUS

Policy for accessing the disk via network.

Used by: Disk_STATUS, and Snapshot_STATUS.

Value	Description
“AllowAll”
“AllowPrivate”
“DenyAll”

PrivateEndpointConnection_STATUS

The Private Endpoint Connection resource.

Used by: DiskAccess_STATUS.

Property	Description	Type
id	private endpoint connection Id	string Optional

PropertyUpdatesInProgress_STATUS

Properties of the disk for which update is pending.

Used by: Disk_STATUS.

Property	Description	Type
targetTier	The target performance tier of the disk if a tier change operation is in progress.	string Optional

PublicNetworkAccess

Policy for controlling export on the disk.

Used by: Disk_Spec, and Snapshot_Spec.

Value	Description
“Disabled”
“Enabled”

PublicNetworkAccess_STATUS

Policy for controlling export on the disk.

Used by: Disk_STATUS, and Snapshot_STATUS.

Value	Description
“Disabled”
“Enabled”

PurchasePlan

Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

Used by: Disk_Spec, and Snapshot_Spec.

Property	Description	Type
name	The plan ID.	string Required
product	Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.	string Required
promotionCode	The Offer Promotion Code.	string Optional
publisher	The publisher ID.	string Required

PurchasePlan_STATUS

Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

Used by: Disk_STATUS, and Snapshot_STATUS.

Property	Description	Type
name	The plan ID.	string Optional
product	Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.	string Optional
promotionCode	The Offer Promotion Code.	string Optional
publisher	The publisher ID.	string Optional

ShareInfoElement_STATUS

Used by: Disk_STATUS.

Property	Description	Type
vmUri	A relative URI containing the ID of the VM that has the disk attached.	string Optional

SnapshotOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: Snapshot_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

SnapshotProperties_HyperVGeneration

Used by: Snapshot_Spec.

Value	Description
“V1”
“V2”

SnapshotProperties_HyperVGeneration_STATUS

Used by: Snapshot_STATUS.

Value	Description
“V1”
“V2”

SnapshotProperties_OsType

Used by: Snapshot_Spec.

Value	Description
“Linux”
“Windows”

SnapshotProperties_OsType_STATUS

Used by: Snapshot_STATUS.

Value	Description
“Linux”
“Windows”

SnapshotSku

The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot

Used by: Snapshot_Spec.

Property	Description	Type
name	The sku name.	SnapshotSku_Name Optional

SnapshotSku_STATUS

Used by: Snapshot_STATUS.

Property	Description	Type
name	The sku name.	SnapshotSku_Name_STATUS Optional
tier	The sku tier.	string Optional

SupportedCapabilities

List of supported capabilities persisted on the disk resource for VM use.

Used by: Disk_Spec, and Snapshot_Spec.

Property	Description	Type
acceleratedNetwork	True if the image from which the OS disk is created supports accelerated networking.	bool Optional
architecture	CPU architecture supported by an OS disk.	SupportedCapabilities_Architecture Optional
diskControllerTypes	The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.	string Optional

SupportedCapabilities_STATUS

List of supported capabilities persisted on the disk resource for VM use.

Used by: Disk_STATUS, and Snapshot_STATUS.

Property	Description	Type
acceleratedNetwork	True if the image from which the OS disk is created supports accelerated networking.	bool Optional
architecture	CPU architecture supported by an OS disk.	SupportedCapabilities_Architecture_STATUS Optional
diskControllerTypes	The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.	string Optional

ApiErrorBase_STATUS

Api error base.

Used by: ApiError_STATUS.

Property	Description	Type
code	The error code.	string Optional
message	The error message.	string Optional
target	The target of the particular error.	string Optional

CopyCompletionError_ErrorCode

Used by: CopyCompletionError.

Value	Description
“CopySourceNotFound”

CopyCompletionError_ErrorCode_STATUS

Used by: CopyCompletionError_STATUS.

Value	Description
“CopySourceNotFound”

CreationData_CreateOption

Used by: CreationData.

Value	Description
“Attach”
“Copy”
“CopyFromSanSnapshot”
“CopyStart”
“Empty”
“FromImage”
“Import”
“ImportSecure”
“Restore”
“Upload”
“UploadPreparedSecure”

CreationData_CreateOption_STATUS

Used by: CreationData_STATUS.

Value	Description
“Attach”
“Copy”
“CopyFromSanSnapshot”
“CopyStart”
“Empty”
“FromImage”
“Import”
“ImportSecure”
“Restore”
“Upload”
“UploadPreparedSecure”

CreationData_ProvisionedBandwidthCopySpeed

Used by: CreationData.

Value	Description
“Enhanced”
“None”

CreationData_ProvisionedBandwidthCopySpeed_STATUS

Used by: CreationData_STATUS.

Value	Description
“Enhanced”
“None”

DiskSecurityType

Specifies the SecurityType of the VM. Applicable for OS disks only.

Used by: DiskSecurityProfile.

Value	Description
“ConfidentialVM_DiskEncryptedWithCustomerKey”
“ConfidentialVM_DiskEncryptedWithPlatformKey”
“ConfidentialVM_NonPersistedTPM”
“ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey”
“TrustedLaunch”

DiskSecurityType_STATUS

Specifies the SecurityType of the VM. Applicable for OS disks only.

Used by: DiskSecurityProfile_STATUS.

Value	Description
“ConfidentialVM_DiskEncryptedWithCustomerKey”
“ConfidentialVM_DiskEncryptedWithPlatformKey”
“ConfidentialVM_NonPersistedTPM”
“ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey”
“TrustedLaunch”

DiskSku_Name

Used by: DiskSku.

Value	Description
“PremiumV2_LRS”
“Premium_LRS”
“Premium_ZRS”
“StandardSSD_LRS”
“StandardSSD_ZRS”
“Standard_LRS”
“UltraSSD_LRS”

DiskSku_Name_STATUS

Used by: DiskSku_STATUS.

Value	Description
“PremiumV2_LRS”
“Premium_LRS”
“Premium_ZRS”
“StandardSSD_LRS”
“StandardSSD_ZRS”
“Standard_LRS”
“UltraSSD_LRS”

EncryptionSetIdentity_Type

Used by: EncryptionSetIdentity.

Value	Description
“None”
“SystemAssigned”
“SystemAssigned, UserAssigned”
“UserAssigned”

EncryptionSetIdentity_Type_STATUS

Used by: EncryptionSetIdentity_STATUS.

Value	Description
“None”
“SystemAssigned”
“SystemAssigned, UserAssigned”
“UserAssigned”

EncryptionSetIdentity_UserAssignedIdentities_STATUS

Used by: EncryptionSetIdentity_STATUS.

Property	Description	Type
clientId	The client id of user assigned identity.	string Optional
principalId	The principal id of user assigned identity.	string Optional

EncryptionSettingsElement

Encryption settings for one disk volume.

Used by: EncryptionSettingsCollection.

Property	Description	Type
diskEncryptionKey	Key Vault Secret Url and vault id of the disk encryption key	KeyVaultAndSecretReference Optional
keyEncryptionKey	Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key.	KeyVaultAndKeyReference Optional

EncryptionSettingsElement_STATUS

Encryption settings for one disk volume.

Used by: EncryptionSettingsCollection_STATUS.

Property	Description	Type
diskEncryptionKey	Key Vault Secret Url and vault id of the disk encryption key	KeyVaultAndSecretReference_STATUS Optional
keyEncryptionKey	Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key.	KeyVaultAndKeyReference_STATUS Optional

EncryptionType

The type of key used to encrypt the data of the disk.

Used by: Encryption.

Value	Description
“EncryptionAtRestWithCustomerKey”
“EncryptionAtRestWithPlatformAndCustomerKeys”
“EncryptionAtRestWithPlatformKey”

EncryptionType_STATUS

The type of key used to encrypt the data of the disk.

Used by: Encryption_STATUS.

Value	Description
“EncryptionAtRestWithCustomerKey”
“EncryptionAtRestWithPlatformAndCustomerKeys”
“EncryptionAtRestWithPlatformKey”

ExtendedLocationType

The type of extendedLocation.

Used by: ExtendedLocation.

Value	Description
“EdgeZone”

ExtendedLocationType_STATUS

The type of extendedLocation.

Used by: ExtendedLocation_STATUS.

Value	Description
“EdgeZone”

ImageDiskReference

The source image used for creating the disk.

Used by: CreationData, and CreationData.

Property	Description	Type
communityGalleryImageId	A relative uri containing a community Azure Compute Gallery image reference.	string Optional
lun	If the disk is created from an image’s data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.	int Optional
reference	A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.	genruntime.ResourceReference Optional
sharedGalleryImageId	A relative uri containing a direct shared Azure Compute Gallery image reference.	string Optional

ImageDiskReference_STATUS

The source image used for creating the disk.

Used by: CreationData_STATUS, and CreationData_STATUS.

Property	Description	Type
communityGalleryImageId	A relative uri containing a community Azure Compute Gallery image reference.	string Optional
id	A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.	string Optional
lun	If the disk is created from an image’s data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.	int Optional
sharedGalleryImageId	A relative uri containing a direct shared Azure Compute Gallery image reference.	string Optional

InnerError_STATUS

Inner error details.

Used by: ApiError_STATUS.

Property	Description	Type
errordetail	The internal error message or exception dump.	string Optional
exceptiontype	The exception type.	string Optional

SnapshotSku_Name

Used by: SnapshotSku.

Value	Description
“Premium_LRS”
“Standard_LRS”
“Standard_ZRS”

SnapshotSku_Name_STATUS

Used by: SnapshotSku_STATUS.

Value	Description
“Premium_LRS”
“Standard_LRS”
“Standard_ZRS”

SourceVault

The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Used by: KeyForDiskEncryptionSet, KeyVaultAndKeyReference, and KeyVaultAndSecretReference.

Property	Description	Type
reference	Resource Id	genruntime.ResourceReference Optional

SourceVault_STATUS

The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Used by: KeyForDiskEncryptionSet_STATUS, KeyVaultAndKeyReference_STATUS, and KeyVaultAndSecretReference_STATUS.

Property	Description	Type
id	Resource Id	string Optional

SupportedCapabilities_Architecture

Used by: SupportedCapabilities.

Value	Description
“Arm64”
“x64”

SupportedCapabilities_Architecture_STATUS

Used by: SupportedCapabilities_STATUS.

Value	Description
“Arm64”
“x64”

UserAssignedIdentityDetails

Information about the user assigned identity for the resource

Used by: EncryptionSetIdentity.

Property	Description	Type
reference		genruntime.ResourceReference Optional

KeyVaultAndKeyReference

Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey

Used by: EncryptionSettingsElement.

Property	Description	Type
keyUrl	Url pointing to a key or secret in KeyVault	string Required
sourceVault	Resource id of the KeyVault containing the key or secret	SourceVault Required

KeyVaultAndKeyReference_STATUS

Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey

Used by: EncryptionSettingsElement_STATUS.

Property	Description	Type
keyUrl	Url pointing to a key or secret in KeyVault	string Optional
sourceVault	Resource id of the KeyVault containing the key or secret	SourceVault_STATUS Optional

KeyVaultAndSecretReference

Key Vault Secret Url and vault id of the encryption key

Used by: EncryptionSettingsElement.

Property	Description	Type
secretUrl	Url pointing to a key or secret in KeyVault	string Required
sourceVault	Resource id of the KeyVault containing the key or secret	SourceVault Required

KeyVaultAndSecretReference_STATUS

Key Vault Secret Url and vault id of the encryption key

Used by: EncryptionSettingsElement_STATUS.

Property	Description	Type
secretUrl	Url pointing to a key or secret in KeyVault	string Optional
sourceVault	Resource id of the KeyVault containing the key or secret	SourceVault_STATUS Optional