Dela via


Get Deleted Secret - Get Deleted Secret

Hämtar den angivna borttagna hemligheten.
Åtgärden Hämta borttagen hemlighet returnerar den angivna borttagna hemligheten tillsammans med dess attribut. Den här åtgärden kräver behörigheten secrets/get.

GET {vaultBaseUrl}/deletedsecrets/{secret-name}?api-version=7.4

URI-parametrar

Name I Obligatorisk Typ Description
secret-name
path True

string

Namnet på hemligheten.

vaultBaseUrl
path True

string

Valvnamnet, till exempel https://myvault.vault.azure.net.

api-version
query True

string

Klient-API-version.

Svar

Name Typ Description
200 OK

DeletedSecretBundle

Ett hemligt paket med hemligheten och dess attribut.

Other Status Codes

KeyVaultError

Key Vault felsvar som beskriver varför åtgärden misslyckades.

Exempel

GetDeletedSecret

Exempelbegäran

GET https://myvault.vault.azure.net//deletedsecrets/GetDeletedSecretTest?api-version=7.4

Exempelsvar

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

Definitioner

Name Description
DeletedSecretBundle

En borttagen hemlighet som består av dess tidigare ID, attribut och taggar, samt information om när den ska rensas.

DeletionRecoveryLevel

Visar den återställningsnivå för borttagning som för närvarande gäller för hemligheter i det aktuella valvet. Om den innehåller "Purgeable" kan hemligheten tas bort permanent av en privilegierad användare. Annars kan bara systemet rensa hemligheten i slutet av kvarhållningsintervallet.

Error

Key Vault-serverns fel.

KeyVaultError

Felfelet för nyckelvalvet.

SecretAttributes

De hemliga hanteringsattributen.

DeletedSecretBundle

En borttagen hemlighet som består av dess tidigare ID, attribut och taggar, samt information om när den ska rensas.

Name Typ Description
attributes

SecretAttributes

De hemliga hanteringsattributen.

contentType

string

Hemlighetens innehållstyp.

deletedDate

integer

Tiden då hemligheten togs bort i UTC

id

string

Det hemliga ID:t.

kid

string

Om det här är en hemlighet som stöder ett KV-certifikat anger det här fältet motsvarande nyckel som stöder KV-certifikatet.

managed

boolean

Sant om hemlighetens livslängd hanteras av nyckelvalvet. Om det här är en hemlighet som säkerhetskopierar ett certifikat är hanterad sant.

recoveryId

string

URL:en för återställningsobjektet som används för att identifiera och återställa den borttagna hemligheten.

scheduledPurgeDate

integer

Den tid då hemligheten är schemalagd att rensas i UTC

tags

object

Programspecifika metadata i form av nyckel/värde-par.

value

string

Det hemliga värdet.

DeletionRecoveryLevel

Visar den återställningsnivå för borttagning som för närvarande gäller för hemligheter i det aktuella valvet. Om den innehåller "Purgeable" kan hemligheten tas bort permanent av en privilegierad användare. Annars kan bara systemet rensa hemligheten i slutet av kvarhållningsintervallet.

Name Typ Description
CustomizedRecoverable

string

Anger ett valvtillstånd där borttagning kan återställas utan möjlighet till omedelbar och permanent borttagning (dvs. rensa när 7<= SoftDeleteRetentionInDays < 90). Den här nivån garanterar återställningsbarheten för den borttagna entiteten under kvarhållningsintervallet och medan prenumerationen fortfarande är tillgänglig.

CustomizedRecoverable+ProtectedSubscription

string

Anger ett valv- och prenumerationstillstånd där borttagning kan återställas, omedelbar och permanent borttagning (d.v.s. rensning) tillåts inte och där själva prenumerationen inte kan avbrytas permanent när 7< = SoftDeleteRetentionInDays < 90. Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet och återspeglar också det faktum att själva prenumerationen inte kan avbrytas.

CustomizedRecoverable+Purgeable

string

Anger ett valvtillstånd där borttagning kan återställas och som också tillåter omedelbar och permanent borttagning (dvs. rensa när 7<= SoftDeleteRetentionInDays < 90). Den här nivån garanterar återställningsmöjligheten för den borttagna entiteten under kvarhållningsintervallet, såvida inte en rensningsåtgärd begärs eller prenumerationen avbryts.

Purgeable

string

Anger ett valvtillstånd där borttagning är en oåterkallelig åtgärd, utan möjlighet till återställning. Den här nivån motsvarar att inget skydd är tillgängligt mot en borttagningsåtgärd. data går oåterkalleligt förlorade när en borttagningsåtgärd accepteras på entitetsnivå eller högre (valv, resursgrupp, prenumeration osv.)

Recoverable

string

Anger ett valvtillstånd där borttagning kan återställas utan möjlighet till omedelbar och permanent borttagning (d.v.s. rensning). Den här nivån garanterar återställning av den borttagna entiteten under kvarhållningsintervallet (90 dagar) och medan prenumerationen fortfarande är tillgänglig. Systemet tar bort det permanent efter 90 dagar, om det inte återställs

Recoverable+ProtectedSubscription

string

Anger ett valv- och prenumerationstillstånd där borttagning kan återställas inom kvarhållningsintervallet (90 dagar), omedelbar och permanent borttagning (d.v.s. rensning) inte tillåts och där själva prenumerationen inte kan avbrytas permanent. Systemet tar bort det permanent efter 90 dagar, om det inte återställs

Recoverable+Purgeable

string

Anger ett valvtillstånd där borttagning kan återställas och som också tillåter omedelbar och permanent borttagning (dvs. rensning). Den här nivån garanterar återställningsmöjligheten för den borttagna entiteten under kvarhållningsintervallet (90 dagar), såvida inte en rensningsåtgärd begärs eller prenumerationen avbryts. Systemet tar bort det permanent efter 90 dagar, om det inte återställs

Error

Key Vault-serverns fel.

Name Typ Description
code

string

Felkoden.

innererror

Error

Key Vault-serverns fel.

message

string

Felmeddelandet.

KeyVaultError

Felfelet för nyckelvalvet.

Name Typ Description
error

Error

Key Vault-serverns fel.

SecretAttributes

De hemliga hanteringsattributen.

Name Typ Description
created

integer

Skapandetid i UTC.

enabled

boolean

Avgör om objektet är aktiverat.

exp

integer

Förfallodatum i UTC.

nbf

integer

Inte före datum i UTC.

recoverableDays

integer

softDelete data retention days. Värdet ska vara >=7 och <=90 när softDelete är aktiverat, annars 0.

recoveryLevel

DeletionRecoveryLevel

Visar den återställningsnivå för borttagning som för närvarande gäller för hemligheter i det aktuella valvet. Om den innehåller "Purgeable" kan hemligheten tas bort permanent av en privilegierad användare. Annars kan bara systemet rensa hemligheten i slutet av kvarhållningsintervallet.

updated

integer

Senast uppdaterad tid i UTC.