Set Secret - Set Secret

サービス:: Key Vault

API バージョン:: 2025-07-01

指定したキーコンテナーにシークレットを設定します。
SET 操作は、Azure Key Vault にシークレットを追加します。名前付きシークレットが既に存在する場合、Azure Key Vault によってそのシークレットの新しいバージョンが作成されます。この操作には、シークレット/設定アクセス許可が必要です。

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

URI パラメーター

名前	/	必須	型	説明
secret-name	path	True	string pattern: ^[0-9a-zA-Z-]+$	シークレットの名前。指定した値は、サービスを実行する目的でグローバルにコピーされる場合があります。提供される値には、個人を特定できる情報や機密情報を含めることはできません。
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
value	True	string	シークレットの値。
attributes		SecretAttributes	シークレット管理属性。
contentType		string	パスワードなどのシークレット値のタイプ。
tags		object	キーと値のペアの形式でのアプリケーション固有のメタデータ。

応答

名前	型	説明
200 OK	SecretBundle	要求は成功しました。
Other Status Codes	KeyVaultError	予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
https://vault.azure.net/.default

例

SetSecret

要求のサンプル

HTTP

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

{
  "value": "mysecretvalue"
}

応答のサンプル

状態コード:: 200

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

定義

名前	説明
DeletionRecoveryLevel	現在のコンテナー内のシークレットに対して現在有効な削除回復レベルを反映します。「Purgeable」が含まれている場合、特権ユーザーはシークレットを完全に削除できます。それ以外の場合は、保存間隔の終了時にシークレットをパージできるのはシステムだけです。
Error
KeyVaultError	キーコンテナーエラーの例外。
SecretAttributes	シークレット管理属性。
SecretBundle	値、id、およびその属性で構成されるシークレット。
SecretSetParameters	シークレットセットパラメータ。

DeletionRecoveryLevel

列挙

現在のコンテナー内のシークレットに対して現在有効な削除回復レベルを反映します。「Purgeable」が含まれている場合、特権ユーザーはシークレットを完全に削除できます。それ以外の場合は、保存間隔の終了時にシークレットをパージできるのはシステムだけです。

値	説明
Purgeable	削除が元に戻せない操作であり、回復の可能性がないボールト状態を示します。このレベルは、削除操作に対して使用可能な保護がないことに相当します。エンティティレベル以上 (コンテナー、リソースグループ、サブスクリプションなど) で削除操作を受け入れると、データが回復不能に失われます。
Recoverable+Purgeable	削除が回復可能であり、即時および永続的な削除 (つまり、パージ) も許可されるボールト状態を示します。このレベルは、パージ操作が要求されるか、サブスクリプションが取り消されない限り、保持間隔 (90 日) 中に削除されたエンティティの回復可能性を保証します。システムは、回復しない場合、90日後に完全に削除されます
Recoverable	即時かつ永続的な削除 (つまり、パージ) の可能性なしに削除が回復できるボールト状態を示します。このレベルでは、保持期間 (90 日) 中、およびサブスクリプションがまだ使用可能な間、削除されたエンティティの回復可能性が保証されます。システムは、回復しない場合、90日後に完全に削除されます
Recoverable+ProtectedSubscription	保持期間 (90 日) 内に削除が回復可能で、即時および永続的な削除 (つまり、パージ) が許可されず、サブスクリプション自体を完全にキャンセルできないボールトおよびサブスクリプションの状態を示します。システムは、回復しない場合、90日後に完全に削除されます
CustomizedRecoverable+Purgeable	削除が回復可能であり、即時かつ永続的な削除も許可されるコンテナーの状態を示します (つまり、7 <= SoftDeleteRetentionInDays < 90 の場合はパージします)。このレベルは、消去操作が要求されるか、サブスクリプションが取り消されない限り、保持間隔中に削除されたエンティティの回復可能性を保証します。
CustomizedRecoverable	即時かつ永続的な削除の可能性を伴わずに削除が回復可能なコンテナー状態を示します (つまり、7 <= SoftDeleteRetentionInDays < 90 の場合はパージします)。このレベルは、保持間隔中およびサブスクリプションがまだ使用可能な間、削除されたエンティティの回復可能性を保証します。
CustomizedRecoverable+ProtectedSubscription	削除が回復可能で、即時および永続的な削除 (つまり、パージ) が許可されず、7 <= SoftDeleteRetentionInDays < 90 の場合にサブスクリプション自体を完全にキャンセルできないボールトおよびサブスクリプションの状態を示します。このレベルは、保持間隔中に削除されたエンティティの回復可能性を保証し、サブスクリプション自体を取り消すことができないという事実も反映します。

Error

Object

名前	型	説明
code	string	エラーコード。
innererror	Error	キーコンテナーサーバーエラー。
message	string	エラーメッセージ。

KeyVaultError

Object

キーコンテナーエラーの例外。

名前	型	説明
error	Error	キーコンテナーサーバーエラー。

SecretAttributes

Object

シークレット管理属性。

名前	型	説明
created	integer (unixtime)	UTCでの作成時刻。
enabled	boolean	オブジェクトが有効かどうかを判断します。
exp	integer (unixtime)	有効期限はUTCです。
nbf	integer (unixtime)	UTCの日付より前ではありません。
recoverableDays	integer (int32)	softDelete データ保有日数。 softDelete が有効な場合は >=7 と <=90 で、それ以外の場合は 0 です。
recoveryLevel	DeletionRecoveryLevel	現在のコンテナー内のシークレットに対して現在有効な削除回復レベルを反映します。「Purgeable」が含まれている場合、特権ユーザーはシークレットを完全に削除できます。それ以外の場合は、保存間隔の終了時にシークレットをパージできるのはシステムだけです。
updated	integer (unixtime)	最終更新時刻 (UTC)。

SecretBundle

Object

値、id、およびその属性で構成されるシークレット。

名前	型	説明
attributes	SecretAttributes	シークレット管理属性。
contentType	string	シークレットのコンテンツタイプ。
id	string	シークレット ID。
kid	string	これが KV 証明書をバックアップするシークレットの場合、このフィールドは KV 証明書をバックアップする対応するキーを指定します。
managed	boolean	シークレットの有効期間がキーコンテナーによって管理されている場合は True。これが証明書を裏付けるシークレットである場合、managed は true になります。
previousVersion	string	以前の証明書のバージョン (該当する場合)。 2025 年 6 月 1 日以降に作成された証明書にのみ適用されます。この日付より前に作成された証明書は遡及的に更新されません。
tags	object	キーと値のペアの形式でのアプリケーション固有のメタデータ。
value	string	シークレット値。

SecretSetParameters

Object

シークレットセットパラメータ。

名前	型	説明
attributes	SecretAttributes	シークレット管理属性。
contentType	string	パスワードなどのシークレット値のタイプ。
tags	object	キーと値のペアの形式でのアプリケーション固有のメタデータ。
value	string	シークレットの値。

次の方法で共有

Set Secret - Set Secret

URI パラメーター

要求本文

応答

セキュリティ

OAuth2Auth

スコープ

例

SetSecret

要求のサンプル

応答のサンプル

定義

DeletionRecoveryLevel

Error

KeyVaultError

SecretAttributes

SecretBundle

SecretSetParameters