Api Gateway - Update

リファレンス

サービス:: API Management

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

既存の API Management ゲートウェイを更新します。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}?api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management ゲートウェイの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties.backend	BackendConfiguration	ゲートウェイをバックエンドシステムと統合する方法に関する情報。
properties.configurationApi	GatewayConfigurationApi	API Management ゲートウェイの構成 API に関する情報。これは、Standard SKU を使用する API ゲートウェイにのみ適用されます。
properties.frontend	FrontendConfiguration	ゲートウェイを公開する方法に関する情報。
properties.virtualNetworkType	VirtualNetworkType	API Management ゲートウェイを構成する必要がある VPN の種類。
sku	ApiManagementGatewaySkuPropertiesForPatch	API Management ゲートウェイの SKU プロパティ。
tags	object	リソースタグ。

応答

名前	型	説明
200 OK	ApiManagementGatewayResource	ゲートウェイが正常に更新されました。
202 Accepted		ゲートウェイの更新要求が受け入れられました。ヘッダー location: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

ApiManagementGatewayResource

ゲートウェイが正常に更新されました。

202 Accepted

ゲートウェイの更新要求が受け入れられました。

ヘッダー

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

例

ApiManagementUpdateStandardGateway

要求のサンプル

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1?api-version=2024-05-01

{
  "properties": {},
  "sku": {
    "name": "Standard",
    "capacity": 10
  },
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateways",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmREI=",
  "properties": {
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "frontend": {
      "defaultHostname": "apimGateway1.eastus.gateway.azure-api.net"
    },
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "configurationApi": {
      "hostname": "apimGateway1.eastus.configuration.gateway.azure-api.net"
    }
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

状態コード:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

定義

名前	説明
ApiGatewaySkuType	SKU の名前。
ApiManagementGatewayResource	List または Get 応答の単一の API Management ゲートウェイリソース。
ApiManagementGatewaySkuProperties	API Management ゲートウェイリソース SKU のプロパティ。
ApiManagementGatewaySkuPropertiesForPatch	何も必要ない場合は、PATCH 操作用の API Management ゲートウェイリソース SKU プロパティを使用する必要があります。
ApiManagementGatewayUpdateParameters	Update API Management ゲートウェイに指定されたパラメーター。
BackendConfiguration	ゲートウェイをバックエンドシステムと統合する方法に関する情報。
BackendSubnetConfiguration	ゲートウェイを挿入するサブネットの方法に関する情報。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
FrontendConfiguration	ゲートウェイを公開する方法に関する情報。
GatewayConfigurationApi	API Management ゲートウェイの構成 API に関する情報。これは、Standard SKU を使用する API ゲートウェイにのみ適用されます。
systemData	リソースの作成と最後の変更に関連するメタデータ。
VirtualNetworkType	API Management ゲートウェイを構成する必要がある VPN の種類。

ApiGatewaySkuType

列挙

SKU の名前。

値	説明
Standard	API ゲートウェイの Standard SKU。
WorkspaceGatewayPremium	ワークスペースで使用する API ゲートウェイの Premium SKU。
WorkspaceGatewayStandard	ワークスペースで使用する API ゲートウェイの Standard SKU。

ApiManagementGatewayResource

Object

List または Get 応答の単一の API Management ゲートウェイリソース。

名前	型	説明
etag	string	リソースの ETag。
id	string	リソース ID。
location	string	リソースの場所。
name	string	リソース名。
properties.backend	BackendConfiguration	ゲートウェイをバックエンドシステムと統合する方法に関する情報。
properties.configurationApi	GatewayConfigurationApi	API Management ゲートウェイの構成 API に関する情報。これは、Standard SKU を使用する API ゲートウェイにのみ適用されます。
properties.createdAtUtc	string (date-time)	API Management ゲートウェイの作成 UTC 日付。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。
properties.frontend	FrontendConfiguration	ゲートウェイを公開する方法に関する情報。
properties.provisioningState	string	API Management ゲートウェイの現在のプロビジョニング状態。作成済み/アクティブ化/成功/更新/失敗/停止/終了/終了Failed/削除済みのいずれかです。
properties.targetProvisioningState	string	API Management ゲートウェイのプロビジョニング状態。これは、ゲートウェイで開始された実行時間の長い操作を対象とします。
properties.virtualNetworkType	VirtualNetworkType	API Management ゲートウェイを構成する必要がある VPN の種類。
sku	ApiManagementGatewaySkuProperties	API Management ゲートウェイの SKU プロパティ。
systemData	systemData	リソースの作成と最後の変更に関連するメタデータ。
tags	object	リソースタグ。
type	string	API Management リソースのリソースの種類が Microsoft.ApiManagement に設定されています。

ApiManagementGatewaySkuProperties

Object

API Management ゲートウェイリソース SKU のプロパティ。

名前	型	説明
capacity	integer (int32)	SKU の容量 (SKU のデプロイされたユニットの数)
name	ApiGatewaySkuType	SKU の名前。

ApiManagementGatewaySkuPropertiesForPatch

Object

何も必要ない場合は、PATCH 操作用の API Management ゲートウェイリソース SKU プロパティを使用する必要があります。

名前	型	説明
capacity	integer (int32)	SKU の容量 (SKU のデプロイされたユニットの数)
name	ApiGatewaySkuType	SKU の名前。

ApiManagementGatewayUpdateParameters

Object

Update API Management ゲートウェイに指定されたパラメーター。

名前	型	説明
etag	string	リソースの ETag。
id	string	リソース ID。
name	string	リソース名。
properties.backend	BackendConfiguration	ゲートウェイをバックエンドシステムと統合する方法に関する情報。
properties.configurationApi	GatewayConfigurationApi	API Management ゲートウェイの構成 API に関する情報。これは、Standard SKU を使用する API ゲートウェイにのみ適用されます。
properties.createdAtUtc	string (date-time)	API Management ゲートウェイの作成 UTC 日付。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。
properties.frontend	FrontendConfiguration	ゲートウェイを公開する方法に関する情報。
properties.provisioningState	string	API Management ゲートウェイの現在のプロビジョニング状態。作成済み/アクティブ化/成功/更新/失敗/停止/終了/終了Failed/削除済みのいずれかです。
properties.targetProvisioningState	string	API Management ゲートウェイのプロビジョニング状態。これは、ゲートウェイで開始された実行時間の長い操作を対象とします。
properties.virtualNetworkType	VirtualNetworkType	API Management ゲートウェイを構成する必要がある VPN の種類。
sku	ApiManagementGatewaySkuPropertiesForPatch	API Management ゲートウェイの SKU プロパティ。
tags	object	リソースタグ。
type	string	API Management リソースのリソースの種類が Microsoft.ApiManagement に設定されています。

BackendConfiguration

Object

ゲートウェイをバックエンドシステムと統合する方法に関する情報。

名前	型	説明
subnet	BackendSubnetConfiguration	要求の送信先となるデータプレーンゲートウェイの既定のホスト名。

BackendSubnetConfiguration

Object

ゲートウェイを挿入するサブネットの方法に関する情報。

名前	型	説明
id	string	バックエンドシステムがホストされているサブネットの ARM ID。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

FrontendConfiguration

Object

ゲートウェイを公開する方法に関する情報。

名前	型	説明
defaultHostname	string	要求の送信先となるデータプレーンゲートウェイの既定のホスト名。これは、Standard SKU を使用する API ゲートウェイにのみ適用されます。

GatewayConfigurationApi

Object

API Management ゲートウェイの構成 API に関する情報。これは、Standard SKU を使用する API ゲートウェイにのみ適用されます。

名前	型	説明
hostname	string	エージェントが接続して構成をクラウドに伝達するホスト名。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

VirtualNetworkType

列挙

API Management ゲートウェイを構成する必要がある VPN の種類。

値	説明
External	API Management ゲートウェイは Virtual Network の一部であり、インターネットからアクセスできます。
Internal	API Management ゲートウェイは Virtual Network の一部であり、仮想ネットワーク内からのみアクセスできます。
None	API Management ゲートウェイは、仮想ネットワークの一部ではありません。

次の方法で共有

Api Gateway - Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementUpdateStandardGateway

要求のサンプル

応答のサンプル

定義

ApiGatewaySkuType

ApiManagementGatewayResource

ApiManagementGatewaySkuProperties

ApiManagementGatewaySkuPropertiesForPatch

ApiManagementGatewayUpdateParameters

BackendConfiguration

BackendSubnetConfiguration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FrontendConfiguration

GatewayConfigurationApi

systemData

VirtualNetworkType

その他のリソース