Set Secret - Set Secret

Hizmet:
Key Vault
API Sürümü:
2025-07-01

Belirtilen anahtar kasasında gizli dizi ayarlar.
SET işlemi Azure Key Vault'a 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 dizi/küme izni gerektirir.

PUT {vaultBaseUrl}/secrets/{secret-name}?api-version=2025-07-01

URI Parametreleri

Name İçinde Gerekli Tür Description
secret-name
 path True

string

pattern: ^[0-9a-zA-Z-]+$

Gizli dizinin adı. Sağladığınız değer, hizmeti çalıştırmak amacıyla genel olarak kopyalanabilir. Sağlanan değer, kişisel olarak tanımlanabilir veya hassas bilgileri içermemelidir.
vaultBaseUrl
 path True

string (uri)

api-version
 query True

string

minLength: 1

Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name Gerekli Tür Description
value True

string

Gizli dizi 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 özel meta veriler.

Yanıtlar

Name Tür Description
200 OK

SecretBundle

İstek başarılı oldu.
Other Status Codes

KeyVaultError

Beklenmeyen bir hata yanıtı.

Güvenlik

OAuth2Auth

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
https://vault.azure.net/.default

Örnekler

SetSecret

Örnek isteği

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

{
  "value": "mysecretvalue"
}

Örnek yanıt

Durum kodu:
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, bekletme aralığının sonunda yalnızca sistem gizli diziyi temizleyebilir.
Error
KeyVaultError

Anahtar kasası hata özel durumu.
SecretAttributes

Gizli dizi yönetimi öznitelikleri.
SecretBundle

Bir değer, kimlik ve özniteliklerinden oluşan bir gizli dizi.
SecretSetParameters

Gizli dizi kümeleri parametreleri.

DeletionRecoveryLevel

Listeleme

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, bekletme aralığının sonunda yalnızca sistem gizli diziyi temizleyebilir.

Değer Description
Purgeable

Silme işleminin, kurtarma olasılığı olmadan geri döndürülemez bir işlem olduğu bir kasa durumunu belirtir. Bu düzey, bir Delete işlemine karşı koruma sağlanmamasına karşılık gelir; varlık düzeyinde veya daha yüksek bir Silme işlemi kabul edildiğinde veriler geri alınamaz bir şekilde kaybolur (kasa, kaynak grubu, abonelik vb.)
Recoverable+Purgeable

Silme işleminin kurtarılabilir olduğu ve aynı zamanda anında ve kalıcı silmeye (yani temizlemeye) 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ılmazsa 90 gün sonra kalıcı olarak silecektir
Recoverable

Silme işleminin anında ve kalıcı silme (yani 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ılmazsa 90 gün sonra kalıcı olarak silecektir
Recoverable+ProtectedSubscription

Silme işleminin saklama aralığı (90 gün) içinde kurtarılabildiği, anında ve kalıcı silmeye (yani temizlemeye) izin verilmeyen ve aboneliğin kendisinin kalıcı olarak iptal edilemediği bir kasa ve abonelik durumunu belirtir. Sistem, kurtarılmazsa 90 gün sonra kalıcı olarak silecektir
CustomizedRecoverable+Purgeable

Silme işleminin kurtarılabilir olduğu ve aynı zamanda 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ığı sırasında silinen varlığın kurtarılabilirliğini garanti eder.
CustomizedRecoverable

Silme işleminin anında ve kalıcı silme olasılığı olmadan kurtarılabilir olduğu bir kasa durumunu belirtir (örneğin, 7 <= SoftDeleteRetentionInDays < 90 olduğunda temizleme). Bu düzey, saklama aralığı sırasında ve abonelik hala kullanılabilir durumdayken silinen varlığın kurtarılabilirliğini garanti eder.
CustomizedRecoverable+ProtectedSubscription

Silme işleminin kurtarılabilir olduğu, anında ve kalıcı silmeye (yani temizleme) izin verilmeyen ve 7 = SoftDeleteRetentionInDays << 90 olduğunda aboneliğin kendisinin kalıcı olarak iptal edilemediği bir kasa ve abonelik durumunu belirtir. Bu düzey, saklama aralığı sırasında silinen varlığın kurtarılabilirliğini garanti eder ve ayrıca aboneliğin kendisinin iptal edilemediği gerçeğini yansıtır.

Error

Object
Name Tür Description
code

string

Hata kodu.
innererror

Error

Anahtar kasası sunucusu hatası.
message

string

Hata iletisi.

KeyVaultError

Object

Anahtar kasası hata özel durumu.

Name Tür Description
error

Error

Anahtar kasası sunucusu hatası.

SecretAttributes

Object

Gizli dizi yönetimi ö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'de son kullanma tarihi.
nbf

integer (unixtime)

UTC'deki tarihten önce değil.
recoverableDays

integer (int32)

softDelete veri saklama günleri. SoftDelete etkinleştirildiğinde değer =7 ve >=90, 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, bekletme aralığının sonunda yalnızca sistem gizli diziyi temizleyebilir.
updated

integer (unixtime)

UTC'de son güncelleme zamanı.

SecretBundle

Object

Bir 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 kimlik.
kid

string

Bu, KV sertifikasını destekleyen bir gizli diziyse, bu alan KV sertifikasını destekleyen ilgili anahtarı belirtir.
managed

boolean

Gizli dizinin ömrü anahtar kasası tarafından yönetiliyorsa True değerini belirler. Bu, sertifikayı destekleyen bir gizli diziyse, yönetilen doğru olur.
previousVersion

string

Varsa, önceki sertifikanın sürümü. Yalnızca 1 Haziran 2025'ten sonra oluşturulan sertifikalar için geçerlidir. Bu tarihten önce oluşturulan sertifikalar geriye dönük olarak güncelleştirilmez.
tags

object

Anahtar-değer çiftleri biçiminde uygulamaya özel meta veriler.
value

string

Gizli dizi değeri.

SecretSetParameters

Object

Gizli dizi kümeleri 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 özel meta veriler.
value

string

Gizli dizi değeri.