Update-AzRecoveryServicesVault

Module:

Az.RecoveryServices Module

Updates MSIdentity to the recovery services vault.

Update-AzRecoveryServicesVault
 [-ResourceGroupName] <String>
 [-Name] <String>
 [-IdentityId <String[]>]
 [-RemoveUserAssigned]
 [-RemoveSystemAssigned]
 [-DisableClassicAlerts <Boolean>]
 [-DisableAzureMonitorAlertsForJobFailure <Boolean>]
 [-DisableEmailNotificationsForSiteRecovery <Boolean>]
 [-DisableAzureMonitorAlertsForAllReplicationIssue <Boolean>]
 [-DisableAzureMonitorAlertsForAllFailoverIssue <Boolean>]
 [-PublicNetworkAccess <PublicNetworkAccess>]
 [-ImmutabilityState <ImmutabilityState>]
 [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>]
 [-DefaultProfile <IAzureContextContainer>]
 [-Token <String>]
 [-SecureToken <SecureString>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Update-AzRecoveryServicesVault
 [-ResourceGroupName] <String>
 [-Name] <String>
 -IdentityType <MSIdentity>
 [-IdentityId <String[]>]
 [-DisableClassicAlerts <Boolean>]
 [-DisableAzureMonitorAlertsForJobFailure <Boolean>]
 [-DisableEmailNotificationsForSiteRecovery <Boolean>]
 [-DisableAzureMonitorAlertsForAllReplicationIssue <Boolean>]
 [-DisableAzureMonitorAlertsForAllFailoverIssue <Boolean>]
 [-PublicNetworkAccess <PublicNetworkAccess>]
 [-ImmutabilityState <ImmutabilityState>]
 [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>]
 [-DefaultProfile <IAzureContextContainer>]
 [-Token <String>]
 [-SecureToken <SecureString>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

This cmdlet is used to add or remove the MSI from the recovery services vault. Use -IdentityType param to add a SystemAssigned/UserAssigned identity to the RSVault. Use RemoveSystemAssigned/RemoveUserAssigned switch to remove the MSI from the vault.

Update-AzRecoveryServicesVault -ResourceGroupName "rgName" -Name "vaultName" -IdentityType SystemAssigned

This cmdlet is used to add a SystemAssigned identity to a recovery services vault.

$vault = Get-AzRecoveryServicesVault -Name "vaultName" -ResourceGroupName "resourceGroupName"
$identity1 = Get-AzUserAssignedIdentity -ResourceGroupName "resourceGroupName" -Name "UserIdentity1"
$identity2 = Get-AzUserAssignedIdentity -ResourceGroupName "resourceGroupName" -Name "UserIdentity2"
$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -IdentityType UserAssigned -IdentityId $identity1.Id, $identity2.Id
$updatedVault.Identity | Format-List

PrincipalId :
TenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Type : UserAssigned
UserAssignedIdentities : {[/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/UserIdentity1,
 Microsoft.Azure.Management.RecoveryServices.Models.UserIdentity],
 [/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/UserIdentity2,
 Microsoft.Azure.Management.RecoveryServices.Models.UserIdentity]}

The first cmdlet fetches the recovery services vault. The second and third cmdlet fetches the user created MSIs. The fourth cmdlet adds the user MSIs to the vault. The fifth cmdlet shows the Identities added to the vault.

$vault = Get-AzRecoveryServicesVault -Name "vaultName" -ResourceGroupName "resourceGroupName"
$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -RemoveSystemAssigned
$AllUserIdentities = $vault.Identity.UserAssignedIdentities.Keys | ForEach-Object {$_}
$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -RemoveUserAssigned -IdentityId $AllUserIdentities
$updatedVault.Identity | Format-List

PrincipalId :
TenantId :
Type : None
UserAssignedIdentities :

The first cmdlet fetches the recovery services vault. The second cmdlet removes the SystemAssigned identity from the vault. The third cmdlet fetches all the user MSIs as a list from the vault. The fourth cmdlet removes all the user MSIs from the vault. In case you want, you can provide selected user identities to be removed as comma separated, like in previous example. The fifth cmdlet shows the identities in the vault, as we removed all the identities, Type is displayed as None.

$vault = Get-AzRecoveryServicesVault -Name "vaultName" -ResourceGroupName "resourceGroupName"
$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -PublicNetworkAccess "Disabled" -ImmutabilityState "Unlocked"
$updatedVault.Properties.PublicNetworkAccess
$updatedVault.Properties.ImmutabilitySettings.ImmutabilityState

Disabled
Unlocked

The first cmdlet fetches the recovery services vault. The second cmdlet updates PublicNetworkAccess, ImmutabilityState properties of the recovery services vault. The third and fourth command are used to fetch the public network access and immutability state of the vault.

$vault = Get-AzRecoveryServicesVault -Name "vaultName" -ResourceGroupName "resourceGroupName"
$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -CrossSubscriptionRestoreState Disabled
$updatedVault.Properties.RestoreSettings.CrossSubscriptionRestoreSettings.CrossSubscriptionRestoreState

Disabled

The first cmdlet fetches the recovery services vault. The second cmdlet updates CrossSubscriptionRestoreState of the recovery services vault. The third command gets the cross subscription restore state of the vault.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.