compute.azure.com/v1beta20200930

compute.azure.com/v1beta20200930

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

Resource Types:

    CreationData

    (Appears on:Disks_Spec, Snapshots_Spec)

    Field Description
    createOption
    CreationDataCreateOption

    CreateOption: This enumerates the possible sources of a disk’s creation.

    galleryImageReference
    ImageDiskReference

    GalleryImageReference: The source image used for creating the disk.

    imageReference
    ImageDiskReference

    ImageReference: The source image used for creating the disk.

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

    CreationDataARM

    (Appears on:DiskPropertiesARM, SnapshotPropertiesARM)

    Field Description
    createOption
    CreationDataCreateOption

    CreateOption: This enumerates the possible sources of a disk’s creation.

    galleryImageReference
    ImageDiskReferenceARM

    GalleryImageReference: The source image used for creating the disk.

    imageReference
    ImageDiskReferenceARM

    ImageReference: The source image used for creating the disk.

    logicalSectorSize
    int

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

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

    CreationDataCreateOption (string alias)

    (Appears on:CreationData, CreationDataARM)

    Value Description

    "Attach"

    "Copy"

    "Empty"

    "FromImage"

    "Import"

    "Restore"

    "Upload"

    CreationDataStatusCreateOption (string alias)

    (Appears on:CreationData_Status, CreationData_StatusARM)

    Value Description

    "Attach"

    "Copy"

    "Empty"

    "FromImage"

    "Import"

    "Restore"

    "Upload"

    CreationData_Status

    (Appears on:Disk_Status, Snapshot_Status)

    Field Description
    createOption
    CreationDataStatusCreateOption

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

    CreationData_StatusARM

    (Appears on:DiskProperties_StatusARM, SnapshotProperties_StatusARM)

    Field Description
    createOption
    CreationDataStatusCreateOption

    CreateOption: This enumerates the possible sources of a disk’s creation.

    galleryImageReference
    ImageDiskReference_StatusARM

    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_StatusARM

    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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Disks_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: Data used when creating a disk.

    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 at rest settings for disk or snapshot

    encryptionSettingsCollection
    EncryptionSettingsCollection

    EncryptionSettingsCollection: Encryption settings for disk or snapshot

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The complex type of the extended location.

    hyperVGeneration
    DiskPropertiesHyperVGeneration

    HyperVGeneration: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.

    location
    string

    Location: Location to deploy resource to

    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
    DiskPropertiesNetworkAccessPolicy
    osType
    DiskPropertiesOsType

    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: Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

    sku
    DiskSku

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

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    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

    DiskPropertiesARM

    (Appears on:Disks_SpecARM)

    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.

    creationData
    CreationDataARM

    CreationData: Data used when creating a disk.

    diskAccessId
    string
    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
    EncryptionARM

    Encryption: Encryption at rest settings for disk or snapshot

    encryptionSettingsCollection
    EncryptionSettingsCollectionARM

    EncryptionSettingsCollection: Encryption settings for disk or snapshot

    hyperVGeneration
    DiskPropertiesHyperVGeneration

    HyperVGeneration: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.

    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
    DiskPropertiesNetworkAccessPolicy
    osType
    DiskPropertiesOsType

    OsType: The Operating System type.

    purchasePlan
    PurchasePlanARM

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

    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.

    DiskPropertiesHyperVGeneration (string alias)

    (Appears on:DiskPropertiesARM, Disks_Spec)

    Value Description

    "V1"

    "V2"

    DiskPropertiesNetworkAccessPolicy (string alias)

    (Appears on:DiskPropertiesARM, Disks_Spec)

    Value Description

    "AllowAll"

    "AllowPrivate"

    "DenyAll"

    DiskPropertiesOsType (string alias)

    (Appears on:DiskPropertiesARM, Disks_Spec)

    Value Description

    "Linux"

    "Windows"

    DiskPropertiesStatusHyperVGeneration (string alias)

    (Appears on:DiskProperties_StatusARM, Disk_Status)

    Value Description

    "V1"

    "V2"

    DiskPropertiesStatusOsType (string alias)

    (Appears on:DiskProperties_StatusARM, Disk_Status)

    Value Description

    "Linux"

    "Windows"

    DiskProperties_StatusARM

    (Appears on:Disk_StatusARM)

    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.

    creationData
    CreationData_StatusARM

    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_StatusARM

    Encryption: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.

    encryptionSettingsCollection
    EncryptionSettingsCollection_StatusARM

    EncryptionSettingsCollection: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

    hyperVGeneration
    DiskPropertiesStatusHyperVGeneration

    HyperVGeneration: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.

    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_Status
    osType
    DiskPropertiesStatusOsType

    OsType: The Operating System type.

    provisioningState
    string

    ProvisioningState: The disk provisioning state.

    purchasePlan
    PurchasePlan_StatusARM

    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_StatusARM

    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.

    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.

    uniqueId
    string

    UniqueId: Unique Guid identifying the resource.

    DiskSku

    (Appears on:Disks_Spec)

    Field Description
    name
    DiskSkuName

    Name: The sku name.

    DiskSkuARM

    (Appears on:Disks_SpecARM)

    Field Description
    name
    DiskSkuName

    Name: The sku name.

    DiskSkuName (string alias)

    (Appears on:DiskSku, DiskSkuARM)

    Value Description

    "Premium_LRS"

    "Standard_LRS"

    "StandardSSD_LRS"

    "UltraSSD_LRS"

    DiskSkuStatusName (string alias)

    (Appears on:DiskSku_Status, DiskSku_StatusARM)

    Value Description

    "Premium_LRS"

    "Standard_LRS"

    "StandardSSD_LRS"

    "UltraSSD_LRS"

    DiskSku_Status

    (Appears on:Disk_Status)

    Field Description
    name
    DiskSkuStatusName

    Name: The sku name.

    tier
    string

    Tier: The sku tier.

    DiskSku_StatusARM

    (Appears on:Disk_StatusARM)

    Field Description
    name
    DiskSkuStatusName

    Name: The sku name.

    tier
    string

    Tier: The sku tier.

    DiskState_Status (string alias)

    (Appears on:DiskProperties_StatusARM, Disk_Status, SnapshotProperties_StatusARM, Snapshot_Status)

    Value Description

    "ActiveSAS"

    "ActiveUpload"

    "Attached"

    "ReadyToUpload"

    "Reserved"

    "Unattached"

    Disk_Status

    (Appears on:Disk)

    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
    DiskPropertiesStatusHyperVGeneration

    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
    osType
    DiskPropertiesStatusOsType

    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
    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_StatusARM

    Field Description
    extendedLocation
    ExtendedLocation_StatusARM

    ExtendedLocation: The extended location where the disk will be created. Extended location cannot be changed.

    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.

    name
    string

    Name: Resource name

    properties
    DiskProperties_StatusARM
    sku
    DiskSku_StatusARM
    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    zones
    []string

    Zones: The Logical zone list for Disk.

    DisksSpecAPIVersion (string alias)

    Value Description

    "2020-09-30"

    Disks_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: Data used when creating a disk.

    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 at rest settings for disk or snapshot

    encryptionSettingsCollection
    EncryptionSettingsCollection

    EncryptionSettingsCollection: Encryption settings for disk or snapshot

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The complex type of the extended location.

    hyperVGeneration
    DiskPropertiesHyperVGeneration

    HyperVGeneration: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.

    location
    string

    Location: Location to deploy resource to

    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
    DiskPropertiesNetworkAccessPolicy
    osType
    DiskPropertiesOsType

    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: Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

    sku
    DiskSku

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

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    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.

    Disks_SpecARM

    Field Description
    extendedLocation
    ExtendedLocationARM

    ExtendedLocation: The complex type of the extended location.

    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: The name of the managed disk that is being created. The name can’t be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.

    properties
    DiskPropertiesARM

    Properties: Disk resource properties.

    sku
    DiskSkuARM

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

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    zones
    []string

    Zones: The Logical zone list for Disk.

    Encryption

    (Appears on:Disks_Spec, Snapshots_Spec)

    Field Description
    diskEncryptionSetReference
    genruntime.ResourceReference

    DiskEncryptionSetReference: ResourceId of the disk encryption set to use for enabling encryption at rest.

    type
    EncryptionType

    EncryptionARM

    (Appears on:DiskPropertiesARM, SnapshotPropertiesARM)

    Field Description
    diskEncryptionSetId
    string
    type
    EncryptionType

    EncryptionSettingsCollection

    (Appears on:Disks_Spec, Snapshots_Spec)

    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.

    EncryptionSettingsCollectionARM

    (Appears on:DiskPropertiesARM, SnapshotPropertiesARM)

    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
    []EncryptionSettingsElementARM

    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)

    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.

    EncryptionSettingsCollection_StatusARM

    (Appears on:DiskProperties_StatusARM, SnapshotProperties_StatusARM)

    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_StatusARM

    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)

    Field Description
    diskEncryptionKey
    KeyVaultAndSecretReference

    DiskEncryptionKey: Key Vault Secret Url and vault id of the encryption key

    keyEncryptionKey
    KeyVaultAndKeyReference

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

    EncryptionSettingsElementARM

    (Appears on:EncryptionSettingsCollectionARM)

    Field Description
    diskEncryptionKey
    KeyVaultAndSecretReferenceARM

    DiskEncryptionKey: Key Vault Secret Url and vault id of the encryption key

    keyEncryptionKey
    KeyVaultAndKeyReferenceARM

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

    EncryptionSettingsElement_Status

    (Appears on:EncryptionSettingsCollection_Status)

    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.

    EncryptionSettingsElement_StatusARM

    (Appears on:EncryptionSettingsCollection_StatusARM)

    Field Description
    diskEncryptionKey
    KeyVaultAndSecretReference_StatusARM

    DiskEncryptionKey: Key Vault Secret Url and vault id of the disk encryption key

    keyEncryptionKey
    KeyVaultAndKeyReference_StatusARM

    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, EncryptionARM)

    Value Description

    "EncryptionAtRestWithCustomerKey"

    "EncryptionAtRestWithPlatformAndCustomerKeys"

    "EncryptionAtRestWithPlatformKey"

    EncryptionType_Status (string alias)

    (Appears on:Encryption_Status, Encryption_StatusARM)

    Value Description

    "EncryptionAtRestWithCustomerKey"

    "EncryptionAtRestWithPlatformAndCustomerKeys"

    "EncryptionAtRestWithPlatformKey"

    Encryption_Status

    (Appears on:Disk_Status, Snapshot_Status)

    Field Description
    diskEncryptionSetId
    string

    DiskEncryptionSetId: ResourceId of the disk encryption set to use for enabling encryption at rest.

    type
    EncryptionType_Status

    Encryption_StatusARM

    (Appears on:DiskProperties_StatusARM, SnapshotProperties_StatusARM)

    Field Description
    diskEncryptionSetId
    string

    DiskEncryptionSetId: ResourceId of the disk encryption set to use for enabling encryption at rest.

    type
    EncryptionType_Status

    ExtendedLocation

    (Appears on:Disks_Spec, Snapshots_Spec)

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType

    Type: The type of the extended location.

    ExtendedLocationARM

    (Appears on:Disks_SpecARM, Snapshots_SpecARM)

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType

    Type: The type of the extended location.

    ExtendedLocationType (string alias)

    (Appears on:ExtendedLocation, ExtendedLocationARM)

    Value Description

    "EdgeZone"

    ExtendedLocationType_Status (string alias)

    (Appears on:ExtendedLocation_Status, ExtendedLocation_StatusARM)

    Value Description

    "EdgeZone"

    ExtendedLocation_Status

    (Appears on:Disk_Status, Snapshot_Status)

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_Status

    Type: The type of the extended location.

    ExtendedLocation_StatusARM

    (Appears on:Disk_StatusARM, Snapshot_StatusARM)

    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)

    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.

    ImageDiskReferenceARM

    (Appears on:CreationDataARM)

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

    ImageDiskReference_Status

    (Appears on:CreationData_Status)

    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.

    ImageDiskReference_StatusARM

    (Appears on:CreationData_StatusARM)

    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)

    Field Description
    keyUrl
    string

    KeyUrl: Url pointing to a key or secret in KeyVault

    sourceVault
    SourceVault

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

    KeyVaultAndKeyReferenceARM

    (Appears on:EncryptionSettingsElementARM)

    Field Description
    keyUrl
    string

    KeyUrl: Url pointing to a key or secret in KeyVault

    sourceVault
    SourceVaultARM

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

    KeyVaultAndKeyReference_Status

    (Appears on:EncryptionSettingsElement_Status)

    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

    KeyVaultAndKeyReference_StatusARM

    (Appears on:EncryptionSettingsElement_StatusARM)

    Field Description
    keyUrl
    string

    KeyUrl: Url pointing to a key or secret in KeyVault

    sourceVault
    SourceVault_StatusARM

    SourceVault: Resource id of the KeyVault containing the key or secret

    KeyVaultAndSecretReference

    (Appears on:EncryptionSettingsElement)

    Field Description
    secretUrl
    string

    SecretUrl: Url pointing to a key or secret in KeyVault

    sourceVault
    SourceVault

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

    KeyVaultAndSecretReferenceARM

    (Appears on:EncryptionSettingsElementARM)

    Field Description
    secretUrl
    string

    SecretUrl: Url pointing to a key or secret in KeyVault

    sourceVault
    SourceVaultARM

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

    KeyVaultAndSecretReference_Status

    (Appears on:EncryptionSettingsElement_Status)

    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

    KeyVaultAndSecretReference_StatusARM

    (Appears on:EncryptionSettingsElement_StatusARM)

    Field Description
    secretUrl
    string

    SecretUrl: Url pointing to a key or secret in KeyVault

    sourceVault
    SourceVault_StatusARM

    SourceVault: Resource id of the KeyVault containing the key or secret

    NetworkAccessPolicy_Status (string alias)

    (Appears on:DiskProperties_StatusARM, Disk_Status, SnapshotProperties_StatusARM, Snapshot_Status)

    Value Description

    "AllowAll"

    "AllowPrivate"

    "DenyAll"

    PurchasePlan

    (Appears on:Disks_Spec, Snapshots_Spec)

    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.

    PurchasePlanARM

    (Appears on:DiskPropertiesARM, SnapshotPropertiesARM)

    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)

    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_StatusARM

    (Appears on:DiskProperties_StatusARM, SnapshotProperties_StatusARM)

    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.

    ShareInfoElement_StatusARM

    (Appears on:DiskProperties_StatusARM)

    Field Description
    vmUri
    string

    VmUri: A relative URI containing the ID of the VM that has the disk attached.

    Snapshot

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Snapshots_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: Data used when creating a disk.

    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
    SnapshotPropertiesDiskState

    DiskState: The state of the snapshot.

    encryption
    Encryption

    Encryption: Encryption at rest settings for disk or snapshot

    encryptionSettingsCollection
    EncryptionSettingsCollection

    EncryptionSettingsCollection: Encryption settings for disk or snapshot

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The complex type of the extended location.

    hyperVGeneration
    SnapshotPropertiesHyperVGeneration

    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: Location to deploy resource to

    networkAccessPolicy
    SnapshotPropertiesNetworkAccessPolicy
    osType
    SnapshotPropertiesOsType

    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: Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

    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: Name-value pairs to add to the resource

    status
    Snapshot_Status

    SnapshotPropertiesARM

    (Appears on:Snapshots_SpecARM)

    Field Description
    creationData
    CreationDataARM

    CreationData: Data used when creating a disk.

    diskAccessId
    string
    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
    SnapshotPropertiesDiskState

    DiskState: The state of the snapshot.

    encryption
    EncryptionARM

    Encryption: Encryption at rest settings for disk or snapshot

    encryptionSettingsCollection
    EncryptionSettingsCollectionARM

    EncryptionSettingsCollection: Encryption settings for disk or snapshot

    hyperVGeneration
    SnapshotPropertiesHyperVGeneration

    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.

    networkAccessPolicy
    SnapshotPropertiesNetworkAccessPolicy
    osType
    SnapshotPropertiesOsType

    OsType: The Operating System type.

    purchasePlan
    PurchasePlanARM

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

    SnapshotPropertiesDiskState (string alias)

    (Appears on:SnapshotPropertiesARM, Snapshots_Spec)

    Value Description

    "ActiveSAS"

    "ActiveUpload"

    "Attached"

    "ReadyToUpload"

    "Reserved"

    "Unattached"

    SnapshotPropertiesHyperVGeneration (string alias)

    (Appears on:SnapshotPropertiesARM, Snapshots_Spec)

    Value Description

    "V1"

    "V2"

    SnapshotPropertiesNetworkAccessPolicy (string alias)

    (Appears on:SnapshotPropertiesARM, Snapshots_Spec)

    Value Description

    "AllowAll"

    "AllowPrivate"

    "DenyAll"

    SnapshotPropertiesOsType (string alias)

    (Appears on:SnapshotPropertiesARM, Snapshots_Spec)

    Value Description

    "Linux"

    "Windows"

    SnapshotPropertiesStatusHyperVGeneration (string alias)

    (Appears on:SnapshotProperties_StatusARM, Snapshot_Status)

    Value Description

    "V1"

    "V2"

    SnapshotPropertiesStatusOsType (string alias)

    (Appears on:SnapshotProperties_StatusARM, Snapshot_Status)

    Value Description

    "Linux"

    "Windows"

    SnapshotProperties_StatusARM

    (Appears on:Snapshot_StatusARM)

    Field Description
    creationData
    CreationData_StatusARM

    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_StatusARM

    Encryption: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.

    encryptionSettingsCollection
    EncryptionSettingsCollection_StatusARM

    EncryptionSettingsCollection: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

    hyperVGeneration
    SnapshotPropertiesStatusHyperVGeneration

    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.

    networkAccessPolicy
    NetworkAccessPolicy_Status
    osType
    SnapshotPropertiesStatusOsType

    OsType: The Operating System type.

    provisioningState
    string

    ProvisioningState: The disk provisioning state.

    purchasePlan
    PurchasePlan_StatusARM

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

    timeCreated
    string

    TimeCreated: The time when the snapshot was created.

    uniqueId
    string

    UniqueId: Unique Guid identifying the resource.

    SnapshotSku

    (Appears on:Snapshots_Spec)

    Field Description
    name
    SnapshotSkuName

    Name: The sku name.

    SnapshotSkuARM

    (Appears on:Snapshots_SpecARM)

    Field Description
    name
    SnapshotSkuName

    Name: The sku name.

    SnapshotSkuName (string alias)

    (Appears on:SnapshotSku, SnapshotSkuARM)

    Value Description

    "Premium_LRS"

    "Standard_LRS"

    "Standard_ZRS"

    SnapshotSkuStatusName (string alias)

    (Appears on:SnapshotSku_Status, SnapshotSku_StatusARM)

    Value Description

    "Premium_LRS"

    "Standard_LRS"

    "Standard_ZRS"

    SnapshotSku_Status

    (Appears on:Snapshot_Status)

    Field Description
    name
    SnapshotSkuStatusName

    Name: The sku name.

    tier
    string

    Tier: The sku tier.

    SnapshotSku_StatusARM

    (Appears on:Snapshot_StatusARM)

    Field Description
    name
    SnapshotSkuStatusName

    Name: The sku name.

    tier
    string

    Tier: The sku tier.

    Snapshot_Status

    (Appears on:Snapshot)

    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
    SnapshotPropertiesStatusHyperVGeneration

    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
    osType
    SnapshotPropertiesStatusOsType

    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
    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_StatusARM

    Field Description
    extendedLocation
    ExtendedLocation_StatusARM

    ExtendedLocation: The extended location where the snapshot will be created. Extended location cannot be changed.

    id
    string

    Id: Resource Id

    location
    string

    Location: Resource location

    managedBy
    string

    ManagedBy: Unused. Always Null.

    name
    string

    Name: Resource name

    properties
    SnapshotProperties_StatusARM
    sku
    SnapshotSku_StatusARM
    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    SnapshotsSpecAPIVersion (string alias)

    Value Description

    "2020-09-30"

    Snapshots_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: Data used when creating a disk.

    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
    SnapshotPropertiesDiskState

    DiskState: The state of the snapshot.

    encryption
    Encryption

    Encryption: Encryption at rest settings for disk or snapshot

    encryptionSettingsCollection
    EncryptionSettingsCollection

    EncryptionSettingsCollection: Encryption settings for disk or snapshot

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The complex type of the extended location.

    hyperVGeneration
    SnapshotPropertiesHyperVGeneration

    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: Location to deploy resource to

    networkAccessPolicy
    SnapshotPropertiesNetworkAccessPolicy
    osType
    SnapshotPropertiesOsType

    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: Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

    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: Name-value pairs to add to the resource

    Snapshots_SpecARM

    Field Description
    extendedLocation
    ExtendedLocationARM

    ExtendedLocation: The complex type of the extended location.

    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: The name of the snapshot that is being created. The name can’t be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters.

    properties
    SnapshotPropertiesARM

    Properties: Snapshot resource properties.

    sku
    SnapshotSkuARM

    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: Name-value pairs to add to the resource

    SourceVault

    (Appears on:KeyVaultAndKeyReference, KeyVaultAndSecretReference)

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource Id

    SourceVaultARM

    (Appears on:KeyVaultAndKeyReferenceARM, KeyVaultAndSecretReferenceARM)

    Field Description
    id
    string

    SourceVault_Status

    (Appears on:KeyVaultAndKeyReference_Status, KeyVaultAndSecretReference_Status)

    Field Description
    id
    string

    Id: Resource Id

    SourceVault_StatusARM

    (Appears on:KeyVaultAndKeyReference_StatusARM, KeyVaultAndSecretReference_StatusARM)

    Field Description
    id
    string

    Id: Resource Id