Update Key - Update Key

Başvuru

Service:: Key Vault

API Version:: 7.4

Güncelleştirme anahtarı işlemi, depolanan anahtarın belirtilen özniteliklerini değiştirir ve Azure Key Vault'de depolanan herhangi bir anahtar türüne ve anahtar sürümüne uygulanabilir.
Bu işlemi gerçekleştirmek için anahtarın Key Vault zaten mevcut olması gerekir. Not: Bir anahtarın şifreleme malzemesi değiştirilemez. Bu işlem anahtarlar/güncelleştirme izni gerektirir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
key-name	path	True	string	Güncelleştirilecek anahtarın adı.
key-version	path	True	string	Güncelleştirilecek anahtarın sürümü.
vaultBaseUrl	path	True	string	Kasa adı, örneğin https://myvault.vault.azure.net.
api-version	query	True	string	İstemci API sürümü.

İstek Gövdesi

Name	Tür	Description
attributes	KeyAttributes	Anahtar kasası hizmeti tarafından yönetilen bir anahtarın öznitelikleri.
key_ops	JsonWebKeyOperation[]	Json web anahtarı işlemleri. Olası anahtar işlemleri hakkında daha fazla bilgi için bkz. JsonWebKeyOperation.
release_policy	KeyReleasePolicy	Anahtarın altında dışarı aktarılabildiği ilke kuralları.
tags	object	Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler.

Yanıtlar

Name	Tür	Description
200 OK	KeyBundle	Güncelleştirilmiş anahtar.
Other Status Codes	KeyVaultError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı Key Vault.

Örnekler

Update key

Sample Request

HTTP

PATCH https://myvault.vault.azure.net//keys/UpdateKeyAttributesTest/3d31e6e5c4c14eaf9be8d42c00225088?api-version=7.4

{
  "key_ops": [
    "decrypt",
    "encrypt"
  ],
  "attributes": {
    "enabled": false,
    "nbf": 631180800,
    "exp": 662716800
  }
}

Sample Response

Status code:: 200

{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/UpdateKeyAttributesTest/3d31e6e5c4c14eaf9be8d42c00225088",
    "kty": "RSA",
    "key_ops": [
      "decrypt",
      "encrypt"
    ],
    "n": "tHCSyq1FqGHXIFHs1m4riKYgPFNSTlJGPzxwfUyZJUxxZsFWMxmZRzbM3kcXC5N40AJfeqDOMs0gY0LZEfhw8kJHBf2GEH2Sz923E4OQjLk_ECdAiKPW_8t22cqD_pGIuB7uibjLZgFFRv7oe0t8cTXKn7IwAH5gQBLs8NNV7hx1Ozy82ekCgOovFldmD3c3P1oZQ_v_-jOP6O202aEfDcZut42J6zI8eYwvGiDKmo2fCPPeth1LYBOeUMnrEZGT_f_w3yAgqvuSkHCL0x4MjZzc2EoNI_3ooAHZohDaPHLRfz8neDPADZzbHA6SDn3GgvC1K_Je5GBmqjTH3aIMlw",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": false,
    "nbf": 631180800,
    "exp": 662716800,
    "created": 1493860275,
    "updated": 1493860277,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

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	Şu şekilde: http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Üç nokta eğrisi adı. Geçerli değerler için bkz. JsonWebKeyCurveName.
JsonWebKeyOperation
JsonWebKeyType	JsonWebKey Anahtar Türü (kty), içinde https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40tanımlandığı gibi.
KeyAttributes	Anahtar kasası hizmeti tarafından yönetilen bir anahtarın öznitelikleri.
KeyBundle	WebKey ve özniteliklerinden oluşan bir KeyBundle.
KeyReleasePolicy	Anahtarın altında dışarı aktarılabildiği ilke kuralları.
KeyUpdateParameters	Anahtar güncelleştirme parametreleri.
KeyVaultError	Anahtar kasası hata özel durumu.

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.

Name	Tür	Description
CustomizedRecoverable	string	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 süresi boyunca ve abonelik hala kullanılabilir durumdayken silinen varlığın kurtarılabilirliğini garanti eder.
CustomizedRecoverable+ProtectedSubscription	string	Silme işleminin kurtarılabilir olduğu, anında ve kalıcı silmeye (temizleme) izin verilmediği ve 7<= SoftDeleteRetentionInDays < 90 olduğunda 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	string	Silme işleminin kurtarılabilir olduğu ve anında ve kalıcı silmeye izin veren bir kasa durumunu belirtir (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	string	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şı hiçbir korumanın mevcut olmadığı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 geri alınabilir bir şekilde kaybolur.
Recoverable	string	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	string	Silme işleminin saklama 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 edilemediği bir kasayı ve abonelik durumunu belirtir. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler
Recoverable+Purgeable	string	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, 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

Anahtar kasası sunucusu hatası.

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

JsonWebKey

Şu şekilde: http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Name	Tür	Description
crv	JsonWebKeyCurveName	Üç nokta eğrisi adı. Geçerli değerler için bkz. JsonWebKeyCurveName.
d	string	RSA özel üssü veya EC özel anahtarının D bileşeni.
dp	string	RSA özel anahtar parametresi.
dq	string	RSA özel anahtar parametresi.
e	string	RSA genel üs.
k	string	Simetrik anahtar.
key_hsm	string	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	JsonWebKey Anahtar Türü (kty), içinde https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40tanımlandığı gibi.
n	string	RSA modulus.
p	string	RSA gizli dizisi.
q	string	P q ile < RSA gizli dizisi
qi	string	RSA özel anahtar parametresi.
x	string	EC ortak anahtarının X bileşeni.
y	string	EC ortak anahtarının Y bileşeni.

JsonWebKeyCurveName

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

Name	Tür	Description
P-256	string	NIST P-256 üç nokta eğrisi, DIĞER adıyla SECG eğrisi SECP256R1.
P-256K	string	SECG SECP256K1 üç nokta eğrisi.
P-384	string	NIST P-384 üç nokta eğrisi, DIĞER adıyla SECG eğrisi SECP384R1.
P-521	string	NIST P-521 üç nokta eğrisi, DIĞER adıyla SECG eğrisi SECP521R1.

JsonWebKeyOperation

Name	Tür	Description
decrypt	string
encrypt	string
export	string
import	string
sign	string
unwrapKey	string
verify	string
wrapKey	string

JsonWebKeyType

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

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

KeyAttributes

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

Name	Tür	Description
created	integer	Oluşturma saati : UTC.
enabled	boolean	Nesnenin etkinleştirilip etkinleştirilmediğini belirler.
exp	integer	Utc'de süre sonu tarihi.
exportable	boolean	Özel anahtarın dışarı aktarılıp aktarılmadığını gösterir. Dışarı aktarılabilir anahtarın ilk sürümü oluşturulurken yayın ilkesi sağlanmalıdır.
nbf	integer	UTC'deki tarihten önce değil.
recoverableDays	integer	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	Son güncelleştirme saati : UTC.

KeyBundle

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 yaşam süresi anahtar kasası tarafından yönetiliyorsa True. Bu bir sertifikayı destekleyen bir anahtarsa, yönetilen doğru olur.
release_policy	KeyReleasePolicy	Anahtarın altında dışarı aktarılabildiği ilke kuralları.
tags	object	Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler.

KeyReleasePolicy

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

Name	Tür	Varsayılan değer	Description
contentType	string	application/json; charset=utf-8	Anahtar yayın ilkesinin içerik türü ve sürümü
data	string		Blob kodlaması, anahtarın serbest bırakılabildiği ilke kurallarını belirtir. 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.

KeyUpdateParameters

Anahtar güncelleştirme parametreleri.

Name	Tür	Description
attributes	KeyAttributes	Anahtar kasası hizmeti tarafından yönetilen bir anahtarın öznitelikleri.
key_ops	JsonWebKeyOperation[]	Json web anahtarı işlemleri. Olası anahtar işlemleri hakkında daha fazla bilgi için bkz. JsonWebKeyOperation.
release_policy	KeyReleasePolicy	Anahtarın altında dışarı aktarılabildiği ilke kuralları.
tags	object	Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler.

KeyVaultError

Anahtar kasası hata özel durumu.

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

Aracılığıyla paylaş