Update-AzKeyVaultSecret

Referência

Módulo:: Az.KeyVault

Atualiza atributos de um segredo em um cofre de chaves.

Sintaxe

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

Update-AzKeyVaultSecret
      [-Id] <String>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-ContentType <String>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzKeyVaultSecret
      [-InputObject] <PSKeyVaultSecretIdentityItem>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-ContentType <String>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O cmdlet Update-AzKeyVaultSecret atualiza atributos editáveis de um segredo em um cofre de chaves.

Exemplos

Exemplo 1: modificar os atributos de um segredo

$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Nbf = (Get-Date).ToUniversalTime()
$Tags = @{ 'Severity' = 'medium'; 'HR' = 'true'}
$ContentType= 'xml'
Update-AzKeyVaultSecret -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, as marcas e o tipo de contexto e armazenam os atributos em variáveis. O comando final modifica os atributos do segredo chamado RH 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

Update-AzKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Version '9EEA45C6EE50490B9C3176A80AC1A0DF' -ContentType '' -Tag @{}

Esse comando exclui as marcas e o tipo de conteúdo para a versão especificada do segredo chamado RH no cofre de chaves chamado Contoso.

Exemplo 3: Desabilitar a versão atual de segredos cujo nome começa com TI

$Vault = 'ContosoVault'
$Prefix = 'IT'
Get-AzKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzKeyVaultSecret -Enable $False

O primeiro comando armazena o valor da cadeia de caracteres Contoso na variável $Vault. O segundo comando armazena a TI do valor da cadeia de caracteres na variável $Prefix. O terceiro comando usa o cmdlet Get-AzKeyVaultSecret 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 de TI. O comando canaliza os segredos que correspondem ao filtro para o cmdlet Update-AzKeyVaultSecret, o que os desabilita.

Exemplo 4: Definir o ContentType para todas as versões de um segredo

$VaultName = 'ContosoVault'
$Name = 'HR'
$ContentType = 'xml'
Get-AzKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzKeyVaultSecret -ContentType $ContentType

Os três primeiros comandos definem variáveis de cadeia de caracteres a serem usadas para os parâmetros VaultName, Namee ContentType. O quarto comando usa o cmdlet Get-AzKeyVaultKey para obter as chaves especificadas e canaliza as chaves para o cmdlet Update-AzKeyVaultSecret para definir seu tipo de conteúdo como XML.

Exemplo 5: excluir as marcas e o tipo de conteúdo de um segredo (usando Uri)

Update-AzKeyVaultSecret -Id 'https://ContosoVault.vault.azure.net:443/secrets/HR/9EEA45C6EE50490B9C3176A80AC1A0DF'  -ContentType '' -Tag @{}

Esse comando exclui as marcas e o tipo de conteúdo para a versão especificada do segredo chamado RH no cofre de chaves chamado Contoso.

Parâmetros

-Confirm

Solicita a 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 segredo. Se não for especificado, o valor existente do tipo de conteúdo do segredo permanecerá inalterado. Remova o valor do 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 comunicação com o Azure.

Tipo:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Enable

Se estiver presente, habilite um segredo se o valor for verdadeiro. Desabilite um segredo se o valor for false. Se não for especificado, o valor existente do estado habilitado/desabilitado do segredo permanecerá inalterado.

Tipo:	Boolean
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Expires

A hora 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:	DateTime
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Id

O URI do segredo KeyVault. Verifique se ele segue o formato: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Tipo:	String
Aliases:	SecretId
Cargo:	0
Valor padrão:	None
Obrigatório:	True
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 do segredo. O cmdlet constrói o FQDN de um segredo a partir do nome do cofre, do ambiente selecionado no momento 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:	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 o 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

Um hashtable que representa marcas secretas. Se não for especificado, as marcas existentes do segredo permanecerão inalteradas. Remova uma marca especificando um Hashtable vazio.

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 a partir do nome do cofre, ambiente atualmente selecionado, nome do segredo e 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

PSKeyVaultSecretIdentityItem

Saídas

PSKeyVaultSecret

Compartilhar via