Certificate - Get

リファレンス

サービス:: API Management

API バージョン:: 2024-05-01

識別子で指定された証明書の詳細を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}?api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
certificateId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	証明書エンティティの識別子。現在の API Management サービスインスタンスで一意である必要があります。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	CertificateContract	応答本文には、指定された証明書エンティティが含まれています。ヘッダー ETag: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

CertificateContract

応答本文には、指定された証明書エンティティが含まれています。

ヘッダー

ETag: string

Other Status Codes

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

ApiManagementGetCertificate

ApiManagementGetCertificateWithKeyVault

ApiManagementGetCertificate

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCert1?api-version=2024-05-01

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCert1",
  "type": "Microsoft.ApiManagement/service/certificates",
  "name": "templateCert1",
  "properties": {
    "subject": "CN=mutual-authcert",
    "thumbprint": "EBA**********************8594A6",
    "expirationDate": "2017-04-23T17:03:41Z"
  }
}

ApiManagementGetCertificateWithKeyVault

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv?api-version=2024-05-01

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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"
      }
    }
  }
}

定義

名前	説明
CertificateContract	証明書の詳細。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
KeyVaultContractProperties	KeyVault コントラクトの詳細。
KeyVaultLastAccessStatusContractProperties	コントラクトの更新プロパティを発行します。

CertificateContract

Object

証明書の詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.expirationDate	string (date-time)	証明書の有効期限。日付は、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"

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

KeyVaultContractProperties

Object

KeyVault コントラクトの詳細。

名前	型	説明
identityClientId	string	SystemAssignedIdentity の場合は Null、UserAssignedIdentity のクライアント ID はキーコンテナーシークレットへのアクセスに使用されます。
lastStatus	KeyVaultLastAccessStatusContractProperties	キーコンテナーからのシークレットの最終同期と更新の状態。
secretIdentifier	string	シークレットをフェッチするためのキーコンテナーシークレット識別子。バージョン管理されたシークレットを指定すると、自動更新が防止されます。そのためには、API Management サービスを aka.ms/apimmsi で構成する必要があります

KeyVaultLastAccessStatusContractProperties

Object

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

名前	型	説明
code	string	キーコンテナーからのシークレットの同期と更新の最後の状態コード。
message	string	エラーの詳細。それ以外は空です。
timeStampUtc	string (date-time)	シークレットが最後にアクセスされた時刻。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。

次の方法で共有

Certificate - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementGetCertificate

要求のサンプル

応答のサンプル

ApiManagementGetCertificateWithKeyVault

要求のサンプル

応答のサンプル

定義

CertificateContract

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultContractProperties

KeyVaultLastAccessStatusContractProperties

その他のリソース