Get Secrets - Get Secrets

Odwołanie

Service:: Key Vault

API Version:: 7.4

Wyświetlanie listy wpisów tajnych w określonym magazynie kluczy.
Operacja Pobieranie wpisów tajnych ma zastosowanie do całego magazynu. Jednak w odpowiedzi podano tylko podstawowy identyfikator wpisu tajnego i jego atrybuty. Poszczególne wersje wpisów tajnych nie są wymienione w odpowiedzi. Ta operacja wymaga uprawnień do wpisów tajnych/listy.

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

With optional parameters:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
vaultBaseUrl	path	True	string	Nazwa magazynu, na przykład https://myvault.vault.azure.net.
api-version	query	True	string	Wersja interfejsu API klienta.
maxresults	query		integer int32	Maksymalna liczba wyników do zwrócenia na stronie. Jeśli nie zostanie określony, usługa zwróci maksymalnie 25 wyników.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SecretListResult	Komunikat odpowiedzi zawierający listę wpisów tajnych w magazynie wraz z linkiem do następnej strony wpisów tajnych.
Other Status Codes	KeyVaultError	Key Vault odpowiedź o błędzie opisująca, dlaczego operacja nie powiodła się.

Przykłady

GetSecrets

Sample Request

HTTP

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

Sample Response

Status code:: 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"
}

Definicje

Nazwa	Opis
DeletionRecoveryLevel	Odzwierciedla obecnie poziom odzyskiwania usuwania dla wpisów tajnych w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", wpis tajny może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić wpis tajny na końcu interwału przechowywania.
Error	Błąd serwera magazynu kluczy.
KeyVaultError	Wyjątek błędu magazynu kluczy.
SecretAttributes	Atrybuty zarządzania wpisami tajnymi.
SecretItem	Element wpisu tajnego zawierający metadane wpisu tajnego.
SecretListResult	Wynik listy wpisów tajnych.

DeletionRecoveryLevel

Odzwierciedla obecnie poziom odzyskiwania usuwania dla wpisów tajnych w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", wpis tajny może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić wpis tajny na końcu interwału przechowywania.

Nazwa	Typ	Opis
CustomizedRecoverable	string	Określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania, gdy 7<= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania i gdy subskrypcja jest nadal dostępna.
CustomizedRecoverable+ProtectedSubscription	string	Określa magazyn i stan subskrypcji, w którym usunięcie jest możliwe do odzyskania, natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) jest niedozwolone i w którym sama subskrypcja nie może zostać trwale anulowana, gdy 7<= SoftDeleteRetentionInDays < 90. Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania, a także odzwierciedla fakt, że sama subskrypcja nie może zostać anulowana.
CustomizedRecoverable+Purgeable	string	Określa stan magazynu, w którym można odzyskać usunięcie, a także zezwala na natychmiastowe i trwałe usunięcie (tj. przeczyszczanie, gdy 7<= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania, chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana.
Purgeable	string	Określa stan magazynu, w którym usunięcie jest nieodwracalną operacją bez możliwości odzyskiwania. Ten poziom nie odpowiada działaniu ochrony przed operacją Usuwania; dane są nieodwracalnie utracone po zaakceptowaniu operacji Usuń na poziomie jednostki lub wyższym (magazyn, grupa zasobów, subskrypcja itp.)
Recoverable	string	Określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni) i gdy subskrypcja jest nadal dostępna. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane
Recoverable+ProtectedSubscription	string	Określa magazyn i stan subskrypcji, w którym usunięcie można odzyskać w interwale przechowywania (90 dni), natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) nie jest dozwolone i w którym sama subskrypcja nie może zostać trwale anulowana. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane
Recoverable+Purgeable	string	Określa stan magazynu, w którym można odzyskać usunięcie, a także zezwala na natychmiastowe i trwałe usunięcie (tj. przeczyszczanie). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni), chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane

Error

Błąd serwera magazynu kluczy.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	Error	Błąd serwera magazynu kluczy.
message	string	Komunikat o błędzie.

KeyVaultError

Wyjątek błędu magazynu kluczy.

Nazwa	Typ	Opis
error	Error	Błąd serwera magazynu kluczy.

SecretAttributes

Atrybuty zarządzania wpisami tajnymi.

Nazwa	Typ	Opis
created	integer	Czas tworzenia w formacie UTC.
enabled	boolean	Określa, czy obiekt jest włączony.
exp	integer	Data wygaśnięcia w formacie UTC.
nbf	integer	Nie wcześniej niż data w formacie UTC.
recoverableDays	integer	softDelete data retention days (dni przechowywania danych softDelete). Wartość powinna mieć wartość >=7 i <=90, gdy funkcja softDelete jest włączona, w przeciwnym razie wartość 0.
recoveryLevel	DeletionRecoveryLevel	Odzwierciedla obecnie poziom odzyskiwania usuwania dla wpisów tajnych w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", wpis tajny może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić wpis tajny na końcu interwału przechowywania.
updated	integer	Czas ostatniej aktualizacji w formacie UTC.

SecretItem

Element wpisu tajnego zawierający metadane wpisu tajnego.

Nazwa	Typ	Opis
attributes	SecretAttributes	Atrybuty zarządzania wpisami tajnymi.
contentType	string	Typ wartości wpisu tajnego, takiej jak hasło.
id	string	Identyfikator wpisu tajnego.
managed	boolean	Prawda, jeśli okres istnienia wpisu tajnego jest zarządzany przez magazyn kluczy. Jeśli jest to klucz kopii zapasowej certyfikatu, zarządzanie będzie prawdziwe.
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

SecretListResult

Wynik listy wpisów tajnych.

Nazwa	Typ	Opis
nextLink	string	Adres URL umożliwiający pobranie następnego zestawu wpisów tajnych.
value	SecretItem[]	Komunikat odpowiedzi zawierający listę wpisów tajnych w magazynie kluczy wraz z linkiem do następnej strony wpisów tajnych.