1. Packages
  2. Azure Native
  3. API Docs
  4. compute
  5. getSnapshot
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.41.0 published on Tuesday, May 14, 2024 by Pulumi

azure-native.compute.getSnapshot

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.41.0 published on Tuesday, May 14, 2024 by Pulumi

    Gets information about a snapshot. Azure REST API version: 2022-07-02.

    Other available API versions: 2016-04-30-preview, 2017-03-30, 2018-06-01, 2023-01-02, 2023-04-02, 2023-10-02.

    Using getSnapshot

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSnapshot(args: GetSnapshotArgs, opts?: InvokeOptions): Promise<GetSnapshotResult>
    function getSnapshotOutput(args: GetSnapshotOutputArgs, opts?: InvokeOptions): Output<GetSnapshotResult>
    def get_snapshot(resource_group_name: Optional[str] = None,
                     snapshot_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
    def get_snapshot_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                     snapshot_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotResult]
    func LookupSnapshot(ctx *Context, args *LookupSnapshotArgs, opts ...InvokeOption) (*LookupSnapshotResult, error)
    func LookupSnapshotOutput(ctx *Context, args *LookupSnapshotOutputArgs, opts ...InvokeOption) LookupSnapshotResultOutput

    > Note: This function is named LookupSnapshot in the Go SDK.

    public static class GetSnapshot 
    {
        public static Task<GetSnapshotResult> InvokeAsync(GetSnapshotArgs args, InvokeOptions? opts = null)
        public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:compute:getSnapshot
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group.
    SnapshotName string
    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.
    ResourceGroupName string
    The name of the resource group.
    SnapshotName string
    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.
    resourceGroupName String
    The name of the resource group.
    snapshotName String
    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.
    resourceGroupName string
    The name of the resource group.
    snapshotName string
    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.
    resource_group_name str
    The name of the resource group.
    snapshot_name str
    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.
    resourceGroupName String
    The name of the resource group.
    snapshotName String
    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.

    getSnapshot Result

    The following output properties are available:

    CreationData Pulumi.AzureNative.Compute.Outputs.CreationDataResponse
    Disk source information. CreationData information cannot be changed after the disk has been created.
    DiskSizeBytes double
    The size of the disk in bytes. This field is read only.
    DiskState string
    The state of the snapshot.
    Id string
    Resource Id
    IncrementalSnapshotFamilyId string
    Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
    Location string
    Resource location
    ManagedBy string
    Unused. Always Null.
    Name string
    Resource name
    ProvisioningState string
    The disk provisioning state.
    TimeCreated string
    The time when the snapshot was created.
    Type string
    Resource type
    UniqueId string
    Unique Guid identifying the resource.
    CompletionPercent double
    Percentage complete for the background copy when a resource is created via the CopyStart operation.
    CopyCompletionError Pulumi.AzureNative.Compute.Outputs.CopyCompletionErrorResponse
    Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
    DataAccessAuthMode string
    Additional authentication requirements when exporting or uploading to a disk or snapshot.
    DiskAccessId string
    ARM id of the DiskAccess resource for using private endpoints on disks.
    DiskSizeGB int
    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 Pulumi.AzureNative.Compute.Outputs.EncryptionResponse
    Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
    EncryptionSettingsCollection Pulumi.AzureNative.Compute.Outputs.EncryptionSettingsCollectionResponse
    Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
    ExtendedLocation Pulumi.AzureNative.Compute.Outputs.ExtendedLocationResponse
    The extended location where the snapshot will be created. Extended location cannot be changed.
    HyperVGeneration string
    The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
    Incremental bool
    Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
    NetworkAccessPolicy string
    Policy for accessing the disk via network.
    OsType string
    The Operating System type.
    PublicNetworkAccess string
    Policy for controlling export on the disk.
    PurchasePlan Pulumi.AzureNative.Compute.Outputs.PurchasePlanResponse
    Purchase plan information for the image from which the source disk for the snapshot was originally created.
    SecurityProfile Pulumi.AzureNative.Compute.Outputs.DiskSecurityProfileResponse
    Contains the security related information for the resource.
    Sku Pulumi.AzureNative.Compute.Outputs.SnapshotSkuResponse
    The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
    SupportedCapabilities Pulumi.AzureNative.Compute.Outputs.SupportedCapabilitiesResponse
    List of supported capabilities for the image from which the source disk from the snapshot was originally created.
    SupportsHibernation bool
    Indicates the OS on a snapshot supports hibernation.
    Tags Dictionary<string, string>
    Resource tags
    CreationData CreationDataResponse
    Disk source information. CreationData information cannot be changed after the disk has been created.
    DiskSizeBytes float64
    The size of the disk in bytes. This field is read only.
    DiskState string
    The state of the snapshot.
    Id string
    Resource Id
    IncrementalSnapshotFamilyId string
    Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
    Location string
    Resource location
    ManagedBy string
    Unused. Always Null.
    Name string
    Resource name
    ProvisioningState string
    The disk provisioning state.
    TimeCreated string
    The time when the snapshot was created.
    Type string
    Resource type
    UniqueId string
    Unique Guid identifying the resource.
    CompletionPercent float64
    Percentage complete for the background copy when a resource is created via the CopyStart operation.
    CopyCompletionError CopyCompletionErrorResponse
    Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
    DataAccessAuthMode string
    Additional authentication requirements when exporting or uploading to a disk or snapshot.
    DiskAccessId string
    ARM id of the DiskAccess resource for using private endpoints on disks.
    DiskSizeGB int
    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 EncryptionResponse
    Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
    EncryptionSettingsCollection EncryptionSettingsCollectionResponse
    Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
    ExtendedLocation ExtendedLocationResponse
    The extended location where the snapshot will be created. Extended location cannot be changed.
    HyperVGeneration string
    The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
    Incremental bool
    Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
    NetworkAccessPolicy string
    Policy for accessing the disk via network.
    OsType string
    The Operating System type.
    PublicNetworkAccess string
    Policy for controlling export on the disk.
    PurchasePlan PurchasePlanResponse
    Purchase plan information for the image from which the source disk for the snapshot was originally created.
    SecurityProfile DiskSecurityProfileResponse
    Contains the security related information for the resource.
    Sku SnapshotSkuResponse
    The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
    SupportedCapabilities SupportedCapabilitiesResponse
    List of supported capabilities for the image from which the source disk from the snapshot was originally created.
    SupportsHibernation bool
    Indicates the OS on a snapshot supports hibernation.
    Tags map[string]string
    Resource tags
    creationData CreationDataResponse
    Disk source information. CreationData information cannot be changed after the disk has been created.
    diskSizeBytes Double
    The size of the disk in bytes. This field is read only.
    diskState String
    The state of the snapshot.
    id String
    Resource Id
    incrementalSnapshotFamilyId String
    Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
    location String
    Resource location
    managedBy String
    Unused. Always Null.
    name String
    Resource name
    provisioningState String
    The disk provisioning state.
    timeCreated String
    The time when the snapshot was created.
    type String
    Resource type
    uniqueId String
    Unique Guid identifying the resource.
    completionPercent Double
    Percentage complete for the background copy when a resource is created via the CopyStart operation.
    copyCompletionError CopyCompletionErrorResponse
    Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
    dataAccessAuthMode String
    Additional authentication requirements when exporting or uploading to a disk or snapshot.
    diskAccessId String
    ARM id of the DiskAccess resource for using private endpoints on disks.
    diskSizeGB Integer
    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 EncryptionResponse
    Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
    encryptionSettingsCollection EncryptionSettingsCollectionResponse
    Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
    extendedLocation ExtendedLocationResponse
    The extended location where the snapshot will be created. Extended location cannot be changed.
    hyperVGeneration String
    The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
    incremental Boolean
    Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
    networkAccessPolicy String
    Policy for accessing the disk via network.
    osType String
    The Operating System type.
    publicNetworkAccess String
    Policy for controlling export on the disk.
    purchasePlan PurchasePlanResponse
    Purchase plan information for the image from which the source disk for the snapshot was originally created.
    securityProfile DiskSecurityProfileResponse
    Contains the security related information for the resource.
    sku SnapshotSkuResponse
    The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
    supportedCapabilities SupportedCapabilitiesResponse
    List of supported capabilities for the image from which the source disk from the snapshot was originally created.
    supportsHibernation Boolean
    Indicates the OS on a snapshot supports hibernation.
    tags Map<String,String>
    Resource tags
    creationData CreationDataResponse
    Disk source information. CreationData information cannot be changed after the disk has been created.
    diskSizeBytes number
    The size of the disk in bytes. This field is read only.
    diskState string
    The state of the snapshot.
    id string
    Resource Id
    incrementalSnapshotFamilyId string
    Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
    location string
    Resource location
    managedBy string
    Unused. Always Null.
    name string
    Resource name
    provisioningState string
    The disk provisioning state.
    timeCreated string
    The time when the snapshot was created.
    type string
    Resource type
    uniqueId string
    Unique Guid identifying the resource.
    completionPercent number
    Percentage complete for the background copy when a resource is created via the CopyStart operation.
    copyCompletionError CopyCompletionErrorResponse
    Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
    dataAccessAuthMode string
    Additional authentication requirements when exporting or uploading to a disk or snapshot.
    diskAccessId string
    ARM id of the DiskAccess resource for using private endpoints on disks.
    diskSizeGB number
    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 EncryptionResponse
    Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
    encryptionSettingsCollection EncryptionSettingsCollectionResponse
    Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
    extendedLocation ExtendedLocationResponse
    The extended location where the snapshot will be created. Extended location cannot be changed.
    hyperVGeneration string
    The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
    incremental boolean
    Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
    networkAccessPolicy string
    Policy for accessing the disk via network.
    osType string
    The Operating System type.
    publicNetworkAccess string
    Policy for controlling export on the disk.
    purchasePlan PurchasePlanResponse
    Purchase plan information for the image from which the source disk for the snapshot was originally created.
    securityProfile DiskSecurityProfileResponse
    Contains the security related information for the resource.
    sku SnapshotSkuResponse
    The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
    supportedCapabilities SupportedCapabilitiesResponse
    List of supported capabilities for the image from which the source disk from the snapshot was originally created.
    supportsHibernation boolean
    Indicates the OS on a snapshot supports hibernation.
    tags {[key: string]: string}
    Resource tags
    creation_data CreationDataResponse
    Disk source information. CreationData information cannot be changed after the disk has been created.
    disk_size_bytes float
    The size of the disk in bytes. This field is read only.
    disk_state str
    The state of the snapshot.
    id str
    Resource Id
    incremental_snapshot_family_id str
    Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
    location str
    Resource location
    managed_by str
    Unused. Always Null.
    name str
    Resource name
    provisioning_state str
    The disk provisioning state.
    time_created str
    The time when the snapshot was created.
    type str
    Resource type
    unique_id str
    Unique Guid identifying the resource.
    completion_percent float
    Percentage complete for the background copy when a resource is created via the CopyStart operation.
    copy_completion_error CopyCompletionErrorResponse
    Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
    data_access_auth_mode str
    Additional authentication requirements when exporting or uploading to a disk or snapshot.
    disk_access_id str
    ARM id of the DiskAccess resource for using private endpoints on disks.
    disk_size_gb int
    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 EncryptionResponse
    Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
    encryption_settings_collection EncryptionSettingsCollectionResponse
    Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
    extended_location ExtendedLocationResponse
    The extended location where the snapshot will be created. Extended location cannot be changed.
    hyper_v_generation str
    The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
    incremental bool
    Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
    network_access_policy str
    Policy for accessing the disk via network.
    os_type str
    The Operating System type.
    public_network_access str
    Policy for controlling export on the disk.
    purchase_plan PurchasePlanResponse
    Purchase plan information for the image from which the source disk for the snapshot was originally created.
    security_profile DiskSecurityProfileResponse
    Contains the security related information for the resource.
    sku SnapshotSkuResponse
    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
    supported_capabilities SupportedCapabilitiesResponse
    List of supported capabilities for the image from which the source disk from the snapshot was originally created.
    supports_hibernation bool
    Indicates the OS on a snapshot supports hibernation.
    tags Mapping[str, str]
    Resource tags
    creationData Property Map
    Disk source information. CreationData information cannot be changed after the disk has been created.
    diskSizeBytes Number
    The size of the disk in bytes. This field is read only.
    diskState String
    The state of the snapshot.
    id String
    Resource Id
    incrementalSnapshotFamilyId String
    Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
    location String
    Resource location
    managedBy String
    Unused. Always Null.
    name String
    Resource name
    provisioningState String
    The disk provisioning state.
    timeCreated String
    The time when the snapshot was created.
    type String
    Resource type
    uniqueId String
    Unique Guid identifying the resource.
    completionPercent Number
    Percentage complete for the background copy when a resource is created via the CopyStart operation.
    copyCompletionError Property Map
    Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
    dataAccessAuthMode String
    Additional authentication requirements when exporting or uploading to a disk or snapshot.
    diskAccessId String
    ARM id of the DiskAccess resource for using private endpoints on disks.
    diskSizeGB Number
    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 Property Map
    Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
    encryptionSettingsCollection Property Map
    Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
    extendedLocation Property Map
    The extended location where the snapshot will be created. Extended location cannot be changed.
    hyperVGeneration String
    The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
    incremental Boolean
    Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
    networkAccessPolicy String
    Policy for accessing the disk via network.
    osType String
    The Operating System type.
    publicNetworkAccess String
    Policy for controlling export on the disk.
    purchasePlan Property Map
    Purchase plan information for the image from which the source disk for the snapshot was originally created.
    securityProfile Property Map
    Contains the security related information for the resource.
    sku Property Map
    The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
    supportedCapabilities Property Map
    List of supported capabilities for the image from which the source disk from the snapshot was originally created.
    supportsHibernation Boolean
    Indicates the OS on a snapshot supports hibernation.
    tags Map<String>
    Resource tags

    Supporting Types

    CopyCompletionErrorResponse

    ErrorCode string
    Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
    ErrorMessage string
    Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
    ErrorCode string
    Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
    ErrorMessage string
    Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
    errorCode String
    Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
    errorMessage String
    Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
    errorCode string
    Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
    errorMessage string
    Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
    error_code str
    Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
    error_message str
    Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
    errorCode String
    Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
    errorMessage String
    Indicates the error message if the background copy of a resource created via the CopyStart operation fails.

    CreationDataResponse

    CreateOption string
    This enumerates the possible sources of a disk's creation.
    SourceUniqueId string
    If this field is set, this is the unique id identifying the source of this resource.
    GalleryImageReference Pulumi.AzureNative.Compute.Inputs.ImageDiskReferenceResponse
    Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
    ImageReference Pulumi.AzureNative.Compute.Inputs.ImageDiskReferenceResponse
    Disk source information for PIR or user images.
    LogicalSectorSize int
    Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
    PerformancePlus bool
    Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
    SecurityDataUri string
    If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
    SourceResourceId string
    If createOption is Copy, this is the ARM id of the source snapshot or disk.
    SourceUri string
    If createOption is Import, this is the URI of a blob to be imported into a managed disk.
    StorageAccountId string
    Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
    UploadSizeBytes double
    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).
    CreateOption string
    This enumerates the possible sources of a disk's creation.
    SourceUniqueId string
    If this field is set, this is the unique id identifying the source of this resource.
    GalleryImageReference ImageDiskReferenceResponse
    Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
    ImageReference ImageDiskReferenceResponse
    Disk source information for PIR or user images.
    LogicalSectorSize int
    Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
    PerformancePlus bool
    Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
    SecurityDataUri string
    If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
    SourceResourceId string
    If createOption is Copy, this is the ARM id of the source snapshot or disk.
    SourceUri string
    If createOption is Import, this is the URI of a blob to be imported into a managed disk.
    StorageAccountId string
    Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
    UploadSizeBytes float64
    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).
    createOption String
    This enumerates the possible sources of a disk's creation.
    sourceUniqueId String
    If this field is set, this is the unique id identifying the source of this resource.
    galleryImageReference ImageDiskReferenceResponse
    Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
    imageReference ImageDiskReferenceResponse
    Disk source information for PIR or user images.
    logicalSectorSize Integer
    Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
    performancePlus Boolean
    Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
    securityDataUri String
    If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
    sourceResourceId String
    If createOption is Copy, this is the ARM id of the source snapshot or disk.
    sourceUri String
    If createOption is Import, this is the URI of a blob to be imported into a managed disk.
    storageAccountId String
    Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
    uploadSizeBytes Double
    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).
    createOption string
    This enumerates the possible sources of a disk's creation.
    sourceUniqueId string
    If this field is set, this is the unique id identifying the source of this resource.
    galleryImageReference ImageDiskReferenceResponse
    Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
    imageReference ImageDiskReferenceResponse
    Disk source information for PIR or user images.
    logicalSectorSize number
    Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
    performancePlus boolean
    Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
    securityDataUri string
    If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
    sourceResourceId string
    If createOption is Copy, this is the ARM id of the source snapshot or disk.
    sourceUri string
    If createOption is Import, this is the URI of a blob to be imported into a managed disk.
    storageAccountId string
    Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
    uploadSizeBytes number
    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).
    create_option str
    This enumerates the possible sources of a disk's creation.
    source_unique_id str
    If this field is set, this is the unique id identifying the source of this resource.
    gallery_image_reference ImageDiskReferenceResponse
    Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
    image_reference ImageDiskReferenceResponse
    Disk source information for PIR or user images.
    logical_sector_size int
    Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
    performance_plus bool
    Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
    security_data_uri str
    If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
    source_resource_id str
    If createOption is Copy, this is the ARM id of the source snapshot or disk.
    source_uri str
    If createOption is Import, this is the URI of a blob to be imported into a managed disk.
    storage_account_id str
    Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
    upload_size_bytes float
    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).
    createOption String
    This enumerates the possible sources of a disk's creation.
    sourceUniqueId String
    If this field is set, this is the unique id identifying the source of this resource.
    galleryImageReference Property Map
    Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
    imageReference Property Map
    Disk source information for PIR or user images.
    logicalSectorSize Number
    Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
    performancePlus Boolean
    Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
    securityDataUri String
    If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
    sourceResourceId String
    If createOption is Copy, this is the ARM id of the source snapshot or disk.
    sourceUri String
    If createOption is Import, this is the URI of a blob to be imported into a managed disk.
    storageAccountId String
    Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
    uploadSizeBytes Number
    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).

    DiskSecurityProfileResponse

    SecureVMDiskEncryptionSetId string
    ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key
    SecurityType string
    Specifies the SecurityType of the VM. Applicable for OS disks only.
    SecureVMDiskEncryptionSetId string
    ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key
    SecurityType string
    Specifies the SecurityType of the VM. Applicable for OS disks only.
    secureVMDiskEncryptionSetId String
    ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key
    securityType String
    Specifies the SecurityType of the VM. Applicable for OS disks only.
    secureVMDiskEncryptionSetId string
    ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key
    securityType string
    Specifies the SecurityType of the VM. Applicable for OS disks only.
    secure_vm_disk_encryption_set_id str
    ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key
    security_type str
    Specifies the SecurityType of the VM. Applicable for OS disks only.
    secureVMDiskEncryptionSetId String
    ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key
    securityType String
    Specifies the SecurityType of the VM. Applicable for OS disks only.

    EncryptionResponse

    DiskEncryptionSetId string
    ResourceId of the disk encryption set to use for enabling encryption at rest.
    Type string
    The type of key used to encrypt the data of the disk.
    DiskEncryptionSetId string
    ResourceId of the disk encryption set to use for enabling encryption at rest.
    Type string
    The type of key used to encrypt the data of the disk.
    diskEncryptionSetId String
    ResourceId of the disk encryption set to use for enabling encryption at rest.
    type String
    The type of key used to encrypt the data of the disk.
    diskEncryptionSetId string
    ResourceId of the disk encryption set to use for enabling encryption at rest.
    type string
    The type of key used to encrypt the data of the disk.
    disk_encryption_set_id str
    ResourceId of the disk encryption set to use for enabling encryption at rest.
    type str
    The type of key used to encrypt the data of the disk.
    diskEncryptionSetId String
    ResourceId of the disk encryption set to use for enabling encryption at rest.
    type String
    The type of key used to encrypt the data of the disk.

    EncryptionSettingsCollectionResponse

    Enabled bool
    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 List<Pulumi.AzureNative.Compute.Inputs.EncryptionSettingsElementResponse>
    A collection of encryption settings, one for each disk volume.
    EncryptionSettingsVersion string
    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.
    Enabled bool
    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 []EncryptionSettingsElementResponse
    A collection of encryption settings, one for each disk volume.
    EncryptionSettingsVersion string
    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.
    enabled Boolean
    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 List<EncryptionSettingsElementResponse>
    A collection of encryption settings, one for each disk volume.
    encryptionSettingsVersion String
    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.
    enabled boolean
    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 EncryptionSettingsElementResponse[]
    A collection of encryption settings, one for each disk volume.
    encryptionSettingsVersion string
    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.
    enabled bool
    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.
    encryption_settings Sequence[EncryptionSettingsElementResponse]
    A collection of encryption settings, one for each disk volume.
    encryption_settings_version str
    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.
    enabled Boolean
    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 List<Property Map>
    A collection of encryption settings, one for each disk volume.
    encryptionSettingsVersion String
    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.

    EncryptionSettingsElementResponse

    DiskEncryptionKey Pulumi.AzureNative.Compute.Inputs.KeyVaultAndSecretReferenceResponse
    Key Vault Secret Url and vault id of the disk encryption key
    KeyEncryptionKey Pulumi.AzureNative.Compute.Inputs.KeyVaultAndKeyReferenceResponse
    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.
    DiskEncryptionKey KeyVaultAndSecretReferenceResponse
    Key Vault Secret Url and vault id of the disk encryption key
    KeyEncryptionKey KeyVaultAndKeyReferenceResponse
    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.
    diskEncryptionKey KeyVaultAndSecretReferenceResponse
    Key Vault Secret Url and vault id of the disk encryption key
    keyEncryptionKey KeyVaultAndKeyReferenceResponse
    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.
    diskEncryptionKey KeyVaultAndSecretReferenceResponse
    Key Vault Secret Url and vault id of the disk encryption key
    keyEncryptionKey KeyVaultAndKeyReferenceResponse
    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.
    disk_encryption_key KeyVaultAndSecretReferenceResponse
    Key Vault Secret Url and vault id of the disk encryption key
    key_encryption_key KeyVaultAndKeyReferenceResponse
    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.
    diskEncryptionKey Property Map
    Key Vault Secret Url and vault id of the disk encryption key
    keyEncryptionKey Property Map
    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.

    ExtendedLocationResponse

    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.
    name string
    The name of the extended location.
    type string
    The type of the extended location.
    name str
    The name of the extended location.
    type str
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.

    ImageDiskReferenceResponse

    CommunityGalleryImageId string
    A relative uri containing a community Azure Compute Gallery image reference.
    Id string
    A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
    Lun int
    If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
    SharedGalleryImageId string
    A relative uri containing a direct shared Azure Compute Gallery image reference.
    CommunityGalleryImageId string
    A relative uri containing a community Azure Compute Gallery image reference.
    Id string
    A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
    Lun int
    If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
    SharedGalleryImageId string
    A relative uri containing a direct shared Azure Compute Gallery image reference.
    communityGalleryImageId String
    A relative uri containing a community Azure Compute Gallery image reference.
    id String
    A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
    lun Integer
    If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
    sharedGalleryImageId String
    A relative uri containing a direct shared Azure Compute Gallery image reference.
    communityGalleryImageId string
    A relative uri containing a community Azure Compute Gallery image reference.
    id string
    A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
    lun number
    If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
    sharedGalleryImageId string
    A relative uri containing a direct shared Azure Compute Gallery image reference.
    community_gallery_image_id str
    A relative uri containing a community Azure Compute Gallery image reference.
    id str
    A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
    lun int
    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.
    shared_gallery_image_id str
    A relative uri containing a direct shared Azure Compute Gallery image reference.
    communityGalleryImageId String
    A relative uri containing a community Azure Compute Gallery image reference.
    id String
    A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
    lun Number
    If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
    sharedGalleryImageId String
    A relative uri containing a direct shared Azure Compute Gallery image reference.

    KeyVaultAndKeyReferenceResponse

    KeyUrl string
    Url pointing to a key or secret in KeyVault
    SourceVault Pulumi.AzureNative.Compute.Inputs.SourceVaultResponse
    Resource id of the KeyVault containing the key or secret
    KeyUrl string
    Url pointing to a key or secret in KeyVault
    SourceVault SourceVaultResponse
    Resource id of the KeyVault containing the key or secret
    keyUrl String
    Url pointing to a key or secret in KeyVault
    sourceVault SourceVaultResponse
    Resource id of the KeyVault containing the key or secret
    keyUrl string
    Url pointing to a key or secret in KeyVault
    sourceVault SourceVaultResponse
    Resource id of the KeyVault containing the key or secret
    key_url str
    Url pointing to a key or secret in KeyVault
    source_vault SourceVaultResponse
    Resource id of the KeyVault containing the key or secret
    keyUrl String
    Url pointing to a key or secret in KeyVault
    sourceVault Property Map
    Resource id of the KeyVault containing the key or secret

    KeyVaultAndSecretReferenceResponse

    SecretUrl string
    Url pointing to a key or secret in KeyVault
    SourceVault Pulumi.AzureNative.Compute.Inputs.SourceVaultResponse
    Resource id of the KeyVault containing the key or secret
    SecretUrl string
    Url pointing to a key or secret in KeyVault
    SourceVault SourceVaultResponse
    Resource id of the KeyVault containing the key or secret
    secretUrl String
    Url pointing to a key or secret in KeyVault
    sourceVault SourceVaultResponse
    Resource id of the KeyVault containing the key or secret
    secretUrl string
    Url pointing to a key or secret in KeyVault
    sourceVault SourceVaultResponse
    Resource id of the KeyVault containing the key or secret
    secret_url str
    Url pointing to a key or secret in KeyVault
    source_vault SourceVaultResponse
    Resource id of the KeyVault containing the key or secret
    secretUrl String
    Url pointing to a key or secret in KeyVault
    sourceVault Property Map
    Resource id of the KeyVault containing the key or secret

    PurchasePlanResponse

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

    SnapshotSkuResponse

    Tier string
    The sku tier.
    Name string
    The sku name.
    Tier string
    The sku tier.
    Name string
    The sku name.
    tier String
    The sku tier.
    name String
    The sku name.
    tier string
    The sku tier.
    name string
    The sku name.
    tier str
    The sku tier.
    name str
    The sku name.
    tier String
    The sku tier.
    name String
    The sku name.

    SourceVaultResponse

    Id string
    Resource Id
    Id string
    Resource Id
    id String
    Resource Id
    id string
    Resource Id
    id str
    Resource Id
    id String
    Resource Id

    SupportedCapabilitiesResponse

    AcceleratedNetwork bool
    True if the image from which the OS disk is created supports accelerated networking.
    Architecture string
    CPU architecture supported by an OS disk.
    DiskControllerTypes string
    The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
    AcceleratedNetwork bool
    True if the image from which the OS disk is created supports accelerated networking.
    Architecture string
    CPU architecture supported by an OS disk.
    DiskControllerTypes string
    The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
    acceleratedNetwork Boolean
    True if the image from which the OS disk is created supports accelerated networking.
    architecture String
    CPU architecture supported by an OS disk.
    diskControllerTypes String
    The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
    acceleratedNetwork boolean
    True if the image from which the OS disk is created supports accelerated networking.
    architecture string
    CPU architecture supported by an OS disk.
    diskControllerTypes string
    The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
    accelerated_network bool
    True if the image from which the OS disk is created supports accelerated networking.
    architecture str
    CPU architecture supported by an OS disk.
    disk_controller_types str
    The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
    acceleratedNetwork Boolean
    True if the image from which the OS disk is created supports accelerated networking.
    architecture String
    CPU architecture supported by an OS disk.
    diskControllerTypes String
    The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.41.0 published on Tuesday, May 14, 2024 by Pulumi