Get Secret - Get Secret

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

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

URI パラメーター

Name In Required Type Description
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 バージョン。

応答

Name Type Description
200 OK

取得したシークレット。

Other Status Codes

操作が失敗した理由を説明する Key Vault エラー応答。

GetSecret

Sample Request

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

Sample Response

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

定義

DeletionRecoveryLevel

現在の資格情報コンテナーのシークレットに対して現在有効な削除復旧レベルを反映します。 ' Purgeable ' が含まれている場合は、特権を持つユーザーがシークレットを完全に削除できます。それ以外の場合、保有期間の終了時に、シークレットを削除できるのはシステムだけです。

Error

Key vault サーバーエラーです。

KeyVaultError

Key vault エラー例外。

SecretAttributes

シークレット管理属性。

SecretBundle

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

DeletionRecoveryLevel

現在の資格情報コンテナーのシークレットに対して現在有効な削除復旧レベルを反映します。 ' Purgeable ' が含まれている場合は、特権を持つユーザーがシークレットを完全に削除できます。それ以外の場合、保有期間の終了時に、シークレットを削除できるのはシステムだけです。

Name Type Description
CustomizedRecoverable
  • string

削除が回復可能なコンテナーの状態を示します。この状態は、直ちに削除したり、完全に削除したりすることはできません (つまり、7<= SoftDeleteRetentionInDays < 90)。このレベルでは、保有期間中に削除されたエンティティの回復性が保証されますが、サブスクリプションは引き続き利用できます。

CustomizedRecoverable+ProtectedSubscription
  • string

削除が回復可能で、即時削除と永続的削除 (つまり、purge) が許可されておらず、7<= SoftDeleteRetentionInDays < 90 の場合にサブスクリプション自体を完全にキャンセルできない、コンテナーとサブスクリプションの状態を示します。 このレベルは、保有期間中に削除されたエンティティの回復性を保証します。また、サブスクリプション自体を取り消すことができないという事実も反映します。

CustomizedRecoverable+Purgeable
  • string

削除が回復可能なコンテナーの状態を示します。また、即時削除と永続的な削除 (たとえば、7<= SoftDeleteRetentionInDays < 90) を許可します。 このレベルでは、消去操作が要求された場合、またはサブスクリプションが取り消された場合を除き、削除されたエンティティの回復性が保持期間中に保証されます。

Purgeable
  • string

回復不可能な操作で、削除を元に戻すことができないコンテナーの状態を示します。 このレベルは、削除操作に対して保護が使用できない場合に対応します。データは、エンティティレベル以上 (コンテナー、リソースグループ、サブスクリプションなど) で削除操作を受け入れると不可能ほど失われます。

Recoverable
  • string

削除が回復可能なコンテナーの状態を示します。直ちに削除することはできません (つまり、purge)。 このレベルは、保有期間 (90 日) に削除されたエンティティの回復性を保証しますが、サブスクリプションは引き続き利用できます。 システム wil は、90日後に完全に削除されます (回復されていない場合)

Recoverable+ProtectedSubscription
  • string

保有期間内 (90 日) に削除が回復可能で、即時削除と永続的削除 (つまり、purge) が許可されておらず、サブスクリプション自体を完全にキャンセルできない場合に、コンテナーとサブスクリプションの状態を示します。 システム wil は、90日後に完全に削除されます (回復されていない場合)

Recoverable+Purgeable
  • string

削除が回復可能なコンテナーの状態を示します。これにより、即時削除と永続的な削除 (つまり、purge) も許可されます。 このレベルでは、消去操作が要求された場合、またはサブスクリプションが取り消された場合を除き、削除されたエンティティの回復性が保持期間 (90 日) に保証されます。 システム wil は、90日後に完全に削除されます (回復されていない場合)

Error

Key vault サーバーエラーです。

Name Type Description
code
  • string

エラー コード。

innererror

Key vault サーバーエラーです。

message
  • string

エラー メッセージ。

KeyVaultError

Key vault エラー例外。

Name Type Description
error

Key vault サーバーエラーです。

SecretAttributes

シークレット管理属性。

Name Type Description
created
  • integer

作成日時 (UTC)。

enabled
  • boolean

オブジェクトが有効かどうかを判断します。

exp
  • integer

有効期限 (UTC)。

nbf
  • integer

UTC の日付の前にありません。

recoverableDays
  • integer

データ保持日数をソフト削除します。 SoftDelete が有効になっている場合、値は >= 7、<= 90 である必要があります。それ以外の場合は0になります。

recoveryLevel

現在の資格情報コンテナーのシークレットに対して現在有効な削除復旧レベルを反映します。 ' Purgeable ' が含まれている場合は、特権を持つユーザーがシークレットを完全に削除できます。それ以外の場合、保有期間の終了時に、シークレットを削除できるのはシステムだけです。

updated
  • integer

最終更新時刻 (UTC)。

SecretBundle

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

Name Type Description
attributes

シークレット管理属性。

contentType
  • string

シークレットのコンテンツタイプ。

id
  • string

シークレット id。

kid
  • string

これが KV 証明書をバッキングするシークレットである場合、このフィールドは KV 証明書をバッキングする、対応するキーを指定します。

managed
  • boolean

シークレットの有効期間が key vault によって管理されている場合は True。 これが証明書をバッキングするシークレットである場合、管理は true になります。

tags
  • object

キーと値のペアの形式による、アプリケーション固有のメタデータ。

value
  • string

シークレット値。