Get Key - Get Key

Hizmet:: Key Vault

API Sürümü:: 7.4

Depolanan anahtarın ortak bölümünü alır.
Anahtar alma işlemi tüm anahtar türleri için geçerlidir. İstenen anahtar simetrikse, yanıtta hiçbir anahtar malzemesi serbest bırakılmaz. Bu işlem için anahtarlar/alma izni gerekir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
key-name	path	True	string	Alınacak anahtarın adı.
key-version	path	True	string	version parametresini eklemek anahtarın belirli bir sürümünü alır. Bu URI parçası isteğe bağlıdır. Belirtilmezse anahtarın en son sürümü döndürülür.
vaultBaseUrl	path	True	string	Kasa adı, örneğin `https://myvault.vault.azure.net`.
api-version	query	True	string	İstemci API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	KeyBundle	Anahtarı ve özniteliklerini içeren bir anahtar paketi.
Other Status Codes	KeyVaultError	İşlemin neden başarısız olduğunu açıklayan Key Vault hata yanıtı.

Örnekler

Get key

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 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"
  }
}

Tanımlar

Name	Description
DeletionRecoveryLevel	Geçerli kasadaki anahtarlar için geçerli olan silme kurtarma düzeyini yansıtır. 'Temizlenebilir' içeriyorsa anahtar ayrıcalıklı bir kullanıcı tarafından kalıcı olarak silinebilir; aksi takdirde, saklama aralığının sonunda anahtarı yalnızca sistem temizleyebilir.
Error	Anahtar kasası sunucusu hatası.
JsonWebKey	http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 itibariyle
JsonWebKeyCurveName	Elips eğrisi adı. Geçerli değerler için bkz. JsonWebKeyCurveName.
JsonWebKeyType	https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40'de tanımlandığı gibi JsonWebKey Anahtar Türü (kty).
KeyAttributes	Anahtar kasası hizmeti tarafından yönetilen bir anahtarın öznitelikleri.
KeyBundle	WebKey ve özniteliklerinden oluşan bir KeyBundle.
KeyReleasePolicy	Anahtarın dışarı aktarılabildiği ilke kuralları.
KeyVaultError	Anahtar kasası hata özel durumu.

DeletionRecoveryLevel

Listeleme

Geçerli kasadaki anahtarlar için geçerli olan silme kurtarma düzeyini yansıtır. 'Temizlenebilir' içeriyorsa anahtar ayrıcalıklı bir kullanıcı tarafından kalıcı olarak silinebilir; aksi takdirde, saklama aralığının sonunda anahtarı yalnızca sistem temizleyebilir.

Değer	Description
CustomizedRecoverable	Silme işleminin anında ve kalıcı silme olanağı olmadan kurtarılabilir olduğu bir kasa durumunu belirtir (örneğin, 7<= SoftDeleteRetentionInDays < 90 olduğunda temizleme). Bu düzey, saklama aralığı boyunca ve abonelik hala kullanılabilir durumdayken silinen varlığın kurtarılabilirliğini garanti eder.
CustomizedRecoverable+ProtectedSubscription	7<= SoftDeleteRetentionInDays < 90 olduğunda, silme işleminin kurtarılabilir, anında ve kalıcı silmeye (temizleme) izin verilmediği ve aboneliğin kendisinin kalıcı olarak iptal edilemeyeceği bir kasayı ve abonelik durumunu belirtir. Bu düzey, bekletme aralığı boyunca silinen varlığın kurtarılabilirliğini garanti eder ve ayrıca aboneliğin kendisinin iptal edilemediğini yansıtır.
CustomizedRecoverable+Purgeable	Silme işleminin kurtarılabilir olduğu ve anında ve kalıcı silmeye izin veren bir kasa durumunu belirtir (örneğin, 7<= SoftDeleteRetentionInDays < 90 olduğunda temizleme). Bu düzey, bir Temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece saklama aralığı boyunca silinen varlığın kurtarılabilirliğini garanti eder.
Purgeable	Kurtarma olasılığı olmadan silme işleminin geri alınamaz bir işlem olduğu kasa durumunu belirtir. Bu düzey, silme işlemine karşı kullanılabilir koruma olmamasına karşılık gelir; Varlık düzeyinde veya daha yüksek bir düzeyde (kasa, kaynak grubu, abonelik vb.) silme işlemi kabul edildikten sonra veriler kurtarılamaz şekilde kaybolur.
Recoverable	Silme işleminin anında ve kalıcı silme (temizleme) olasılığı olmadan kurtarılabilir olduğu bir kasa durumunu belirtir. Bu düzey, saklama aralığı (90 gün) boyunca ve abonelik hala kullanılabilir durumdayken silinen varlığın kurtarılabilirliğini garanti eder. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler
Recoverable+ProtectedSubscription	Silme işleminin bekletme aralığı (90 gün) içinde kurtarılabilir olduğu, anında ve kalıcı silmeye (temizleme) izin verilmediği ve aboneliğin kendisinin kalıcı olarak iptal edilemeyeceği bir kasayı ve abonelik durumunu belirtir. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler
Recoverable+Purgeable	Silme işleminin kurtarılabilir olduğu ve ayrıca anında ve kalıcı silmeye (temizleme) izin veren bir kasa durumunu belirtir. Bu düzey, bir Temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece saklama aralığı (90 gün) boyunca silinen varlığın kurtarılabilirliğini garanti eder. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler

Error

Object

Anahtar kasası sunucusu hatası.

Name	Tür	Description
code	string	Hata kodu.
innererror	Error	Anahtar kasası sunucusu hatası.
message	string	Hata iletisi.

JsonWebKey

Object

http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 itibariyle

Name	Tür	Description
crv	JsonWebKeyCurveName	Elips eğrisi adı. Geçerli değerler için bkz. JsonWebKeyCurveName.
d	string (base64url)	RSA özel üssü veya EC özel anahtarının D bileşeni.
dp	string (base64url)	RSA özel anahtar parametresi.
dq	string (base64url)	RSA özel anahtar parametresi.
e	string (base64url)	RSA genel üs.
k	string (base64url)	Simetrik anahtar.
key_hsm	string (base64url)	Korumalı Anahtar, 'Kendi Anahtarını Getir' ile kullanılır.
key_ops	string[]	Desteklenen anahtar işlemleri.
kid	string	Anahtar tanımlayıcısı.
kty	JsonWebKeyType	https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40'de tanımlandığı gibi JsonWebKey Anahtar Türü (kty).
n	string (base64url)	RSA modülü.
p	string (base64url)	RSA gizli dizisi.
q	string (base64url)	p < q ile RSA secret prime
qi	string (base64url)	RSA özel anahtar parametresi.
x	string (base64url)	EC ortak anahtarının X bileşeni.
y	string (base64url)	EC ortak anahtarının Y bileşeni.

JsonWebKeyCurveName

Listeleme

Elips eğrisi adı. Geçerli değerler için bkz. JsonWebKeyCurveName.

Değer	Description
P-256	NIST P-256 eliptik eğri, DIĞER adıyla SECG eğrisi SECP256R1.
P-256K	SECG SECP256K1 elips eğrisi.
P-384	NIST P-384 eliptik eğri, DIĞER adıyla SECG eğrisi SECP384R1.
P-521	NIST P-521 üç nokta eğrisi, DIĞER adıyla SECG eğrisi SECP521R1.

JsonWebKeyType

Listeleme

https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40'de tanımlandığı gibi JsonWebKey Anahtar Türü (kty).

Değer	Description
EC	Elips Eğrisi.
EC-HSM	HSM'de depolanan özel anahtara sahip Eliptik Eğri.
RSA	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	HSM'de depolanan özel anahtarla RSA.
oct	Sekizli sıra (simetrik anahtarları temsil etmek için kullanılır)
oct-HSM	HSM'de depolanan sekizli dizi (simetrik anahtarları temsil etmek için kullanılır).

KeyAttributes

Object

Anahtar kasası hizmeti tarafından yönetilen bir anahtarın öznitelikleri.

Name	Tür	Description
created	integer (unixtime)	UTC'de oluşturma zamanı.
enabled	boolean	Nesnenin etkinleştirilip etkinleştirilmediğini belirler.
exp	integer (unixtime)	Utc olarak bitiş tarihi.
exportable	boolean	Özel anahtarın dışarı aktarılıp aktarılamadığını gösterir. Dışarı aktarılabilir anahtarın ilk sürümü oluşturulurken sürüm ilkesi sağlanmalıdır.
nbf	integer (unixtime)	UTC'de tarihten önce değil.
recoverableDays	integer (int32)	softDelete veri saklama günleri. SoftDelete etkinleştirildiğinde değer =7 >ve <=90 olmalıdır, aksi takdirde 0 olmalıdır.
recoveryLevel	DeletionRecoveryLevel	Geçerli kasadaki anahtarlar için geçerli olan silme kurtarma düzeyini yansıtır. 'Temizlenebilir' içeriyorsa anahtar ayrıcalıklı bir kullanıcı tarafından kalıcı olarak silinebilir; aksi takdirde, saklama aralığının sonunda anahtarı yalnızca sistem temizleyebilir.
updated	integer (unixtime)	Son güncelleştirme saati : UTC.

KeyBundle

Object

WebKey ve özniteliklerinden oluşan bir KeyBundle.

Name	Tür	Description
attributes	KeyAttributes	Anahtar yönetimi öznitelikleri.
key	JsonWebKey	Json web anahtarı.
managed	boolean	Anahtarın ömrü anahtar kasası tarafından yönetiliyorsa true. Bu, sertifikayı destekleyen bir anahtarsa, yönetilen doğru olur.
release_policy	KeyReleasePolicy	Anahtarın dışarı aktarılabildiği ilke kuralları.
tags	object	Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler.

KeyReleasePolicy

Object

Anahtarın dışarı aktarılabildiği ilke kuralları.

Name	Tür	Default value	Description
contentType	string	application/json; charset=utf-8	Anahtar yayın ilkesinin içerik türü ve sürümü
data	string (base64url)		Blob kodlaması, anahtarın hangi ilke kurallarının altında serbest bırakılabilmesini sağlar. Blob base64 URL kodlanmış olmalıdır.
immutable	boolean		İlkenin değişebilirlik durumunu tanımlar. Sabit olarak işaretlendikten sonra bu bayrak sıfırlanamaz ve ilke hiçbir koşulda değiştirilemez.

KeyVaultError

Object

Anahtar kasası hata özel durumu.

Name	Tür	Description
error	Error	Anahtar kasası sunucusu hatası.

Aracılığıyla paylaş

Get Key - Get Key

URI Parametreleri

Yanıtlar

Örnekler

Get key

Örnek isteği

Örnek yanıt

Tanımlar

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyType

KeyAttributes

KeyBundle

KeyReleasePolicy

KeyVaultError