New-AzElasticSanVolumeGroup
Create a Volume Group.
Syntax
New-AzElasticSanVolumeGroup
-ElasticSanName <String>
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-Encryption <String>]
[-EnforceDataIntegrityCheckForIscsi <Boolean>]
[-EncryptionUserAssignedIdentity <String>]
[-IdentityType <String>]
[-IdentityUserAssignedIdentityId <String>]
[-KeyName <String>]
[-KeyVaultUri <String>]
[-KeyVersion <String>]
[-NetworkAclsVirtualNetworkRule <IVirtualNetworkRule[]>]
[-ProtocolType <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzElasticSanVolumeGroup
-Name <String>
-ElasticSanInputObject <IElasticSanIdentity>
[-Encryption <String>]
[-EnforceDataIntegrityCheckForIscsi <Boolean>]
[-EncryptionUserAssignedIdentity <String>]
[-IdentityType <String>]
[-IdentityUserAssignedIdentityId <String>]
[-KeyName <String>]
[-KeyVaultUri <String>]
[-KeyVersion <String>]
[-NetworkAclsVirtualNetworkRule <IVirtualNetworkRule[]>]
[-ProtocolType <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzElasticSanVolumeGroup
-InputObject <IElasticSanIdentity>
[-Encryption <String>]
[-EnforceDataIntegrityCheckForIscsi <Boolean>]
[-EncryptionUserAssignedIdentity <String>]
[-IdentityType <String>]
[-IdentityUserAssignedIdentityId <String>]
[-KeyName <String>]
[-KeyVaultUri <String>]
[-KeyVersion <String>]
[-NetworkAclsVirtualNetworkRule <IVirtualNetworkRule[]>]
[-ProtocolType <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Create a Volume Group.
Examples
Example 1: Create a volume group with network rule objects
$virtualNetworkRule1 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1" -Action Allow
$virtualNetworkRule2 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2" -Action Allow
New-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -Name myvolumegroup -ProtocolType 'Iscsi' -NetworkAclsVirtualNetworkRule $virtualNetworkRule1,$virtualNetworkRule2
Encryption : EncryptionAtRestWithPlatformKey
EnforceDataIntegrityCheckForIscsi : True
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup
Name : myvolumegroup
NetworkAclsVirtualNetworkRule : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2}
ProtocolType : iSCSI
ProvisioningState : Succeeded
SystemDataCreatedAt : 9/19/2022 7:05:47 AM
SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
SystemDataCreatedByType : Application
SystemDataLastModifiedAt : 9/19/2022 7:05:47 AM
SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
SystemDataLastModifiedByType : Application
Type : Microsoft.ElasticSan/ElasticSans
This example creates two VirtualNetworkRule objects and then input the objects and other variables to create a volume group.
Example 2: Create a volume group with network rule JSON input
New-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -Name myvolumegroup -ProtocolType 'Iscsi' `
-NetworkAclsVirtualNetworkRule (
@{VirtualNetworkResourceId="/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1";
Action="Allow"},
@{VirtualNetworkResourceId="/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2";
Action="Allow"})
Encryption : EncryptionAtRestWithPlatformKey
EnforceDataIntegrityCheckForIscsi : True
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumegroups/myvolumegroup
Name : myvolumegroup
NetworkAclsVirtualNetworkRule : {/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1, /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2}
ProtocolType : iSCSI
ProvisioningState : Succeeded
SystemDataCreatedAt : 9/19/2022 7:05:47 AM
SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
SystemDataCreatedByType : Application
SystemDataLastModifiedAt : 9/19/2022 7:05:47 AM
SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy
SystemDataLastModifiedByType : Application
Type : Microsoft.ElasticSan/ElasticSans
This command creates a volume group with the NetworkAclsVirtualNetworkRule input in json format.
Example 3: Create a volume group with platform-managed key and SystemAssigned identity type
New-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -Name myvolumegroup -IdentityType SystemAssigned -ProtocolType Iscsi -Encryption EncryptionAtRestWithPlatformKey
Encryption : EncryptionAtRestWithPlatformKey
EncryptionIdentityEncryptionUserAssignedIdentity :
EnforceDataIntegrityCheckForIscsi : True
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumeGroups/myvolumegroup
IdentityPrincipalId : 00000000-0000-0000-0000-000000000000
IdentityTenantId : 00000000-0000-0000-0000-000000000000
IdentityType : SystemAssigned
IdentityUserAssignedIdentity : {
}
KeyVaultPropertyCurrentVersionedKeyExpirationTimestamp :
KeyVaultPropertyCurrentVersionedKeyIdentifier :
KeyVaultPropertyKeyName :
KeyVaultPropertyKeyVaultUri :
KeyVaultPropertyKeyVersion :
KeyVaultPropertyLastKeyRotationTimestamp :
Name : myvolumegroup
NetworkAclsVirtualNetworkRule :
PrivateEndpointConnection :
ProtocolType : iSCSI
ProvisioningState : Succeeded
ResourceGroupName : myresourcegroup
SystemDataCreatedAt : 10/7/2023 6:20:55 AM
SystemDataCreatedBy : 00000000-0000-0000-0000-000000000000
SystemDataCreatedByType : Application
SystemDataLastModifiedAt : 10/7/2023 6:20:55 AM
SystemDataLastModifiedBy : 00000000-0000-0000-0000-000000000000
SystemDataLastModifiedByType : Application
Type : Microsoft.ElasticSan/elasticSans/volumeGroups
This command creates a volume group with identity type "SystemAssigned" and encryption type "platform-managed key".
Example 4: Create a volume group with platform-managed key and SystemAssigned identity type
$useridentity = Get-AzUserAssignedIdentity -ResourceGroupName myresoucegroup -Name myuai
New-AzElasticSanVolumeGroup -ResourceGroupName myresoucegroup -ElasticSanName myelasticsan -Name myvolumegroup -IdentityType UserAssigned -IdentityUserAssignedIdentityId $useridentity.Id -Encryption EncryptionAtRestWithCustomerManagedKey -KeyName mykey -KeyVaultUri "https://mykeyvault.vault.azure.net:443" -EncryptionUserAssignedIdentity $useridentity.Id -ProtocolType Iscsi
Encryption : EncryptionAtRestWithCustomerManagedKey
EncryptionIdentityEncryptionUserAssignedIdentity : /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuai
EnforceDataIntegrityCheckForIscsi : True
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumeGroups/myvolumegroup
IdentityPrincipalId :
IdentityTenantId :
IdentityType : UserAssigned
IdentityUserAssignedIdentity : {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuai": {
}
}
KeyVaultPropertyCurrentVersionedKeyExpirationTimestamp : 1/1/1970 12:00:00 AM
KeyVaultPropertyCurrentVersionedKeyIdentifier : https://mykeyvault.vault.azure.net/keys/mykey/37ec78b20f9e4a29b14a0d29d93cb79f
KeyVaultPropertyKeyName : mykey
KeyVaultPropertyKeyVaultUri : https://mykeyvault.vault.azure.net:443
KeyVaultPropertyKeyVersion :
KeyVaultPropertyLastKeyRotationTimestamp : 10/7/2023 6:32:28 AM
Name : myvolumegroup
NetworkAclsVirtualNetworkRule :
PrivateEndpointConnection :
ProtocolType : iSCSI
ProvisioningState : Succeeded
ResourceGroupName : myresourcegroup
SystemDataCreatedAt : 10/7/2023 6:32:27 AM
SystemDataCreatedBy : 00000000-0000-0000-0000-000000000000
SystemDataCreatedByType : Application
SystemDataLastModifiedAt : 10/7/2023 6:32:27 AM
SystemDataLastModifiedBy : 00000000-0000-0000-0000-000000000000
SystemDataLastModifiedByType : Application
Type : Microsoft.ElasticSan/elasticSans/volumeGroups
This command creates a volume group with identity type "SystemAssigned" and encryption type "platform-managed key".
Example 5: Create a volume group with EnforceDataIntegrityCheckForIscsi disabled
New-AzElasticSanVolumeGroup -ResourceGroupName myresoucegroup -ElasticSanName myelasticsan -Name myvolumegroup -EnforceDataIntegrityCheckForIscsi $false
Encryption : EncryptionAtRestWithPlatformKey
EncryptionIdentityEncryptionUserAssignedIdentity :
EnforceDataIntegrityCheckForIscsi : False
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan/volumeGroups/myvolumegroup
IdentityPrincipalId :
IdentityTenantId :
IdentityType :
IdentityUserAssignedIdentity : {
}
KeyVaultPropertyCurrentVersionedKeyExpirationTimestamp :
KeyVaultPropertyCurrentVersionedKeyIdentifier :
KeyVaultPropertyKeyName :
KeyVaultPropertyKeyVaultUri :
KeyVaultPropertyKeyVersion :
KeyVaultPropertyLastKeyRotationTimestamp :
Name : myvolumegroup
NetworkAclsVirtualNetworkRule :
PrivateEndpointConnection :
ProtocolType : iSCSI
ProvisioningState : Succeeded
ResourceGroupName : myresourcegroup
SystemDataCreatedAt : 9/18/2024 3:45:01 AM
SystemDataCreatedBy : 00000000-0000-0000-0000-000000000000
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 9/18/2024 4:58:14 AM
SystemDataLastModifiedBy : 00000000-0000-0000-0000-000000000000
SystemDataLastModifiedByType : User
Type : Microsoft.ElasticSan/elasticSans/volumeGroups
This command creates a volume group with EnforceDataIntegrityCheckForIscsi disabled.
Parameters
-AsJob
Run the command as a job
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Type: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ElasticSanInputObject
Identity Parameter To construct, see NOTES section for ELASTICSANINPUTOBJECT properties and create a hash table.
Type: | IElasticSanIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ElasticSanName
The name of the ElasticSan.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Encryption
Type of encryption
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EncryptionUserAssignedIdentity
Resource identifier of the UserAssigned identity to be associated with server-side encryption on the volume group.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EnforceDataIntegrityCheckForIscsi
A boolean indicating whether or not Data Integrity Check is enabled
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IdentityType
The identity type.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IdentityUserAssignedIdentityId
Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this volume group. The key is the ARM resource identifier of the identity.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | IElasticSanIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-KeyName
The name of KeyVault key.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-KeyVaultUri
The Uri of KeyVault.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-KeyVersion
The version of KeyVault key.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The name of the VolumeGroup.
Type: | String |
Aliases: | VolumeGroupName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NetworkAclsVirtualNetworkRule
The list of virtual network rules. To construct, see NOTES section for NETWORKACLSVIRTUALNETWORKRULE properties and create a hash table.
Type: | IVirtualNetworkRule[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProtocolType
Type of storage target
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription.
Type: | String |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |