Get Deleted Certificates - Get Deleted Certificates

リファレンス

Service:: Key Vault

API Version:: 7.4

現在復旧に使用できる指定されたコンテナー内の削除された証明書をListsします。
GetDeletedCertificates 操作は、現在のコンテナー内の証明書を取得します。この証明書は削除された状態で、復旧または消去の準備ができています。この操作には、削除固有の情報が含まれます。この操作には、certificates/get/list アクセス許可が必要です。この操作は、論理的な削除が有効なコンテナーでのみ有効にすることができます。

GET {vaultBaseUrl}/deletedcertificates?api-version=7.4

With optional parameters:

GET {vaultBaseUrl}/deletedcertificates?maxresults={maxresults}&includePending={includePending}&api-version=7.4

URI パラメーター

名前	/	必須	型	説明
vaultBaseUrl	path	True	string	コンテナー名 (例: https://myvault.vault.azure.net)。
api-version	query	True	string	クライアント API バージョン。
includePending	query		boolean	完全にプロビジョニングされていない証明書を含めるかどうかを指定します。
maxresults	query		integer int32	ページに返される結果の最大数。指定しない場合、サービスは最大 25 件の結果を返します。

応答

名前	型	説明
200 OK	DeletedCertificateListResult	コンテナー内の削除された証明書の一覧と、削除された証明書の次のページへのリンクを含む応答メッセージ
Other Status Codes	KeyVaultError	操作が失敗した理由を説明するエラー応答をKey Vaultします。

例

GetDeletedCertificates

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "recoveryId": "https://myvault.vault.azure.net/deletedcertificates/listdeletedcerttest0",
      "deletedDate": 1493937659,
      "scheduledPurgeDate": 1501713659,
      "id": "https://myvault.vault.azure.net/certificates/listdeletedcerttest0",
      "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
      "attributes": {
        "enabled": true,
        "nbf": 1430344421,
        "exp": 2208988799,
        "created": 1493937658,
        "updated": 1493937658,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/deletedcertificates?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMTIhTURBd01ETTVJV05sY25ScFptbGpZWFJsTDB4SlUxUkVSVXhGVkVWRVEwVlNWRlJGVTFRd0wxQlBURWxEV1NFd01EQXdNamdoT1RrNU9TMHhNaTB6TVZReU16bzFPVG8xT1M0NU9UazVPVGs1V2lFLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1"
}

定義

名前	説明
CertificateAttributes	証明書管理属性。
DeletedCertificateItem	削除された証明書に関するメタデータを含む削除された証明書アイテム。
DeletedCertificateListResult	このコンテナーで削除された証明書の一覧。
DeletionRecoveryLevel	現在のコンテナー内の証明書に対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーが証明書を完全に削除できます。それ以外の場合は、保持間隔の最後に証明書を消去できるのはシステムだけです。
Error	キーコンテナーサーバーエラー。
KeyVaultError	キーコンテナーエラー例外。

CertificateAttributes

証明書管理属性。

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

DeletedCertificateItem

削除された証明書に関するメタデータを含む削除された証明書アイテム。

名前	型	説明
attributes	CertificateAttributes	証明書管理属性。
deletedDate	integer	証明書が削除された時刻 (UTC)
id	string	証明書識別子。
recoveryId	string	削除された証明書を識別して回復するために使用される回復オブジェクトの URL。
scheduledPurgeDate	integer	証明書の消去がスケジュールされている時刻 (UTC)
tags	object	キーと値のペアの形式による、アプリケーション固有のメタデータ。
x5t	string	証明書の拇印。

DeletedCertificateListResult

このコンテナーで削除された証明書の一覧。

名前	型	説明
nextLink	string	削除された証明書の次のセットを取得する URL。
value	DeletedCertificateItem[]	コンテナー内の削除された証明書の一覧と、削除された証明書の次のページへのリンクを含む応答メッセージ

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	キーコンテナーサーバーエラー。

Share via