Freigeben über

Set Secret - Set Secret

Dienst:
Key Vault
API-Version:
2025-07-01

Legt ein Geheimnis in einem angegebenen Schlüsseltresor fest.
Der SET-Vorgang fügt Azure Key Vault ein Geheimnis hinzu. Wenn das benannte Geheimnis bereits vorhanden ist, erstellt Azure Key Vault eine neue Version dieses Geheimnisses. Für diesen Vorgang sind die geheimen/festgelegten Berechtigungen erforderlich.

PUT {vaultBaseUrl}/secrets/{secret-name}?api-version=2025-07-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
secret-name
 path True

string

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

Der Name des geheimen Schlüssels. Der von Ihnen angegebene Wert kann zum Zwecke der Ausführung des Diensts global kopiert werden. Der angegebene Wert sollte keine personenbezogenen oder vertraulichen Informationen enthalten.
vaultBaseUrl
 path True

string (uri)

api-version
 query True

string

minLength: 1

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
value True

string

Der Wert des geheimen Schlüssels.
attributes

SecretAttributes

Die Attribute für die Verwaltung von Geheimnissen.
contentType

string

Typ des geheimen Werts, z. B. ein Kennwort.
tags

object

Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren.

Antworten

Name Typ Beschreibung
200 OK

SecretBundle

Die Anforderung ist erfolgreich.
Other Status Codes

KeyVaultError

Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
https://vault.azure.net/.default

Beispiele

SetSecret

Beispielanforderung

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

{
  "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 Wiederherstellungsstufe für das Löschen an, die derzeit für Geheimnisse im aktuellen Tresor gilt. Wenn es "Purgeable" enthält, kann das Geheimnis von einem privilegierten Benutzer dauerhaft gelöscht werden. Andernfalls kann nur das System den geheimen Schlüssel am Ende des Aufbewahrungsintervalls löschen.
Error
KeyVaultError

Die Key Vault-Fehlerausnahme.
SecretAttributes

Die Attribute für die Verwaltung von Geheimnissen.
SecretBundle

Ein Geheimnis, das aus einem Wert, einer ID und seinen Attributen besteht.
SecretSetParameters

Das Geheimnis legt Parameter fest.

DeletionRecoveryLevel

Enumeration

Gibt die Wiederherstellungsstufe für das Löschen an, die derzeit für Geheimnisse im aktuellen Tresor gilt. Wenn es "Purgeable" enthält, kann das Geheimnis von einem privilegierten Benutzer dauerhaft gelöscht werden. Andernfalls kann nur das System den geheimen Schlüssel am Ende des Aufbewahrungsintervalls löschen.

Wert Beschreibung
Purgeable

Gibt einen Tresorstatus an, in dem der Löschvorgang nicht rückgängig gemacht werden kann, ohne dass eine Wiederherstellung möglich ist. Diese Stufe entspricht dem Hintergrund, dass kein Schutz gegen einen Delete-Vorgang verfügbar ist. Die Daten gehen unwiederbringlich verloren, wenn ein Löschvorgang auf Entitätsebene oder höher (Tresor, Ressourcengruppe, Abonnement usw.) akzeptiert wird.
Recoverable+Purgeable

Gibt einen Tresorstatus an, in dem der Löschvorgang wiederhergestellt werden kann und der auch ein sofortiges und dauerhaftes Löschen (d. h. Löschen) ermöglicht. Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage), es sei denn, es wird ein Bereinigungsvorgang angefordert oder das Abonnement gekündigt. Das System löscht es nach 90 Tagen dauerhaft, wenn es nicht wiederhergestellt wird
Recoverable

Bezeichnet einen Tresorstatus, in dem der Löschvorgang wiederhergestellt werden kann, ohne dass eine sofortige und dauerhafte Löschung möglich ist (d. h. Löschung). Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage) und solange das Abonnement noch verfügbar ist. Das System löscht es nach 90 Tagen dauerhaft, wenn es nicht wiederhergestellt wird
Recoverable+ProtectedSubscription

Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen innerhalb des Aufbewahrungsintervalls (90 Tage) wiederhergestellt werden kann, ein sofortiges und dauerhaftes Löschen (d. h. Löschung) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann. Das System löscht es nach 90 Tagen dauerhaft, wenn es nicht wiederhergestellt wird
CustomizedRecoverable+Purgeable

Gibt einen Tresorstatus an, in dem der Löschvorgang wiederhergestellt werden kann und der auch ein sofortiges und dauerhaftes Löschen zulässt (d. h. Bereinigung, wenn 7 <= SoftDeleteRetentionInDays < 90). Diese Stufe 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.
CustomizedRecoverable

Gibt einen Tresorstatus an, in dem der Löschvorgang ohne die Möglichkeit eines sofortigen und dauerhaften Löschens wiederhergestellt werden kann (d. h. Bereinigung, wenn 7 <= SoftDeleteRetentionInDays < 90). Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und solange das Abonnement noch verfügbar ist.
CustomizedRecoverable+ProtectedSubscription

Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen wiederherstellbar ist, ein sofortiges und dauerhaftes 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 ist. Diese Stufe 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.

Error

Objekt
Name Typ Beschreibung
code

string

Der Fehlercode.
innererror

Error

Der Key Vault-Serverfehler.
message

string

Die Fehlermeldung.

KeyVaultError

Objekt

Die Key Vault-Fehlerausnahme.

Name Typ Beschreibung
error

Error

Der Key Vault-Serverfehler.

SecretAttributes

Objekt

Die Attribute für die Verwaltung von Geheimnissen.

Name Typ Beschreibung
created

integer (unixtime)

Erstellungszeit in UTC.
enabled

boolean

Bestimmt, ob das Objekt aktiviert ist.
exp

integer (unixtime)

Ablaufdatum in UTC.
nbf

integer (unixtime)

Nicht vor dem Datum in UTC.
recoverableDays

integer (int32)

SoftDelete-Datenaufbewahrungstage. Der Wert sollte =7 und >=90 sein<, wenn softDelete aktiviert ist, andernfalls 0.
recoveryLevel

DeletionRecoveryLevel

Gibt die Wiederherstellungsstufe für das Löschen an, die derzeit für Geheimnisse im aktuellen Tresor gilt. Wenn es "Purgeable" enthält, kann das Geheimnis von einem privilegierten Benutzer dauerhaft gelöscht werden. Andernfalls kann nur das System den geheimen Schlüssel am Ende des Aufbewahrungsintervalls löschen.
updated

integer (unixtime)

Uhrzeit der letzten Aktualisierung in UTC.

SecretBundle

Objekt

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

Name Typ Beschreibung
attributes

SecretAttributes

Die Attribute für die Verwaltung von Geheimnissen.
contentType

string

Der Inhaltstyp des geheimen Schlüssels.
id

string

Die geheime ID.
kid

string

Wenn es sich um einen geheimen Schlüssel handelt, der ein KV-Zertifikat unterstützt, gibt dieses Feld den entsprechenden Schlüssel an, der das KV-Zertifikat unterstützt.
managed

boolean

True, wenn die Lebensdauer des Geheimnisses von Key Vault verwaltet wird. Wenn es sich um ein Geheimnis handelt, das ein Zertifikat sichert, ist managed true.
previousVersion

string

Die Version des vorherigen Zertifikats, falls zutreffend. Gilt nur für Zertifikate, die nach dem 1. Juni 2025 erstellt wurden. Zertifikate, die vor diesem Datum erstellt wurden, werden nicht rückwirkend aktualisiert.
tags

object

Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren.
value

string

Der geheime Wert.

SecretSetParameters

Objekt

Das Geheimnis legt Parameter fest.

Name Typ Beschreibung
attributes

SecretAttributes

Die Attribute für die Verwaltung von Geheimnissen.
contentType

string

Typ des geheimen Werts, z. B. ein Kennwort.
tags

object

Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren.
value

string

Der Wert des geheimen Schlüssels.