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ämtar.

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	När du lägger till versionsparametern hämtas en specifik version av en nyckel. Det här URI-fragmentet är valfritt. Om den inte 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-serverfelet.
JsonWebKey	Från och med http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Elliptisk kurva. Giltiga värden finns i JsonWebKeyCurveName.
JsonWebKeyType	JsonWebKey-nyckeltyp (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 som nyckeln kan exporteras under.
KeyVaultError	Felfelet för nyckelvalvet.

DeletionRecoveryLevel

Uppräkning

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.

Värde	Description
CustomizedRecoverable	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	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	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	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 godkänns på entitetsnivå eller högre (valv, resursgrupp, prenumeration osv.)
Recoverable	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	Anger ett valv- och prenumerationstillstånd där borttagningen kan återställas inom kvarhållningsintervallet (90 dagar), omedelbar och permanent borttagning (dvs. rensning) tillåts inte 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	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ä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

Objekt

Key Vault-serverfelet.

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

JsonWebKey

Objekt

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

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

JsonWebKeyCurveName

Uppräkning

Elliptisk kurva. Giltiga värden finns i JsonWebKeyCurveName.

Värde	Description
P-256	NIST P-256 elliptisk kurva, AKA SECG kurva SECP256R1.
P-256K	SECG SECP256K1 elliptisk kurva.
P-384	NIST P-384 elliptisk kurva, AKA SECG kurva SECP384R1.
P-521	NIST P-521 elliptisk kurva, AKA SECG kurva SECP521R1.

JsonWebKeyType

Uppräkning

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

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

KeyAttributes

Objekt

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

Name	Typ	Description
created	integer (unixtime)	Skapandetid i UTC.
enabled	boolean	Avgör om objektet är aktiverat.
exp	integer (unixtime)	Utgångsdatum 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 (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	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 (unixtime)	Senast uppdaterad tid i UTC.

KeyBundle

Objekt

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 som nyckeln kan exporteras under.
tags	object	Programspecifika metadata i form av nyckel/värde-par.

KeyReleasePolicy

Objekt

De principregler som nyckeln kan exporteras under.

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

KeyVaultError

Objekt

Felfelet för nyckelvalvet.

Name	Typ	Description
error	Error	Key Vault-serverfelet.

Dela via

Get Key - Get Key

URI-parametrar

Svar

Exempel

Get key

Exempelbegäran

Exempelsvar

Definitioner

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyType

KeyAttributes

KeyBundle

KeyReleasePolicy

KeyVaultError

Ytterligare resurser