Set Secret - Set Secret

Dienst:

Key Vault

API-Version:

7.4

Legt ein Geheimnis in einem angegebenen Schlüsseltresor fest.
Der SET-Vorgang fügt dem Azure-Key Vault ein Geheimnis hinzu. Wenn der benannte geheime Schlüssel bereits vorhanden ist, erstellt der Azure-Schlüsseltresor eine neue Version des geheimen Schlüssels. Dieser Vorgang erfordert die „secrets/set“-Berechtigung.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
secret-name	path	True	string	Der Name des Geheimnisses. Der von Ihnen bereitgestellte Wert kann global kopiert werden, um den Dienst auszuführen. Der bereitgestellte Wert sollte keine persönlich identifizierbaren oder sensiblen Informationen enthalten. RegEx-Muster: ^[0-9a-zA-Z-]+$
vaultBaseUrl	path	True	string	Der Tresorname, z. B https://myvault.vault.azure.net. .
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
value	True	string	Der Wert des geheimen Schlüssels.
attributes		SecretAttributes	Die Attribute für die Geheimnisverwaltung.
contentType		string	Der Typ des Geheimniswerts, z. B. ein Kennwort.
tags		object	Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren.

Antworten

Name	Typ	Beschreibung
200 OK	SecretBundle	Ein Geheimnispaket, das das Ergebnis der Set Secret-Anforderung enthält.
Other Status Codes	KeyVaultError	Key Vault Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

SetSecret

Beispielanforderung

HTTP

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

{
  "value": "mysecretvalue"
}

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
DeletionRecoveryLevel	Gibt die Löschwiederherstellungsebene an, die derzeit für Geheimnisse im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Geheimnis von einem privilegierten Benutzer endgültig gelöscht werden. Andernfalls kann nur das System das Geheimnis am Ende des Aufbewahrungsintervalls bereinigen.
Error	Der Schlüsseltresorserverfehler.
KeyVaultError	Die Schlüsseltresorfehler-Ausnahme.
SecretAttributes	Die Attribute für die Geheimnisverwaltung.
SecretBundle	Ein Geheimnis, das aus einem Wert, id und seinen Attributen besteht.
SecretSetParameters	Die Geheimnissatzparameter.

DeletionRecoveryLevel

Gibt die Löschwiederherstellungsebene an, die derzeit für Geheimnisse im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Geheimnis von einem privilegierten Benutzer endgültig gelöscht werden. Andernfalls kann nur das System das Geheimnis am Ende des Aufbewahrungsintervalls bereinigen.

Name	Typ	Beschreibung
CustomizedRecoverable	string	Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann, ohne die Möglichkeit einer sofortigen und dauerhaften Löschung zu haben (d. h. löschen, wenn 7< = SoftDeleteRetentionInDays < 90). Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und solange das Abonnement noch verfügbar ist.
CustomizedRecoverable+ProtectedSubscription	string	Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen wiederhergestellt werden kann, das sofortige und dauerhafte Löschen (d. h. löschen) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann, wenn 7<= SoftDeleteRetentionInDays < 90. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und spiegelt auch die Tatsache wider, dass das Abonnement selbst nicht gekündigt werden kann.
CustomizedRecoverable+Purgeable	string	Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann, und der auch das sofortige und dauerhafte Löschen zulässt (d. h. löschen, wenn 7< = SoftDeleteRetentionInDays < 90). Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls, es sei denn, es wird ein Bereinigungsvorgang angefordert oder das Abonnement gekündigt.
Purgeable	string	Gibt einen Tresorzustand an, bei dem das Löschen ein irreversibler Vorgang ist, ohne dass eine Wiederherstellung möglich ist. Diese Ebene entspricht keinem Schutz vor einem Löschvorgang. Die Daten sind unwiederbringlich verloren, wenn Sie einen Löschvorgang auf Entitätsebene oder höher (Tresor, Ressourcengruppe, Abonnement usw.) akzeptieren.
Recoverable	string	Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann, ohne die Möglichkeit einer sofortigen und dauerhaften Löschung (d. h. Löschen) zu haben. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage) und solange das Abonnement noch verfügbar ist. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird
Recoverable+ProtectedSubscription	string	Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen innerhalb eines Aufbewahrungsintervalls (90 Tage) wiederhergestellt werden kann, das sofortige und dauerhafte Löschen (d. h. löschen) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird
Recoverable+Purgeable	string	Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann, und der auch das sofortige und dauerhafte Löschen (d. h. Löschen) zulässt. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage), es sei denn, ein Bereinigungsvorgang wird angefordert oder das Abonnement wird gekündigt. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird

Error

Der Schlüsseltresorserverfehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
innererror	Error	Der Schlüsseltresorserverfehler.
message	string	Die Fehlermeldung.

KeyVaultError

Die Schlüsseltresorfehler-Ausnahme.

Name	Typ	Beschreibung
error	Error	Der Schlüsseltresorserverfehler.

SecretAttributes

Die Attribute für die Geheimnisverwaltung.

Name	Typ	Beschreibung
created	integer	Erstellungszeit in UTC.
enabled	boolean	Bestimmt, ob das Objekt aktiviert ist.
exp	integer	Ablaufdatum in UTC.
nbf	integer	Nicht vor Datum in UTC.
recoverableDays	integer	softDelete Datenaufbewahrungstage. Der Wert sollte =7 und <=90 sein>, wenn softDelete aktiviert ist, andernfalls 0.
recoveryLevel	DeletionRecoveryLevel	Gibt die Löschwiederherstellungsebene an, die derzeit für Geheimnisse im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Geheimnis von einem privilegierten Benutzer endgültig gelöscht werden. Andernfalls kann nur das System das Geheimnis am Ende des Aufbewahrungsintervalls bereinigen.
updated	integer	Uhrzeit der letzten Aktualisierung in UTC.

SecretBundle

Ein Geheimnis, das aus einem Wert, id und seinen Attributen besteht.

Name	Typ	Beschreibung
attributes	SecretAttributes	Die Attribute für die Geheimnisverwaltung.
contentType	string	Der Inhaltstyp des Geheimnisses.
id	string	Die Geheimnis-ID.
kid	string	Wenn dies ein Geheimnis ist, das ein KV-Zertifikat sichert, gibt dieses Feld den entsprechenden Schlüssel an, der das KV-Zertifikat sichert.
managed	boolean	True, wenn die Lebensdauer des Geheimnisses vom Schlüsseltresor verwaltet wird. Wenn dies ein Geheimnis ist, das ein Zertifikat sichert, ist verwaltet true.
tags	object	Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren.
value	string	Der Geheimniswert.

SecretSetParameters

Die Geheimnissatzparameter.

Name	Typ	Beschreibung
attributes	SecretAttributes	Die Attribute für die Geheimnisverwaltung.
contentType	string	Der Typ des Geheimniswerts, z. B. ein Kennwort.
tags	object	Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren.
value	string	Der Wert des geheimen Schlüssels.