Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. azurestackhci
  5. getVirtualHardDisk
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.azurestackhci.getVirtualHardDisk

Explore with Pulumi AI

azure-native logo
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets a virtual hard disk

    Uses Azure REST API version 2025-02-01-preview.

    Other available API versions: 2022-12-15-preview, 2023-07-01-preview, 2023-09-01-preview, 2024-01-01, 2024-02-01-preview, 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurestackhci [ApiVersion]. See the version guide for details.

    Using getVirtualHardDisk

    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 getVirtualHardDisk(args: GetVirtualHardDiskArgs, opts?: InvokeOptions): Promise<GetVirtualHardDiskResult>
function getVirtualHardDiskOutput(args: GetVirtualHardDiskOutputArgs, opts?: InvokeOptions): Output<GetVirtualHardDiskResult>
    def get_virtual_hard_disk(resource_group_name: Optional[str] = None,
                          virtual_hard_disk_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetVirtualHardDiskResult
def get_virtual_hard_disk_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                          virtual_hard_disk_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetVirtualHardDiskResult]
    func LookupVirtualHardDisk(ctx *Context, args *LookupVirtualHardDiskArgs, opts ...InvokeOption) (*LookupVirtualHardDiskResult, error)
func LookupVirtualHardDiskOutput(ctx *Context, args *LookupVirtualHardDiskOutputArgs, opts ...InvokeOption) LookupVirtualHardDiskResultOutput

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

    public static class GetVirtualHardDisk 
{
    public static Task<GetVirtualHardDiskResult> InvokeAsync(GetVirtualHardDiskArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualHardDiskResult> Invoke(GetVirtualHardDiskInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVirtualHardDiskResult> getVirtualHardDisk(GetVirtualHardDiskArgs args, InvokeOptions options)
public static Output<GetVirtualHardDiskResult> getVirtualHardDisk(GetVirtualHardDiskArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:azurestackhci:getVirtualHardDisk
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VirtualHardDiskName string
    Name of the virtual hard disk
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VirtualHardDiskName string
    Name of the virtual hard disk
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    virtualHardDiskName String
    Name of the virtual hard disk
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    virtualHardDiskName string
    Name of the virtual hard disk
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    virtual_hard_disk_name str
    Name of the virtual hard disk
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    virtualHardDiskName String
    Name of the virtual hard disk

    getVirtualHardDisk Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the virtual hard disk.
    Status Pulumi.AzureNative.AzureStackHCI.Outputs.VirtualHardDiskStatusResponse
    The observed state of virtual hard disks
    SystemData Pulumi.AzureNative.AzureStackHCI.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"
    BlockSizeBytes int
    Block size in bytes
    ContainerId string
    Storage ContainerID of the storage container to be used for VHD
    CreateFromLocal bool
    Boolean indicating whether it is an existing local hard disk or if one should be created.
    DiskFileFormat string
    The format of the actual VHD file [vhd, vhdx]
    DiskSizeGB double
    Size of the disk in GB
    DownloadUrl string
    URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly.
    Dynamic bool
    Boolean for enabling dynamic sizing on the virtual hard disk
    ExtendedLocation Pulumi.AzureNative.AzureStackHCI.Outputs.ExtendedLocationResponse
    The extendedLocation of the resource.
    HyperVGeneration string
    The hypervisor generation of the Virtual Machine [V1, V2]
    LogicalSectorBytes int
    Logical sector in bytes
    PhysicalSectorBytes int
    Physical sector in bytes
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the virtual hard disk.
    Status VirtualHardDiskStatusResponse
    The observed state of virtual hard disks
    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"
    BlockSizeBytes int
    Block size in bytes
    ContainerId string
    Storage ContainerID of the storage container to be used for VHD
    CreateFromLocal bool
    Boolean indicating whether it is an existing local hard disk or if one should be created.
    DiskFileFormat string
    The format of the actual VHD file [vhd, vhdx]
    DiskSizeGB float64
    Size of the disk in GB
    DownloadUrl string
    URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly.
    Dynamic bool
    Boolean for enabling dynamic sizing on the virtual hard disk
    ExtendedLocation ExtendedLocationResponse
    The extendedLocation of the resource.
    HyperVGeneration string
    The hypervisor generation of the Virtual Machine [V1, V2]
    LogicalSectorBytes int
    Logical sector in bytes
    PhysicalSectorBytes int
    Physical sector in bytes
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the virtual hard disk.
    status VirtualHardDiskStatusResponse
    The observed state of virtual hard disks
    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"
    blockSizeBytes Integer
    Block size in bytes
    containerId String
    Storage ContainerID of the storage container to be used for VHD
    createFromLocal Boolean
    Boolean indicating whether it is an existing local hard disk or if one should be created.
    diskFileFormat String
    The format of the actual VHD file [vhd, vhdx]
    diskSizeGB Double
    Size of the disk in GB
    downloadUrl String
    URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly.
    dynamic Boolean
    Boolean for enabling dynamic sizing on the virtual hard disk
    extendedLocation ExtendedLocationResponse
    The extendedLocation of the resource.
    hyperVGeneration String
    The hypervisor generation of the Virtual Machine [V1, V2]
    logicalSectorBytes Integer
    Logical sector in bytes
    physicalSectorBytes Integer
    Physical sector in bytes
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    Provisioning state of the virtual hard disk.
    status VirtualHardDiskStatusResponse
    The observed state of virtual hard disks
    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"
    blockSizeBytes number
    Block size in bytes
    containerId string
    Storage ContainerID of the storage container to be used for VHD
    createFromLocal boolean
    Boolean indicating whether it is an existing local hard disk or if one should be created.
    diskFileFormat string
    The format of the actual VHD file [vhd, vhdx]
    diskSizeGB number
    Size of the disk in GB
    downloadUrl string
    URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly.
    dynamic boolean
    Boolean for enabling dynamic sizing on the virtual hard disk
    extendedLocation ExtendedLocationResponse
    The extendedLocation of the resource.
    hyperVGeneration string
    The hypervisor generation of the Virtual Machine [V1, V2]
    logicalSectorBytes number
    Logical sector in bytes
    physicalSectorBytes number
    Physical sector in bytes
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    Provisioning state of the virtual hard disk.
    status VirtualHardDiskStatusResponse
    The observed state of virtual hard disks
    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"
    block_size_bytes int
    Block size in bytes
    container_id str
    Storage ContainerID of the storage container to be used for VHD
    create_from_local bool
    Boolean indicating whether it is an existing local hard disk or if one should be created.
    disk_file_format str
    The format of the actual VHD file [vhd, vhdx]
    disk_size_gb float
    Size of the disk in GB
    download_url str
    URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly.
    dynamic bool
    Boolean for enabling dynamic sizing on the virtual hard disk
    extended_location ExtendedLocationResponse
    The extendedLocation of the resource.
    hyper_v_generation str
    The hypervisor generation of the Virtual Machine [V1, V2]
    logical_sector_bytes int
    Logical sector in bytes
    physical_sector_bytes int
    Physical sector in bytes
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the virtual hard disk.
    status Property Map
    The observed state of virtual hard disks
    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"
    blockSizeBytes Number
    Block size in bytes
    containerId String
    Storage ContainerID of the storage container to be used for VHD
    createFromLocal Boolean
    Boolean indicating whether it is an existing local hard disk or if one should be created.
    diskFileFormat String
    The format of the actual VHD file [vhd, vhdx]
    diskSizeGB Number
    Size of the disk in GB
    downloadUrl String
    URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly.
    dynamic Boolean
    Boolean for enabling dynamic sizing on the virtual hard disk
    extendedLocation Property Map
    The extendedLocation of the resource.
    hyperVGeneration String
    The hypervisor generation of the Virtual Machine [V1, V2]
    logicalSectorBytes Number
    Logical sector in bytes
    physicalSectorBytes Number
    Physical sector in bytes
    tags Map<String>
    Resource tags.

    Supporting Types

    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.

    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.

    VirtualHardDiskDownloadStatusResponse

    Status string
    The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]
    DownloadedSizeInMB double
    The downloaded sized of the virtual hard disk in MB
    ProgressPercentage double
    The progress of the operation in percentage
    Status string
    The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]
    DownloadedSizeInMB float64
    The downloaded sized of the virtual hard disk in MB
    ProgressPercentage float64
    The progress of the operation in percentage
    status String
    The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]
    downloadedSizeInMB Double
    The downloaded sized of the virtual hard disk in MB
    progressPercentage Double
    The progress of the operation in percentage
    status string
    The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]
    downloadedSizeInMB number
    The downloaded sized of the virtual hard disk in MB
    progressPercentage number
    The progress of the operation in percentage
    status str
    The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]
    downloaded_size_in_mb float
    The downloaded sized of the virtual hard disk in MB
    progress_percentage float
    The progress of the operation in percentage
    status String
    The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]
    downloadedSizeInMB Number
    The downloaded sized of the virtual hard disk in MB
    progressPercentage Number
    The progress of the operation in percentage

    VirtualHardDiskStatusProvisioningStatusResponse

    Status string
    The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress]
    OperationId string
    The ID of the operation performed on the virtual hard disk
    Status string
    The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress]
    OperationId string
    The ID of the operation performed on the virtual hard disk
    status String
    The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress]
    operationId String
    The ID of the operation performed on the virtual hard disk
    status string
    The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress]
    operationId string
    The ID of the operation performed on the virtual hard disk
    status str
    The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress]
    operation_id str
    The ID of the operation performed on the virtual hard disk
    status String
    The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress]
    operationId String
    The ID of the operation performed on the virtual hard disk

    VirtualHardDiskStatusResponse

    DownloadStatus VirtualHardDiskDownloadStatusResponse
    The download status of the virtual hard disk
    ErrorCode string
    VirtualHardDisk provisioning error code
    ErrorMessage string
    Descriptive error message
    ProvisioningStatus VirtualHardDiskStatusProvisioningStatusResponse
    Provisioning status of the vhd
    UploadStatus VirtualHardDiskUploadStatusResponse
    The upload status of the virtual hard disk
    downloadStatus VirtualHardDiskDownloadStatusResponse
    The download status of the virtual hard disk
    errorCode String
    VirtualHardDisk provisioning error code
    errorMessage String
    Descriptive error message
    provisioningStatus VirtualHardDiskStatusProvisioningStatusResponse
    Provisioning status of the vhd
    uploadStatus VirtualHardDiskUploadStatusResponse
    The upload status of the virtual hard disk
    downloadStatus VirtualHardDiskDownloadStatusResponse
    The download status of the virtual hard disk
    errorCode string
    VirtualHardDisk provisioning error code
    errorMessage string
    Descriptive error message
    provisioningStatus VirtualHardDiskStatusProvisioningStatusResponse
    Provisioning status of the vhd
    uploadStatus VirtualHardDiskUploadStatusResponse
    The upload status of the virtual hard disk
    download_status VirtualHardDiskDownloadStatusResponse
    The download status of the virtual hard disk
    error_code str
    VirtualHardDisk provisioning error code
    error_message str
    Descriptive error message
    provisioning_status VirtualHardDiskStatusProvisioningStatusResponse
    Provisioning status of the vhd
    upload_status VirtualHardDiskUploadStatusResponse
    The upload status of the virtual hard disk
    downloadStatus Property Map
    The download status of the virtual hard disk
    errorCode String
    VirtualHardDisk provisioning error code
    errorMessage String
    Descriptive error message
    provisioningStatus Property Map
    Provisioning status of the vhd
    uploadStatus Property Map
    The upload status of the virtual hard disk

    VirtualHardDiskUploadStatusResponse

    Status string
    The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]
    ErrorCode string
    VirtualHardDisk upload error code
    ErrorMessage string
    Descriptive upload error message
    ProgressPercentage double
    The progress of the operation in percentage
    UploadedSizeInMB double
    The uploaded sized of the virtual hard disk in MB
    Status string
    The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]
    ErrorCode string
    VirtualHardDisk upload error code
    ErrorMessage string
    Descriptive upload error message
    ProgressPercentage float64
    The progress of the operation in percentage
    UploadedSizeInMB float64
    The uploaded sized of the virtual hard disk in MB
    status String
    The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]
    errorCode String
    VirtualHardDisk upload error code
    errorMessage String
    Descriptive upload error message
    progressPercentage Double
    The progress of the operation in percentage
    uploadedSizeInMB Double
    The uploaded sized of the virtual hard disk in MB
    status string
    The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]
    errorCode string
    VirtualHardDisk upload error code
    errorMessage string
    Descriptive upload error message
    progressPercentage number
    The progress of the operation in percentage
    uploadedSizeInMB number
    The uploaded sized of the virtual hard disk in MB
    status str
    The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]
    error_code str
    VirtualHardDisk upload error code
    error_message str
    Descriptive upload error message
    progress_percentage float
    The progress of the operation in percentage
    uploaded_size_in_mb float
    The uploaded sized of the virtual hard disk in MB
    status String
    The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]
    errorCode String
    VirtualHardDisk upload error code
    errorMessage String
    Descriptive upload error message
    progressPercentage Number
    The progress of the operation in percentage
    uploadedSizeInMB Number
    The uploaded sized of the virtual hard disk in MB

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native