Set Secret - Set Secret

Service:

Key Vault

API Version:

7.4

Define um segredo em um cofre de chaves especificado.
A operação SET adiciona um segredo ao Key Vault do Azure. Se o segredo denominado já existir, o Cofre de Chaves do Azure cria uma nova versão do segredo. Essa operação exige a permissão de segredos/definição.

PUT {vaultBaseUrl}/secrets/{secret-name}?api-version=7.4

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
secret-name	path	True	string	O nome do segredo. O valor fornecido pode ser copiado globalmente para fins de execução do serviço. O valor fornecido não deve incluir informações pessoais identificáveis ou confidenciais. Regex pattern: ^[0-9a-zA-Z-]+$
vaultBaseUrl	path	True	string	O nome do cofre, por exemplo https://myvault.vault.azure.net, .
api-version	query	True	string	Versão de API do cliente.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
value	True	string	O valor do segredo.
attributes		SecretAttributes	Os atributos de gerenciamento de segredos.
contentType		string	Tipo do valor do segredo, como uma senha.
tags		object	Metadados específicos do aplicativo na forma de pares chave-valor.

Respostas

Nome	Tipo	Description
200 OK	SecretBundle	Um pacote secreto que contém o resultado da solicitação de segredo definida.
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve por que a operação falhou.

Exemplos

SetSecret

Sample Request

HTTP

PUT https://myvault.vault.azure.net//secrets/crpsecret?api-version=7.4

{
  "value": "mysecretvalue"
}

Sample Response

Status code:

200

{
  "value": "mysecretvalue",
  "id": "https://myvault.vault.azure.net/secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441",
  "attributes": {
    "enabled": true,
    "created": 1493938459,
    "updated": 1493938459,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

Definições

Nome	Description
DeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se ele contiver 'Purgeable', o segredo poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar o segredo, no final do intervalo de retenção.
Error	O erro do servidor do cofre de chaves.
KeyVaultError	A exceção de erro do cofre de chaves.
SecretAttributes	Os atributos de gerenciamento de segredos.
SecretBundle	Um segredo que consiste em um valor, id e seus atributos.
SecretSetParameters	Os parâmetros do conjunto de segredos.

DeletionRecoveryLevel

Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se ele contiver 'Purgeable', o segredo poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar o segredo, no final do intervalo de retenção.

Nome	Tipo	Description
CustomizedRecoverable	string	Indica um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpeza quando 7<= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e enquanto a assinatura ainda está disponível.
CustomizedRecoverable+ProtectedSubscription	string	Indica um cofre e um estado de assinatura no qual a exclusão é recuperável, exclusão imediata e permanente (ou seja, limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente quando 7<= SoftDeleteRetentionInDays < 90. Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e também reflete o fato de que a própria assinatura não pode ser cancelada.
CustomizedRecoverable+Purgeable	string	Indica um estado de cofre no qual a exclusão é recuperável e que também permite exclusão imediata e permanente (ou seja, limpeza quando 7<= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção, a menos que uma operação de limpeza seja solicitada ou a assinatura seja cancelada.
Purgeable	string	Indica um estado de cofre no qual a exclusão é uma operação irreversível, sem a possibilidade de recuperação. Esse nível corresponde a nenhuma proteção disponível em uma operação Delete; os dados são irremediavelmente perdidos ao aceitar uma operação Delete no nível da entidade ou superior (cofre, grupo de recursos, assinatura etc.)
Recoverable	string	Indica um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpeza). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias) e enquanto a assinatura ainda estiver disponível. O sistema o excluirá permanentemente após 90 dias, se não for recuperado
Recoverable+ProtectedSubscription	string	Indica um cofre e um estado de assinatura no qual a exclusão é recuperável dentro do intervalo de retenção (90 dias), a exclusão imediata e permanente (ou seja, a limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente. O sistema o excluirá permanentemente após 90 dias, se não for recuperado
Recoverable+Purgeable	string	Indica um estado de cofre no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, limpeza). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias), a menos que uma operação de limpeza seja solicitada ou a assinatura seja cancelada. O sistema o excluirá permanentemente após 90 dias, se não for recuperado

Error

O erro do servidor do cofre de chaves.

Nome	Tipo	Description
code	string	O código de erro.
innererror	Error	O erro do servidor do cofre de chaves.
message	string	A mensagem de erro.

KeyVaultError

A exceção de erro do cofre de chaves.

Nome	Tipo	Description
error	Error	O erro do servidor do cofre de chaves.

SecretAttributes

Os atributos de gerenciamento de segredos.

Nome	Tipo	Description
created	integer	Tempo de criação em UTC.
enabled	boolean	Determina se o objeto está habilitado.
exp	integer	Data de expiração em UTC.
nbf	integer	Não antes da data em UTC.
recoverableDays	integer	softDelete dias de retenção de dados. O valor deve ser >=7 e <=90 quando softDelete habilitado, caso contrário, 0.
recoveryLevel	DeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se ele contiver 'Purgeable', o segredo poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar o segredo, no final do intervalo de retenção.
updated	integer	Hora da última atualização em UTC.

SecretBundle

Um segredo que consiste em um valor, id e seus atributos.

Nome	Tipo	Description
attributes	SecretAttributes	Os atributos de gerenciamento de segredos.
contentType	string	O tipo de conteúdo do segredo.
id	string	A ID do segredo.
kid	string	Se esse for um segredo que faz backup de um certificado KV, esse campo especificará a chave correspondente que dá suporte ao certificado KV.
managed	boolean	True se o tempo de vida do segredo for gerenciado pelo cofre de chaves. Se esse for um segredo que faz backup de um certificado, o gerenciado será verdadeiro.
tags	object	Metadados específicos do aplicativo na forma de pares chave-valor.
value	string	O valor do segredo.

SecretSetParameters

Os parâmetros do conjunto de segredos.

Nome	Tipo	Description
attributes	SecretAttributes	Os atributos de gerenciamento de segredos.
contentType	string	Tipo do valor do segredo, como uma senha.
tags	object	Metadados específicos do aplicativo na forma de pares chave-valor.
value	string	O valor do segredo.