< Back
Set-AzureKeyVaultKeyAttribute
Post
NAME Set-AzureKeyVaultKeyAttribute
SYNOPSIS
Updates the attributes of a key in a key vault.
SYNTAX
Set-AzureKeyVaultKeyAttribute [-InputObject] <PSKeyVaultKeyIdentityItem> [[-Version] <String>] [-DefaultProfile <IAzureContextContainer>] [-Enable
<Boolean>] [-Expires <DateTime>] [-KeyOps <String[]>] [-NotBefore <DateTime>] [-PassThru] [-Tag <Hashtable>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Set-AzureKeyVaultKeyAttribute [-VaultName] <String> [-Name] <String> [[-Version] <String>] [-DefaultProfile <IAzureContextContainer>] [-Enable
<Boolean>] [-Expires <DateTime>] [-KeyOps <String[]>] [-NotBefore <DateTime>] [-PassThru] [-Tag <Hashtable>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Set-AzureKeyVaultKeyAttribute cmdlet updates the editable attributes of a key in a key vault.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Enable <Boolean>
Specifies whether to enable or disable a key. A value of $True enables the key. A value of $False disables the key. If you do not specify this
parameter, this cmdlet does not modify the status of the key.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Expires <DateTime>
Specifies the expiration time, as a DateTime object, for the key that this cmdlet updates. This parameter uses Coordinated Universal Time
(UTC). To obtain a DateTime object, use the Get-Date cmdlet. For more information, type `Get-Help Get-Date`.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-InputObject <PSKeyVaultKeyIdentityItem>
Key object
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-KeyOps <String[]>
Specifies an array of operations that can be performed by using the key that this cmdlet adds. If you do not specify this parameter, all
operations can be performed.
The acceptable values for this parameter are a comma-separated list of key operations as defined by the JSON Web Key specification. These
values (case-sensitive) are:
- encrypt
- decrypt
- wrap
- unwrap
- sign
- verify
- backup
- restore
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the key to update. This cmdlet constructs the fully qualified domain name (FQDN) of a key based on the name that this
parameter specifies, the name of the key vault, and your current environment.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NotBefore <DateTime>
Specifies the time, as a DateTime object, before which the key cannot be used. This parameter uses UTC. To obtain a DateTime object, use the
Get-Date cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Tag <Hashtable>
Key-value pairs in the form of a hash table. For example:
@{key0="value0";key1=$null;key2="value2"}
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VaultName <String>
Specifies the name of the key vault in which this cmdlet modifies the key. This cmdlet constructs the FQDN of a key vault based on the name
that this parameter specifies and your current environment.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Specifies the key version. This cmdlet constructs the FQDN of a key based on the key vault name, your currently selected environment, the key
name, and the key version.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey
NOTES
Example 1: Modify a key to enable it, and set the expiration date and tags
PS C:\\>$Expires = (Get-Date).AddYears(2).ToUniversalTime()
PS C:\\> $Tags = @{'Severity' = 'high'; 'Accounting' = null}
PS C:\\> Set-AzureKeyVaultKeyAttribute -VaultName 'Contoso' -Name 'ITSoftware' -Expires $Expires -Enable $True -Tag $Tags -PassThru
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.
Example 2: Modify a key to delete all tags
PS C:\\>Set-AzureKeyVaultKeyAttribute -VaultName 'Contoso' -Name 'ITSoftware' -Version '7EEA45C6EE50490B9C3176F80AC1A0DG' -Tag @{}
This commands deletes all tags for a specific version of a key named ITSoftware.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... yattribute
Add-AzureKeyVaultKey
Get-AzureKeyVaultKey
Remove-AzureKeyVaultKey
SYNOPSIS
Updates the attributes of a key in a key vault.
SYNTAX
Set-AzureKeyVaultKeyAttribute [-InputObject] <PSKeyVaultKeyIdentityItem> [[-Version] <String>] [-DefaultProfile <IAzureContextContainer>] [-Enable
<Boolean>] [-Expires <DateTime>] [-KeyOps <String[]>] [-NotBefore <DateTime>] [-PassThru] [-Tag <Hashtable>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Set-AzureKeyVaultKeyAttribute [-VaultName] <String> [-Name] <String> [[-Version] <String>] [-DefaultProfile <IAzureContextContainer>] [-Enable
<Boolean>] [-Expires <DateTime>] [-KeyOps <String[]>] [-NotBefore <DateTime>] [-PassThru] [-Tag <Hashtable>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Set-AzureKeyVaultKeyAttribute cmdlet updates the editable attributes of a key in a key vault.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Enable <Boolean>
Specifies whether to enable or disable a key. A value of $True enables the key. A value of $False disables the key. If you do not specify this
parameter, this cmdlet does not modify the status of the key.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Expires <DateTime>
Specifies the expiration time, as a DateTime object, for the key that this cmdlet updates. This parameter uses Coordinated Universal Time
(UTC). To obtain a DateTime object, use the Get-Date cmdlet. For more information, type `Get-Help Get-Date`.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-InputObject <PSKeyVaultKeyIdentityItem>
Key object
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-KeyOps <String[]>
Specifies an array of operations that can be performed by using the key that this cmdlet adds. If you do not specify this parameter, all
operations can be performed.
The acceptable values for this parameter are a comma-separated list of key operations as defined by the JSON Web Key specification. These
values (case-sensitive) are:
- encrypt
- decrypt
- wrap
- unwrap
- sign
- verify
- backup
- restore
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the key to update. This cmdlet constructs the fully qualified domain name (FQDN) of a key based on the name that this
parameter specifies, the name of the key vault, and your current environment.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NotBefore <DateTime>
Specifies the time, as a DateTime object, before which the key cannot be used. This parameter uses UTC. To obtain a DateTime object, use the
Get-Date cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Tag <Hashtable>
Key-value pairs in the form of a hash table. For example:
@{key0="value0";key1=$null;key2="value2"}
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VaultName <String>
Specifies the name of the key vault in which this cmdlet modifies the key. This cmdlet constructs the FQDN of a key vault based on the name
that this parameter specifies and your current environment.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Specifies the key version. This cmdlet constructs the FQDN of a key based on the key vault name, your currently selected environment, the key
name, and the key version.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey
NOTES
Example 1: Modify a key to enable it, and set the expiration date and tags
PS C:\\>$Expires = (Get-Date).AddYears(2).ToUniversalTime()
PS C:\\> $Tags = @{'Severity' = 'high'; 'Accounting' = null}
PS C:\\> Set-AzureKeyVaultKeyAttribute -VaultName 'Contoso' -Name 'ITSoftware' -Expires $Expires -Enable $True -Tag $Tags -PassThru
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.
Example 2: Modify a key to delete all tags
PS C:\\>Set-AzureKeyVaultKeyAttribute -VaultName 'Contoso' -Name 'ITSoftware' -Version '7EEA45C6EE50490B9C3176F80AC1A0DG' -Tag @{}
This commands deletes all tags for a specific version of a key named ITSoftware.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... yattribute
Add-AzureKeyVaultKey
Get-AzureKeyVaultKey
Remove-AzureKeyVaultKey