Update-AzKeyVaultKey

Module:

Az.KeyVault Module

Updates the attributes of a key in a key vault.

Update-AzKeyVaultKey
 [-VaultName] <String>
 [-Name] <String>
 [[-Version] <String>]
 [-Enable <Boolean>]
 [-Expires <DateTime>]
 [-NotBefore <DateTime>]
 [-KeyOps <String[]>]
 [-Tag <Hashtable>]
 [-PassThru]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Update-AzKeyVaultKey
 [-Name] <String>
 [[-Version] <String>]
 -HsmName <String>
 [-Enable <Boolean>]
 [-Expires <DateTime>]
 [-NotBefore <DateTime>]
 [-KeyOps <String[]>]
 [-Immutable]
 [-ReleasePolicyPath <String>]
 [-Tag <Hashtable>]
 [-PassThru]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Update-AzKeyVaultKey
 [-InputObject] <PSKeyVaultKeyIdentityItem>
 [[-Version] <String>]
 [-Enable <Boolean>]
 [-Expires <DateTime>]
 [-NotBefore <DateTime>]
 [-KeyOps <String[]>]
 [-Tag <Hashtable>]
 [-PassThru]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

The Update-AzKeyVaultKey cmdlet updates the editable attributes of a key in a key vault.

$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Tags = @{'Severity' = 'high'; 'Accounting' = 'true'}
Update-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Expires $Expires -Enable $True -Tag $Tags -PassThru

Vault Name : Contoso
Name : ITSoftware
Version : 394f9379a47a4e2086585468de6c7ae5
Id : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled : True
Expires : 5/25/2020 7:58:07 PM
Not Before :
Created : 4/6/2018 11:31:36 PM
Updated : 5/25/2018 7:59:02 PM
Purge Disabled : False
Tags : Name Value
 Severity high
 Accounting true

The first command creates a DateTime object by using the Get-Date cmdlet. That object specifies a time two years in the future. The command stores that date in the $Expires variable. For more information, type Get-Help Get-Date. The second command creates a variable to store tag values of high severity and Accounting. The final command modifies a key named ITSoftware. The command enables the key, sets its expiration time to the time stored in $Expires, and sets the tags that are stored in $Tags.

Update-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Version '394f9379a47a4e2086585468de6c7ae5' -Tag @{}

Vault Name : Contoso
Name : ITSoftware
Version : 394f9379a47a4e2086585468de6c7ae5
Id : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled : True
Expires : 5/25/2020 7:58:07 PM
Not Before :
Created : 4/6/2018 11:31:36 PM
Updated : 5/25/2018 8:00:08 PM
Purge Disabled : False
Tags :

This commands deletes all tags for a specific version of a key named ITSoftware.

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.