Dela via

Get Deleted Secret - Get Deleted Secret

Tjänst:
Key Vault
API-version:
2025-07-01

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 hemligheter/hämtar.

GET {vaultBaseUrl}/deletedsecrets/{secret-name}?api-version=2025-07-01

URI-parametrar

Name I Obligatorisk Typ Description
secret-name
 path True

string

Namnet på hemligheten.
vaultBaseUrl
 path True

string (uri)

api-version
 query True

string

minLength: 1

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

DeletedSecretBundle

Begäran har slutförts.
Other Status Codes

KeyVaultError

Ett oväntat felsvar.

Säkerhet

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Exempel

GetDeletedSecret

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
DeletedSecretBundle

En borttagen hemlighet som består av dess tidigare id, attribut och dess taggar, samt information om när den kommer att rensas.
DeletionRecoveryLevel

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

Felundantaget för nyckelvalvet.
SecretAttributes

Attributen för hemlighetshantering.

DeletedSecretBundle

Objekt

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

Name Typ Description
attributes

SecretAttributes

Attributen för hemlighetshantering.
contentType

string

Hemlighetens innehållstyp.
deletedDate

integer (unixtime)

Tiden då hemligheten togs bort, i UTC
id

string

Det hemliga id:t.
kid

string

Om det här är en hemlighet som backar upp ett KV-certifikat anger det här fältet motsvarande nyckel som backar upp KV-certifikatet.
managed

boolean

Sant om hemlighetens livslängd hanteras av nyckelvalvet. Om det här är en hemlighet som stöder ett certifikat kommer managed att vara true.
previousVersion

string

Versionen av det tidigare certifikatet, om tillämpligt. Gäller endast för certifikat som skapats efter den 1 juni 2025. Certifikat som skapats före detta datum uppdateras inte retroaktivt.
recoveryId

string

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

integer (unixtime)

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

Uppräkning

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

Värde Description
Purgeable

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 det inte finns något skydd mot en borttagningsåtgärd. data går oåterkalleligt förlorade när du accepterar en borttagningsåtgärd på entitetsnivå eller högre (valv, resursgrupp, prenumeration osv.)
Recoverable+Purgeable

Betecknar ett valvtillstånd där borttagning kan återställas och som även tillåter omedelbar och permanent borttagning (d.v.s. rensning). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet (90 dagar), såvida inte en rensningsåtgärd begärs eller om prenumerationen avbryts. Systemet kommer att ta bort det permanent efter 90 dagar, om det inte återställs
Recoverable

Betecknar 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ällningen av den borttagna entiteten under kvarhållningsintervallet (90 dagar) och medan prenumerationen fortfarande är tillgänglig. Systemet kommer att ta bort det permanent efter 90 dagar, om det inte återställs
Recoverable+ProtectedSubscription

Anger ett valv- och prenumerationstillstånd där borttagningen 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 kommer att ta bort det permanent efter 90 dagar, om det inte återställs
CustomizedRecoverable+Purgeable

Betecknar ett valvtillstånd där borttagning kan återställas och som även tillåter omedelbar och permanent borttagning (d.v.s. rensning när 7 <= SoftDeleteRetentionInDays < 90). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet, såvida inte en rensningsåtgärd begärs eller prenumerationen avbryts.
CustomizedRecoverable

Anger ett valvtillstånd där borttagningen kan återställas utan möjlighet till omedelbar och permanent borttagning (d.v.s. rensning när 7 <= SoftDeleteRetentionInDays < 90). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet och medan prenumerationen fortfarande är tillgänglig.
CustomizedRecoverable+ProtectedSubscription

Betecknar ett valv- och prenumerationstillstånd där borttagning kan återställas, omedelbar och permanent borttagning (d.v.s. rensning) inte är tillåten 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 även det faktum att själva prenumerationen inte kan avbrytas.

Error

Objekt
Name Typ Description
code

string

Felkoden.
innererror

Error

Felet på nyckelvalvsservern.
message

string

Felmeddelandet.

KeyVaultError

Objekt

Felundantaget för nyckelvalvet.

Name Typ Description
error

Error

Felet på nyckelvalvsservern.

SecretAttributes

Objekt

Attributen för hemlighetshantering.

Name Typ Description
created

integer (unixtime)

Skapandetid i UTC.
enabled

boolean

Avgör om objektet är aktiverat.
exp

integer (unixtime)

Utgångsdatum i UTC.
nbf

integer (unixtime)

Inte före datum i UTC.
recoverableDays

integer (int32)

softTa bort datakvarhållningsdagar. Värdet ska vara >=7 och <=90 när softDelete är aktiverat, annars 0.
recoveryLevel

DeletionRecoveryLevel

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

integer (unixtime)

Tid för senaste uppdatering i UTC.