1. Packages
  2. Azure Native
  3. API Docs
  4. azurestackhci
  5. VirtualHardDisk
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.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.azurestackhci.VirtualHardDisk

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.2.0 published on Monday, Apr 14, 2025 by Pulumi

The virtual hard disk resource definition.

Uses Azure REST API version 2025-02-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-12-15-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.

Example Usage

CreateVirtualHardDiskFromLocal

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var virtualHardDisk = new AzureNative.AzureStackHCI.VirtualHardDisk("virtualHardDisk", new()
    {
        ContainerId = "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container",
        CreateFromLocal = true,
        ExtendedLocation = new AzureNative.AzureStackHCI.Inputs.ExtendedLocationArgs
        {
            Name = "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
            Type = AzureNative.AzureStackHCI.ExtendedLocationTypes.CustomLocation,
        },
        Location = "West US2",
        ResourceGroupName = "test-rg",
        VirtualHardDiskName = "test-vhd",
    });

});
Copy
package main

import (
	azurestackhci "github.com/pulumi/pulumi-azure-native-sdk/azurestackhci/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azurestackhci.NewVirtualHardDisk(ctx, "virtualHardDisk", &azurestackhci.VirtualHardDiskArgs{
			ContainerId:     pulumi.String("/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container"),
			CreateFromLocal: pulumi.Bool(true),
			ExtendedLocation: &azurestackhci.ExtendedLocationArgs{
				Name: pulumi.String("/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location"),
				Type: pulumi.String(azurestackhci.ExtendedLocationTypesCustomLocation),
			},
			Location:            pulumi.String("West US2"),
			ResourceGroupName:   pulumi.String("test-rg"),
			VirtualHardDiskName: pulumi.String("test-vhd"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.azurestackhci.VirtualHardDisk;
import com.pulumi.azurenative.azurestackhci.VirtualHardDiskArgs;
import com.pulumi.azurenative.azurestackhci.inputs.ExtendedLocationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var virtualHardDisk = new VirtualHardDisk("virtualHardDisk", VirtualHardDiskArgs.builder()
            .containerId("/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container")
            .createFromLocal(true)
            .extendedLocation(ExtendedLocationArgs.builder()
                .name("/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location")
                .type("CustomLocation")
                .build())
            .location("West US2")
            .resourceGroupName("test-rg")
            .virtualHardDiskName("test-vhd")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const virtualHardDisk = new azure_native.azurestackhci.VirtualHardDisk("virtualHardDisk", {
    containerId: "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container",
    createFromLocal: true,
    extendedLocation: {
        name: "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
        type: azure_native.azurestackhci.ExtendedLocationTypes.CustomLocation,
    },
    location: "West US2",
    resourceGroupName: "test-rg",
    virtualHardDiskName: "test-vhd",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

virtual_hard_disk = azure_native.azurestackhci.VirtualHardDisk("virtualHardDisk",
    container_id="/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container",
    create_from_local=True,
    extended_location={
        "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
        "type": azure_native.azurestackhci.ExtendedLocationTypes.CUSTOM_LOCATION,
    },
    location="West US2",
    resource_group_name="test-rg",
    virtual_hard_disk_name="test-vhd")
Copy
resources:
  virtualHardDisk:
    type: azure-native:azurestackhci:VirtualHardDisk
    properties:
      containerId: /subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container
      createFromLocal: true
      extendedLocation:
        name: /subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location
        type: CustomLocation
      location: West US2
      resourceGroupName: test-rg
      virtualHardDiskName: test-vhd
Copy

PutVirtualHardDisk

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var virtualHardDisk = new AzureNative.AzureStackHCI.VirtualHardDisk("virtualHardDisk", new()
    {
        DiskSizeGB = 32,
        ExtendedLocation = new AzureNative.AzureStackHCI.Inputs.ExtendedLocationArgs
        {
            Name = "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
            Type = AzureNative.AzureStackHCI.ExtendedLocationTypes.CustomLocation,
        },
        Location = "West US2",
        ResourceGroupName = "test-rg",
        VirtualHardDiskName = "test-vhd",
    });

});
Copy
package main

import (
	azurestackhci "github.com/pulumi/pulumi-azure-native-sdk/azurestackhci/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azurestackhci.NewVirtualHardDisk(ctx, "virtualHardDisk", &azurestackhci.VirtualHardDiskArgs{
			DiskSizeGB: pulumi.Float64(32),
			ExtendedLocation: &azurestackhci.ExtendedLocationArgs{
				Name: pulumi.String("/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location"),
				Type: pulumi.String(azurestackhci.ExtendedLocationTypesCustomLocation),
			},
			Location:            pulumi.String("West US2"),
			ResourceGroupName:   pulumi.String("test-rg"),
			VirtualHardDiskName: pulumi.String("test-vhd"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.azurestackhci.VirtualHardDisk;
import com.pulumi.azurenative.azurestackhci.VirtualHardDiskArgs;
import com.pulumi.azurenative.azurestackhci.inputs.ExtendedLocationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var virtualHardDisk = new VirtualHardDisk("virtualHardDisk", VirtualHardDiskArgs.builder()
            .diskSizeGB(32.0)
            .extendedLocation(ExtendedLocationArgs.builder()
                .name("/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location")
                .type("CustomLocation")
                .build())
            .location("West US2")
            .resourceGroupName("test-rg")
            .virtualHardDiskName("test-vhd")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const virtualHardDisk = new azure_native.azurestackhci.VirtualHardDisk("virtualHardDisk", {
    diskSizeGB: 32,
    extendedLocation: {
        name: "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
        type: azure_native.azurestackhci.ExtendedLocationTypes.CustomLocation,
    },
    location: "West US2",
    resourceGroupName: "test-rg",
    virtualHardDiskName: "test-vhd",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

virtual_hard_disk = azure_native.azurestackhci.VirtualHardDisk("virtualHardDisk",
    disk_size_gb=32,
    extended_location={
        "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
        "type": azure_native.azurestackhci.ExtendedLocationTypes.CUSTOM_LOCATION,
    },
    location="West US2",
    resource_group_name="test-rg",
    virtual_hard_disk_name="test-vhd")
Copy
resources:
  virtualHardDisk:
    type: azure-native:azurestackhci:VirtualHardDisk
    properties:
      diskSizeGB: 32
      extendedLocation:
        name: /subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location
        type: CustomLocation
      location: West US2
      resourceGroupName: test-rg
      virtualHardDiskName: test-vhd
Copy

Create VirtualHardDisk Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new VirtualHardDisk(name: string, args: VirtualHardDiskArgs, opts?: CustomResourceOptions);
@overload
def VirtualHardDisk(resource_name: str,
                    args: VirtualHardDiskArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def VirtualHardDisk(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    resource_group_name: Optional[str] = None,
                    dynamic: Optional[bool] = None,
                    hyper_v_generation: Optional[Union[str, HyperVGeneration]] = None,
                    disk_file_format: Optional[Union[str, DiskFileFormat]] = None,
                    disk_size_gb: Optional[float] = None,
                    download_url: Optional[str] = None,
                    block_size_bytes: Optional[int] = None,
                    extended_location: Optional[ExtendedLocationArgs] = None,
                    create_from_local: Optional[bool] = None,
                    location: Optional[str] = None,
                    logical_sector_bytes: Optional[int] = None,
                    physical_sector_bytes: Optional[int] = None,
                    container_id: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    virtual_hard_disk_name: Optional[str] = None)
func NewVirtualHardDisk(ctx *Context, name string, args VirtualHardDiskArgs, opts ...ResourceOption) (*VirtualHardDisk, error)
public VirtualHardDisk(string name, VirtualHardDiskArgs args, CustomResourceOptions? opts = null)
public VirtualHardDisk(String name, VirtualHardDiskArgs args)
public VirtualHardDisk(String name, VirtualHardDiskArgs args, CustomResourceOptions options)
type: azure-native:azurestackhci:VirtualHardDisk
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VirtualHardDiskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VirtualHardDiskArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VirtualHardDiskArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VirtualHardDiskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VirtualHardDiskArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var virtualHardDiskResource = new AzureNative.AzureStackHCI.VirtualHardDisk("virtualHardDiskResource", new()
{
    ResourceGroupName = "string",
    Dynamic = false,
    HyperVGeneration = "string",
    DiskFileFormat = "string",
    DiskSizeGB = 0,
    DownloadUrl = "string",
    BlockSizeBytes = 0,
    ExtendedLocation = new AzureNative.AzureStackHCI.Inputs.ExtendedLocationArgs
    {
        Name = "string",
        Type = "string",
    },
    CreateFromLocal = false,
    Location = "string",
    LogicalSectorBytes = 0,
    PhysicalSectorBytes = 0,
    ContainerId = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VirtualHardDiskName = "string",
});
Copy
example, err := azurestackhci.NewVirtualHardDisk(ctx, "virtualHardDiskResource", &azurestackhci.VirtualHardDiskArgs{
	ResourceGroupName: pulumi.String("string"),
	Dynamic:           pulumi.Bool(false),
	HyperVGeneration:  pulumi.String("string"),
	DiskFileFormat:    pulumi.String("string"),
	DiskSizeGB:        pulumi.Float64(0),
	DownloadUrl:       pulumi.String("string"),
	BlockSizeBytes:    pulumi.Int(0),
	ExtendedLocation: &azurestackhci.ExtendedLocationArgs{
		Name: pulumi.String("string"),
		Type: pulumi.String("string"),
	},
	CreateFromLocal:     pulumi.Bool(false),
	Location:            pulumi.String("string"),
	LogicalSectorBytes:  pulumi.Int(0),
	PhysicalSectorBytes: pulumi.Int(0),
	ContainerId:         pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VirtualHardDiskName: pulumi.String("string"),
})
Copy
var virtualHardDiskResource = new VirtualHardDisk("virtualHardDiskResource", VirtualHardDiskArgs.builder()
    .resourceGroupName("string")
    .dynamic(false)
    .hyperVGeneration("string")
    .diskFileFormat("string")
    .diskSizeGB(0)
    .downloadUrl("string")
    .blockSizeBytes(0)
    .extendedLocation(ExtendedLocationArgs.builder()
        .name("string")
        .type("string")
        .build())
    .createFromLocal(false)
    .location("string")
    .logicalSectorBytes(0)
    .physicalSectorBytes(0)
    .containerId("string")
    .tags(Map.of("string", "string"))
    .virtualHardDiskName("string")
    .build());
Copy
virtual_hard_disk_resource = azure_native.azurestackhci.VirtualHardDisk("virtualHardDiskResource",
    resource_group_name="string",
    dynamic=False,
    hyper_v_generation="string",
    disk_file_format="string",
    disk_size_gb=0,
    download_url="string",
    block_size_bytes=0,
    extended_location={
        "name": "string",
        "type": "string",
    },
    create_from_local=False,
    location="string",
    logical_sector_bytes=0,
    physical_sector_bytes=0,
    container_id="string",
    tags={
        "string": "string",
    },
    virtual_hard_disk_name="string")
Copy
const virtualHardDiskResource = new azure_native.azurestackhci.VirtualHardDisk("virtualHardDiskResource", {
    resourceGroupName: "string",
    dynamic: false,
    hyperVGeneration: "string",
    diskFileFormat: "string",
    diskSizeGB: 0,
    downloadUrl: "string",
    blockSizeBytes: 0,
    extendedLocation: {
        name: "string",
        type: "string",
    },
    createFromLocal: false,
    location: "string",
    logicalSectorBytes: 0,
    physicalSectorBytes: 0,
    containerId: "string",
    tags: {
        string: "string",
    },
    virtualHardDiskName: "string",
});
Copy
type: azure-native:azurestackhci:VirtualHardDisk
properties:
    blockSizeBytes: 0
    containerId: string
    createFromLocal: false
    diskFileFormat: string
    diskSizeGB: 0
    downloadUrl: string
    dynamic: false
    extendedLocation:
        name: string
        type: string
    hyperVGeneration: string
    location: string
    logicalSectorBytes: 0
    physicalSectorBytes: 0
    resourceGroupName: string
    tags:
        string: string
    virtualHardDiskName: string
Copy

VirtualHardDisk Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The VirtualHardDisk resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
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 | Pulumi.AzureNative.AzureStackHCI.DiskFileFormat
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.Inputs.ExtendedLocation
The extendedLocation of the resource.
HyperVGeneration string | Pulumi.AzureNative.AzureStackHCI.HyperVGeneration
The hypervisor generation of the Virtual Machine [V1, V2]
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
LogicalSectorBytes int
Logical sector in bytes
PhysicalSectorBytes int
Physical sector in bytes
Tags Dictionary<string, string>
Resource tags.
VirtualHardDiskName Changes to this property will trigger replacement. string
Name of the virtual hard disk
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
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 | DiskFileFormat
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 ExtendedLocationArgs
The extendedLocation of the resource.
HyperVGeneration string | HyperVGeneration
The hypervisor generation of the Virtual Machine [V1, V2]
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
LogicalSectorBytes int
Logical sector in bytes
PhysicalSectorBytes int
Physical sector in bytes
Tags map[string]string
Resource tags.
VirtualHardDiskName Changes to this property will trigger replacement. string
Name of the virtual hard disk
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
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 | DiskFileFormat
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 ExtendedLocation
The extendedLocation of the resource.
hyperVGeneration String | HyperVGeneration
The hypervisor generation of the Virtual Machine [V1, V2]
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
logicalSectorBytes Integer
Logical sector in bytes
physicalSectorBytes Integer
Physical sector in bytes
tags Map<String,String>
Resource tags.
virtualHardDiskName Changes to this property will trigger replacement. String
Name of the virtual hard disk
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
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 | DiskFileFormat
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 ExtendedLocation
The extendedLocation of the resource.
hyperVGeneration string | HyperVGeneration
The hypervisor generation of the Virtual Machine [V1, V2]
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
logicalSectorBytes number
Logical sector in bytes
physicalSectorBytes number
Physical sector in bytes
tags {[key: string]: string}
Resource tags.
virtualHardDiskName Changes to this property will trigger replacement. string
Name of the virtual hard disk
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
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 | DiskFileFormat
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 ExtendedLocationArgs
The extendedLocation of the resource.
hyper_v_generation str | HyperVGeneration
The hypervisor generation of the Virtual Machine [V1, V2]
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
logical_sector_bytes int
Logical sector in bytes
physical_sector_bytes int
Physical sector in bytes
tags Mapping[str, str]
Resource tags.
virtual_hard_disk_name Changes to this property will trigger replacement. str
Name of the virtual hard disk
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
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 | "vhdx" | "vhd"
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 | "V1" | "V2"
The hypervisor generation of the Virtual Machine [V1, V2]
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
logicalSectorBytes Number
Logical sector in bytes
physicalSectorBytes Number
Physical sector in bytes
tags Map<String>
Resource tags.
virtualHardDiskName Changes to this property will trigger replacement. String
Name of the virtual hard disk

Outputs

All input properties are implicitly available as output properties. Additionally, the VirtualHardDisk resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
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"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
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"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
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"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
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"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
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"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
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"

Supporting Types

DiskFileFormat
, DiskFileFormatArgs

Vhdx
vhdxVHDX file format
Vhd
vhdVHD file format
DiskFileFormatVhdx
vhdxVHDX file format
DiskFileFormatVhd
vhdVHD file format
Vhdx
vhdxVHDX file format
Vhd
vhdVHD file format
Vhdx
vhdxVHDX file format
Vhd
vhdVHD file format
VHDX
vhdxVHDX file format
VHD
vhdVHD file format
"vhdx"
vhdxVHDX file format
"vhd"
vhdVHD file format

ExtendedLocation
, ExtendedLocationArgs

Name string
The name of the extended location.
Type string | Pulumi.AzureNative.AzureStackHCI.ExtendedLocationTypes
The type of the extended location.
Name string
The name of the extended location.
Type string | ExtendedLocationTypes
The type of the extended location.
name String
The name of the extended location.
type String | ExtendedLocationTypes
The type of the extended location.
name string
The name of the extended location.
type string | ExtendedLocationTypes
The type of the extended location.
name str
The name of the extended location.
type str | ExtendedLocationTypes
The type of the extended location.
name String
The name of the extended location.
type String | "CustomLocation"
The type of the extended location.

ExtendedLocationResponse
, ExtendedLocationResponseArgs

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.

ExtendedLocationTypes
, ExtendedLocationTypesArgs

CustomLocation
CustomLocation
ExtendedLocationTypesCustomLocation
CustomLocation
CustomLocation
CustomLocation
CustomLocation
CustomLocation
CUSTOM_LOCATION
CustomLocation
"CustomLocation"
CustomLocation

HyperVGeneration
, HyperVGenerationArgs

V1
V1Generation 1 (V1) hypervisor
V2
V2Generation 2 (V2) hypervisor
HyperVGenerationV1
V1Generation 1 (V1) hypervisor
HyperVGenerationV2
V2Generation 2 (V2) hypervisor
V1
V1Generation 1 (V1) hypervisor
V2
V2Generation 2 (V2) hypervisor
V1
V1Generation 1 (V1) hypervisor
V2
V2Generation 2 (V2) hypervisor
V1
V1Generation 1 (V1) hypervisor
V2
V2Generation 2 (V2) hypervisor
"V1"
V1Generation 1 (V1) hypervisor
"V2"
V2Generation 2 (V2) hypervisor

SystemDataResponse
, SystemDataResponseArgs

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
, VirtualHardDiskDownloadStatusResponseArgs

Status This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
, VirtualHardDiskStatusProvisioningStatusResponseArgs

Status This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
, VirtualHardDiskStatusResponseArgs

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
, VirtualHardDiskUploadStatusResponseArgs

Status This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:azurestackhci:VirtualHardDisk test-vhd /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks/{virtualHardDiskName} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

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.2.0 published on Monday, Apr 14, 2025 by Pulumi