Get Key - Get Key

Referens

Tjänst:: Key Vault

API-version:: 7.4

Hämtar den offentliga delen av en lagrad nyckel.
Åtgärden hämta nyckel gäller för alla nyckeltyper. Om den begärda nyckeln är symmetrisk frigörs inget nyckelmaterial i svaret. Den här åtgärden kräver behörigheten nycklar/hämta.

GET {vaultBaseUrl}/keys/{key-name}/{key-version}?api-version=7.4

URI-parametrar

Name	I	Obligatorisk	Typ	Description
key-name	path	True	string	Namnet på nyckeln som ska hämtas.
key-version	path	True	string	Om du lägger till versionsparametern hämtas en specifik version av en nyckel. Det här URI-fragmentet är valfritt. Om inget anges returneras den senaste versionen av nyckeln.
vaultBaseUrl	path	True	string	Valvnamnet, till exempel https://myvault.vault.azure.net.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	KeyBundle	Ett nyckelpaket som innehåller nyckeln och dess attribut.
Other Status Codes	KeyVaultError	Key Vault felsvar som beskriver varför åtgärden misslyckades.

Exempel

Get key

Exempelbegäran

HTTP

GET https://myvault.vault.azure.net//keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71?api-version=7.4

Exempelsvar

Statuskod:: 200

{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71",
    "kty": "RSA",
    "key_ops": [
      "encrypt",
      "decrypt",
      "sign",
      "verify",
      "wrapKey",
      "unwrapKey"
    ],
    "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": true,
    "created": 1493942451,
    "updated": 1493942451,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "purpose": "unit test",
    "test name ": "CreateGetDeleteKeyTest"
  }
}

Definitioner

Name	Description
DeletionRecoveryLevel	Visar den återställningsnivå för borttagning som för närvarande gäller för nycklar i det aktuella valvet. Om den innehåller "Rensningsbar" kan nyckeln tas bort permanent av en privilegierad användare. Annars kan bara systemet rensa nyckeln i slutet av kvarhållningsintervallet.
Error	Key Vault-serverns fel.
JsonWebKey	Från och med http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Namn på elliptisk kurva. Giltiga värden finns i JsonWebKeyCurveName.
JsonWebKeyType	Nyckeltyp för JsonWebKey (kty), enligt definitionen i https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes	Attributen för en nyckel som hanteras av key vault-tjänsten.
KeyBundle	En KeyBundle som består av en WebKey plus dess attribut.
KeyReleasePolicy	De principregler enligt vilka nyckeln kan exporteras.
KeyVaultError	Felfelet för nyckelvalvet.

DeletionRecoveryLevel

Visar den återställningsnivå för borttagning som för närvarande gäller för nycklar i det aktuella valvet. Om den innehåller "Rensningsbar" kan nyckeln tas bort permanent av en privilegierad användare. Annars kan bara systemet rensa nyckeln 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ällningsbarheten för 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 (d.v.s. 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 också 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ällningsmöjligheten för 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återkalleligt 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 (d.v.s. rensning). Den här nivån garanterar återställning 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 (d.v.s. rensning) inte tillåts 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 (dvs. rensning). Den här nivån garanterar återställningsmöjligheten för 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

Key Vault-serverns fel.

Name	Typ	Description
code	string	Felkoden.
innererror	Error	Key Vault-serverns fel.
message	string	Felmeddelandet.

JsonWebKey

Från och med http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Name	Typ	Description
crv	JsonWebKeyCurveName	Namn på elliptisk kurva. Giltiga värden finns i JsonWebKeyCurveName.
d	string	Privat RSA-exponent eller D-komponenten i en privat EC-nyckel.
dp	string	RSA-parameter för privat nyckel.
dq	string	RSA-parameter för privat nyckel.
e	string	Offentlig RSA-exponent.
k	string	Symmetrisk nyckel.
key_hsm	string	Skyddad nyckel, som används med "Bring Your Own Key".
key_ops	string[]	Nyckelåtgärder som stöds.
kid	string	Nyckelidentifierare.
kty	JsonWebKeyType	Nyckeltyp för JsonWebKey (kty), enligt definitionen i https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n	string	RSA-modulus.
p	string	RSA hemlig prime.
q	string	RSA secret prime, med p < q.
qi	string	RSA-parameter för privat nyckel.
x	string	X-komponent i en offentlig EG-nyckel.
y	string	Y-komponenten i en offentlig EG-nyckel.

JsonWebKeyCurveName

Namn på elliptisk kurva. Giltiga värden finns i JsonWebKeyCurveName.

Name	Typ	Description
P-256	string	NIST P-256 elliptisk kurva, AKA SECG kurva SECP256R1.
P-256K	string	SECG SECP256K1 elliptisk kurva.
P-384	string	NIST P-384 elliptisk kurva, AKA SECG kurva SECP384R1.
P-521	string	NIST P-521 elliptisk kurva, AKA SECG kurva SECP521R1.

JsonWebKeyType

Nyckeltyp för JsonWebKey (kty), enligt definitionen i https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Name	Typ	Description
EC	string	Elliptisk kurva.
EC-HSM	string	Elliptisk kurva med en privat nyckel som lagras i HSM.
RSA	string	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	string	RSA med en privat nyckel som lagras i HSM.
oct	string	Oktettsekvens (används för att representera symmetriska nycklar)
oct-HSM	string	Oktettsekvens (används för att representera symmetriska nycklar) som lagras på HSM.

KeyAttributes

Attributen för en nyckel som hanteras av key vault-tjänsten.

Name	Typ	Description
created	integer	Skapandetid i UTC.
enabled	boolean	Avgör om objektet är aktiverat.
exp	integer	Förfallodatum i UTC.
exportable	boolean	Anger om den privata nyckeln kan exporteras. Versionsprincip måste anges när du skapar den första versionen av en exporterbar nyckel.
nbf	integer	Inte före datum i UTC.
recoverableDays	integer	softDelete data retention days. 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 nycklar i det aktuella valvet. Om den innehåller "Rensningsbar" kan nyckeln tas bort permanent av en privilegierad användare. Annars kan bara systemet rensa nyckeln i slutet av kvarhållningsintervallet.
updated	integer	Senast uppdaterad tid i UTC.

KeyBundle

En KeyBundle som består av en WebKey plus dess attribut.

Name	Typ	Description
attributes	KeyAttributes	Nyckelhanteringsattributen.
key	JsonWebKey	Json-webbnyckeln.
managed	boolean	Sant om nyckelns livslängd hanteras av nyckelvalvet. Om det här är en nyckel som säkerhetskopierar ett certifikat är hanterad sant.
release_policy	KeyReleasePolicy	De principregler enligt vilka nyckeln kan exporteras.
tags	object	Programspecifika metadata i form av nyckel/värde-par.

KeyReleasePolicy

De principregler enligt vilka nyckeln kan exporteras.

Name	Typ	Standardvärde	Description
contentType	string	application/json; charset=utf-8	Innehållstyp och version av nyckelfrisläppningsprincip
data	string		Blobkodning av principreglerna som nyckeln kan släppas under. Bloben måste vara base64 URL-kodad.
immutable	boolean		Definierar principens föränderlighetstillstånd. När den här flaggan har markerats som oföränderlig kan den inte återställas och principen kan inte ändras under några omständigheter.

KeyVaultError

Felfelet för nyckelvalvet.

Name	Typ	Description
error	Error	Key Vault-serverns fel.

Dela via