Get Secrets - Get Secrets

Tjänst:

Key Vault

API-version:

2025-07-01

Visa en lista över hemligheter i ett angivet nyckelvalv.
Åtgärden Hämta hemligheter gäller för hela valvet. Endast den grundläggande hemliga identifieraren och dess attribut tillhandahålls dock i svaret. Enskilda hemliga versioner visas inte i svaret. Den här åtgärden kräver behörigheten hemligheter/lista.

GET {vaultBaseUrl}/secrets?api-version=2025-07-01

Med valfria parametrar:

GET {vaultBaseUrl}/secrets?api-version=2025-07-01&maxresults={maxresults}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
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.
maxresults	query		integer (int32) minimum: 1 maximum: 25	Maximalt antal resultat som ska returneras på en sida. Om inget anges returnerar tjänsten upp till 25 resultat.

Svar

Name	Typ	Description
200 OK	SecretListResult	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

GetSecrets

Exempelbegäran

HTTP

GET https://myvault.vault.azure.net//secrets?api-version=2025-07-01&maxresults=1

Exempelsvar

Statuskod:

200

{
  "value": [
    {
      "contentType": "plainText",
      "id": "https://myvault.vault.azure.net/secrets/listsecrettest0",
      "attributes": {
        "enabled": true,
        "created": 1482189047,
        "updated": 1482189047
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/secrets?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE4OCFNREF3TURJeUlYTmxZM0psZEM5TVNWTlVVMFZEVWtWVVZFVlRWREVoTURBd01ESTRJVEl3TVRZdE1USXRNVGxVTWpNNk1UQTZORFV1T0RneE9ERXhNRm9oIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1"
}

Definitioner

Name	Description
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.
SecretItem	Det hemliga objektet som innehåller hemliga metadata.
SecretListResult	Resultatet av den hemliga listan.

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.

SecretItem

Objekt

Det hemliga objektet som innehåller hemliga metadata.

Name	Typ	Description
attributes	SecretAttributes	Attributen för hemlighetshantering.
contentType	string	Typ av hemligt värde, till exempel ett lösenord.
id	string	Hemlig identifierare.
managed	boolean	Sant om hemlighetens livslängd hanteras av nyckelvalvet. Om det här är en nyckel som stöder ett certifikat kommer managed att vara true.
tags	object	Programspecifika metadata i form av nyckel/värde-par.

SecretListResult

Objekt

Resultatet av den hemliga listan.

Name	Typ	Description
nextLink	string	URL:en för att hämta nästa uppsättning hemligheter.
value	SecretItem[]	Ett svarsmeddelande som innehåller en lista över hemligheter i nyckelvalvet tillsammans med en länk till nästa sida med hemligheter.