Set Secret - Set Secret
Ustawia wpis tajny w określonym magazynie kluczy.
Operacja SET dodaje wpis tajny do usługi Azure Key Vault. Jeśli nazwany wpis tajny już istnieje, usługa Azure Key Vault tworzy nową wersję tego wpisu tajnego. Ta operacja wymaga uprawnień wpisów tajnych/zestawu.
PUT {vaultBaseUrl}/secrets/{secret-name}?api-version=7.4
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
secret-name
|
path | True |
string |
Nazwa wpisu tajnego. Wartość, którą podajesz, może zostać skopiowana globalnie na potrzeby uruchamiania usługi. Podana wartość nie powinna zawierać danych osobowych ani poufnych. Regex pattern: |
vault
|
path | True |
string |
Nazwa magazynu, na przykład https://myvault.vault.azure.net. |
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
Treść żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
value | True |
string |
Wartość wpisu tajnego. |
attributes |
Atrybuty zarządzania wpisami tajnymi. |
||
contentType |
string |
Typ wartości wpisu tajnego, takiej jak hasło. |
|
tags |
object |
Metadane specyficzne dla aplikacji w postaci par klucz-wartość. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Pakiet tajny zawierający wynik ustawionego żądania wpisu tajnego. |
|
Other Status Codes |
Key Vault odpowiedź o błędzie opisująca, dlaczego operacja nie powiodła się. |
Przykłady
SetSecret
Sample Request
PUT https://myvault.vault.azure.net//secrets/crpsecret?api-version=7.4
{
"value": "mysecretvalue"
}
Sample Response
{
"value": "mysecretvalue",
"id": "https://myvault.vault.azure.net/secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441",
"attributes": {
"enabled": true,
"created": 1493938459,
"updated": 1493938459,
"recoveryLevel": "Recoverable+Purgeable"
}
}
Definicje
Nazwa | Opis |
---|---|
Deletion |
Odzwierciedla obecnie poziom odzyskiwania usuwania dla wpisów tajnych w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", wpis tajny może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić wpis tajny na końcu interwału przechowywania. |
Error |
Błąd serwera magazynu kluczy. |
Key |
Wyjątek błędu magazynu kluczy. |
Secret |
Atrybuty zarządzania wpisami tajnymi. |
Secret |
Wpis tajny składający się z wartości, identyfikatora i jego atrybutów. |
Secret |
Parametry zestawu wpisów tajnych. |
DeletionRecoveryLevel
Odzwierciedla obecnie poziom odzyskiwania usuwania dla wpisów tajnych w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", wpis tajny może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić wpis tajny na końcu interwału przechowywania.
Nazwa | Typ | Opis |
---|---|---|
CustomizedRecoverable |
string |
Określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania, gdy 7<= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania i gdy subskrypcja jest nadal dostępna. |
CustomizedRecoverable+ProtectedSubscription |
string |
Określa magazyn i stan subskrypcji, w którym usunięcie jest możliwe do odzyskania, natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) jest niedozwolone i w którym sama subskrypcja nie może zostać trwale anulowana, gdy 7<= SoftDeleteRetentionInDays < 90. Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania, a także odzwierciedla fakt, że sama subskrypcja nie może zostać anulowana. |
CustomizedRecoverable+Purgeable |
string |
Określa stan magazynu, w którym można odzyskać usunięcie, a także zezwala na natychmiastowe i trwałe usunięcie (tj. przeczyszczanie, gdy 7<= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania, chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana. |
Purgeable |
string |
Określa stan magazynu, w którym usunięcie jest nieodwracalną operacją bez możliwości odzyskiwania. Ten poziom nie odpowiada działaniu ochrony przed operacją Usuwania; dane są nieodwracalnie utracone po zaakceptowaniu operacji Usuń na poziomie jednostki lub wyższym (magazyn, grupa zasobów, subskrypcja itp.) |
Recoverable |
string |
Określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni) i gdy subskrypcja jest nadal dostępna. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane |
Recoverable+ProtectedSubscription |
string |
Określa magazyn i stan subskrypcji, w którym usunięcie można odzyskać w interwale przechowywania (90 dni), natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) nie jest dozwolone i w którym sama subskrypcja nie może zostać trwale anulowana. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane |
Recoverable+Purgeable |
string |
Określa stan magazynu, w którym można odzyskać usunięcie, a także zezwala na natychmiastowe i trwałe usunięcie (tj. przeczyszczanie). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni), chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane |
Error
Błąd serwera magazynu kluczy.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
innererror |
Błąd serwera magazynu kluczy. |
|
message |
string |
Komunikat o błędzie. |
KeyVaultError
Wyjątek błędu magazynu kluczy.
Nazwa | Typ | Opis |
---|---|---|
error |
Błąd serwera magazynu kluczy. |
SecretAttributes
Atrybuty zarządzania wpisami tajnymi.
Nazwa | Typ | Opis |
---|---|---|
created |
integer |
Czas tworzenia w formacie UTC. |
enabled |
boolean |
Określa, czy obiekt jest włączony. |
exp |
integer |
Data wygaśnięcia w formacie UTC. |
nbf |
integer |
Nie wcześniej niż data w formacie UTC. |
recoverableDays |
integer |
softDelete data retention days (dni przechowywania danych softDelete). Wartość powinna mieć wartość >=7 i <=90, gdy funkcja softDelete jest włączona, w przeciwnym razie wartość 0. |
recoveryLevel |
Odzwierciedla obecnie poziom odzyskiwania usuwania dla wpisów tajnych w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", wpis tajny może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić wpis tajny na końcu interwału przechowywania. |
|
updated |
integer |
Czas ostatniej aktualizacji w formacie UTC. |
SecretBundle
Wpis tajny składający się z wartości, identyfikatora i jego atrybutów.
Nazwa | Typ | Opis |
---|---|---|
attributes |
Atrybuty zarządzania wpisami tajnymi. |
|
contentType |
string |
Typ zawartości wpisu tajnego. |
id |
string |
Identyfikator wpisu tajnego. |
kid |
string |
Jeśli jest to wpis tajny, który jest kopią zapasową certyfikatu KV, to pole określa odpowiedni klucz kopii zapasowej certyfikatu KV. |
managed |
boolean |
Prawda, jeśli okres istnienia wpisu tajnego jest zarządzany przez magazyn kluczy. Jeśli jest to wpis tajny kopii zapasowej certyfikatu, zarządzanie będzie prawdziwe. |
tags |
object |
Metadane specyficzne dla aplikacji w postaci par klucz-wartość. |
value |
string |
Wartość wpisu tajnego. |
SecretSetParameters
Parametry zestawu wpisów tajnych.
Nazwa | Typ | Opis |
---|---|---|
attributes |
Atrybuty zarządzania wpisami tajnymi. |
|
contentType |
string |
Typ wartości wpisu tajnego, takiej jak hasło. |
tags |
object |
Metadane specyficzne dla aplikacji w postaci par klucz-wartość. |
value |
string |
Wartość wpisu tajnego. |