Update-AzureKeyVaultKey

Referência

Módulo:: AzureRM.KeyVault

Atualiza os atributos de uma chave em um cofre de chaves.

Aviso

O módulo AzureRM PowerShell foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo Az PowerShell para garantir suporte e atualizações contínuos.

Embora o módulo AzureRM ainda possa funcionar, ele não é mais mantido ou suportado, colocando qualquer uso continuado a critério e risco do usuário. Consulte nossos recursos de migração para obter orientação sobre a transição para o módulo Az.

Syntax

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

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

Description

O cmdlet Update-AzureKeyVaultKey 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 expiração e as tags

PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime()
PS C:\> $Tags = @{'Severity' = 'high'; 'Accounting' = 'true'}
PS C:\> Update-AzureKeyVaultKey -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 prazo 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 tag de alta severidade e Contabilidade. O comando final modifica uma chave chamada ITSoftware. O comando habilita a chave, define seu tempo de expiração para o tempo armazenado no $Expires e define as tags que são armazenadas no $Tags.

Exemplo 2: Modificar uma chave para excluir todas as tags

PS C:\> Update-AzureKeyVaultKey -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           :

Este comando exclui todas as tags de uma versão específica de uma chave chamada ITSoftware.

Parâmetros

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:	SwitchParameter
Aliases:	cf
Position:	Named
valor predefinido:	None
Necessário:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Tipo:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
valor predefinido:	None
Necessário:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Enable

O valor de true habilita a chave e um valor de false disabless a chave. Se não for especificado, o estado habilitado/desativado existente permanecerá inalterado.

Tipo:	Nullable<T>[Boolean]
Position:	Named
valor predefinido:	None
Necessário:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Expires

O tempo de expiração de uma chave na hora UTC. Se não for especificado, o tempo de expiração existente da chave permanecerá inalterado.

Tipo:	Nullable<T>[DateTime]
Position:	Named
valor predefinido:	None
Necessário:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Objeto-chave

Tipo:	PSKeyVaultKeyIdentityItem
Position:	0
valor predefinido:	None
Necessário:	True
Accept pipeline input:	True
Accept wildcard characters:	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.

Tipo:	String[]
Position:	Named
valor predefinido:	None
Necessário:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Nome da chave. O cmdlet constrói o FQDN de uma chave a partir do nome do vault, do ambiente selecionado no momento e do nome da chave.

Tipo:	String
Aliases:	KeyName
Position:	1
valor predefinido:	None
Necessário:	True
Accept pipeline input:	False
Accept wildcard characters:	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.

Tipo:	Nullable<T>[DateTime]
Position:	Named
valor predefinido:	None
Necessário:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Tipo:	SwitchParameter
Position:	Named
valor predefinido:	None
Necessário:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

Uma hashtable representa tags de chave. Se não for especificado, as tags existentes da chave permanecerão inalteradas.

Tipo:	Hashtable
Aliases:	Tags
Position:	Named
valor predefinido:	None
Necessário:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VaultName

Nome do cofre. O cmdlet constrói o FQDN de um cofre com base no nome e no ambiente selecionado no momento.

Tipo:	String
Position:	0
valor predefinido:	None
Necessário:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Version

Versão chave. O cmdlet constrói o FQDN de uma chave a partir do nome do vault, do ambiente selecionado no momento, do nome da chave e da versão da chave.

Tipo:	String
Aliases:	KeyVersion
Position:	2
valor predefinido:	None
Necessário:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:	SwitchParameter
Aliases:	wi
Position:	Named
valor predefinido:	None
Necessário:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entradas

PSKeyVaultKeyIdentityItem

Parâmetros: InputObject (ByValue)

Saídas

PSKeyVaultKey

Partilhar via