Share via

Microsoft.AzureStackHCI virtualHardDisks 2022-12-15-preview

Bicep resource definition

The virtualHardDisks resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureStackHCI/virtualHardDisks resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AzureStackHCI/virtualHardDisks@2022-12-15-preview' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    blockSizeBytes: int
    containerId: 'string'
    diskFileFormat: 'string'
    diskSizeGB: int
    dynamic: bool
    hyperVGeneration: 'string'
    logicalSectorBytes: int
    physicalSectorBytes: int
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.AzureStackHCI/virtualHardDisks

Name Description Value
extendedLocation The extendedLocation of the resource. ExtendedLocation
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 80
Pattern = ^[-_a-zA-Z0-9]{1,80}$ (required)
properties Properties under the virtual hard disk resource VirtualHardDiskProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. 'CustomLocation'

TrackedResourceTags

Name Description Value

VirtualHardDiskProperties

Name Description Value
blockSizeBytes int
containerId Storage ContainerID of the storage container to be used for VHD string
diskFileFormat The format of the actual VHD file [vhd, vhdx] 'vhd'
'vhdx'
diskSizeGB Size of the disk in GB int
dynamic Boolean for enabling dynamic sizing on the virtual hard disk bool
hyperVGeneration The hypervisor generation of the Virtual Machine [V1, V2] 'V1'
'V2'
logicalSectorBytes int
physicalSectorBytes int

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Azure Stack HCI Hard Disk AVM Resource Module for Azure Stack HCI Hard Disk

ARM template resource definition

The virtualHardDisks resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureStackHCI/virtualHardDisks resource, add the following JSON to your template.

{
  "type": "Microsoft.AzureStackHCI/virtualHardDisks",
  "apiVersion": "2022-12-15-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "blockSizeBytes": "int",
    "containerId": "string",
    "diskFileFormat": "string",
    "diskSizeGB": "int",
    "dynamic": "bool",
    "hyperVGeneration": "string",
    "logicalSectorBytes": "int",
    "physicalSectorBytes": "int"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.AzureStackHCI/virtualHardDisks

Name Description Value
apiVersion The api version '2022-12-15-preview'
extendedLocation The extendedLocation of the resource. ExtendedLocation
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 80
Pattern = ^[-_a-zA-Z0-9]{1,80}$ (required)
properties Properties under the virtual hard disk resource VirtualHardDiskProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.AzureStackHCI/virtualHardDisks'

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. 'CustomLocation'

TrackedResourceTags

Name Description Value

VirtualHardDiskProperties

Name Description Value
blockSizeBytes int
containerId Storage ContainerID of the storage container to be used for VHD string
diskFileFormat The format of the actual VHD file [vhd, vhdx] 'vhd'
'vhdx'
diskSizeGB Size of the disk in GB int
dynamic Boolean for enabling dynamic sizing on the virtual hard disk bool
hyperVGeneration The hypervisor generation of the Virtual Machine [V1, V2] 'V1'
'V2'
logicalSectorBytes int
physicalSectorBytes int

Usage Examples

Terraform (AzAPI provider) resource definition

The virtualHardDisks resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureStackHCI/virtualHardDisks resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureStackHCI/virtualHardDisks@2022-12-15-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      blockSizeBytes = int
      containerId = "string"
      diskFileFormat = "string"
      diskSizeGB = int
      dynamic = bool
      hyperVGeneration = "string"
      logicalSectorBytes = int
      physicalSectorBytes = int
    }
  }
}

Property Values

Microsoft.AzureStackHCI/virtualHardDisks

Name Description Value
extendedLocation The extendedLocation of the resource. ExtendedLocation
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 80
Pattern = ^[-_a-zA-Z0-9]{1,80}$ (required)
properties Properties under the virtual hard disk resource VirtualHardDiskProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.AzureStackHCI/virtualHardDisks@2022-12-15-preview"

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. 'CustomLocation'

TrackedResourceTags

Name Description Value

VirtualHardDiskProperties

Name Description Value
blockSizeBytes int
containerId Storage ContainerID of the storage container to be used for VHD string
diskFileFormat The format of the actual VHD file [vhd, vhdx] 'vhd'
'vhdx'
diskSizeGB Size of the disk in GB int
dynamic Boolean for enabling dynamic sizing on the virtual hard disk bool
hyperVGeneration The hypervisor generation of the Virtual Machine [V1, V2] 'V1'
'V2'
logicalSectorBytes int
physicalSectorBytes int