compute.azure.com/v1api20200930
APIVersion
| Value | Description |
|---|---|
| “2020-09-30” |
Disk
Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/DiskRP/stable/2020-09-30/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 |
| creationData | Disk source information. CreationData information cannot be changed after the disk has been created. | CreationData Required |
| 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 |
| 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 |
| 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 |
| sku | The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS. | DiskSku 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 |
| 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 |
| 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 |
| 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 |
| osType | The Operating System type. | DiskProperties_OsType_STATUS Optional |
| provisioningState | The disk provisioning state. | string 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 |
| 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, or UltraSSD_LRS. | DiskSku_STATUS 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 |
DiskList
Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/DiskRP/stable/2020-09-30/disk.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Disk[] Optional |
Snapshot
Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/DiskRP/stable/2020-09-30/disk.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 |
| creationData | Disk source information. CreationData information cannot be changed after the disk has been created. | CreationData Required |
| 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 |
| purchasePlan | Purchase plan information for the image from which the source disk for the snapshot was originally created. | PurchasePlan 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 |
| tags | Resource tags | map[string]string Optional |
Snapshot_STATUS
| Property | Description | Type |
|---|---|---|
| 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 |
| 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 |
| 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 |
| purchasePlan | Purchase plan information for the image from which the source disk for the snapshot was originally created. | PurchasePlan_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 |
| 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
Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/DiskRP/stable/2020-09-30/disk.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}
| 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 |
| creationData | Disk source information. CreationData information cannot be changed after the disk has been created. | CreationData Required |
| 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 |
| 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 |
| 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 |
| sku | The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS. | DiskSku 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 |
| 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 |
| 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 |
| 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 |
| osType | The Operating System type. | DiskProperties_OsType_STATUS Optional |
| provisioningState | The disk provisioning state. | string 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 |
| 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, or UltraSSD_LRS. | DiskSku_STATUS 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 |
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 |
| creationData | Disk source information. CreationData information cannot be changed after the disk has been created. | CreationData Required |
| 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 |
| purchasePlan | Purchase plan information for the image from which the source disk for the snapshot was originally created. | PurchasePlan 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 |
| tags | Resource tags | map[string]string Optional |
Snapshot_STATUS
Snapshot resource.
Used by: Snapshot.
| Property | Description | Type |
|---|---|---|
| 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 |
| 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 |
| 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 |
| purchasePlan | Purchase plan information for the image from which the source disk for the snapshot was originally created. | PurchasePlan_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 |
| 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 |
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 |
| galleryImageReference | Required if creating from a Gallery Image. The id 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. | ImageDiskReference Optional |
| logicalSectorSize | Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. | int 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 |
| galleryImageReference | Required if creating from a Gallery Image. The id 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. | ImageDiskReference_STATUS Optional |
| logicalSectorSize | Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. | int 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 |
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” |
DiskSku
The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_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, or UltraSSD_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” | |
| “ActiveUpload” | |
| “Attached” | |
| “ReadyToUpload” | |
| “Reserved” | |
| “Unattached” |
DiskState_STATUS
This enumerates the possible state of the disk.
Used by: Disk_STATUS, and Snapshot_STATUS.
| Value | Description |
|---|---|
| “ActiveSAS” | |
| “ActiveUpload” | |
| “Attached” | |
| “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 |
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, 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, 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 |
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” |
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
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_STATUS.
| Property | Description | Type |
|---|---|---|
| name | The sku name. | SnapshotSku_Name_STATUS Optional |
| tier | The sku tier. | string Optional |
CreationData_CreateOption
Used by: CreationData.
| Value | Description |
|---|---|
| “Attach” | |
| “Copy” | |
| “Empty” | |
| “FromImage” | |
| “Import” | |
| “Restore” | |
| “Upload” |
CreationData_CreateOption_STATUS
Used by: CreationData_STATUS.
| Value | Description |
|---|---|
| “Attach” | |
| “Copy” | |
| “Empty” | |
| “FromImage” | |
| “Import” | |
| “Restore” | |
| “Upload” |
DiskSku_Name
Used by: DiskSku.
| Value | Description |
|---|---|
| “Premium_LRS” | |
| “StandardSSD_LRS” | |
| “Standard_LRS” | |
| “UltraSSD_LRS” |
DiskSku_Name_STATUS
Used by: DiskSku_STATUS.
| Value | Description |
|---|---|
| “Premium_LRS” | |
| “StandardSSD_LRS” | |
| “Standard_LRS” | |
| “UltraSSD_LRS” |
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 |
|---|---|---|
| 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 or user image reference. | genruntime.ResourceReference Required |
ImageDiskReference_STATUS
The source image used for creating the disk.
Used by: CreationData_STATUS, and CreationData_STATUS.
| Property | Description | Type |
|---|---|---|
| id | A relative uri containing either a Platform Image Repository or user 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 |
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” |
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 |
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: 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: KeyVaultAndKeyReference_STATUS, and KeyVaultAndSecretReference_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Resource Id | string Optional |