Update-AzKeyVaultKey
Atualiza os atributos de uma chave em um cofre de chaves.
Sintaxe
Default (Padrão)
Update-AzKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[[-Version] <String>]
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-KeyOps <String[]>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
HsmInteractive
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>]
Description
O cmdlet Update-AzKeyVaultKey atualiza os atributos editáveis de uma chave em um cofre de chaves.
Exemplos
Exemplo 1: modificar uma chave para habilitá-la e definir a data de validade e as marcas
$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
O primeiro comando cria um objeto DateTime usando o cmdlet Get-Date . Esse objeto especifica um tempo de dois anos no futuro. O comando armazena essa data na variável $Expires.
Para obter mais informações, digite Get-Help Get-Date.
O segundo comando cria uma variável para armazenar valores de marca de alta gravidade e Contabilidade.
O comando final modifica uma chave chamada ITSoftware. O comando habilita a chave, define seu tempo de expiração como o tempo armazenado em $Expires e define as marcas armazenadas em $Tags.
Exemplo 2: Modificar uma chave para excluir todas as marcas
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 :
Esses comandos excluem todas as marcas de uma versão específica de uma chave chamada ITSoftware.
Parâmetros
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: cf
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para a comunicação com o Azure.
Propriedades do parâmetro
Tipo: IAzureContextContainer
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-Enable
O valor de true habilita a chave e um valor de false desabilita a chave.
Se não for especificado, o estado existente habilitado/desabilitado permanecerá inalterado.
Propriedades do parâmetro
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-Expires
O tempo de expiração de uma chave no horário UTC.
Se não for especificado, o tempo de expiração existente da chave permanecerá inalterado.
Observe que expira é ignorado para Chave do Exchange de Chaves usada no processo BYOK.
Propriedades do parâmetro
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-HsmName
Nome do HSM. O cmdlet constrói o FQDN de um HSM gerenciado com base no nome e no ambiente selecionado no momento.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
HsmInteractive
Cargo: Named Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-Immutable
Define a política de versão como um estado imutável. Uma vez marcado como imutável, esse sinalizador não pode ser redefinido e a política não pode ser alterada em nenhuma circunstância.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
HsmInteractive
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
Objeto key
InputObject
Cargo: 0 Obrigatório: True Valor do pipeline: True Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-KeyOps
As operações que podem ser executadas com a chave.
Se não for especificado, as operações de chave existentes da chave permanecerão inalteradas.
Propriedades do parâmetro
Tipo: String [ ]
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-Name
Nome da chave.
O cmdlet constrói o FQDN de uma chave a partir do nome do cofre, do ambiente e do nome da chave selecionados no momento.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: Nome da chave
Conjuntos de parâmetros
Default
Cargo: 1 Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
HsmInteractive
Cargo: 1 Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-NotBefore
A hora UTC antes da qual a chave não pode ser usada.
Se não for especificado, o atributo NotBefore existente da chave permanecerá inalterado.
Propriedades do parâmetro
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-PassThru
O cmdlet não retorna um objeto por padrão.
Se essa opção for especificada, retornará o objeto de pacote de chaves atualizado.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-ReleasePolicyPath
Um caminho para um arquivo que contém a definição de política JSON. As regras de política sob as quais uma chave pode ser exportada.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
HsmInteractive
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-Tag
Um hashtable representa marcas de chave.
Se não for especificado, as marcas existentes da chave permanecerão inalteradas.
Propriedades do parâmetro
Tipo: Hashtable
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: Etiquetas
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-VaultName
Nome do cofre.
O cmdlet constrói o FQDN de um cofre com base no nome e no ambiente selecionado no momento.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
Default
Cargo: 0 Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-Version
Versão da chave.
O cmdlet constrói o FQDN de uma chave a partir do nome do cofre, ambiente atualmente selecionado, nome da chave e versão da chave.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: KeyVersion
Conjuntos de parâmetros
(All)
Cargo: 2 Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado.
O cmdlet não é executado.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: wi
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters .
Saídas
