Update-AzDiskEncryptionSet

Reference

Module:: Az.Compute

Updates a disk encryption set.

Syntax

Update-AzDiskEncryptionSet
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-KeyUrl <String>]
      [-SourceVaultId <String>]
      [-RotationToLatestKeyVersionEnabled <Boolean>]
      [[-Tag] <Hashtable>]
      [-AsJob]
      [-FederatedClientId <String>]
      [-UserAssignedIdentity <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzDiskEncryptionSet
      [-ResourceId] <String>
      [-KeyUrl <String>]
      [-SourceVaultId <String>]
      [-RotationToLatestKeyVersionEnabled <Boolean>]
      [[-Tag] <Hashtable>]
      [-AsJob]
      [-FederatedClientId <String>]
      [-UserAssignedIdentity <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzDiskEncryptionSet
      [-InputObject] <PSDiskEncryptionSet>
      [-KeyUrl <String>]
      [-SourceVaultId <String>]
      [-RotationToLatestKeyVersionEnabled <Boolean>]
      [[-Tag] <Hashtable>]
      [-AsJob]
      [-FederatedClientId <String>]
      [-UserAssignedIdentity <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Updates a disk encryption set.

Examples

Example 1

Update-AzDiskEncryptionSet -ResourceGroupName 'rg1' -Name 'enc1' -KeyUrl "https://valut1.vault.azure.net:443/keys/key1/mykey" -SourceVaultId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.KeyVault/vaults/vault1';

Updates disk encryption set using the given active key in the key vault.

Parameters

-AsJob

Run cmdlet in the background

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 credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FederatedClientId

Multi-tenant application client id to access key vault in a different tenant. Setting value to 'None' will clear the property.

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

-InputObject

The local object of the disk encryption set.

Type:	PSDiskEncryptionSet
Aliases:	DiskEncryptionSet
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-KeyUrl

Url pointing to the active key in KeyVault

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

-Name

Name of disk encryption set.

Type:	String
Aliases:	DiskEncryptionSetName
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Specifies the name of a resource group.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceId

The ID of the resource.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-RotationToLatestKeyVersionEnabled

Set this flag to true to enable auto-updating of this disk encryption set to the latest key version

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

-SourceVaultId

Resource id of the KeyVault containing the active key.

Type:	String
Position:	Named
Default value:	None
Required:	False
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:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-UserAssignedIdentity

The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

PSDiskEncryptionSet

Hashtable

Outputs