Delen via


Get Keys - Get Keys

Sleutels in de opgegeven kluis weergeven.
Haalt een lijst op van de sleutels in de Key Vault als JSON-websleutelstructuren die het openbare deel van een opgeslagen sleutel bevatten. De list-bewerking is van toepassing op alle sleuteltypen, maar alleen de basissleutel-id, kenmerken en tags worden opgegeven in het antwoord. Afzonderlijke versies van een sleutel worden niet vermeld in het antwoord. Voor deze bewerking is de machtiging sleutels/lijsten vereist.

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

URI-parameters

Name In Vereist Type Description
vaultBaseUrl
path True

string

De kluisnaam, bijvoorbeeld https://myvault.vault.azure.net.

api-version
query True

string

Client-API-versie.

maxresults
query

integer

int32

Maximum aantal resultaten dat op een pagina moet worden geretourneerd. Als dit niet is opgegeven, retourneert de service maximaal 25 resultaten.

Antwoorden

Name Type Description
200 OK

KeyListResult

Een antwoordbericht met een lijst met sleutels in de kluis, samen met een koppeling naar de volgende pagina met sleutels.

Other Status Codes

KeyVaultError

Key Vault foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

GetKeys

Voorbeeldaanvraag

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

Voorbeeldrespons

{
  "value": [
    {
      "kid": "https://myvault.vault.azure.net/keys/sdktestkey",
      "attributes": {
        "enabled": true,
        "created": 1493937656,
        "updated": 1493937656,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/keys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE5NiFNREF3TURJM0lXdGxlUzlWVUVSQlZFVkxSVmxCVkZSU1NVSlZWRVZUVkVWVFZDRXdNREF3TWpnaE1qQXhOeTB3TlMwd05GUXdNVG94TVRveE5pNDNNekE0TnpReVdpRS0iLCJUYXJnZXRMb2NhdGlvbiI6MH0&maxresults=1"
}

Definities

Name Description
DeletionRecoveryLevel

Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor sleutels in de huidige kluis. Als deze 'Opschoonbaar' bevat, kan de sleutel permanent worden verwijderd door een bevoegde gebruiker; Anders kan alleen het systeem de sleutel aan het einde van het retentie-interval leegmaken.

Error

De sleutelkluisserverfout.

KeyAttributes

De kenmerken van een sleutel die wordt beheerd door de sleutelkluisservice.

KeyItem

Het sleutelitem met sleutelmetagegevens.

KeyListResult

Het resultaat van de sleutellijst.

KeyVaultError

De foutuitzondering voor de sleutelkluis.

DeletionRecoveryLevel

Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor sleutels in de huidige kluis. Als deze 'Opschoonbaar' bevat, kan de sleutel permanent worden verwijderd door een bevoegde gebruiker; Anders kan alleen het systeem de sleutel aan het einde van het retentie-interval leegmaken.

Name Type Description
CustomizedRecoverable

string

Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (dat wil zeggen opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en zolang het abonnement nog beschikbaar is.

CustomizedRecoverable+ProtectedSubscription

string

Geeft een kluis- en abonnementstatus aan waarin verwijdering kan worden hersteld, onmiddellijke en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet definitief kan worden geannuleerd wanneer 7<= SoftDeleteRetentionInDays < 90. Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en weerspiegelt ook het feit dat het abonnement zelf niet kan worden geannuleerd.

CustomizedRecoverable+Purgeable

string

Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (dat wil zeggen opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval, tenzij een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd.

Purgeable

string

Geeft een kluisstatus aan waarin het verwijderen een onomkeerbare bewerking is, zonder de mogelijkheid voor herstel. Dit niveau komt overeen met het feit dat er geen bescherming beschikbaar is tegen een Verwijderbewerking; de gegevens gaan onherroepelijk verloren bij het accepteren van een verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement, enzovoort)

Recoverable

string

Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (dat wil zeggen opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen) en zolang het abonnement nog beschikbaar is. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld

Recoverable+ProtectedSubscription

string

Geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld binnen een retentieperiode (90 dagen), directe en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet definitief kan worden geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld

Recoverable+Purgeable

string

Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (dat wil zeggen leegmaken). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen), tenzij een opschoonbewerking wordt aangevraagd of het abonnement wordt geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld

Error

De sleutelkluisserverfout.

Name Type Description
code

string

De foutcode.

innererror

Error

De sleutelkluisserverfout.

message

string

Het foutbericht.

KeyAttributes

De kenmerken van een sleutel die wordt beheerd door de sleutelkluisservice.

Name Type Description
created

integer

Aanmaaktijd in UTC.

enabled

boolean

Bepaalt of het object is ingeschakeld.

exp

integer

Vervaldatum in UTC.

exportable

boolean

Geeft aan of de persoonlijke sleutel kan worden geëxporteerd. Releasebeleid moet worden opgegeven bij het maken van de eerste versie van een exporteerbare sleutel.

nbf

integer

Niet vóór datum in UTC.

recoverableDays

integer

softDelete dagen voor gegevensretentie. De waarde moet =7 en <=90 zijn wanneer softDelete is >ingeschakeld, anders 0.

recoveryLevel

DeletionRecoveryLevel

Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor sleutels in de huidige kluis. Als deze 'Opschoonbaar' bevat, kan de sleutel permanent worden verwijderd door een bevoegde gebruiker; Anders kan alleen het systeem de sleutel aan het einde van het retentie-interval leegmaken.

updated

integer

Tijdstip laatst bijgewerkt in UTC.

KeyItem

Het sleutelitem met sleutelmetagegevens.

Name Type Description
attributes

KeyAttributes

De kenmerken van sleutelbeheer.

kid

string

Sleutel-id.

managed

boolean

Is waar als de levensduur van de sleutel wordt beheerd door de sleutelkluis. Als dit een sleutel is die een back-up vormt van een certificaat, is beheerd true.

tags

object

Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen.

KeyListResult

Het resultaat van de sleutellijst.

Name Type Description
nextLink

string

De URL voor het ophalen van de volgende set sleutels.

value

KeyItem[]

Een antwoordbericht met een lijst met sleutels in de sleutelkluis, samen met een koppeling naar de volgende pagina met sleutels.

KeyVaultError

De foutuitzondering voor de sleutelkluis.

Name Type Description
error

Error

De sleutelkluisserverfout.