Get Secret Versions - Get Secret Versions

リファレンス

Service:: Key Vault

API Version:: 7.4

指定したシークレットのすべてのバージョンを一覧表示します。
完全なシークレット識別子および属性は応答で提供されます。シークレットの値は返されません。この操作には、secrets/list アクセス許可が必要です。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
secret-name	path	True	string	シークレットの名前。
vaultBaseUrl	path	True	string	コンテナー名 (例: https://myvault.vault.azure.net)。
api-version	query	True	string	クライアント API バージョン。
maxresults	query		integer int32	ページに返される結果の最大数。指定しない場合、サービスは最大 25 件の結果を返します。

応答

名前	型	説明
200 OK	SecretListResult	シークレットの一覧とシークレットの次のページへのリンクを含む応答メッセージ。
Other Status Codes	KeyVaultError	操作が失敗した理由を説明するエラー応答をKey Vaultします。

例

GetSecretVersions

Sample Request

HTTP

GET https://myvault.vault.azure.net//secrets/listsecretversionstest/versions?maxresults=1&api-version=7.4

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "https://myvault.vault.azure.net/secrets/listsecretversionstest/11a536561da34d6b8b452d880df58f3a",
      "attributes": {
        "enabled": true,
        "created": 1481851699,
        "updated": 1481851699
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/secrets/listsecretversionstest/versions?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExNDQhTURBd01EWXlJWE5sWTNKbGRDOU1TVk5VVTBWRFVrVlVWa1ZTVTBsUFRsTlVSVk5VTHpGRU5EazJNa0l4UlVRM09EUkVRa1k0T1RsR016TXpNa1UwTnpZNFFqY3dJVEF3TURBeU9DRTVPVGs1TFRFeUxUTXhWREl6T2pVNU9qVTVMams1T1RrNU9UbGFJUS0tIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1"
}

定義

名前	説明
DeletionRecoveryLevel	現在のコンテナー内のシークレットに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーによってシークレットを完全に削除できます。それ以外の場合は、保持間隔の最後に、システムのみがシークレットを消去できます。
Error	キーコンテナーサーバーエラー。
KeyVaultError	キーコンテナーエラー例外。
SecretAttributes	シークレット管理属性。
SecretItem	シークレットメタデータを含むシークレットアイテム。
SecretListResult	シークレットリストの結果。

DeletionRecoveryLevel

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

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

Error

キーコンテナーサーバーエラー。

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

KeyVaultError

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

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

SecretAttributes

シークレット管理属性。

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

SecretItem

シークレットメタデータを含むシークレットアイテム。

名前	型	説明
attributes	SecretAttributes	シークレット管理属性。
contentType	string	パスワードなどのシークレット値の種類。
id	string	シークレット識別子。
managed	boolean	シークレットの有効期間がキーコンテナーによって管理されている場合は True。これが証明書をバックアップするキーの場合、マネージドは true になります。
tags	object	キーと値のペアの形式による、アプリケーション固有のメタデータ。

SecretListResult

シークレットリストの結果。

名前	型	説明
nextLink	string	次のシークレットセットを取得する URL。
value	SecretItem[]	キーコンテナー内のシークレットの一覧と、シークレットの次のページへのリンクを含む応答メッセージ。