azure-native.devtestlab.getDisk

Azure Native v3.16.0, Mar 20 26

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

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(expand: Optional[str] = None,
             lab_name: Optional[str] = None,
             name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             user_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetDiskResult
def get_disk_output(expand: Optional[pulumi.Input[str]] = None,
             lab_name: Optional[pulumi.Input[str]] = None,
             name: Optional[pulumi.Input[str]] = None,
             resource_group_name: Optional[pulumi.Input[str]] = None,
             user_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)
public static Output<GetDiskResult> getDisk(GetDiskArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:devtestlab:getDisk
  arguments:
    # arguments dictionary

The following arguments are supported:

LabName string: The name of the lab.
Name string: The name of the disk.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
UserName string: The name of the user profile.
Expand string: Specify the $expand query. Example: 'properties($select=diskType)'

LabName string: The name of the lab.
Name string: The name of the disk.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
UserName string: The name of the user profile.
Expand string: Specify the $expand query. Example: 'properties($select=diskType)'

labName String: The name of the lab.
name String: The name of the disk.
resourceGroupName String: The name of the resource group. The name is case insensitive.
userName String: The name of the user profile.
expand String: Specify the $expand query. Example: 'properties($select=diskType)'

labName string: The name of the lab.
name string: The name of the disk.
resourceGroupName string: The name of the resource group. The name is case insensitive.
userName string: The name of the user profile.
expand string: Specify the $expand query. Example: 'properties($select=diskType)'

lab_name str: The name of the lab.
name str: The name of the disk.
resource_group_name str: The name of the resource group. The name is case insensitive.
user_name str: The name of the user profile.
expand str: Specify the $expand query. Example: 'properties($select=diskType)'

labName String: The name of the lab.
name String: The name of the disk.
resourceGroupName String: The name of the resource group. The name is case insensitive.
userName String: The name of the user profile.
expand String: Specify the $expand query. Example: 'properties($select=diskType)'

getDisk Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
CreatedDate string: The creation date of the disk.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
ProvisioningState string: The provisioning status of the resource.
SystemData Pulumi.AzureNative.DevTestLab.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UniqueIdentifier string: The unique immutable identifier of a resource (Guid).
DiskBlobName string: When backed by a blob, the name of the VHD blob without extension.
DiskSizeGiB int: The size of the disk in Gibibytes.
DiskType string: The storage type for the disk (i.e. Standard, Premium).
DiskUri string: When backed by a blob, the URI of underlying blob.
HostCaching string: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).
LeasedByLabVmId string: The resource ID of the VM to which this disk is leased.
Location string: The geo-location where the resource lives
ManagedDiskId string: When backed by managed disk, this is the ID of the compute disk resource.
StorageAccountId string: When backed by a blob, the storage account where the blob is.
Tags Dictionary<string, string>: Resource tags.

AzureApiVersion string: The Azure API version of the resource.
CreatedDate string: The creation date of the disk.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
ProvisioningState string: The provisioning status of the resource.
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UniqueIdentifier string: The unique immutable identifier of a resource (Guid).
DiskBlobName string: When backed by a blob, the name of the VHD blob without extension.
DiskSizeGiB int: The size of the disk in Gibibytes.
DiskType string: The storage type for the disk (i.e. Standard, Premium).
DiskUri string: When backed by a blob, the URI of underlying blob.
HostCaching string: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).
LeasedByLabVmId string: The resource ID of the VM to which this disk is leased.
Location string: The geo-location where the resource lives
ManagedDiskId string: When backed by managed disk, this is the ID of the compute disk resource.
StorageAccountId string: When backed by a blob, the storage account where the blob is.
Tags map[string]string: Resource tags.

azureApiVersion String: The Azure API version of the resource.
createdDate String: The creation date of the disk.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
provisioningState String: The provisioning status of the resource.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uniqueIdentifier String: The unique immutable identifier of a resource (Guid).
diskBlobName String: When backed by a blob, the name of the VHD blob without extension.
diskSizeGiB Integer: The size of the disk in Gibibytes.
diskType String: The storage type for the disk (i.e. Standard, Premium).
diskUri String: When backed by a blob, the URI of underlying blob.
hostCaching String: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).
leasedByLabVmId String: The resource ID of the VM to which this disk is leased.
location String: The geo-location where the resource lives
managedDiskId String: When backed by managed disk, this is the ID of the compute disk resource.
storageAccountId String: When backed by a blob, the storage account where the blob is.
tags Map<String,String>: Resource tags.

azureApiVersion string: The Azure API version of the resource.
createdDate string: The creation date of the disk.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string: The name of the resource
provisioningState string: The provisioning status of the resource.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uniqueIdentifier string: The unique immutable identifier of a resource (Guid).
diskBlobName string: When backed by a blob, the name of the VHD blob without extension.
diskSizeGiB number: The size of the disk in Gibibytes.
diskType string: The storage type for the disk (i.e. Standard, Premium).
diskUri string: When backed by a blob, the URI of underlying blob.
hostCaching string: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).
leasedByLabVmId string: The resource ID of the VM to which this disk is leased.
location string: The geo-location where the resource lives
managedDiskId string: When backed by managed disk, this is the ID of the compute disk resource.
storageAccountId string: When backed by a blob, the storage account where the blob is.
tags {[key: string]: string}: Resource tags.

azure_api_version str: The Azure API version of the resource.
created_date str: The creation date of the disk.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str: The name of the resource
provisioning_state str: The provisioning status of the resource.
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
unique_identifier str: The unique immutable identifier of a resource (Guid).
disk_blob_name str: When backed by a blob, the name of the VHD blob without extension.
disk_size_gi_b int: The size of the disk in Gibibytes.
disk_type str: The storage type for the disk (i.e. Standard, Premium).
disk_uri str: When backed by a blob, the URI of underlying blob.
host_caching str: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).
leased_by_lab_vm_id str: The resource ID of the VM to which this disk is leased.
location str: The geo-location where the resource lives
managed_disk_id str: When backed by managed disk, this is the ID of the compute disk resource.
storage_account_id str: When backed by a blob, the storage account where the blob is.
tags Mapping[str, str]: Resource tags.

azureApiVersion String: The Azure API version of the resource.
createdDate String: The creation date of the disk.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
provisioningState String: The provisioning status of the resource.
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uniqueIdentifier String: The unique immutable identifier of a resource (Guid).
diskBlobName String: When backed by a blob, the name of the VHD blob without extension.
diskSizeGiB Number: The size of the disk in Gibibytes.
diskType String: The storage type for the disk (i.e. Standard, Premium).
diskUri String: When backed by a blob, the URI of underlying blob.
hostCaching String: The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).
leasedByLabVmId String: The resource ID of the VM to which this disk is leased.
location String: The geo-location where the resource lives
managedDiskId String: When backed by managed disk, this is the ID of the compute disk resource.
storageAccountId String: When backed by a blob, the storage account where the blob is.
tags Map<String>: Resource tags.

Supporting Types

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.