Set Secret - Set Secret

Service:

Key Vault

API Version:

7.4

Belirtilen anahtar kasasında bir gizli dizi ayarlar.
SET işlemi Azure Key Vault bir gizli dizi ekler. Adlandırılmış gizli dizi zaten varsa, Azure Key Vault bu gizli dizinin yeni bir sürümünü oluşturur. Bu işlem gizli diziler/küme izni gerektirir.

PUT {vaultBaseUrl}/secrets/{secret-name}?api-version=7.4

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
secret-name	path	True	string	Gizli dizinin adı. 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: ^[0-9a-zA-Z-]+$
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	Gerekli	Tür	Description
value	True	string	Gizli dizinin değeri.
attributes		SecretAttributes	Gizli dizi yönetimi öznitelikleri.
contentType		string	Parola gibi gizli dizi değerinin türü.
tags		object	Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler.

Yanıtlar

Name	Tür	Description
200 OK	SecretBundle	Ayarlanmış gizli dizi isteğinin sonucunu içeren gizli dizi paketi.
Other Status Codes	KeyVaultError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı Key Vault.

Örnekler

SetSecret

Sample Request

HTTP

PUT https://myvault.vault.azure.net//secrets/crpsecret?api-version=7.4

{
  "value": "mysecretvalue"
}

Sample Response

Status code:

200

{
  "value": "mysecretvalue",
  "id": "https://myvault.vault.azure.net/secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441",
  "attributes": {
    "enabled": true,
    "created": 1493938459,
    "updated": 1493938459,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

Tanımlar

Name	Description
DeletionRecoveryLevel	Geçerli kasadaki gizli diziler için geçerli olan silme kurtarma düzeyini yansıtır. 'Temizlenebilir' içeriyorsa gizli dizi ayrıcalıklı bir kullanıcı tarafından kalıcı olarak silinebilir; aksi takdirde, saklama aralığının sonunda yalnızca sistem gizli diziyi temizleyebilir.
Error	Anahtar kasası sunucusu hatası.
KeyVaultError	Anahtar kasası hata özel durumu.
SecretAttributes	Gizli dizi yönetimi öznitelikleri.
SecretBundle	Değer, kimlik ve özniteliklerinden oluşan bir gizli dizi.
SecretSetParameters	Gizli dizi kümesi parametreleri.

DeletionRecoveryLevel

Geçerli kasadaki gizli diziler için geçerli olan silme kurtarma düzeyini yansıtır. 'Temizlenebilir' içeriyorsa gizli dizi ayrıcalıklı bir kullanıcı tarafından kalıcı olarak silinebilir; aksi takdirde, saklama aralığının sonunda yalnızca sistem gizli diziyi 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	Error	Anahtar kasası sunucusu hatası.
message	string	Hata iletisi.

KeyVaultError

Anahtar kasası hata özel durumu.

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

SecretAttributes

Gizli dizi yönetimi ö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.
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	DeletionRecoveryLevel	Geçerli kasadaki gizli diziler için geçerli olan silme kurtarma düzeyini yansıtır. 'Temizlenebilir' içeriyorsa gizli dizi ayrıcalıklı bir kullanıcı tarafından kalıcı olarak silinebilir; aksi takdirde, saklama aralığının sonunda yalnızca sistem gizli diziyi temizleyebilir.
updated	integer	Son güncelleştirme saati : UTC.

SecretBundle

Değer, kimlik ve özniteliklerinden oluşan bir gizli dizi.

Name	Tür	Description
attributes	SecretAttributes	Gizli dizi yönetimi öznitelikleri.
contentType	string	Gizli dizinin içerik türü.
id	string	Gizli dizi kimliği.
kid	string	Bu bir KV sertifikasının yedeklendiği gizli diziyse, bu alan KV sertifikasının yedeklendiği ilgili anahtarı belirtir.
managed	boolean	Gizli dizi yaşam süresi anahtar kasası tarafından yönetiliyorsa true. Bu bir sertifikayı destekleyen gizli diziyse, yönetilen doğru olacaktır.
tags	object	Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler.
value	string	Gizli dizi değeri.

SecretSetParameters

Gizli dizi kümesi parametreleri.

Name	Tür	Description
attributes	SecretAttributes	Gizli dizi yönetimi öznitelikleri.
contentType	string	Parola gibi gizli dizi değerinin türü.
tags	object	Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler.
value	string	Gizli dizinin değeri.