Gateway Certificate Authority - Create Or Update

証明書エンティティを証明機関としてゲートウェイ エンティティに割り当てます。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}?api-version=2021-08-01

URI パラメーター

Name In Required Type Description
certificateId
path True
  • string

証明書エンティティの識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。

Regex pattern: ^[^*#&+:<>?]+$

gatewayId
path True
  • string

ゲートウェイ エンティティ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 値 'managed' を持つ必要はありません

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

サブスクリプションを一意に識別するサブスクリプション資格情報Microsoft Azure。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True
  • string

クライアント要求で使用する API のバージョン。

要求ヘッダー

Name Required Type Description
If-Match
  • string

エンティティの ETag。 エンティティを作成する場合は必須ではありませんが、エンティティを更新する場合は必須です。

要求本文

Name Type Description
properties.isTrusted
  • boolean

証明機関が信頼されているかどうかを判断します。

応答

Name Type Description
200 OK

ゲートウェイ証明機関の詳細が正常に更新されました

Headers

  • ETag: string
201 Created

証明書エンティティが証明機関としてゲートウェイ エンティティに正常に割り当てられました。

Headers

  • ETag: string
Other Status Codes

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

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryします。

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

ApiManagementCreateGatewayCertificateAuthority

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1?api-version=2021-08-01

{
  "properties": {
    "isTrusted": false
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1",
  "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities",
  "name": "cert1",
  "properties": {
    "isTrusted": false
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1",
  "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities",
  "name": "cert1",
  "properties": {
    "isTrusted": false
  }
}

定義

ErrorFieldContract

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

ErrorResponse

エラー応答。

GatewayCertificateAuthorityContract

ゲートウェイ証明機関の詳細。

ErrorFieldContract

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

Name Type Description
code
  • string

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

message
  • string

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

target
  • string

プロパティ名。

ErrorResponse

エラー応答。

Name Type Description
error.code
  • string

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

error.details

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

error.message
  • string

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

GatewayCertificateAuthorityContract

ゲートウェイ証明機関の詳細。

Name Type Description
id
  • string

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

name
  • string

リソースの名前

properties.isTrusted
  • boolean

証明機関が信頼されているかどうかを判断します。

type
  • string

リソースの型。 たとえば、"Microsoft.Compute/virtualMachines" や "Microsoft" などです。Storage/storageAccounts"