Set Secret - Set Secret

Serviço:
Key Vault
Versão da API:
2025-07-01

Define um segredo em um cofre de chaves especificado.
A operação SET adiciona um segredo ao Azure Key Vault. Se o segredo nomeado já existir, o Azure Key Vault criará uma nova versão desse segredo. Essa operação requer a permissão de segredos/conjunto.

PUT {vaultBaseUrl}/secrets/{secret-name}?api-version=2025-07-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
secret-name
 path True

string

pattern: ^[0-9a-zA-Z-]+$

O nome do segredo. O valor fornecido pode ser copiado globalmente com a finalidade de executar o serviço. O valor fornecido não deve incluir informações pessoais identificáveis ou confidenciais.
vaultBaseUrl
 path True

string (uri)

api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.

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 secreto, como uma senha.
tags

object

Metadados específicos do aplicativo na forma de pares de chave-valor.

Respostas

Nome Tipo Description
200 OK

SecretBundle

A solicitação foi bem-sucedida.
Other Status Codes

KeyVaultError

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
https://vault.azure.net/.default

Exemplos

SetSecret

Solicitação de exemplo

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

{
  "value": "mysecretvalue"
}

Resposta de exemplo

Código de status:
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 contiver 'Purgeable', o segredo poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema pode limpar o segredo, no final do intervalo de retenção.
Error
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 secreto.

DeletionRecoveryLevel

Enumeração

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

Valor Description
Purgeable

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 contra 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+Purgeable

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 irá excluí-lo permanentemente após 90 dias, se não for recuperado
Recoverable

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 irá excluí-lo permanentemente após 90 dias, se não for recuperado
Recoverable+ProtectedSubscription

Indica um estado de cofre e assinatura no qual a exclusão é recuperável dentro do intervalo de retenção (90 dias), a exclusão imediata e permanente (ou seja, limpeza) não é permitida e no qual a assinatura em si não pode ser cancelada permanentemente. O sistema irá excluí-lo permanentemente após 90 dias, se não for recuperado
CustomizedRecoverable+Purgeable

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, limpar 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.
CustomizedRecoverable

Indica um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpar 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 estiver disponível.
CustomizedRecoverable+ProtectedSubscription

Indica um estado de cofre e assinatura no qual a exclusão é recuperável, a exclusão imediata e permanente (ou seja, limpeza) não é permitida e no 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 assinatura em si não pode ser cancelada.

Error

Objeto
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

Objeto

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

Nome Tipo Description
error

Error

O erro do servidor do cofre de chaves.

SecretAttributes

Objeto

Os atributos de gerenciamento de segredos.

Nome Tipo Description
created

integer (unixtime)

Tempo de criação em UTC.
enabled

boolean

Determina se o objeto está habilitado.
exp

integer (unixtime)

Data de expiração em UTC.
nbf

integer (unixtime)

Não antes da data em UTC.
recoverableDays

integer (int32)

dias de retenção de dados softDelete. 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 contiver 'Purgeable', o segredo poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema pode limpar o segredo, no final do intervalo de retenção.
updated

integer (unixtime)

Hora da última atualização em UTC.

SecretBundle

Objeto

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

O id secreto.
kid

string

Se esse for um segredo que dá suporte a um certificado KV, esse campo especifica 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 dá suporte a um certificado, gerenciado será verdadeiro.
previousVersion

string

A versão do certificado anterior, se aplicável. Aplica-se somente a certificados criados após 1º de junho de 2025. Os certificados criados antes dessa data não são atualizados retroativamente.
tags

object

Metadados específicos do aplicativo na forma de pares de chave-valor.
value

string

O valor secreto.

SecretSetParameters

Objeto

Os parâmetros do conjunto secreto.

Nome Tipo Description
attributes

SecretAttributes

Os atributos de gerenciamento de segredos.
contentType

string

Tipo do valor secreto, como uma senha.
tags

object

Metadados específicos do aplicativo na forma de pares de chave-valor.
value

string

O valor do segredo.