compute.azure.com/v1api20240302

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

Resource Types:

APIVersion (`string` alias)

Value	Description
"2024-03-02"

ApiErrorBase_STATUS

(Appears on:ApiError_STATUS)

Api error base.

Field	Description
`code` string	Code: The error code.
`message` string	Message: The error message.
`target` string	Target: The target of the particular error.

ApiError_STATUS

(Appears on:DiskEncryptionSet_STATUS)

Api error.

Field	Description
`code` string	Code: The error code.
`details` []ApiErrorBase_STATUS	Details: The Api error details
`innererror` InnerError_STATUS	Innererror: The Api inner error
`message` string	Message: The error message.
`target` string	Target: The target of the particular error.

CopyCompletionError

(Appears on:Snapshot_Spec)

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

Field	Description
`errorCode` CopyCompletionError_ErrorCode	ErrorCode: Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
`errorMessage` string	ErrorMessage: Indicates the error message if the background copy of a resource created via the CopyStart operation fails.

CopyCompletionError_ErrorCode (`string` alias)

(Appears on:CopyCompletionError)

Value	Description
"CopySourceNotFound"

CopyCompletionError_ErrorCode_STATUS (`string` alias)

(Appears on:CopyCompletionError_STATUS)

Value	Description
"CopySourceNotFound"

CopyCompletionError_STATUS

(Appears on:Snapshot_STATUS)

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

Field	Description
`errorCode` CopyCompletionError_ErrorCode_STATUS	ErrorCode: Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
`errorMessage` string	ErrorMessage: Indicates the error message if the background copy of a resource created via the CopyStart operation fails.

CreationData

(Appears on:Disk_Spec, Snapshot_Spec)

Data used when creating a disk.

Field	Description
`createOption` CreationData_CreateOption	CreateOption: This enumerates the possible sources of a disk’s creation.
`elasticSanResourceReference` genruntime.ResourceReference	ElasticSanResourceReference: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
`galleryImageReference` ImageDiskReference	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.
`imageReference` ImageDiskReference	ImageReference: Disk source information for PIR or user images.
`logicalSectorSize` int	LogicalSectorSize: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
`performancePlus` bool	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.
`provisionedBandwidthCopySpeed` CreationData_ProvisionedBandwidthCopySpeed	ProvisionedBandwidthCopySpeed: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
`securityDataUri` string	SecurityDataUri: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
`sourceResourceReference` genruntime.ResourceReference	SourceResourceReference: If createOption is Copy, this is the ARM id of the source snapshot or disk.
`sourceUri` string	SourceUri: If createOption is Import, this is the URI of a blob to be imported into a managed disk.
`storageAccountId` string	StorageAccountId: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
`uploadSizeBytes` int	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).

CreationData_CreateOption (`string` alias)

(Appears on:CreationData)

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

CreationData_CreateOption_STATUS (`string` alias)

(Appears on:CreationData_STATUS)

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

CreationData_ProvisionedBandwidthCopySpeed (`string` alias)

(Appears on:CreationData)

Value	Description
"Enhanced"
"None"

CreationData_ProvisionedBandwidthCopySpeed_STATUS (`string` alias)

(Appears on:CreationData_STATUS)

Value	Description
"Enhanced"
"None"

CreationData_STATUS

(Appears on:Disk_STATUS, Snapshot_STATUS)

Data used when creating a disk.

Field	Description
`createOption` CreationData_CreateOption_STATUS	CreateOption: This enumerates the possible sources of a disk’s creation.
`elasticSanResourceId` string	ElasticSanResourceId: Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
`galleryImageReference` ImageDiskReference_STATUS	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.
`imageReference` ImageDiskReference_STATUS	ImageReference: Disk source information for PIR or user images.
`logicalSectorSize` int	LogicalSectorSize: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
`performancePlus` bool	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.
`provisionedBandwidthCopySpeed` CreationData_ProvisionedBandwidthCopySpeed_STATUS	ProvisionedBandwidthCopySpeed: If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
`securityDataUri` string	SecurityDataUri: If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
`sourceResourceId` string	SourceResourceId: If createOption is Copy, this is the ARM id of the source snapshot or disk.
`sourceUniqueId` string	SourceUniqueId: If this field is set, this is the unique id identifying the source of this resource.
`sourceUri` string	SourceUri: If createOption is Import, this is the URI of a blob to be imported into a managed disk.
`storageAccountId` string	StorageAccountId: Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
`uploadSizeBytes` int	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).

DataAccessAuthMode (`string` alias)

(Appears on:Disk_Spec, Snapshot_Spec)

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

Value	Description
"AzureActiveDirectory"
"None"

DataAccessAuthMode_STATUS (`string` alias)

(Appears on:Disk_STATUS, Snapshot_STATUS)

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

Value	Description
"AzureActiveDirectory"
"None"

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}

Field Description

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

spec
Disk_Spec

`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`burstingEnabled` bool	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.
`completionPercent` float64	CompletionPercent: Percentage complete for the background copy when a resource is created via the CopyStart operation.
`creationData` CreationData	CreationData: Disk source information. CreationData information cannot be changed after the disk has been created.
`dataAccessAuthMode` DataAccessAuthMode	DataAccessAuthMode: Additional authentication requirements when exporting or uploading to a disk or snapshot.
`diskAccessReference` genruntime.ResourceReference	DiskAccessReference: ARM id of the DiskAccess resource for using private endpoints on disks.
`diskIOPSReadOnly` int	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.
`diskIOPSReadWrite` int	DiskIOPSReadWrite: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
`diskMBpsReadOnly` int	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.
`diskMBpsReadWrite` int	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.
`diskSizeGB` int	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.
`encryption` Encryption	Encryption: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
`encryptionSettingsCollection` EncryptionSettingsCollection	EncryptionSettingsCollection: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
`extendedLocation` ExtendedLocation	ExtendedLocation: The extended location where the disk will be created. Extended location cannot be changed.
`hyperVGeneration` DiskProperties_HyperVGeneration	HyperVGeneration: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
`location` string	Location: Resource location
`maxShares` int	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.
`networkAccessPolicy` NetworkAccessPolicy	NetworkAccessPolicy: Policy for accessing the disk via network.
`operatorSpec` DiskOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`optimizedForFrequentAttach` bool	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.
`osType` DiskProperties_OsType	OsType: The Operating System type.
`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
`publicNetworkAccess` PublicNetworkAccess	PublicNetworkAccess: Policy for controlling export on the disk.
`purchasePlan` PurchasePlan	PurchasePlan: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}
`securityProfile` DiskSecurityProfile	SecurityProfile: Contains the security related information for the resource.
`sku` DiskSku	Sku: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.
`supportedCapabilities` SupportedCapabilities	SupportedCapabilities: List of supported capabilities for the image from which the OS disk was created.
`supportsHibernation` bool	SupportsHibernation: Indicates the OS on a disk supports hibernation.
`tags` map[string]string	Tags: Resource tags
`tier` string	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.
`zones` []string	Zones: The Logical zone list for Disk.

status
Disk_STATUS

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}

Field Description

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

spec
DiskAccess_Spec

`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`extendedLocation` ExtendedLocation	ExtendedLocation: The extended location where the disk access will be created. Extended location cannot be changed.
`location` string	Location: Resource location
`operatorSpec` DiskAccessOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`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
`tags` map[string]string	Tags: Resource tags

status
DiskAccess_STATUS

DiskAccessOperatorSpec

(Appears on:DiskAccess_Spec)

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

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

DiskAccess_STATUS

(Appears on:DiskAccess)

disk access resource.

Field	Description
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`extendedLocation` ExtendedLocation_STATUS	ExtendedLocation: The extended location where the disk access will be created. Extended location cannot be changed.
`id` string	Id: Resource Id
`location` string	Location: Resource location
`name` string	Name: Resource name
`privateEndpointConnections` []PrivateEndpointConnection_STATUS	PrivateEndpointConnections: A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported.
`provisioningState` string	ProvisioningState: The disk access resource provisioning state.
`tags` map[string]string	Tags: Resource tags
`timeCreated` string	TimeCreated: The time when the disk access was created.
`type` string	Type: Resource type

DiskAccess_Spec

(Appears on:DiskAccess)

Field	Description
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`extendedLocation` ExtendedLocation	ExtendedLocation: The extended location where the disk access will be created. Extended location cannot be changed.
`location` string	Location: Resource location
`operatorSpec` DiskAccessOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`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
`tags` map[string]string	Tags: Resource tags

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}

Field Description

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

spec
DiskEncryptionSet_Spec

`activeKey` KeyForDiskEncryptionSet	ActiveKey: The key vault key which is currently used by this disk encryption set.
`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.
`encryptionType` DiskEncryptionSetType	EncryptionType: The type of key used to encrypt the data of the disk.
`federatedClientId` string	FederatedClientId: Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.
`federatedClientIdFromConfig` genruntime.ConfigMapReference	FederatedClientIdFromConfig: Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.
`identity` EncryptionSetIdentity	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.
`location` string	Location: Resource location
`operatorSpec` DiskEncryptionSetOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`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
`rotationToLatestKeyVersionEnabled` bool	RotationToLatestKeyVersionEnabled: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
`tags` map[string]string	Tags: Resource tags

status
DiskEncryptionSet_STATUS

DiskEncryptionSetOperatorSpec

(Appears on:DiskEncryptionSet_Spec)

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

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

DiskEncryptionSetType (`string` alias)

(Appears on:DiskEncryptionSet_Spec)

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

Value	Description
"ConfidentialVmEncryptedWithCustomerKey"
"EncryptionAtRestWithCustomerKey"
"EncryptionAtRestWithPlatformAndCustomerKeys"

DiskEncryptionSetType_STATUS (`string` alias)

(Appears on:DiskEncryptionSet_STATUS)

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

Value	Description
"ConfidentialVmEncryptedWithCustomerKey"
"EncryptionAtRestWithCustomerKey"
"EncryptionAtRestWithPlatformAndCustomerKeys"

DiskEncryptionSet_STATUS

(Appears on:DiskEncryptionSet)

disk encryption set resource.

Field	Description
`activeKey` KeyForDiskEncryptionSet_STATUS	ActiveKey: The key vault key which is currently used by this disk encryption set.
`autoKeyRotationError` ApiError_STATUS	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.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`encryptionType` DiskEncryptionSetType_STATUS	EncryptionType: The type of key used to encrypt the data of the disk.
`federatedClientId` string	FederatedClientId: Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.
`id` string	Id: Resource Id
`identity` EncryptionSetIdentity_STATUS	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.
`lastKeyRotationTimestamp` string	LastKeyRotationTimestamp: The time when the active key of this disk encryption set was updated.
`location` string	Location: Resource location
`name` string	Name: Resource name
`previousKeys` []KeyForDiskEncryptionSet_STATUS	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.
`provisioningState` string	ProvisioningState: The disk encryption set provisioning state.
`rotationToLatestKeyVersionEnabled` bool	RotationToLatestKeyVersionEnabled: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
`tags` map[string]string	Tags: Resource tags
`type` string	Type: Resource type

DiskEncryptionSet_Spec

(Appears on:DiskEncryptionSet)

Field	Description
`activeKey` KeyForDiskEncryptionSet	ActiveKey: The key vault key which is currently used by this disk encryption set.
`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.
`encryptionType` DiskEncryptionSetType	EncryptionType: The type of key used to encrypt the data of the disk.
`federatedClientId` string	FederatedClientId: Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.
`federatedClientIdFromConfig` genruntime.ConfigMapReference	FederatedClientIdFromConfig: Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.
`identity` EncryptionSetIdentity	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.
`location` string	Location: Resource location
`operatorSpec` DiskEncryptionSetOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`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
`rotationToLatestKeyVersionEnabled` bool	RotationToLatestKeyVersionEnabled: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
`tags` map[string]string	Tags: Resource tags

DiskOperatorSpec

(Appears on:Disk_Spec)

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

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

DiskProperties_HyperVGeneration (`string` alias)

(Appears on:Disk_Spec)

Value	Description
"V1"
"V2"

DiskProperties_HyperVGeneration_STATUS (`string` alias)

(Appears on:Disk_STATUS)

Value	Description
"V1"
"V2"

DiskProperties_OsType (`string` alias)

(Appears on:Disk_Spec)

Value	Description
"Linux"
"Windows"

DiskProperties_OsType_STATUS (`string` alias)

(Appears on:Disk_STATUS)

Value	Description
"Linux"
"Windows"

DiskSecurityProfile

(Appears on:Disk_Spec, Snapshot_Spec)

Contains the security related information for the resource.

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

DiskSecurityProfile_STATUS

(Appears on:Disk_STATUS, Snapshot_STATUS)

Contains the security related information for the resource.

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

DiskSecurityType (`string` alias)

(Appears on:DiskSecurityProfile)

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

Value	Description
"ConfidentialVM_DiskEncryptedWithCustomerKey"
"ConfidentialVM_DiskEncryptedWithPlatformKey"
"ConfidentialVM_NonPersistedTPM"
"ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey"
"TrustedLaunch"

DiskSecurityType_STATUS (`string` alias)

(Appears on:DiskSecurityProfile_STATUS)

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

Value	Description
"ConfidentialVM_DiskEncryptedWithCustomerKey"
"ConfidentialVM_DiskEncryptedWithPlatformKey"
"ConfidentialVM_NonPersistedTPM"
"ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey"
"TrustedLaunch"

DiskSku

(Appears on:Disk_Spec)

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

Field	Description
`name` DiskSku_Name	Name: The sku name.

DiskSku_Name (`string` alias)

(Appears on:DiskSku)

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

DiskSku_Name_STATUS (`string` alias)

(Appears on:DiskSku_STATUS)

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

DiskSku_STATUS

(Appears on:Disk_STATUS)

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

Field	Description
`name` DiskSku_Name_STATUS	Name: The sku name.
`tier` string	Tier: The sku tier.

DiskState (`string` alias)

(Appears on:Snapshot_Spec)

This enumerates the possible state of the disk.

Value	Description
"ActiveSAS"
"ActiveSASFrozen"
"ActiveUpload"
"Attached"
"Frozen"
"ReadyToUpload"
"Reserved"
"Unattached"

DiskState_STATUS (`string` alias)

(Appears on:Disk_STATUS, Snapshot_STATUS)

This enumerates the possible state of the disk.

Value	Description
"ActiveSAS"
"ActiveSASFrozen"
"ActiveUpload"
"Attached"
"Frozen"
"ReadyToUpload"
"Reserved"
"Unattached"

Disk_STATUS

(Appears on:Disk)

Disk resource.

Field	Description
`burstingEnabled` bool	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.
`burstingEnabledTime` string	BurstingEnabledTime: Latest time when bursting was last enabled on a disk.
`completionPercent` float64	CompletionPercent: Percentage complete for the background copy when a resource is created via the CopyStart operation.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`creationData` CreationData_STATUS	CreationData: Disk source information. CreationData information cannot be changed after the disk has been created.
`dataAccessAuthMode` DataAccessAuthMode_STATUS	DataAccessAuthMode: Additional authentication requirements when exporting or uploading to a disk or snapshot.
`diskAccessId` string	DiskAccessId: ARM id of the DiskAccess resource for using private endpoints on disks.
`diskIOPSReadOnly` int	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.
`diskIOPSReadWrite` int	DiskIOPSReadWrite: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
`diskMBpsReadOnly` int	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.
`diskMBpsReadWrite` int	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.
`diskSizeBytes` int	DiskSizeBytes: The size of the disk in bytes. This field is read only.
`diskSizeGB` int	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.
`diskState` DiskState_STATUS	DiskState: The state of the disk.
`encryption` Encryption_STATUS	Encryption: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
`encryptionSettingsCollection` EncryptionSettingsCollection_STATUS	EncryptionSettingsCollection: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
`extendedLocation` ExtendedLocation_STATUS	ExtendedLocation: The extended location where the disk will be created. Extended location cannot be changed.
`hyperVGeneration` DiskProperties_HyperVGeneration_STATUS	HyperVGeneration: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
`id` string	Id: Resource Id
`LastOwnershipUpdateTime` string	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.
`location` string	Location: Resource location
`managedBy` string	ManagedBy: A relative URI containing the ID of the VM that has the disk attached.
`managedByExtended` []string	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.
`maxShares` int	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.
`name` string	Name: Resource name
`networkAccessPolicy` NetworkAccessPolicy_STATUS	NetworkAccessPolicy: Policy for accessing the disk via network.
`optimizedForFrequentAttach` bool	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.
`osType` DiskProperties_OsType_STATUS	OsType: The Operating System type.
`propertyUpdatesInProgress` PropertyUpdatesInProgress_STATUS	PropertyUpdatesInProgress: Properties of the disk for which update is pending.
`provisioningState` string	ProvisioningState: The disk provisioning state.
`publicNetworkAccess` PublicNetworkAccess_STATUS	PublicNetworkAccess: Policy for controlling export on the disk.
`purchasePlan` PurchasePlan_STATUS	PurchasePlan: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}
`securityProfile` DiskSecurityProfile_STATUS	SecurityProfile: Contains the security related information for the resource.
`shareInfo` []ShareInfoElement_STATUS	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.
`sku` DiskSku_STATUS	Sku: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.
`supportedCapabilities` SupportedCapabilities_STATUS	SupportedCapabilities: List of supported capabilities for the image from which the OS disk was created.
`supportsHibernation` bool	SupportsHibernation: Indicates the OS on a disk supports hibernation.
`tags` map[string]string	Tags: Resource tags
`tier` string	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.
`timeCreated` string	TimeCreated: The time when the disk was created.
`type` string	Type: Resource type
`uniqueId` string	UniqueId: Unique Guid identifying the resource.
`zones` []string	Zones: The Logical zone list for Disk.

Disk_Spec

(Appears on:Disk)

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.
`burstingEnabled` bool	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.
`completionPercent` float64	CompletionPercent: Percentage complete for the background copy when a resource is created via the CopyStart operation.
`creationData` CreationData	CreationData: Disk source information. CreationData information cannot be changed after the disk has been created.
`dataAccessAuthMode` DataAccessAuthMode	DataAccessAuthMode: Additional authentication requirements when exporting or uploading to a disk or snapshot.
`diskAccessReference` genruntime.ResourceReference	DiskAccessReference: ARM id of the DiskAccess resource for using private endpoints on disks.
`diskIOPSReadOnly` int	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.
`diskIOPSReadWrite` int	DiskIOPSReadWrite: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
`diskMBpsReadOnly` int	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.
`diskMBpsReadWrite` int	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.
`diskSizeGB` int	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.
`encryption` Encryption	Encryption: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
`encryptionSettingsCollection` EncryptionSettingsCollection	EncryptionSettingsCollection: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
`extendedLocation` ExtendedLocation	ExtendedLocation: The extended location where the disk will be created. Extended location cannot be changed.
`hyperVGeneration` DiskProperties_HyperVGeneration	HyperVGeneration: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
`location` string	Location: Resource location
`maxShares` int	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.
`networkAccessPolicy` NetworkAccessPolicy	NetworkAccessPolicy: Policy for accessing the disk via network.
`operatorSpec` DiskOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`optimizedForFrequentAttach` bool	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.
`osType` DiskProperties_OsType	OsType: The Operating System type.
`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
`publicNetworkAccess` PublicNetworkAccess	PublicNetworkAccess: Policy for controlling export on the disk.
`purchasePlan` PurchasePlan	PurchasePlan: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}
`securityProfile` DiskSecurityProfile	SecurityProfile: Contains the security related information for the resource.
`sku` DiskSku	Sku: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.
`supportedCapabilities` SupportedCapabilities	SupportedCapabilities: List of supported capabilities for the image from which the OS disk was created.
`supportsHibernation` bool	SupportsHibernation: Indicates the OS on a disk supports hibernation.
`tags` map[string]string	Tags: Resource tags
`tier` string	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.
`zones` []string	Zones: The Logical zone list for Disk.

Encryption

(Appears on:Disk_Spec, Snapshot_Spec)

Encryption at rest settings for disk or snapshot

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

EncryptionSetIdentity

(Appears on:DiskEncryptionSet_Spec)

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.

Field	Description
`type` EncryptionSetIdentity_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.
`userAssignedIdentities` []UserAssignedIdentityDetails	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}’.

EncryptionSetIdentity_STATUS

(Appears on:DiskEncryptionSet_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.

Field	Description
`principalId` string	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
`tenantId` string	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
`type` EncryptionSetIdentity_Type_STATUS	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.
`userAssignedIdentities` map[string]./api/compute/v1api20240302.EncryptionSetIdentity_UserAssignedIdentities_STATUS	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}’.

EncryptionSetIdentity_Type (`string` alias)

(Appears on:EncryptionSetIdentity)

Value	Description
"None"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"

EncryptionSetIdentity_Type_STATUS (`string` alias)

(Appears on:EncryptionSetIdentity_STATUS)

Value	Description
"None"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"

EncryptionSetIdentity_UserAssignedIdentities_STATUS

(Appears on:EncryptionSetIdentity_STATUS)

Field	Description
`clientId` string	ClientId: The client id of user assigned identity.
`principalId` string	PrincipalId: The principal id of user assigned identity.

EncryptionSettingsCollection

(Appears on:Disk_Spec, Snapshot_Spec)

Encryption settings for disk or snapshot

Field	Description
`enabled` bool	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.
`encryptionSettings` []EncryptionSettingsElement	EncryptionSettings: A collection of encryption settings, one for each disk volume.
`encryptionSettingsVersion` string	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.

EncryptionSettingsCollection_STATUS

(Appears on:Disk_STATUS, Snapshot_STATUS)

Encryption settings for disk or snapshot

Field	Description
`enabled` bool	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.
`encryptionSettings` []EncryptionSettingsElement_STATUS	EncryptionSettings: A collection of encryption settings, one for each disk volume.
`encryptionSettingsVersion` string	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.

EncryptionSettingsElement

(Appears on:EncryptionSettingsCollection)

Encryption settings for one disk volume.

Field	Description
`diskEncryptionKey` KeyVaultAndSecretReference	DiskEncryptionKey: Key Vault Secret Url and vault id of the disk encryption key
`keyEncryptionKey` KeyVaultAndKeyReference	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.

EncryptionSettingsElement_STATUS

(Appears on:EncryptionSettingsCollection_STATUS)

Encryption settings for one disk volume.

Field	Description
`diskEncryptionKey` KeyVaultAndSecretReference_STATUS	DiskEncryptionKey: Key Vault Secret Url and vault id of the disk encryption key
`keyEncryptionKey` KeyVaultAndKeyReference_STATUS	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.

EncryptionType (`string` alias)

(Appears on:Encryption)

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

Value	Description
"EncryptionAtRestWithCustomerKey"
"EncryptionAtRestWithPlatformAndCustomerKeys"
"EncryptionAtRestWithPlatformKey"

EncryptionType_STATUS (`string` alias)

(Appears on:Encryption_STATUS)

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

Value	Description
"EncryptionAtRestWithCustomerKey"
"EncryptionAtRestWithPlatformAndCustomerKeys"
"EncryptionAtRestWithPlatformKey"

Encryption_STATUS

(Appears on:Disk_STATUS, Snapshot_STATUS)

Encryption at rest settings for disk or snapshot

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

ExtendedLocation

(Appears on:DiskAccess_Spec, Disk_Spec, Snapshot_Spec)

The complex type of the extended location.

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

ExtendedLocationType (`string` alias)

(Appears on:ExtendedLocation)

The type of extendedLocation.

Value	Description
"EdgeZone"

ExtendedLocationType_STATUS (`string` alias)

(Appears on:ExtendedLocation_STATUS)

The type of extendedLocation.

Value	Description
"EdgeZone"

ExtendedLocation_STATUS

(Appears on:DiskAccess_STATUS, Disk_STATUS, Snapshot_STATUS)

The complex type of the extended location.

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

ImageDiskReference

(Appears on:CreationData)

The source image used for creating the disk.

Field	Description
`communityGalleryImageId` string	CommunityGalleryImageId: A relative uri containing a community Azure Compute Gallery image reference.
`lun` int	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.
`reference` genruntime.ResourceReference	Reference: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
`sharedGalleryImageId` string	SharedGalleryImageId: A relative uri containing a direct shared Azure Compute Gallery image reference.

ImageDiskReference_STATUS

(Appears on:CreationData_STATUS)

The source image used for creating the disk.

Field	Description
`communityGalleryImageId` string	CommunityGalleryImageId: A relative uri containing a community Azure Compute Gallery image reference.
`id` string	Id: A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
`lun` int	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.
`sharedGalleryImageId` string	SharedGalleryImageId: A relative uri containing a direct shared Azure Compute Gallery image reference.

InnerError_STATUS

(Appears on:ApiError_STATUS)

Inner error details.

Field	Description
`errordetail` string	Errordetail: The internal error message or exception dump.
`exceptiontype` string	Exceptiontype: The exception type.

KeyForDiskEncryptionSet

(Appears on:DiskEncryptionSet_Spec)

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

Field	Description
`keyUrl` string	KeyUrl: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value.
`keyUrlFromConfig` genruntime.ConfigMapReference	KeyUrlFromConfig: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value.
`sourceVault` SourceVault	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.

KeyForDiskEncryptionSet_STATUS

(Appears on:DiskEncryptionSet_STATUS)

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

Field	Description
`keyUrl` string	KeyUrl: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value.
`sourceVault` SourceVault_STATUS	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.

KeyVaultAndKeyReference

(Appears on:EncryptionSettingsElement)

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

Field	Description
`keyUrl` string	KeyUrl: Url pointing to a key or secret in KeyVault
`sourceVault` SourceVault	SourceVault: Resource id of the KeyVault containing the key or secret

KeyVaultAndKeyReference_STATUS

(Appears on:EncryptionSettingsElement_STATUS)

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

Field	Description
`keyUrl` string	KeyUrl: Url pointing to a key or secret in KeyVault
`sourceVault` SourceVault_STATUS	SourceVault: Resource id of the KeyVault containing the key or secret

KeyVaultAndSecretReference

(Appears on:EncryptionSettingsElement)

Key Vault Secret Url and vault id of the encryption key

Field	Description
`secretUrl` string	SecretUrl: Url pointing to a key or secret in KeyVault
`sourceVault` SourceVault	SourceVault: Resource id of the KeyVault containing the key or secret

KeyVaultAndSecretReference_STATUS

(Appears on:EncryptionSettingsElement_STATUS)

Key Vault Secret Url and vault id of the encryption key

Field	Description
`secretUrl` string	SecretUrl: Url pointing to a key or secret in KeyVault
`sourceVault` SourceVault_STATUS	SourceVault: Resource id of the KeyVault containing the key or secret

NetworkAccessPolicy (`string` alias)

(Appears on:Disk_Spec, Snapshot_Spec)

Policy for accessing the disk via network.

Value	Description
"AllowAll"
"AllowPrivate"
"DenyAll"

NetworkAccessPolicy_STATUS (`string` alias)

(Appears on:Disk_STATUS, Snapshot_STATUS)

Policy for accessing the disk via network.

Value	Description
"AllowAll"
"AllowPrivate"
"DenyAll"

PrivateEndpointConnection_STATUS

(Appears on:DiskAccess_STATUS)

The Private Endpoint Connection resource.

Field	Description
`id` string	Id: private endpoint connection Id

PropertyUpdatesInProgress_STATUS

(Appears on:Disk_STATUS)

Properties of the disk for which update is pending.

Field	Description
`targetTier` string	TargetTier: The target performance tier of the disk if a tier change operation is in progress.

PublicNetworkAccess (`string` alias)

(Appears on:Disk_Spec, Snapshot_Spec)

Policy for controlling export on the disk.

Value	Description
"Disabled"
"Enabled"

PublicNetworkAccess_STATUS (`string` alias)

(Appears on:Disk_STATUS, Snapshot_STATUS)

Policy for controlling export on the disk.

Value	Description
"Disabled"
"Enabled"

PurchasePlan

(Appears on:Disk_Spec, Snapshot_Spec)

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

Field	Description
`name` string	Name: The plan ID.
`product` string	Product: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
`promotionCode` string	PromotionCode: The Offer Promotion Code.
`publisher` string	Publisher: The publisher ID.

PurchasePlan_STATUS

(Appears on:Disk_STATUS, Snapshot_STATUS)

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

Field	Description
`name` string	Name: The plan ID.
`product` string	Product: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
`promotionCode` string	PromotionCode: The Offer Promotion Code.
`publisher` string	Publisher: The publisher ID.

ShareInfoElement_STATUS

(Appears on:Disk_STATUS)

Field	Description
`vmUri` string	VmUri: A relative URI containing the ID of the VM that has the disk attached.

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}

Field Description

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

spec
Snapshot_Spec

`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`completionPercent` float64	CompletionPercent: Percentage complete for the background copy when a resource is created via the CopyStart operation.
`copyCompletionError` CopyCompletionError	CopyCompletionError: Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
`creationData` CreationData	CreationData: Disk source information. CreationData information cannot be changed after the disk has been created.
`dataAccessAuthMode` DataAccessAuthMode	DataAccessAuthMode: Additional authentication requirements when exporting or uploading to a disk or snapshot.
`diskAccessReference` genruntime.ResourceReference	DiskAccessReference: ARM id of the DiskAccess resource for using private endpoints on disks.
`diskSizeGB` int	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.
`diskState` DiskState	DiskState: The state of the snapshot.
`encryption` Encryption	Encryption: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
`encryptionSettingsCollection` EncryptionSettingsCollection	EncryptionSettingsCollection: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
`extendedLocation` ExtendedLocation	ExtendedLocation: The extended location where the snapshot will be created. Extended location cannot be changed.
`hyperVGeneration` SnapshotProperties_HyperVGeneration	HyperVGeneration: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
`incremental` bool	Incremental: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
`location` string	Location: Resource location
`networkAccessPolicy` NetworkAccessPolicy	NetworkAccessPolicy: Policy for accessing the disk via network.
`operatorSpec` SnapshotOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`osType` SnapshotProperties_OsType	OsType: The Operating System type.
`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
`publicNetworkAccess` PublicNetworkAccess	PublicNetworkAccess: Policy for controlling export on the disk.
`purchasePlan` PurchasePlan	PurchasePlan: Purchase plan information for the image from which the source disk for the snapshot was originally created.
`securityProfile` DiskSecurityProfile	SecurityProfile: Contains the security related information for the resource.
`sku` SnapshotSku	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
`supportedCapabilities` SupportedCapabilities	SupportedCapabilities: List of supported capabilities for the image from which the source disk from the snapshot was originally created.
`supportsHibernation` bool	SupportsHibernation: Indicates the OS on a snapshot supports hibernation.
`tags` map[string]string	Tags: Resource tags

status
Snapshot_STATUS

SnapshotOperatorSpec

(Appears on:Snapshot_Spec)

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

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

SnapshotProperties_HyperVGeneration (`string` alias)

(Appears on:Snapshot_Spec)

Value	Description
"V1"
"V2"

SnapshotProperties_HyperVGeneration_STATUS (`string` alias)

(Appears on:Snapshot_STATUS)

Value	Description
"V1"
"V2"

SnapshotProperties_OsType (`string` alias)

(Appears on:Snapshot_Spec)

Value	Description
"Linux"
"Windows"

SnapshotProperties_OsType_STATUS (`string` alias)

(Appears on:Snapshot_STATUS)

Value	Description
"Linux"
"Windows"

SnapshotSku

(Appears on:Snapshot_Spec)

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

Field	Description
`name` SnapshotSku_Name	Name: The sku name.

SnapshotSku_Name (`string` alias)

(Appears on:SnapshotSku)

Value	Description
"Premium_LRS"
"Standard_LRS"
"Standard_ZRS"

SnapshotSku_Name_STATUS (`string` alias)

(Appears on:SnapshotSku_STATUS)

Value	Description
"Premium_LRS"
"Standard_LRS"
"Standard_ZRS"

SnapshotSku_STATUS

(Appears on:Snapshot_STATUS)

Field	Description
`name` SnapshotSku_Name_STATUS	Name: The sku name.
`tier` string	Tier: The sku tier.

Snapshot_STATUS

(Appears on:Snapshot)

Snapshot resource.

Field	Description
`completionPercent` float64	CompletionPercent: Percentage complete for the background copy when a resource is created via the CopyStart operation.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`copyCompletionError` CopyCompletionError_STATUS	CopyCompletionError: Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
`creationData` CreationData_STATUS	CreationData: Disk source information. CreationData information cannot be changed after the disk has been created.
`dataAccessAuthMode` DataAccessAuthMode_STATUS	DataAccessAuthMode: Additional authentication requirements when exporting or uploading to a disk or snapshot.
`diskAccessId` string	DiskAccessId: ARM id of the DiskAccess resource for using private endpoints on disks.
`diskSizeBytes` int	DiskSizeBytes: The size of the disk in bytes. This field is read only.
`diskSizeGB` int	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.
`diskState` DiskState_STATUS	DiskState: The state of the snapshot.
`encryption` Encryption_STATUS	Encryption: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
`encryptionSettingsCollection` EncryptionSettingsCollection_STATUS	EncryptionSettingsCollection: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
`extendedLocation` ExtendedLocation_STATUS	ExtendedLocation: The extended location where the snapshot will be created. Extended location cannot be changed.
`hyperVGeneration` SnapshotProperties_HyperVGeneration_STATUS	HyperVGeneration: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
`id` string	Id: Resource Id
`incremental` bool	Incremental: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
`incrementalSnapshotFamilyId` string	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.
`location` string	Location: Resource location
`managedBy` string	ManagedBy: Unused. Always Null.
`name` string	Name: Resource name
`networkAccessPolicy` NetworkAccessPolicy_STATUS	NetworkAccessPolicy: Policy for accessing the disk via network.
`osType` SnapshotProperties_OsType_STATUS	OsType: The Operating System type.
`provisioningState` string	ProvisioningState: The disk provisioning state.
`publicNetworkAccess` PublicNetworkAccess_STATUS	PublicNetworkAccess: Policy for controlling export on the disk.
`purchasePlan` PurchasePlan_STATUS	PurchasePlan: Purchase plan information for the image from which the source disk for the snapshot was originally created.
`securityProfile` DiskSecurityProfile_STATUS	SecurityProfile: Contains the security related information for the resource.
`sku` SnapshotSku_STATUS	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
`supportedCapabilities` SupportedCapabilities_STATUS	SupportedCapabilities: List of supported capabilities for the image from which the source disk from the snapshot was originally created.
`supportsHibernation` bool	SupportsHibernation: Indicates the OS on a snapshot supports hibernation.
`tags` map[string]string	Tags: Resource tags
`timeCreated` string	TimeCreated: The time when the snapshot was created.
`type` string	Type: Resource type
`uniqueId` string	UniqueId: Unique Guid identifying the resource.

Snapshot_Spec

(Appears on:Snapshot)

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.
`completionPercent` float64	CompletionPercent: Percentage complete for the background copy when a resource is created via the CopyStart operation.
`copyCompletionError` CopyCompletionError	CopyCompletionError: Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
`creationData` CreationData	CreationData: Disk source information. CreationData information cannot be changed after the disk has been created.
`dataAccessAuthMode` DataAccessAuthMode	DataAccessAuthMode: Additional authentication requirements when exporting or uploading to a disk or snapshot.
`diskAccessReference` genruntime.ResourceReference	DiskAccessReference: ARM id of the DiskAccess resource for using private endpoints on disks.
`diskSizeGB` int	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.
`diskState` DiskState	DiskState: The state of the snapshot.
`encryption` Encryption	Encryption: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
`encryptionSettingsCollection` EncryptionSettingsCollection	EncryptionSettingsCollection: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
`extendedLocation` ExtendedLocation	ExtendedLocation: The extended location where the snapshot will be created. Extended location cannot be changed.
`hyperVGeneration` SnapshotProperties_HyperVGeneration	HyperVGeneration: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
`incremental` bool	Incremental: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
`location` string	Location: Resource location
`networkAccessPolicy` NetworkAccessPolicy	NetworkAccessPolicy: Policy for accessing the disk via network.
`operatorSpec` SnapshotOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`osType` SnapshotProperties_OsType	OsType: The Operating System type.
`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
`publicNetworkAccess` PublicNetworkAccess	PublicNetworkAccess: Policy for controlling export on the disk.
`purchasePlan` PurchasePlan	PurchasePlan: Purchase plan information for the image from which the source disk for the snapshot was originally created.
`securityProfile` DiskSecurityProfile	SecurityProfile: Contains the security related information for the resource.
`sku` SnapshotSku	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
`supportedCapabilities` SupportedCapabilities	SupportedCapabilities: List of supported capabilities for the image from which the source disk from the snapshot was originally created.
`supportsHibernation` bool	SupportsHibernation: Indicates the OS on a snapshot supports hibernation.
`tags` map[string]string	Tags: Resource tags

SourceVault

(Appears on:KeyForDiskEncryptionSet, KeyVaultAndKeyReference, KeyVaultAndSecretReference)

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

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

SourceVault_STATUS

(Appears on:KeyForDiskEncryptionSet_STATUS, KeyVaultAndKeyReference_STATUS, KeyVaultAndSecretReference_STATUS)

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

Field	Description
`id` string	Id: Resource Id

SupportedCapabilities

(Appears on:Disk_Spec, Snapshot_Spec)

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

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

SupportedCapabilities_Architecture (`string` alias)

(Appears on:SupportedCapabilities)

Value	Description
"Arm64"
"x64"

SupportedCapabilities_Architecture_STATUS (`string` alias)

(Appears on:SupportedCapabilities_STATUS)

Value	Description
"Arm64"
"x64"

SupportedCapabilities_STATUS

(Appears on:Disk_STATUS, Snapshot_STATUS)

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

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

UserAssignedIdentityDetails

(Appears on:EncryptionSetIdentity)

Information about the user assigned identity for the resource

Field	Description
`reference` genruntime.ResourceReference

compute.azure.com/v1api20240302