Get Secret - Get Secret

サービス:: Key Vault

API バージョン:: 7.4

特定のキーコンテナーから指定されたシークレットを取得します。
GET 操作は、Azure Key Vault に格納されているすべてのシークレットに適用されます。この操作には、シークレット/取得アクセス許可が必要です。

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

URI パラメーター

名前	/	必須	型	説明
secret-name	path	True	string	シークレットの名前。
secret-version	path	True	string	シークレットのバージョン。この URI フラグメントは省略可能です。指定しない場合は、シークレットの最新バージョンが返されます。
vaultBaseUrl	path	True	string	コンテナー名 (`https://myvault.vault.azure.net`など)。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	SecretBundle	取得したシークレット。
Other Status Codes	KeyVaultError	操作が失敗した理由を説明する Key Vault エラー応答。

例

GetSecret

要求のサンプル

HTTP

GET https://myvault.vault.azure.net//secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79?api-version=7.4

応答のサンプル

状態コード:: 200

{
  "value": "mysecretvalue",
  "id": "https://myvault.vault.azure.net/secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79",
  "attributes": {
    "enabled": true,
    "created": 1493938410,
    "updated": 1493938410,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

定義

名前	説明
DeletionRecoveryLevel	現在のコンテナー内のシークレットに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーがシークレットを完全に削除できます。それ以外の場合は、リテンション期間の最後に、システムだけがシークレットを消去できます。
Error	キーコンテナーサーバーエラー。
KeyVaultError	キーコンテナーのエラー例外。
SecretAttributes	シークレット管理属性。
SecretBundle	値、ID、およびその属性で構成されるシークレット。

DeletionRecoveryLevel

列挙

現在のコンテナー内のシークレットに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーがシークレットを完全に削除できます。それ以外の場合は、リテンション期間の最後に、システムだけがシークレットを消去できます。

値	説明
CustomizedRecoverable	即時および永続的な削除を行わずに削除を復旧できるコンテナーの状態を示します (つまり、7<= SoftDeleteRetentionInDays < 90 の場合の消去)。このレベルでは、保持期間中およびサブスクリプションが引き続き使用可能な間に、削除されたエンティティの回復可能性が保証されます。
CustomizedRecoverable+ProtectedSubscription	7<= SoftDeleteRetentionInDays < 90 の場合に、削除が回復可能、即時削除、完全削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができないコンテナーとサブスクリプションの状態を示します。このレベルでは、保持期間中に削除されたエンティティの回復可能性が保証され、サブスクリプション自体を取り消すことができないという事実も反映されます。
CustomizedRecoverable+Purgeable	削除が回復可能であり、即時および永続的な削除も許可されるコンテナーの状態を示します (つまり、7<= SoftDeleteRetentionInDays < 90 の場合の消去)。このレベルでは、消去操作が要求されていないか、サブスクリプションが取り消されない限り、保持期間中に削除されたエンティティの回復可能性が保証されます。
Purgeable	削除が元に戻せない操作であるコンテナーの状態を示します。復旧の可能性はありません。このレベルは、削除操作に対して使用できる保護に対応しません。エンティティレベル以上 (コンテナー、リソースグループ、サブスクリプションなど) で削除操作を受け入れると、データは回復不能に失われます
Recoverable	即時削除と完全削除 (消去) なしで削除が復旧可能なコンテナーの状態を示します。このレベルでは、リテンション期間 (90 日) の間、およびサブスクリプションが引き続き使用可能な間に、削除されたエンティティの回復可能性が保証されます。システムは、90日後に完全に削除します(回復されていない場合)
Recoverable+ProtectedSubscription	コンテナーとサブスクリプションの状態を示します。この状態では、削除がリテンション期間内 (90 日以内)、即時削除と完全削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことはできません。システムは、90日後に完全に削除します(回復されていない場合)
Recoverable+Purgeable	削除が回復可能であり、即時および永続的な削除 (消去) も許可されるコンテナーの状態を示します。このレベルでは、消去操作が要求されるか、サブスクリプションが取り消されない限り、リテンション期間中 (90 日間) に削除されたエンティティの回復可能性が保証されます。システムは、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。これが証明書をバックアップするシークレットの場合、マネージドは true になります。
tags	object	キーと値のペアの形式のアプリケーション固有のメタデータ。
value	string	シークレット値。

次の方法で共有

Get Secret - Get Secret

URI パラメーター

応答

例

GetSecret

要求のサンプル

応答のサンプル

定義

DeletionRecoveryLevel

Error

KeyVaultError

SecretAttributes

SecretBundle