Update-AzureKeyVaultSecret
Atualiza atributos de um segredo em um cofre de chaves.
Aviso
O módulo do PowerShell do AzureRM foi oficialmente preterido em 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo do Az PowerShell para garantir o suporte e as atualizações contínuas.
Embora o módulo AzureRM ainda possa funcionar, ele não é mais mantido ou suportado, colocando qualquer uso contínuo a critério e risco do usuário. Consulte nossos recursos de migração para obter diretrizes sobre a transição para o módulo Az.
Sintaxe
Update-AzureKeyVaultSecret
[-VaultName] <String>
[-Name] <String>
[[-Version] <String>]
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-ContentType <String>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzureKeyVaultSecret
[-InputObject] <PSKeyVaultSecretIdentityItem>
[[-Version] <String>]
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-ContentType <String>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Update-AzureKeyVaultSecret atualiza atributos editáveis de um segredo em um cofre de chaves.
Exemplos
Exemplo 1: Modificar os atributos de um segredo
PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime()
PS C:\> $Nbf = (Get-Date).ToUniversalTime()
PS C:\> $Tags = @{ 'Severity' = 'medium'; 'HR' = 'true'}
PS C:\> $ContentType= 'xml'
PS C:\> Update-AzureKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Expires $Expires -NotBefore $Nbf -ContentType $ContentType -Enable $True -Tag $Tags -PassThru
Vault Name : ContosoVault
Name : HR
Version : d476edfcd3544017a03bc49c1f3abec0
Id : https://ContosoVault.vault.azure.net:443/secrets/HR/d476edfcd3544017a03bc49c1f3abec0
Enabled : True
Expires : 5/25/2020 8:01:58 PM
Not Before : 5/25/2018 8:02:02 PM
Created : 4/11/2018 11:45:06 PM
Updated : 5/25/2018 8:02:45 PM
Content Type : xml
Tags : Name Value
Severity medium
HR true
Os quatro primeiros comandos definem atributos para a data de expiração, a data NotBefore, marcas e tipo de contexto e armazenam os atributos em variáveis. O comando final modifica os atributos do segredo chamado HR no cofre de chaves chamado ContosoVault, usando as variáveis armazenadas.
Exemplo 2: Excluir as marcas e o tipo de conteúdo de um segredo
PS C:\> Update-AzureKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Version '9EEA45C6EE50490B9C3176A80AC1A0DF' -ContentType '' -Tag -@{}
Esse comando exclui as marcas e o tipo de conteúdo da versão especificada do segredo chamado HR no cofre de chaves chamado Contoso.
Exemplo 3: Desabilitar a versão atual de segredos cujo nome começa com IT
PS C:\> $Vault = 'ContosoVault'
PS C:\> $Prefix = 'IT'
PS C:\> Get-AzureKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzureKeyVaultSecret -Enable $False
O primeiro comando armazena o valor da cadeia de caracteres Contoso na variável $Vault. O segundo comando armazena o valor da cadeia de caracteres IT na variável $Prefix. O terceiro comando usa o cmdlet Get-AzureKeyVaultSecret para obter os segredos no cofre de chaves especificado e, em seguida, passa esses segredos para o cmdlet Where-Object . O cmdlet Where-Object filtra os segredos para nomes que começam com os caracteres IT. O comando canaliza os segredos que correspondem ao filtro para o cmdlet Update-AzureKeyVaultSecret, que os desabilita.
Exemplo 4: Definir o ContentType para todas as versões de um segredo
PS C:\> $VaultName = 'ContosoVault'
PS C:\> $Name = 'HR'
PS C:\> $ContentType = 'xml'
PS C:\> Get-AzureKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzureKeyVaultSecret -ContentType $ContentType
Os três primeiros comandos definem variáveis de cadeia de caracteres a serem usadas para os parâmetros VaultName, Name e ContentType. O quarto comando usa o cmdlet Get-AzureKeyVaultKey para obter as chaves especificadas e canaliza as chaves para o cmdlet Update-AzureKeyVaultSecret para definir seu tipo de conteúdo como XML.
Parâmetros
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Tipo: | SwitchParameter |
Aliases: | cf |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ContentType
Tipo de conteúdo do Secret. Se não for especificado, o valor existente do tipo de conteúdo do segredo permanecerá inalterado. Remova o valor de tipo de conteúdo existente especificando uma cadeia de caracteres vazia.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para a comunicação com o Azure.
Tipo: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Enable
Se presente, habilite um segredo se o valor for true. Desative um segredo se o valor for false. Se não for especificado, o valor existente do estado habilitado/desabilitado do segredo permanecerá inalterado.
Tipo: | Nullable<T>[Boolean] |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Expires
O tempo de expiração de um segredo no horário UTC. Se não for especificado, o valor existente do tempo de expiração do segredo permanecerá inalterado.
Tipo: | Nullable<T>[DateTime] |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-InputObject
Objeto secreto
Tipo: | PSKeyVaultSecretIdentityItem |
Cargo: | 0 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-Name
Nome secreto. O cmdlet constrói o FQDN de um segredo do nome do cofre, do ambiente atualmente selecionado e do nome do segredo.
Tipo: | String |
Aliases: | SecretName |
Cargo: | 1 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-NotBefore
A hora UTC antes da qual o segredo não pode ser usado. Se não for especificado, o valor existente do atributo NotBefore do segredo permanecerá inalterado.
Tipo: | Nullable<T>[DateTime] |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-PassThru
O cmdlet não retorna objeto por padrão. Se essa opção for especificada, retorne o objeto Secret.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Tag
Uma hashtable que representa tags secretas. Se não for especificado, as marcas existentes do segredo permanecerão inalteradas. Remova uma tag especificando uma Hashtable vazia.
Tipo: | Hashtable |
Aliases: | Tags |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | 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 |
Cargo: | 0 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Version
Versão secreta. O cmdlet constrói o FQDN de um segredo do nome do cofre, do ambiente atualmente selecionado, do nome do segredo e da versão secreta.
Tipo: | String |
Aliases: | SecretVersion |
Cargo: | 2 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Tipo: | SwitchParameter |
Aliases: | wi |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Entradas
Parâmetros: InputObject (ByValue)