Update-AzElasticSanVolumeGroup
Update an VolumeGroup.
Syntax
Update-AzElasticSanVolumeGroup
-ElasticSanName <String>
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-Encryption <String>]
[-EncryptionUserAssignedIdentity <String>]
[-IdentityType <String>]
[-IdentityUserAssignedIdentityId <String>]
[-KeyName <String>]
[-KeyVaultUri <String>]
[-KeyVersion <String>]
[-NetworkAclsVirtualNetworkRule <IVirtualNetworkRule[]>]
[-ProtocolType <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzElasticSanVolumeGroup
-Name <String>
-ElasticSanInputObject <IElasticSanIdentity>
[-Encryption <String>]
[-EncryptionUserAssignedIdentity <String>]
[-IdentityType <String>]
[-IdentityUserAssignedIdentityId <String>]
[-KeyName <String>]
[-KeyVaultUri <String>]
[-KeyVersion <String>]
[-NetworkAclsVirtualNetworkRule <IVirtualNetworkRule[]>]
[-ProtocolType <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzElasticSanVolumeGroup
-InputObject <IElasticSanIdentity>
[-Encryption <String>]
[-EncryptionUserAssignedIdentity <String>]
[-IdentityType <String>]
[-IdentityUserAssignedIdentityId <String>]
[-KeyName <String>]
[-KeyVaultUri <String>]
[-KeyVersion <String>]
[-NetworkAclsVirtualNetworkRule <IVirtualNetworkRule[]>]
[-ProtocolType <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Update an VolumeGroup.
Examples
Example 1: Update a volume group
$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
Update-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -Name myvolumegroup -ProtocolType 'Iscsi' -NetworkAclsVirtualNetworkRule $virtualNetworkRule1,$virtualNetworkRule2
Encryption : EncryptionAtRestWithPlatformKey
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/ElasticSansThis example updates the protocol type and virtual network rules of a volume gorup
Example 2: Update a volume group virtual network rule with JSON input
Update-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
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/ElasticSansThis example updates the protocol type, virtual network rules, and tag of a volume group. It takes in the virtual network rules in JSON format.
Example 3: Update a volume group from CMK to PMK
Update-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -Name myvolumegroup -Encryption EncryptionAtRestWithPlatformKey
Encryption : EncryptionAtRestWithPlatformKey
EncryptionIdentityEncryptionUserAssignedIdentity :
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 :
KeyVaultPropertyCurrentVersionedKeyIdentifier :
KeyVaultPropertyKeyName :
KeyVaultPropertyKeyVaultUri :
KeyVaultPropertyKeyVersion :
KeyVaultPropertyLastKeyRotationTimestamp :
Name : myvolumegroup
NetworkAclsVirtualNetworkRule :
PrivateEndpointConnection :
ProtocolType : iSCSI
ProvisioningState : Succeeded
ResourceGroupName : myresourcegroup
SystemDataCreatedAt : 10/7/2023 2:31:45 AM
SystemDataCreatedBy : 00000000-0000-0000-0000-000000000000
SystemDataCreatedByType : Application
SystemDataLastModifiedAt : 10/7/2023 6:47:24 AM
SystemDataLastModifiedBy : 00000000-0000-0000-0000-000000000000
SystemDataLastModifiedByType : Application
Type : Microsoft.ElasticSan/elasticSans/volumeGroupsThis command updates a volume group from CMK to PMK.
Example 4: Update a volume group to a new user assigned identity
$useridentity2 = Get-AzUserAssignedIdentity -ResourceGroupName myresoucegroup -Name myuai2
Update-AzElasticSanVolumeGroup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -Name myvolumegroup -IdentityType UserAssigned -IdentityUserAssignedIdentityId $useridentity2.Id -EncryptionUserAssignedIdentity $useridentity2.Id
Encryption : EncryptionAtRestWithCustomerManagedKey
EncryptionIdentityEncryptionUserAssignedIdentity : /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuai2
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/myuai2": {
}
}
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 7:03:27 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 7:03:27 AM
SystemDataLastModifiedBy : 00000000-0000-0000-0000-000000000000
SystemDataLastModifiedByType : Application
Type : Microsoft.ElasticSan/elasticSans/volumeGroupsThis command updates a volume group's user assigned identity.
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 |
-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 |
Inputs
Outputs
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure PowerShell
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for