Certificate - List By Service

  • リファレンス
Service:
API Management
API Version:
2022-08-01

指定されたサービス インスタンスにおけるすべての証明書のコレクションを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates?api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates?$filter={$filter}&$top={$top}&$skip={$skip}&isKeyVaultRefreshFailed={isKeyVaultRefreshFailed}&api-version=2022-08-01

URI パラメーター

名前 / 必須 型 説明
resourceGroupName
 path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。
serviceName
 path True

string

API Management サービスの名前。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

ターゲット サブスクリプションの ID。
api-version
 query True

string

この操作に使用する API バージョン。
$filter
 query

string

|フィールド |使用法 |サポートされている演算子 |サポートされている関数 |
|-------------|-------------|-------------|-------------|
|name |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|subject |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|拇印 |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|expirationDate |filter |ge、le、eq、ne、gt、lt | |
$skip
 query

integer

int32

スキップするレコードの数。
$top
 query

integer

int32

返されるレコードの数。
isKeyVaultRefreshFailed
 query

boolean

true に設定すると、応答には更新に失敗した証明書エンティティのみが含まれます。

応答

名前 型 説明
200 OK

CertificateCollection

Certificate エンティティのコレクションを返します。
Other Status Codes

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

例

ApiManagementListCertificates

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/kjoshiarmtemplateCert1",
      "type": "Microsoft.ApiManagement/service/certificates",
      "name": "templateCert1",
      "properties": {
        "subject": "CN=mutual-authcert",
        "thumbprint": "EBA************************48594A6",
        "expirationDate": "2017-04-23T17:03:41Z"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv",
      "type": "Microsoft.ApiManagement/service/certificates",
      "name": "templateCertkv",
      "properties": {
        "subject": "CN=*.msitesting.net",
        "thumbprint": "EA**********************9AD690",
        "expirationDate": "2037-01-01T07:00:00Z",
        "keyVault": {
          "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert",
          "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
          "lastStatus": {
            "code": "Success",
            "timeStampUtc": "2020-09-22T00:24:53.3191468Z"
          }
        }
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

定義

名前 説明
CertificateCollection

[Paged Certificates list representation]\(ページ証明書リストの表現\)
CertificateContract

証明書の詳細。
ErrorFieldContract

エラー フィールド コントラクト。
ErrorResponse

エラー応答。
KeyVaultContractProperties

KeyVault コントラクトの詳細。
KeyVaultLastAccessStatusContractProperties

コントラクトの更新プロパティを発行します。

CertificateCollection

[Paged Certificates list representation]\(ページ証明書リストの表現\)

名前 型 説明
count

integer

すべてのページの合計レコード数。
nextLink

string

次のページリンク (存在する場合)。
value

CertificateContract[]

ページ値。

CertificateContract

証明書の詳細。

名前 型 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

リソースの名前
properties.expirationDate

string

証明書の有効期限。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。
properties.keyVault

KeyVaultContractProperties

証明書の KeyVault の場所の詳細。
properties.subject

string

証明書の件名属性。
properties.thumbprint

string

証明書の拇印。
type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ErrorFieldContract

エラー フィールド コントラクト。

名前 型 説明
code

string

プロパティ レベルのエラー コード。
message

string

プロパティ レベルエラーの人間が判読できる表現。
target

string

プロパティ名。

ErrorResponse

エラー応答。

名前 型 説明
error.code

string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details

ErrorFieldContract[]

検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message

string

人が判読できるエラーの表現。

KeyVaultContractProperties

KeyVault コントラクトの詳細。

名前 型 説明
identityClientId

string

SystemAssignedIdentity の場合は Null、UserAssignedIdentity の場合はクライアント ID で、キー コンテナーシークレットへのアクセスに使用されます。
lastStatus

KeyVaultLastAccessStatusContractProperties

キー コンテナーからのシークレットの前回の同期と更新の状態。
secretIdentifier

string

シークレットをフェッチするためのキー コンテナー シークレット識別子。 バージョン管理されたシークレットを指定すると、自動更新が防止されます。 これには、API Management サービスを aka.ms/apimmsi で構成する必要があります

KeyVaultLastAccessStatusContractProperties

コントラクトの更新プロパティを発行します。

名前 型 説明
code

string

キー コンテナーからのシークレットの同期と更新の最後の状態コード。
message

string

エラーの詳細は空です。
timeStampUtc

string

前回シークレットにアクセスしました。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。