Delete Secret - Delete Secret

Referentie

Service:: Key Vault

API Version:: 7.4

Hiermee verwijdert u een geheim uit een opgegeven sleutelkluis.
De delete-bewerking is van toepassing op elk geheim dat is opgeslagen in Azure Key Vault. DELETE kan niet worden toegepast op een afzonderlijke versie van een geheim. Voor deze bewerking is de machtiging geheimen/verwijderen vereist.

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

URI-parameters

Name	In	Vereist	Type	Description
secret-name	path	True	string	De naam van het geheim.
vaultBaseUrl	path	True	string	De kluisnaam, bijvoorbeeld https://myvault.vault.azure.net.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	DeletedSecretBundle	Het verwijderde geheim en informatie over wanneer het geheim wordt verwijderd en hoe u het verwijderde geheim kunt herstellen.
Other Status Codes	KeyVaultError	Key Vault foutbericht waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

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"
  }
}

Definities

Name	Description
DeletedSecretBundle	Een verwijderd geheim dat bestaat uit de vorige id, kenmerken en tags, evenals informatie over wanneer het wordt verwijderd.
DeletionRecoveryLevel	Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor geheimen in de huidige kluis. Als het 'Opschoonbaar' bevat, kan het geheim permanent worden verwijderd door een bevoegde gebruiker; Anders kan alleen het systeem het geheim aan het einde van het retentie-interval opschonen.
Error	De sleutelkluisserverfout.
KeyVaultError	De fout-uitzondering voor de sleutelkluis.
SecretAttributes	De geheime beheerkenmerken.

DeletedSecretBundle

Een verwijderd geheim dat bestaat uit de vorige id, kenmerken en tags, evenals informatie over wanneer het wordt verwijderd.

Name	Type	Description
attributes	SecretAttributes	De geheime beheerkenmerken.
contentType	string	Het inhoudstype van het geheim.
deletedDate	integer	Het tijdstip waarop het geheim is verwijderd, in UTC
id	string	De geheime id.
kid	string	Als dit een geheim is achter een KV-certificaat, geeft dit veld de bijbehorende sleutel aan die het KV-certificaat moet ondersteunen.
managed	boolean	True als de levensduur van het geheim wordt beheerd door de sleutelkluis. Als dit een geheim is dat een back-up maakt van een certificaat, wordt beheerd waar.
recoveryId	string	De URL van het herstelobject, dat wordt gebruikt om het verwijderde geheim te identificeren en te herstellen.
scheduledPurgeDate	integer	Het tijdstip waarop het geheim volgens de planning moet worden opgeschoond, in UTC
tags	object	Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen.
value	string	De geheime waarde.

DeletionRecoveryLevel

Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor geheimen in de huidige kluis. Als het 'Opschoonbaar' bevat, kan het geheim permanent worden verwijderd door een bevoegde gebruiker; Anders kan alleen het systeem het geheim aan het einde van het retentie-interval opschonen.

Name	Type	Description
CustomizedRecoverable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid voor onmiddellijke en permanente verwijdering (d.w.w. opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en zolang het abonnement nog beschikbaar is.
CustomizedRecoverable+ProtectedSubscription	string	Geeft een kluis- en abonnementstatus aan waarin verwijdering kan worden hersteld, directe en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd wanneer 7<= SoftDeleteRetentionInDays < 90. Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en weerspiegelt ook het feit dat het abonnement zelf niet kan worden geannuleerd.
CustomizedRecoverable+Purgeable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (d.w.w. opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval, tenzij een opschoonbewerking wordt aangevraagd of het abonnement wordt geannuleerd.
Purgeable	string	Geeft een kluisstatus aan waarin het verwijderen een onomkeerbare bewerking is, zonder de mogelijkheid tot herstel. Dit niveau komt overeen met het feit dat er geen bescherming beschikbaar is tegen een Delete-bewerking; de gegevens gaan onherroepelijk verloren bij het accepteren van een Verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement, enzovoort)
Recoverable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (d.w.w. opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval (90 dagen) en zolang het abonnement nog beschikbaar is. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
Recoverable+ProtectedSubscription	string	Geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld binnen een bewaarperiode (90 dagen), directe en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
Recoverable+Purgeable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (d.w.w. opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen), tenzij een opschoonbewerking wordt aangevraagd of het abonnement wordt geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld

Error

De sleutelkluisserverfout.

Name	Type	Description
code	string	De foutcode.
innererror	Error	De sleutelkluisserverfout.
message	string	Het foutbericht.

KeyVaultError

De fout-uitzondering voor de sleutelkluis.

Name	Type	Description
error	Error	De sleutelkluisserverfout.

SecretAttributes

De geheime beheerkenmerken.

Name	Type	Description
created	integer	Aanmaaktijd in UTC.
enabled	boolean	Bepaalt of het object is ingeschakeld.
exp	integer	Vervaldatum in UTC.
nbf	integer	Niet vóór datum in UTC.
recoverableDays	integer	softDelete dagen voor gegevensretentie. De waarde moet =7 en <=90 zijn wanneer softDelete is >ingeschakeld, anders 0.
recoveryLevel	DeletionRecoveryLevel	Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor geheimen in de huidige kluis. Als het 'Opschoonbaar' bevat, kan het geheim permanent worden verwijderd door een bevoegde gebruiker; Anders kan alleen het systeem het geheim aan het einde van het retentie-interval opschonen.
updated	integer	Tijdstip laatst bijgewerkt in UTC.