Certificate - Create Or Update

リファレンス

サービス:: API Management

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

バックエンドでの認証に使用されている証明書を作成または更新します。

PUT 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 バージョン。

要求ヘッダー

名前	必須	型	説明
If-Match		string	エンティティの ETag。エンティティを作成する場合は必要ありませんが、エンティティを更新する場合は必須です。

要求本文

名前	型	説明
properties.data	string	アプリケーション/x-pkcs12 表現を使用して Base 64 でエンコードされた証明書。
properties.keyVault	KeyVaultContractCreateProperties	証明書の KeyVault の場所の詳細。
properties.password	string	証明書のパスワード

応答

名前	型	説明
200 OK	CertificateContract	証明書の詳細が正常に更新されました。ヘッダー ETag: string
201 Created	CertificateContract	新しい証明書が正常に追加されました。ヘッダー ETag: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

CertificateContract

証明書の詳細が正常に更新されました。

ヘッダー

ETag: string

201 Created

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	ユーザーアカウントを偽装する

例

ApiManagementCreateCertificate

ApiManagementCreateCertificateWithKeyVault

ApiManagementCreateCertificate

要求のサンプル

HTTP

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

{
  "properties": {
    "data": "****************Base 64 Encoded Certificate *******************************",
    "password": "****Certificate Password******"
  }
}

応答のサンプル

状態コード:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert",
  "type": "Microsoft.ApiManagement/service/certificates",
  "name": "tempcert",
  "properties": {
    "subject": "CN=contoso.com",
    "thumbprint": "*******************3",
    "expirationDate": "2018-03-17T21:55:07+00:00"
  }
}

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert",
  "type": "Microsoft.ApiManagement/service/certificates",
  "name": "tempcert",
  "properties": {
    "subject": "CN=contoso.com",
    "thumbprint": "*******************3",
    "expirationDate": "2018-03-17T21:55:07+00:00"
  }
}

ApiManagementCreateCertificateWithKeyVault

要求のサンプル

HTTP

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

{
  "properties": {
    "keyVault": {
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert"
    }
  }
}

応答のサンプル

状態コード:: 201

{
  "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"
      }
    }
  }
}

状態コード:: 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	証明書の詳細。
CertificateCreateOrUpdateParameters	証明書の作成または更新の詳細。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
KeyVaultContractCreateProperties	keyVault コントラクトの詳細を作成します。
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"

CertificateCreateOrUpdateParameters

Object

証明書の作成または更新の詳細。

名前	型	説明
properties.data	string	アプリケーション/x-pkcs12 表現を使用して Base 64 でエンコードされた証明書。
properties.keyVault	KeyVaultContractCreateProperties	証明書の KeyVault の場所の詳細。
properties.password	string	証明書のパスワード

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

KeyVaultContractCreateProperties

Object

keyVault コントラクトの詳細を作成します。

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

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 - Create Or Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementCreateCertificate

要求のサンプル

応答のサンプル

ApiManagementCreateCertificateWithKeyVault

要求のサンプル

応答のサンプル

定義

CertificateContract

CertificateCreateOrUpdateParameters

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultContractCreateProperties

KeyVaultContractProperties

KeyVaultLastAccessStatusContractProperties

その他のリソース