Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. devtestlab
  5. getDisk
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.devtestlab.getDisk

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Get disk.

Uses Azure REST API version 2018-09-15.

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>
Copy
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]
Copy
func LookupDisk(ctx *Context, args *LookupDiskArgs, opts ...InvokeOption) (*LookupDiskResult, error)
func LookupDiskOutput(ctx *Context, args *LookupDiskOutputArgs, opts ...InvokeOption) LookupDiskResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetDiskResult> getDisk(GetDiskArgs args, InvokeOptions options)
public static Output<GetDiskResult> getDisk(GetDiskArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:devtestlab:getDisk
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the disk.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
UserName
This property is required.
Changes to this property will trigger replacement.
string
The name of the user profile.
Expand string
Specify the $expand query. Example: 'properties($select=diskType)'
LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the disk.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
UserName
This property is required.
Changes to this property will trigger replacement.
string
The name of the user profile.
Expand string
Specify the $expand query. Example: 'properties($select=diskType)'
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the disk.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
userName
This property is required.
Changes to this property will trigger replacement.
String
The name of the user profile.
expand String
Specify the $expand query. Example: 'properties($select=diskType)'
labName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
string
The name of the disk.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
userName
This property is required.
Changes to this property will trigger replacement.
string
The name of the user profile.
expand string
Specify the $expand query. Example: 'properties($select=diskType)'
lab_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
str
The name of the disk.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
user_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the user profile.
expand str
Specify the $expand query. Example: 'properties($select=diskType)'
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the disk.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
userName
This property is required.
Changes to this property will trigger replacement.
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
The identifier of the resource.
Name string
The name of the resource.
ProvisioningState string
The provisioning status of the resource.
Type string
The type of the resource.
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 location of the resource.
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>
The tags of the resource.
AzureApiVersion string
The Azure API version of the resource.
CreatedDate string
The creation date of the disk.
Id string
The identifier of the resource.
Name string
The name of the resource.
ProvisioningState string
The provisioning status of the resource.
Type string
The type of the resource.
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 location of the resource.
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
The tags of the resource.
azureApiVersion String
The Azure API version of the resource.
createdDate String
The creation date of the disk.
id String
The identifier of the resource.
name String
The name of the resource.
provisioningState String
The provisioning status of the resource.
type String
The type of the resource.
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 location of the resource.
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>
The tags of the resource.
azureApiVersion string
The Azure API version of the resource.
createdDate string
The creation date of the disk.
id string
The identifier of the resource.
name string
The name of the resource.
provisioningState string
The provisioning status of the resource.
type string
The type of the resource.
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 location of the resource.
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}
The tags of the resource.
azure_api_version str
The Azure API version of the resource.
created_date str
The creation date of the disk.
id str
The identifier of the resource.
name str
The name of the resource.
provisioning_state str
The provisioning status of the resource.
type str
The type of the resource.
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 location of the resource.
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]
The tags of the resource.
azureApiVersion String
The Azure API version of the resource.
createdDate String
The creation date of the disk.
id String
The identifier of the resource.
name String
The name of the resource.
provisioningState String
The provisioning status of the resource.
type String
The type of the resource.
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 location of the resource.
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>
The tags of the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native