New-AzDiskConfig

Creates a configurable disk object.

Syntax

New-AzDiskConfig
   [[-SkuName] <String>]
   [[-OsType] <OperatingSystemTypes>]
   [[-DiskSizeGB] <Int32>]
   [[-Location] <String>]
   [-Zone <String[]>]
   [-HyperVGeneration <String>]
   [-DiskIOPSReadWrite <Int64>]
   [-DiskMBpsReadWrite <Int64>]
   [-DiskIOPSReadOnly <Int64>]
   [-DiskMBpsReadOnly <Int64>]
   [-MaxSharesCount <Int32>]
   [-Tag <Hashtable>]
   [-CreateOption <String>]
   [-StorageAccountId <String>]
   [-ImageReference <ImageDiskReference>]
   [-GalleryImageReference <ImageDiskReference>]
   [-SourceUri <String>]
   [-SourceResourceId <String>]
   [-UploadSizeInBytes <Int64>]
   [-EncryptionSettingsEnabled <Boolean>]
   [-DiskEncryptionKey <KeyVaultAndSecretReference>]
   [-KeyEncryptionKey <KeyVaultAndKeyReference>]
   [-DiskEncryptionSetId <String>]
   [-EncryptionType <String>] [DiskAccessId <String>]
   [-NetworkAccessPolicy <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzDiskConfig cmdlet creates a configurable disk object.

Examples

Example 1

PS C:\> $diskconfig = New-AzDiskConfig -Location 'Central US' -DiskSizeGB 5 -AccountType Standard_LRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true;
PS C:\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/;
PS C:\> $secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123';
PS C:\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456;
PS C:\> $keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456';
PS C:\> $diskconfig = Set-AzDiskDiskEncryptionKey -Disk $diskconfig -SecretUrl $secretUrl -SourceVaultId $secretId;
PS C:\> $diskconfig = Set-AzDiskKeyEncryptionKey -Disk $diskconfig -KeyUrl $keyUrl -SourceVaultId $keyId;
PS C:\> New-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig;

The first command creates a local empty disk object with size 5GB in Standard_LRS storage account type. It also sets Windows OS type and enables encryption settings. The second and third commands set the disk encryption key and key encryption key settings for the disk object. The last command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'.

Example 2

PS C:\> $diskconfig = New-AzDiskConfig -Location 'Central US' -DiskSizeGB 1023 -SkuName Standard_LRS -OsType Windows -CreateOption Upload -DiskIOPSReadWrite 500 -DiskMBpsReadWrite 8;
PS C:\> New-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskconfig;
PS C:\> $diskSas = Grant-AzDiskAccess -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DurationInSecond 86400 -Access 'Write'
PS C:\> $disk = Get-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01'
# $disk.DiskState == 'ReadyToUpload'
PS C:\> AzCopy /Source:https://myaccount.blob.core.windows.net/mycontainer1 /Dest:$diskSas
PS C:\> $disk = Get-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01'
# $disk.DiskState == 'ActiveUpload'
PS C:\> Revoke-AzDiskAccess -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01'

The first command creates a local disk object for Upload. The second command takes the disk object and creates a disk with name 'Disk01' in resource group 'ResourceGroup01'. The third command gets SAS Url for the disk. The fourth command gets the state of the disk. If the disk state is 'ReadyToUpload', a user can upload a disk from blob storage to the disk SAS Url using AzCopy. During uploading, the disk state is changed to 'ActiveUpload'. The last command revokes the disk access for the SAS Url.

Example 3

PS C:\> $galleryImageReference = @{Id = '/subscriptions/0296790d-427c-48ca-b204-8b729bbd8670/resourceGroups/swaggertests/providers/Microsoft.Compute/galleries/swaggergallery/images/swaggerimagedef/versions/1.0.0'; Lun=1}
PS C:\> $diskConfig = New-AzDiskConfig -Location 'West US' -CreateOption 'FromImage' -GalleryImageReference $galleryImageReference;
PS C:\> New-AzDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -Disk $diskConfig

Create a disk from a Shared Gallery Image Version. Id is the id of the shared gallery image version. Lun is needed only if the source is a data disk.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CreateOption

Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, creates an empty disk, or attaches an existing disk.

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DiskAccessId

Gets or sets ARM ID of the DiskAccess resource for using private endpoints on.

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-DiskEncryptionKey

Specifies the disk encryption key object on a disk.

Type:KeyVaultAndSecretReference
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-DiskEncryptionSetId

Specifies the resource Id of the disk encryption set to use for enabling encryption at rest.

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-DiskIOPSReadOnly

The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.

Type:Int64
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-DiskIOPSReadWrite

The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

Type:Int64
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-DiskMBpsReadOnly

"description": "The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.

Type:Int64
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-DiskMBpsReadWrite

The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.

Type:Int64
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-DiskSizeGB

Specifies the size of the disk in GB.

Type:Int32
Position:2
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-EncryptionSettingsEnabled

Enable encryption settings.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-EncryptionType

The type of key used to encrypt the data of the disk. Available values are: 'EncryptionAtRestWithPlatformKey', 'EncryptionAtRestWithCustomerKey'

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-GalleryImageReference

The GalleryImageReference object. Required if creating from a Gallery Image. The id will be the ARM id of the shared galley image version from which to create a disk. A lun is needed if the source of the copy is one of the data disks in the gallery image; if null, the OS disk of the image will be copied.

Type:ImageDiskReference
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-HyperVGeneration

The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Allowed values are V1 and V2.

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-ImageReference

Specifies the image reference on a disk.

Type:ImageDiskReference
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-KeyEncryptionKey

Specifies the Key encryption key on a disk.

Type:KeyVaultAndKeyReference
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Location

Specifies a location.

Type:String
Position:3
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-MaxSharesCount

The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-NetworkAccessPolicy

Network access policy defines the network access policy. Possible values include: 'AllowAll', 'AllowPrivate', 'DenyAll'

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-OsType

Specifies the OS type.

Type:Nullable<T>[OperatingSystemTypes]
Accepted values:Windows, Linux
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-SkuName

Specifies the Sku name of the storage account. Available values are Standard_LRS, Premium_LRS, StandardSSD_LRS, and UltraSSD_LRS. UltraSSD_LRS can only be used with Empty value for CreateOption parameter.

Type:String
Aliases:AccountType
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-SourceResourceId

Specifies the source resource ID.

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-SourceUri

Specifies the source Uri.

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-StorageAccountId

Specifies the storage account ID.

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Tag

Key-value pairs in the form of a hash table. For example: @{key0="value0";key1=$null;key2="value2"}

Type:Hashtable
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-UploadSizeInBytes

Specifies the size of the contents of the upload including the VHD footer when CreateOption is Upload. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).

Type:Int64
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Zone

Specifies the logical zone list for Disk.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Nullable<T>[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=23.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]

Int32

String[]

Hashtable

ImageDiskReference

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

KeyVaultAndSecretReference

KeyVaultAndKeyReference

Outputs

PSDisk