Set Secret - Set Secret

Szolgáltatás:

Key Vault

API-verzió:

7.4

Titkos kulcsot állít be egy megadott kulcstartóban.
A SET művelet titkos kulcsot ad hozzá az Azure Key Vault. Ha a nevesített titkos kód már létezik, az Azure Key Vault létrehozza a titkos kód új verzióját. Ehhez a művelethez titkos kulcsra/beállításra van szükség.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
secret-name	path	True	string	A titkos kód neve. A megadott érték globálisan másolható a szolgáltatás futtatása céljából. A megadott érték nem tartalmazhat személyazonosításra alkalmas vagy bizalmas adatokat. Reguláris kifejezési minta: ^[0-9a-zA-Z-]+$
vaultBaseUrl	path	True	string	A tároló neve, például https://myvault.vault.azure.net.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem törzse

Name	Kötelező	Típus	Description
value	True	string	A titkos kód értéke.
attributes		SecretAttributes	A titkos kódkezelési attribútumok.
contentType		string	A titkos kód értékének típusa, például jelszó.
tags		object	Alkalmazásspecifikus metaadatok kulcs-érték párok formájában.

Válaszok

Name	Típus	Description
200 OK	SecretBundle	Titkos kódcsomag, amely a beállított titkos kulcs kérésének eredményét tartalmazza.
Other Status Codes	KeyVaultError	Key Vault hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Példák

SetSecret

Mintakérelem

HTTP

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

{
  "value": "mysecretvalue"
}

Mintaválasz

Állapotkód:

200

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

Definíciók

Name	Description
DeletionRecoveryLevel	Az aktuális tároló titkos kulcsainak törlési helyreállítási szintjét tükrözi. Ha a "Törölhető" szöveget tartalmazza, a titkos kód véglegesen törölhető egy kiemelt felhasználó számára; ellenkező esetben csak a rendszer törölheti a titkos kódot a megőrzési időköz végén.
Error	A Key Vault-kiszolgáló hibája.
KeyVaultError	A key vault hibakivétele.
SecretAttributes	A titkos kódkezelési attribútumok.
SecretBundle	Egy értékből, azonosítóból és attribútumokból álló titkos kód.
SecretSetParameters	A titkos kódkészlet paraméterei.

DeletionRecoveryLevel

Az aktuális tároló titkos kulcsainak törlési helyreállítási szintjét tükrözi. Ha a "Törölhető" szöveget tartalmazza, a titkos kód véglegesen törölhető egy kiemelt felhasználó számára; ellenkező esetben csak a rendszer törölheti a titkos kódot a megőrzési időköz végén.

Name	Típus	Description
CustomizedRecoverable	string	Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható anélkül, hogy azonnali és végleges törlésre van lehetőség (azaz törlés, ha 7< = SoftDeleteRetentionInDays < 90). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időköz alatt, és amíg az előfizetés továbbra is elérhető.
CustomizedRecoverable+ProtectedSubscription	string	Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés helyreállítható, az azonnali és végleges törlés (azaz a végleges törlés) nem engedélyezett, és amelyben maga az előfizetés nem mondható le véglegesen, ha 7<= SoftDeleteRetentionInDays < 90. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időköz alatt, és azt is tükrözi, hogy maga az előfizetés nem mondható le.
CustomizedRecoverable+Purgeable	string	Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést is (azaz a törlést, amikor 7< = SoftDeleteRetentionInDays < 90). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időtartam alatt, kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják.
Purgeable	string	Olyan tárolóállapotot jelöl, amelyben a törlés visszafordíthatatlan művelet, a helyreállítás lehetősége nélkül. Ez a szint nem felel meg a Törlés művelet elleni védelemnek; az adatok helyrehozhatatlanul elvesznek egy törlési művelet entitásszinten vagy magasabb szinten (tároló, erőforráscsoport, előfizetés stb.) elfogadásakor.
Recoverable	string	Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható anélkül, hogy azonnali és végleges törlésre (azaz végleges törlésre) van lehetőség. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időköz (90 nap) alatt, és amíg az előfizetés továbbra is elérhető. A rendszer 90 nap elteltével véglegesen törli, ha nem állítható helyre
Recoverable+ProtectedSubscription	string	Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés helyreállítható a megőrzési időtartamon belül (90 nap), az azonnali és végleges törlés (azaz végleges törlés) nem engedélyezett, és amelyben maga az előfizetés nem mondható le véglegesen. A rendszer 90 nap elteltével véglegesen törli, ha nem állítható helyre
Recoverable+Purgeable	string	Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést (azaz a végleges törlést). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időtartam alatt (90 nap), kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják. A rendszer 90 nap elteltével véglegesen törli, ha nem állítható helyre

Error

A Key Vault-kiszolgáló hibája.

Name	Típus	Description
code	string	A hibakód.
innererror	Error	A Key Vault-kiszolgáló hibája.
message	string	A hibaüzenet.

KeyVaultError

A key vault hibakivétele.

Name	Típus	Description
error	Error	A Key Vault-kiszolgáló hibája.

SecretAttributes

A titkos kódkezelési attribútumok.

Name	Típus	Description
created	integer	Létrehozás időpontja UTC-ben.
enabled	boolean	Meghatározza, hogy az objektum engedélyezve van-e.
exp	integer	Lejárati dátum UTC-ben.
nbf	integer	Dátum előtt nem UTC-ben.
recoverableDays	integer	softDelete adatmegőrzési napok. Ha a softDelete engedélyezve van >, akkor az érték =7 és <=90 lehet, ellenkező esetben 0.
recoveryLevel	DeletionRecoveryLevel	Az aktuális tároló titkos kulcsainak törlési helyreállítási szintjét tükrözi. Ha a "Törölhető" szöveget tartalmazza, a titkos kód véglegesen törölhető egy kiemelt felhasználó számára; ellenkező esetben csak a rendszer törölheti a titkos kódot a megőrzési időköz végén.
updated	integer	Utolsó frissítés időpontja UTC-ben.

SecretBundle

Egy értékből, azonosítóból és attribútumokból álló titkos kód.

Name	Típus	Description
attributes	SecretAttributes	A titkos kódkezelési attribútumok.
contentType	string	A titkos kód tartalomtípusa.
id	string	A titkos azonosító.
kid	string	Ha ez egy titkos kód egy KV-tanúsítványról, akkor ez a mező megadja a KV-tanúsítványhoz tartozó megfelelő kulcsot.
managed	boolean	Igaz, ha a titkos kulcs élettartamát a kulcstartó kezeli. Ha ez egy tanúsítványt tartalmazó titkos kód, akkor a felügyelt érték igaz lesz.
tags	object	Alkalmazásspecifikus metaadatok kulcs-érték párok formájában.
value	string	A titkos érték.

SecretSetParameters

A titkos kódkészlet paraméterei.

Name	Típus	Description
attributes	SecretAttributes	A titkos kódkezelési attribútumok.
contentType	string	A titkos kód értékének típusa, például jelszó.
tags	object	Alkalmazásspecifikus metaadatok kulcs-érték párok formájában.
value	string	A titkos kód értéke.