Set Secret - Set Secret

Service:

Key Vault

API Version:

7.4

Mengatur rahasia dalam brankas kunci tertentu.
Operasi SET menambahkan rahasia ke Key Vault Azure. Jika rahasia bernama sudah ada, Azure Key Vault membuat versi baru rahasia tersebut. Operasi ini memerlukan izin rahasia/set.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
secret-name	path	True	string	Nama rahasianya. Nilai yang Anda berikan dapat disalin secara global untuk tujuan menjalankan layanan. Nilai yang diberikan tidak boleh menyertakan informasi pribadi yang dapat diidentifikasi atau informasi yang sensitif. Regex pattern: ^[0-9a-zA-Z-]+$
vaultBaseUrl	path	True	string	Nama vault, misalnya https://myvault.vault.azure.net.
api-version	query	True	string	Versi API klien.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
value	True	string	Nilai rahasia.
attributes		SecretAttributes	Atribut manajemen rahasia.
contentType		string	Jenis nilai rahasia seperti kata sandi.
tags		object	Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

Respons

Nama	Jenis	Deskripsi
200 OK	SecretBundle	Bundel rahasia yang berisi hasil permintaan rahasia yang ditetapkan.
Other Status Codes	KeyVaultError	Key Vault respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

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"
  }
}

Definisi

Nama	Deskripsi
DeletionRecoveryLevel	Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk rahasia di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh', rahasia dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh rahasia, di akhir interval retensi.
Error	Kesalahan server brankas kunci.
KeyVaultError	Pengecualian kesalahan brankas kunci.
SecretAttributes	Atribut manajemen rahasia.
SecretBundle	Rahasia yang terdiri dari nilai, id, dan atributnya.
SecretSetParameters	Parameter set rahasia.

DeletionRecoveryLevel

Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk rahasia di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh', rahasia dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh rahasia, di akhir interval retensi.

Nama	Jenis	Deskripsi
CustomizedRecoverable	string	Menunjukkan status vault di mana penghapusan dapat dipulihkan tanpa kemungkinan untuk penghapusan segera dan permanen (yaitu hapus menyeluruh ketika 7<= SoftDeleteRetentionInDays < 90). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi dan saat langganan masih tersedia.
CustomizedRecoverable+ProtectedSubscription	string	Menunjukkan status vault dan langganan di mana penghapusan dapat dipulihkan, penghapusan langsung dan permanen (yaitu pembersihan) tidak diizinkan, dan di mana langganan itu sendiri tidak dapat dibatalkan secara permanen ketika 7<= SoftDeleteRetentionInDays < 90. Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi, dan juga mencerminkan fakta bahwa langganan itu sendiri tidak dapat dibatalkan.
CustomizedRecoverable+Purgeable	string	Menunjukkan status vault di mana penghapusan dapat dipulihkan, dan yang juga mengizinkan penghapusan segera dan permanen (yaitu pembersihan saat 7<= SoftDeleteRetentionInDays < 90). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi, kecuali jika operasi Pembersihan diminta, atau langganan dibatalkan.
Purgeable	string	Menunjukkan status vault di mana penghapusan adalah operasi yang tidak dapat diubah, tanpa kemungkinan untuk pemulihan. Tingkat ini sesuai dengan tidak ada perlindungan yang tersedia terhadap operasi Hapus; data hilang secara tidak dapat diambil setelah menerima operasi Hapus di tingkat entitas atau lebih tinggi (vault, grup sumber daya, langganan, dll.)
Recoverable	string	Menunjukkan status vault di mana penghapusan dapat dipulihkan tanpa kemungkinan untuk penghapusan segera dan permanen (yaitu pembersihan). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi (90 hari) dan saat langganan masih tersedia. Sistem akan menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan
Recoverable+ProtectedSubscription	string	Menunjukkan status vault dan langganan di mana penghapusan dapat dipulihkan dalam interval retensi (90 hari), penghapusan segera dan permanen (yaitu penghapusan menyeluruh) tidak diizinkan, dan di mana langganan itu sendiri tidak dapat dibatalkan secara permanen. Sistem akan menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan
Recoverable+Purgeable	string	Menunjukkan status vault di mana penghapusan dapat dipulihkan, dan yang juga mengizinkan penghapusan segera dan permanen (yaitu pembersihan). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi (90 hari), kecuali operasi Pembersihan diminta, atau langganan dibatalkan. Sistem akan menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan

Error

Kesalahan server brankas kunci.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
innererror	Error	Kesalahan server brankas kunci.
message	string	Pesan kesalahan.

KeyVaultError

Pengecualian kesalahan brankas kunci.

Nama	Jenis	Deskripsi
error	Error	Kesalahan server brankas kunci.

SecretAttributes

Atribut manajemen rahasia.

Nama	Jenis	Deskripsi
created	integer	Waktu pembuatan di UTC.
enabled	boolean	Menentukan apakah objek diaktifkan.
exp	integer	Tanggal kedaluwarsa dalam UTC.
nbf	integer	Tidak sebelum tanggal dalam UTC.
recoverableDays	integer	softDelete hari retensi data. Nilai harus >=7 dan <=90 saat softDelete diaktifkan, jika tidak 0.
recoveryLevel	DeletionRecoveryLevel	Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk rahasia di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh', rahasia dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh rahasia, di akhir interval retensi.
updated	integer	Waktu terakhir diperbarui di UTC.

SecretBundle

Rahasia yang terdiri dari nilai, id, dan atributnya.

Nama	Jenis	Deskripsi
attributes	SecretAttributes	Atribut manajemen rahasia.
contentType	string	Jenis konten rahasia.
id	string	Id rahasia.
kid	string	Jika ini adalah rahasia yang mendukung sertifikat KV, maka bidang ini menentukan kunci yang sesuai yang mendukung sertifikat KV.
managed	boolean	True jika masa pakai rahasia dikelola oleh brankas kunci. Jika ini adalah rahasia yang mendukung sertifikat, maka dikelola akan benar.
tags	object	Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.
value	string	Nilai rahasia.

SecretSetParameters

Parameter set rahasia.

Nama	Jenis	Deskripsi
attributes	SecretAttributes	Atribut manajemen rahasia.
contentType	string	Jenis nilai rahasia seperti kata sandi.
tags	object	Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.
value	string	Nilai rahasia.