Megosztás a következőn keresztül:

Set Secret - Set Secret

  • Referencia
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 Vaulthoz. Ha a névvel ellátott 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 kulcsok/beállítások megadása szükséges.

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

URI-paraméterek

Name In Kötelező Típus Description
secret-name
 path True

string

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

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.
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ódok kezelési attribútumai.
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

Egy titkos csomag, amely a beállított titkos kulcs kérésének eredményét tartalmazza.
Other Status Codes

KeyVaultError

A Key Vault hibaválasza leírja, hogy miért nem sikerült a művelet.

Példák

SetSecret

Mintakérelem

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 jelenleg érvényben lévő törlési helyreállítási szintjét tükrözi. Ha "Eltávolítható" fájlt tartalmaz, a titkos kód véglegesen törölhető egy kiemelt felhasználó által; ellenkező esetben csak a rendszer tudja kiüríteni a titkos 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ódok kezelési attribútumai.
SecretBundle

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

A titkos kódkészlet paraméterei.

DeletionRecoveryLevel

Enumerálás

Az aktuális tároló titkos kulcsainak jelenleg érvényben lévő törlési helyreállítási szintjét tükrözi. Ha "Eltávolítható" fájlt tartalmaz, a titkos kód véglegesen törölhető egy kiemelt felhasználó által; ellenkező esetben csak a rendszer tudja kiüríteni a titkos megőrzési időköz végén.

Érték Description
CustomizedRecoverable

Olyan tárolóállapotot jelöl, amelyben a törlés azonnali és végleges törlés nélkül helyreállítható (azaz 7<= SoftDeleteRetentionInDays < 90 esetén). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt, és amíg az előfizetés továbbra is elérhető.
CustomizedRecoverable+ProtectedSubscription

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 törlés) nem engedélyezett, és amelyben maga az előfizetés nem mondható le véglegesen, 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őszak alatt, és azt is tükrözi, hogy maga az előfizetés nem törölhető.
CustomizedRecoverable+Purgeable

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őszak alatt, kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják.
Purgeable

Olyan tárolóállapotot jelöl, amelyben a törlés visszavonhatatlan művelet, a helyreállítás lehetősége nélkül. Ez a szint nem felel meg a törlési műveletekkel szembeni védelemnek; az adatok helyrehozhatatlanul elvesznek, ha egy törlési műveletet az entitás szintjén vagy annál magasabb szinten fogadnak el (tároló, erőforráscsoport, előfizetés stb.)
Recoverable

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 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őszak (90 nap) alatt, és amíg az előfizetés továbbra is elérhető. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre
Recoverable+ProtectedSubscription

Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés megőrzési idő (90 nap) alatt helyreállítható, az azonnali és végleges törlés (azaz a törlés) nem engedélyezett, és amelyben maga az előfizetés nem törölhető véglegesen. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre
Recoverable+Purgeable

Egy tároló állapotát jelöli, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést (azaz a 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őszak alatt (90 nap), kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre

Error

Objektum

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

Objektum

A key vault hibakivétele.

Name Típus Description
error

Error

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

SecretAttributes

Objektum

A titkos kódok kezelési attribútumai.

Name Típus Description
created

integer (unixtime)

Létrehozás időpontja UTC-ben.
enabled

boolean

Meghatározza, hogy az objektum engedélyezve van-e.
exp

integer (unixtime)

Lejárati dátum UTC-ben.
nbf

integer (unixtime)

Dátum előtt nem UTC-ben.
recoverableDays

integer (int32)

softDelete adatmegőrzési napok. Az értéknek =7 >és <=90 értéknek kell lennie, ha a softDelete engedélyezve van, egyébként 0.
recoveryLevel

DeletionRecoveryLevel

Az aktuális tároló titkos kulcsainak jelenleg érvényben lévő törlési helyreállítási szintjét tükrözi. Ha "Eltávolítható" fájlt tartalmaz, a titkos kód véglegesen törölhető egy kiemelt felhasználó által; ellenkező esetben csak a rendszer tudja kiüríteni a titkos megőrzési időköz végén.
updated

integer (unixtime)

Utolsó frissítés időpontja UTC-ben.

SecretBundle

Objektum

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

Name Típus Description
attributes

SecretAttributes

A titkos kódok kezelési attribútumai.
contentType

string

A titkos kód tartalomtípusa.
id

string

A titkos azonosító.
kid

string

Ha ez egy titkos kulcs, amely egy KV-tanúsítványt készít, akkor ez a mező megadja a KV-tanúsítvány megfelelő kulcsát.
managed

boolean

Igaz, ha a titkos kód élettartamát a Key Vault felügyeli. Ha ez egy tanúsítványt tartalmazó titkos kód, akkor a felügyelet igaz lesz.
tags

object

Alkalmazásspecifikus metaadatok kulcs-érték párok formájában.
value

string

A titkos kód értéke.

SecretSetParameters

Objektum

A titkos kódkészlet paraméterei.

Name Típus Description
attributes

SecretAttributes

A titkos kódok kezelési attribútumai.
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.