Get Secrets - Get Secrets

Referens

Tjänst:: Key Vault

API-version:: 7.4

Lista hemligheter i ett angivet nyckelvalv.
Åtgärden Hämta hemligheter gäller för hela valvet. Men endast den grundläggande hemliga identifieraren och dess attribut anges 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=7.4

Med valfria parametrar:

GET {vaultBaseUrl}/secrets?maxresults={maxresults}&api-version=7.4

URI-parametrar

Name	I	Obligatorisk	Typ	Description
vaultBaseUrl	path	True	string	Valvnamnet, till exempel https://myvault.vault.azure.net.
api-version	query	True	string	Klient-API-version.
maxresults	query		integer int32	Maximalt antal resultat som ska returneras på en sida. Om inte anges returnerar tjänsten upp till 25 resultat.

Svar

Name	Typ	Description
200 OK	SecretListResult	Ett svarsmeddelande som innehåller en lista över hemligheter i valvet tillsammans med en länk till nästa sida med hemligheter.
Other Status Codes	KeyVaultError	Key Vault felsvar som beskriver varför åtgärden misslyckades.

Exempel

GetSecrets

Exempelbegäran

HTTP

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

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	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 endast systemet rensa hemligheten i slutet av kvarhållningsintervallet.
Error	Nyckelvalvsserverfelet.
KeyVaultError	Felfelet för nyckelvalvet.
SecretAttributes	De hemliga hanteringsattributen.
SecretItem	Det hemliga objektet som innehåller hemliga metadata.
SecretListResult	Resultatet av den hemliga listan.

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 endast 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ällningen av 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 (dvs. 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 även 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ällningen av 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återkalleligen 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 (dvs. 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 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 (dvs. rensning) är inte tillåtet 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 (t.ex. 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 prenumerationen avbryts. Systemet tar bort det permanent efter 90 dagar, om det inte återställs

Error

Nyckelvalvsserverfelet.

Name	Typ	Description
code	string	Felkoden.
innererror	Error	Nyckelvalvsserverfelet.
message	string	Felmeddelandet.

KeyVaultError

Felfelet för nyckelvalvet.

Name	Typ	Description
error	Error	Nyckelvalvsserverfelet.

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	softTa bort datakvarhållningsdagar. 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 endast systemet rensa hemligheten i slutet av kvarhållningsintervallet.
updated	integer	Senast uppdaterad tid i UTC.

SecretItem

Det hemliga objektet som innehåller hemliga metadata.

Name	Typ	Description
attributes	SecretAttributes	De hemliga hanteringsattributen.
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 är hanterad sant.
tags	object	Programspecifika metadata i form av nyckel/värde-par.

SecretListResult

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.

Dela via