Create Key - Create Key
Yeni bir anahtar oluşturur, depolar, ardından anahtar parametrelerini ve özniteliklerini istemciye döndürür.
Anahtar oluşturma işlemi, Azure Key Vault'da herhangi bir anahtar türü oluşturmak için kullanılabilir. Adlandırılmış anahtar zaten varsa Azure Key Vault anahtarın yeni bir sürümünü oluşturur. Anahtarlar/oluşturma izni gerektirir.
POST {vaultBaseUrl}/keys/{key-name}/create?api-version=7.4
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
key-name
|
path | True |
string |
Yeni anahtarın adı. Sistem, yeni anahtar için sürüm adını oluşturur. Sağladığınız değer, hizmeti çalıştırmak amacıyla genel olarak kopyalanabilir. Sağlanan değer, kişisel veya hassas bilgileri içermemelidir. Regex pattern: |
vault
|
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 | Gerekli | Tür | Description |
---|---|---|---|
kty | True |
Oluşturulacak anahtarın türü. Geçerli değerler için bkz. JsonWebKeyType. |
|
attributes |
Anahtar kasası hizmeti tarafından yönetilen bir anahtarın öznitelikleri. |
||
crv |
Üç nokta eğrisi adı. Geçerli değerler için bkz. JsonWebKeyCurveName. |
||
key_ops |
JSON web anahtarı işlemleri. Daha fazla bilgi için bkz. JsonWebKeyOperation. |
||
key_size |
integer |
Bit cinsinden anahtar boyutu. Örneğin: RSA için 2048, 3072 veya 4096. |
|
public_exponent |
integer |
RSA anahtarı için genel üs. |
|
release_policy |
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 |
Anahtar oluşturma isteğinin sonucunu içeren bir anahtar paketi. |
|
Other Status Codes |
İşlemin neden başarısız olduğunu açıklayan hata yanıtı Key Vault. |
Örnekler
Create key
Sample Request
POST https://myvault.vault.azure.net//keys/CreateSoftKeyTest/create?api-version=7.4
{
"kty": "RSA",
"key_size": 2048,
"key_ops": [
"encrypt",
"decrypt",
"sign",
"verify",
"wrapKey",
"unwrapKey"
],
"attributes": {},
"tags": {
"purpose": "unit test",
"test name ": "CreateGetDeleteKeyTest"
}
}
Sample Response
{
"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 |
---|---|
Deletion |
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ı. |
Json |
Şu anda http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
Json |
Elips eğrisi adı. Geçerli değerler için bkz. JsonWebKeyCurveName. |
Json |
|
Json |
JsonWebKey Anahtar Türü (kty), içinde https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40tanımlandığı gibi. |
Key |
Anahtar kasası hizmeti tarafından yönetilen bir anahtarın öznitelikleri. |
Key |
WebKey ve özniteliklerinden oluşan bir KeyBundle. |
Key |
Anahtar oluşturma parametreleri. |
Key |
Anahtarın altında dışarı aktarılabildiği ilke kuralları. |
Key |
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 aralığı 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 ayrıca 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 bekletme 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 bir kasa durumunu belirtir. Bu düzey, Silme işlemine karşı kullanılabilir koruma olmamasını ifade eder; 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 |
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) 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, bir Temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece bekletme 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 |
Anahtar kasası sunucusu hatası. |
|
message |
string |
Hata iletisi. |
JsonWebKey
Şu anda http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
Name | Tür | Description |
---|---|---|
crv |
Elips 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 |
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
Elips 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 üç nokta eğrisini SECP256K1. |
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-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 dizi (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 olarak 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'de 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 |
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 |
Anahtar yönetimi öznitelikleri. |
|
key |
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 olacaktır. |
release_policy |
Anahtarın altında dışarı aktarılabildiği ilke kuralları. |
|
tags |
object |
Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler. |
KeyCreateParameters
Anahtar oluşturma parametreleri.
Name | Tür | Description |
---|---|---|
attributes |
Anahtar kasası hizmeti tarafından yönetilen bir anahtarın öznitelikleri. |
|
crv |
Elips eğrisi adı. Geçerli değerler için bkz. JsonWebKeyCurveName. |
|
key_ops |
JSON web anahtarı işlemleri. Daha fazla bilgi için bkz. JsonWebKeyOperation. |
|
key_size |
integer |
Bit cinsinden anahtar boyutu. Örneğin: RSA için 2048, 3072 veya 4096. |
kty |
Oluşturulacak anahtarın türü. Geçerli değerler için bkz. JsonWebKeyType. |
|
public_exponent |
integer |
RSA anahtarı için genel üs. |
release_policy |
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 altında serbest bırakılabildiği ilke kurallarını kodlar. Blob base64 URL'si 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
Anahtar kasası hata özel durumu.
Name | Tür | Description |
---|---|---|
error |
Anahtar kasası sunucusu hatası. |