Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.2 published on Tuesday, Aug 16, 2022 by Pulumi

getDisk

Disk resource. API Version: 2020-12-01.

Using getDisk

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 getDisk(args: GetDiskArgs, opts?: InvokeOptions): Promise<GetDiskResult>
function getDiskOutput(args: GetDiskOutputArgs, opts?: InvokeOptions): Output<GetDiskResult>
def get_disk(disk_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetDiskResult
def get_disk_output(disk_name: Optional[pulumi.Input[str]] = None,
             resource_group_name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetDiskResult]
func LookupDisk(ctx *Context, args *LookupDiskArgs, opts ...InvokeOption) (*LookupDiskResult, error)
func LookupDiskOutput(ctx *Context, args *LookupDiskOutputArgs, opts ...InvokeOption) LookupDiskResultOutput

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

public static class GetDisk 
{
    public static Task<GetDiskResult> InvokeAsync(GetDiskArgs args, InvokeOptions? opts = null)
    public static Output<GetDiskResult> Invoke(GetDiskInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDiskResult> getDisk(GetDiskArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:compute:getDisk
  Arguments:
    # Arguments dictionary

The following arguments are supported:

DiskName string

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.

ResourceGroupName string

The name of the resource group.

DiskName string

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.

ResourceGroupName string

The name of the resource group.

diskName String

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.

resourceGroupName String

The name of the resource group.

diskName string

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.

resourceGroupName string

The name of the resource group.

disk_name str

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.

resource_group_name str

The name of the resource group.

diskName String

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.

resourceGroupName String

The name of the resource group.

getDisk 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 disk.

Id string

Resource Id

Location string

Resource location

ManagedBy string

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

ManagedByExtended List<string>

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

Resource name

PropertyUpdatesInProgress Pulumi.AzureNative.Compute.Outputs.PropertyUpdatesInProgressResponse

Properties of the disk for which update is pending.

ProvisioningState string

The disk provisioning state.

ShareInfo List<Pulumi.AzureNative.Compute.Outputs.ShareInfoElementResponse>

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.

TimeCreated string

The time when the disk was created.

Type string

Resource type

UniqueId string

Unique Guid identifying the resource.

BurstingEnabled bool

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.

DiskAccessId string

ARM id of the DiskAccess resource for using private endpoints on disks.

DiskIOPSReadOnly double

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 double

The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

DiskMBpsReadOnly double

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 double

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

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 for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

ExtendedLocation Pulumi.AzureNative.Compute.Outputs.ExtendedLocationResponse

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

HyperVGeneration string

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

MaxShares int

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 string

Policy for accessing the disk via network.

OsType string

The Operating System type.

PurchasePlan Pulumi.AzureNative.Compute.Outputs.PurchasePlanResponse

Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}

SecurityProfile Pulumi.AzureNative.Compute.Outputs.DiskSecurityProfileResponse

Contains the security related information for the resource.

Sku Pulumi.AzureNative.Compute.Outputs.DiskSkuResponse

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

SupportsHibernation bool

Indicates the OS on a disk supports hibernation.

Tags Dictionary<string, string>

Resource tags

Tier string

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 List<string>

The Logical zone list for Disk.

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

Id string

Resource Id

Location string

Resource location

ManagedBy string

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

ManagedByExtended []string

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

Resource name

PropertyUpdatesInProgress PropertyUpdatesInProgressResponse

Properties of the disk for which update is pending.

ProvisioningState string

The disk provisioning state.

ShareInfo []ShareInfoElementResponse

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.

TimeCreated string

The time when the disk was created.

Type string

Resource type

UniqueId string

Unique Guid identifying the resource.

BurstingEnabled bool

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.

DiskAccessId string

ARM id of the DiskAccess resource for using private endpoints on disks.

DiskIOPSReadOnly float64

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 float64

The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

DiskMBpsReadOnly float64

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 float64

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

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 for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

ExtendedLocation ExtendedLocationResponse

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

HyperVGeneration string

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

MaxShares int

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 string

Policy for accessing the disk via network.

OsType string

The Operating System type.

PurchasePlan PurchasePlanResponse

Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}

SecurityProfile DiskSecurityProfileResponse

Contains the security related information for the resource.

Sku DiskSkuResponse

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

SupportsHibernation bool

Indicates the OS on a disk supports hibernation.

Tags map[string]string

Resource tags

Tier string

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

The Logical zone list for Disk.

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

id String

Resource Id

location String

Resource location

managedBy String

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

managedByExtended List<String>

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

Resource name

propertyUpdatesInProgress PropertyUpdatesInProgressResponse

Properties of the disk for which update is pending.

provisioningState String

The disk provisioning state.

shareInfo List<ShareInfoElementResponse>

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.

timeCreated String

The time when the disk was created.

type String

Resource type

uniqueId String

Unique Guid identifying the resource.

burstingEnabled Boolean

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.

diskAccessId String

ARM id of the DiskAccess resource for using private endpoints on disks.

diskIOPSReadOnly Double

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 Double

The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

diskMBpsReadOnly Double

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 Double

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 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 for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

extendedLocation ExtendedLocationResponse

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

hyperVGeneration String

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

maxShares Integer

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 String

Policy for accessing the disk via network.

osType String

The Operating System type.

purchasePlan PurchasePlanResponse

Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}

securityProfile DiskSecurityProfileResponse

Contains the security related information for the resource.

sku DiskSkuResponse

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

supportsHibernation Boolean

Indicates the OS on a disk supports hibernation.

tags Map<String,String>

Resource tags

tier String

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 List<String>

The Logical zone list for Disk.

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

id string

Resource Id

location string

Resource location

managedBy string

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

managedByExtended string[]

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

Resource name

propertyUpdatesInProgress PropertyUpdatesInProgressResponse

Properties of the disk for which update is pending.

provisioningState string

The disk provisioning state.

shareInfo ShareInfoElementResponse[]

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.

timeCreated string

The time when the disk was created.

type string

Resource type

uniqueId string

Unique Guid identifying the resource.

burstingEnabled boolean

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.

diskAccessId string

ARM id of the DiskAccess resource for using private endpoints on disks.

diskIOPSReadOnly number

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 number

The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

diskMBpsReadOnly number

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 number

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 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 for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

extendedLocation ExtendedLocationResponse

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

hyperVGeneration string

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

maxShares number

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 string

Policy for accessing the disk via network.

osType string

The Operating System type.

purchasePlan PurchasePlanResponse

Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}

securityProfile DiskSecurityProfileResponse

Contains the security related information for the resource.

sku DiskSkuResponse

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

supportsHibernation boolean

Indicates the OS on a disk supports hibernation.

tags {[key: string]: string}

Resource tags

tier string

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

The Logical zone list for Disk.

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

id str

Resource Id

location str

Resource location

managed_by str

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

managed_by_extended Sequence[str]

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 str

Resource name

property_updates_in_progress PropertyUpdatesInProgressResponse

Properties of the disk for which update is pending.

provisioning_state str

The disk provisioning state.

share_info Sequence[ShareInfoElementResponse]

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.

time_created str

The time when the disk was created.

type str

Resource type

unique_id str

Unique Guid identifying the resource.

bursting_enabled bool

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.

disk_access_id str

ARM id of the DiskAccess resource for using private endpoints on disks.

disk_iops_read_only float

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.

disk_iops_read_write float

The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

disk_m_bps_read_only float

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.

disk_m_bps_read_write float

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.

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 for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

extended_location ExtendedLocationResponse

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

hyper_v_generation str

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

max_shares int

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.

network_access_policy str

Policy for accessing the disk via network.

os_type str

The Operating System type.

purchase_plan PurchasePlanResponse

Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}

security_profile DiskSecurityProfileResponse

Contains the security related information for the resource.

sku DiskSkuResponse

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

supports_hibernation bool

Indicates the OS on a disk supports hibernation.

tags Mapping[str, str]

Resource tags

tier str

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 Sequence[str]

The Logical zone list for Disk.

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

id String

Resource Id

location String

Resource location

managedBy String

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

managedByExtended List<String>

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

Resource name

propertyUpdatesInProgress Property Map

Properties of the disk for which update is pending.

provisioningState String

The disk provisioning state.

shareInfo List<Property Map>

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.

timeCreated String

The time when the disk was created.

type String

Resource type

uniqueId String

Unique Guid identifying the resource.

burstingEnabled Boolean

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.

diskAccessId String

ARM id of the DiskAccess resource for using private endpoints on disks.

diskIOPSReadOnly Number

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 Number

The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

diskMBpsReadOnly Number

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 Number

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 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 for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

extendedLocation Property Map

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

hyperVGeneration String

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

maxShares Number

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 String

Policy for accessing the disk via network.

osType String

The Operating System type.

purchasePlan Property Map

Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}

securityProfile Property Map

Contains the security related information for the resource.

sku Property Map

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

supportsHibernation Boolean

Indicates the OS on a disk supports hibernation.

tags Map<String>

Resource tags

tier String

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 List<String>

The Logical zone list for Disk.

Supporting Types

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

LogicalSectorSize int

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

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

LogicalSectorSize int

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

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

logicalSectorSize Integer

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

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

logicalSectorSize number

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

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

logical_sector_size int

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

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

logicalSectorSize Number

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

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

SecurityType string

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

SecurityType string

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

securityType String

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

securityType string

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

security_type str

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

securityType String

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

DiskSkuResponse

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.

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

Id string

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

Id string

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

id String

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

id string

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

id str

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

id String

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

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

PropertyUpdatesInProgressResponse

TargetTier string

The target performance tier of the disk if a tier change operation is in progress.

TargetTier string

The target performance tier of the disk if a tier change operation is in progress.

targetTier String

The target performance tier of the disk if a tier change operation is in progress.

targetTier string

The target performance tier of the disk if a tier change operation is in progress.

target_tier str

The target performance tier of the disk if a tier change operation is in progress.

targetTier String

The target performance tier of the disk if a tier change operation is in progress.

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.

ShareInfoElementResponse

VmUri string

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

VmUri string

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

vmUri String

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

vmUri string

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

vm_uri str

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

vmUri String

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0