Delete Secret - Delete Secret

Referência

Service:: Key Vault

API Version:: 7.4

Exclui um segredo de um cofre de chaves especificado.
A operação DELETE se aplica a qualquer segredo armazenado em um Cofre de Chaves do Azure. A operação DELETE não pode ser aplicada a uma versão individual de um segredo. Essa operação requer a permissão de segredos/exclusão.

DELETE {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.
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.

Respostas

Nome	Tipo	Description
200 OK	DeletedSecretBundle	O segredo excluído e as informações sobre quando o segredo será excluído e como recuperar o segredo excluído.
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve por que a operação falhou.

Exemplos

DeleteSecret

Sample Request

HTTP

DELETE https://myvault.vault.azure.net//secrets/GetDeletedSecretTest?api-version=7.4

Sample Response

Status code:: 200

{
  "recoveryId": "https://myvault.vault.azure.net/deletedsecrets/GetDeletedSecretTest",
  "deletedDate": 1493938433,
  "scheduledPurgeDate": 1501714433,
  "id": "https://myvault.vault.azure.net/secrets/GetDeletedSecretTest/b595353d9c39413d80626575b3b5d865",
  "attributes": {
    "enabled": true,
    "created": 1493938433,
    "updated": 1493938433,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

Definições

Nome	Description
DeletedSecretBundle	Um Segredo Excluído que consiste em sua ID anterior, atributos e suas marcas, bem como informações sobre quando ele será limpo.
DeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se contiver "Purgável", 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	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.

DeletedSecretBundle

Um Segredo Excluído que consiste em sua ID anterior, atributos e suas marcas, bem como informações sobre quando ele será limpo.

Nome	Tipo	Description
attributes	SecretAttributes	Os atributos de gerenciamento de segredos.
contentType	string	O tipo de conteúdo do segredo.
deletedDate	integer	A hora em que o segredo foi excluído, em UTC
id	string	A ID secreta.
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.
recoveryId	string	A URL do objeto de recuperação, usada para identificar e recuperar o segredo excluído.
scheduledPurgeDate	integer	A hora em que o segredo está agendado para ser limpo, em UTC
tags	object	Metadados específicos do aplicativo na forma de pares chave-valor.
value	string	O valor do segredo.

DeletionRecoveryLevel

Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se contiver "Purgável", 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.

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, 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 está disponível.
CustomizedRecoverable+ProtectedSubscription	string	Indica um cofre e um estado de assinatura no qual a exclusão é recuperável, a 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 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.
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 relação a uma operação De exclusão; os dados são irremediavelmente perdidos ao aceitar uma operação De exclusão 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 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 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	Hora 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 contiver "Purgável", 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	Hora da última atualização em UTC.