compute.azure.com/v1api20200930

compute.azure.com/v1api20200930

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

Resource Types:

    APIVersion (string alias)

    Value Description

    "2020-09-30"

    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.

    galleryImageReference
    ImageDiskReference

    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.

    imageReference
    ImageDiskReference

    ImageReference: Disk source information.

    logicalSectorSize
    int

    LogicalSectorSize: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.

    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"

    "Empty"

    "FromImage"

    "Import"

    "Restore"

    "Upload"

    CreationData_CreateOption_STATUS (string alias)

    (Appears on:CreationData_STATUS)

    Value Description

    "Attach"

    "Copy"

    "Empty"

    "FromImage"

    "Import"

    "Restore"

    "Upload"

    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.

    galleryImageReference
    ImageDiskReference_STATUS

    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.

    imageReference
    ImageDiskReference_STATUS

    ImageReference: Disk source information.

    logicalSectorSize
    int

    LogicalSectorSize: Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.

    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).

    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}

    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.

    creationData
    CreationData

    CreationData: Disk source information. CreationData information cannot be changed after the disk has been created.

    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.

    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

    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}

    sku
    DiskSku

    Sku: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS.

    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

    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"

    DiskSku

    (Appears on:Disk_Spec)

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

    Field Description
    name
    DiskSku_Name

    Name: The sku name.

    DiskSku_Name (string alias)

    (Appears on:DiskSku)

    Value Description

    "Premium_LRS"

    "StandardSSD_LRS"

    "Standard_LRS"

    "UltraSSD_LRS"

    DiskSku_Name_STATUS (string alias)

    (Appears on:DiskSku_STATUS)

    Value Description

    "Premium_LRS"

    "StandardSSD_LRS"

    "Standard_LRS"

    "UltraSSD_LRS"

    DiskSku_STATUS

    (Appears on:Disk_STATUS)

    The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_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"

    "ActiveUpload"

    "Attached"

    "ReadyToUpload"

    "Reserved"

    "Unattached"

    DiskState_STATUS (string alias)

    (Appears on:Disk_STATUS, Snapshot_STATUS)

    This enumerates the possible state of the disk.

    Value Description

    "ActiveSAS"

    "ActiveUpload"

    "Attached"

    "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.

    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.

    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

    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.

    osType
    DiskProperties_OsType_STATUS

    OsType: The Operating System type.

    provisioningState
    string

    ProvisioningState: The disk provisioning state.

    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}

    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, or UltraSSD_LRS.

    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.

    creationData
    CreationData

    CreationData: Disk source information. CreationData information cannot be changed after the disk has been created.

    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.

    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

    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}

    sku
    DiskSku

    Sku: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS.

    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.

    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: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: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
    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 or user image reference.

    ImageDiskReference_STATUS

    (Appears on:CreationData_STATUS)

    The source image used for creating the disk.

    Field Description
    id
    string

    Id: A relative uri containing either a Platform Image Repository or user 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.

    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"

    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/2020-09-30/disk.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.

    creationData
    CreationData

    CreationData: Disk source information. CreationData information cannot be changed after the disk has been created.

    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.

    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

    purchasePlan
    PurchasePlan

    PurchasePlan: Purchase plan information for the image from which the source disk for the snapshot was originally created.

    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

    tags
    map[string]string

    Tags: Resource tags

    status
    Snapshot_STATUS

    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)

    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_STATUS

    Name: The sku name.

    tier
    string

    Tier: The sku tier.

    Snapshot_STATUS

    (Appears on:Snapshot)

    Snapshot resource.

    Field Description
    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.

    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.

    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.

    purchasePlan
    PurchasePlan_STATUS

    PurchasePlan: Purchase plan information for the image from which the source disk for the snapshot was originally created.

    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

    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.

    creationData
    CreationData

    CreationData: Disk source information. CreationData information cannot be changed after the disk has been created.

    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.

    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

    purchasePlan
    PurchasePlan

    PurchasePlan: Purchase plan information for the image from which the source disk for the snapshot was originally created.

    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

    tags
    map[string]string

    Tags: Resource tags

    SourceVault

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