Delete Secret - Delete Secret
Töröl egy titkos kódot egy adott kulcstartóból.
A DELETE művelet az Azure Key Vault tárolt titkos kódokra vonatkozik. A DELETE nem alkalmazható a titkos kódok egyéni verziójára. Ehhez a művelethez titkos kódokra/törlési engedélyekre van szükség.
DELETE {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. |
vault
|
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. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A törölt titkos kód és a titkos kód törlésének időpontjával, valamint a törölt titkos kód helyreállításának módjával kapcsolatos információk. |
|
Other Status Codes |
Key Vault hibaválasz leírja, hogy miért hiúsult meg a művelet. |
Példák
DeleteSecret
Sample Request
DELETE https://myvault.vault.azure.net//secrets/GetDeletedSecretTest?api-version=7.4
Sample Response
{
"recoveryId": "https://myvault.vault.azure.net/deletedsecrets/GetDeletedSecretTest",
"deletedDate": 1493938433,
"scheduledPurgeDate": 1501714433,
"id": "https://myvault.vault.azure.net/secrets/GetDeletedSecretTest/b595353d9c39413d80626575b3b5d865",
"attributes": {
"enabled": true,
"created": 1493938433,
"updated": 1493938433,
"recoveryLevel": "Recoverable+Purgeable"
}
}
Definíciók
Name | Description |
---|---|
Deleted |
Törölt titkos kód, amely a korábbi azonosítóját, attribútumait és címkéit tartalmazza, valamint a törlés időpontjára vonatkozó információkat. |
Deletion |
Az aktuális tároló titkos kulcsainak törlési helyreállítási szintjét tükrözi. Ha tartalmazza a "Véglegesen törölhető" elemet, a titkos kódot véglegesen törölheti egy kiemelt felhasználó; ellenkező esetben csak a rendszer törölheti a titkos kódot a megőrzési időtartam végén. |
Error |
A Key Vault-kiszolgáló hibája. |
Key |
A Key Vault hibakivétele. |
Secret |
A titkos kódok kezelési attribútumai. |
DeletedSecretBundle
Törölt titkos kód, amely a korábbi azonosítóját, attribútumait és címkéit tartalmazza, valamint a törlés időpontjára vonatkozó információkat.
Name | Típus | Description |
---|---|---|
attributes |
A titkos kódok kezelési attribútumai. |
|
contentType |
string |
A titkos kód tartalomtípusa. |
deletedDate |
integer |
A titkos kód törlésének időpontja (UTC) |
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ő határozza meg a KV-tanúsítványhoz tartozó kulcsot. |
managed |
boolean |
Igaz, ha a titkos kulcstartó kezeli a titkos kód élettartamát. Ha ez egy tanúsítványt tartalmazó titkos kód, akkor a felügyelt érték igaz lesz. |
recoveryId |
string |
A törölt titkos kód azonosítására és helyreállítására használt helyreállítási objektum URL-címe. |
scheduledPurgeDate |
integer |
A titkos kód végleges törlésének ütemezett időpontja (UTC) |
tags |
object |
Alkalmazásspecifikus metaadatok kulcs-érték párok formájában. |
value |
string |
A titkos kód értéke. |
DeletionRecoveryLevel
Az aktuális tároló titkos kulcsainak törlési helyreállítási szintjét tükrözi. Ha tartalmazza a "Véglegesen törölhető" elemet, a titkos kódot véglegesen törölheti egy kiemelt felhasználó; ellenkező esetben csak a rendszer törölheti a titkos kódot a megőrzési időtartam végén.
Name | Típus | Description |
---|---|---|
CustomizedRecoverable |
string |
Azt a tárolóállapotot jelöli, amelyben a törlés azonnali és végleges törlés nélkül helyreállítható (azaz 7<= SoftDeleteRetentionInDays < 90 esetén végleges törlés). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időtartam 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őtartam 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 7<= SoftDeleteRetentionInDays < 90 utáni 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, 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 azt jelenti, hogy a törlési műveletekkel szemben nem áll rendelkezésre védelem; az adatok helyrehozhatatlanul elvesznek egy Törlés művelet elfogadásakor az entitás szintjén vagy annál magasabb szinten (tároló, erőforráscsoport, előfizetés stb.) |
Recoverable |
string |
Azt a tárolóállapotot jelöli, 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) lennének 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őtartam (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 |
string |
Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés megőrzési időtartamon (90 napon) belül helyreállítható, 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 után véglegesen törli, ha nem állítható helyre |
Recoverable+Purgeable |
string |
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 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 után 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 |
A Key Vault-kiszolgáló hibája. |
|
message |
string |
A hibaüzenet. |
KeyVaultError
A Key Vault hibakivétele.
Name | Típus | Description |
---|---|---|
error |
A Key Vault-kiszolgáló hibája. |
SecretAttributes
A titkos kódok kezelési attribútumai.
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) |
nbf |
integer |
Időpont előtt utc. |
recoverableDays |
integer |
softDelete adatmegőrzési napok. Az érték =7 és <=90 lehet>, ha a softDelete engedélyezve van, ellenkező esetben 0. |
recoveryLevel |
Az aktuális tároló titkos kulcsainak törlési helyreállítási szintjét tükrözi. Ha tartalmazza a "Véglegesen törölhető" elemet, a titkos kódot véglegesen törölheti egy kiemelt felhasználó; ellenkező esetben csak a rendszer törölheti a titkos kódot a megőrzési időtartam végén. |
|
updated |
integer |
Utolsó frissítés időpontja (UTC). |