Get Certificates - Get Certificates

リファレンス

Service:: Key Vault

API Version:: 7.4

指定したキーコンテナー内の証明書を一覧表示する
GetCertificates 操作は、指定されたキーコンテナー内の証明書リソースのセットを返します。この操作には、証明書/リストのアクセス許可が必要です。

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

With optional parameters:

GET {vaultBaseUrl}/certificates?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	CertificateListResult	証明書の一覧と、証明書の次のページへのリンクを含む応答メッセージ。
Other Status Codes	KeyVaultError	操作が失敗した理由を説明するエラー応答をKey Vaultします。

例

GetCertificates

Sample Request

HTTP

GET https://myvault.vault.azure.net//certificates?api-version=7.4

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "https://myvault.vault.azure.net/certificates/listCert01",
      "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
      "attributes": {
        "enabled": true,
        "nbf": 1430344421,
        "exp": 2208988799,
        "created": 1482188987,
        "updated": 1482188987
      }
    },
    {
      "id": "https://myvault.vault.azure.net/certificates/listCert02",
      "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
      "attributes": {
        "enabled": true,
        "nbf": 1430344421,
        "exp": 2208988799,
        "created": 1482188988,
        "updated": 1482188988
      }
    }
  ],
  "nextLink": null
}

定義

名前	説明
CertificateAttributes	証明書管理属性。
CertificateItem	証明書メタデータを含む証明書項目。
CertificateListResult	証明書リストの結果。
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 での最終更新時刻。

CertificateItem

証明書メタデータを含む証明書項目。

名前	型	説明
attributes	CertificateAttributes	証明書管理属性。
id	string	証明書識別子。
tags	object	キーと値のペアの形式による、アプリケーション固有のメタデータ。
x5t	string	証明書の拇印。

CertificateListResult

証明書リストの結果。

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

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