Gateway Api - Create Or Update

Service:

API Management

API Version:

2022-08-01

指定されたゲートウェイに API を追加します。

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

URI パラメーター

名前	/	必須	型	説明
apiId	path	True	string	API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
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	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties.provisioningState	ProvisioningState	プロビジョニングの状態。

応答

名前	型	説明
200 OK	ApiContract	指定した API は既にゲートウェイに追加されています。
201 Created	ApiContract	API がゲートウェイに正常に追加されました。
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	ユーザー アカウントの借用

例

ApiManagementCreateGatewayApi

Sample Request

HTTP

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

{
  "properties": {
    "provisioningState": "created"
  }
}

Java

import com.azure.resourcemanager.apimanagement.models.AssociationContract;
import com.azure.resourcemanager.apimanagement.models.ProvisioningState;

/** Samples for GatewayApi CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateGatewayApi.json
     */
    /**
     * Sample code: ApiManagementCreateGatewayApi.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateGatewayApi(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .gatewayApis()
            .createOrUpdateWithResponse(
                "rg1",
                "apimService1",
                "gw1",
                "echo-api",
                new AssociationContract().withProvisioningState(ProvisioningState.CREATED),
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_gateway_api.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.gateway_api.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        gateway_id="gw1",
        api_id="echo-api",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateGatewayApi.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateGatewayApi.json
func ExampleGatewayAPIClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewGatewayAPIClient().CreateOrUpdate(ctx, "rg1", "apimService1", "gw1", "echo-api", &armapimanagement.GatewayAPIClientCreateOrUpdateOptions{Parameters: &armapimanagement.AssociationContract{
		Properties: &armapimanagement.AssociationContractProperties{
			ProvisioningState: to.Ptr("created"),
		},
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.APIContract = armapimanagement.APIContract{
	// 	Name: to.Ptr("echo-api"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/gateways/apis"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/echo-api"),
	// 	Properties: &armapimanagement.APIContractProperties{
	// 		APIRevision: to.Ptr("1"),
	// 		IsCurrent: to.Ptr(true),
	// 		SubscriptionKeyParameterNames: &armapimanagement.SubscriptionKeyParameterNamesContract{
	// 			Header: to.Ptr("Ocp-Apim-Subscription-Key"),
	// 			Query: to.Ptr("subscription-key"),
	// 		},
	// 		Path: to.Ptr(""),
	// 		DisplayName: to.Ptr("EchoApi"),
	// 		Protocols: []*armapimanagement.Protocol{
	// 			to.Ptr(armapimanagement.ProtocolHTTP),
	// 			to.Ptr(armapimanagement.ProtocolHTTPS)},
	// 			ServiceURL: to.Ptr("https://contoso.com/apis/echo"),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Adds an API to the specified Gateway.
 *
 * @summary Adds an API to the specified Gateway.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateGatewayApi.json
 */
async function apiManagementCreateGatewayApi() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const gatewayId = "gw1";
  const apiId = "echo-api";
  const parameters = { provisioningState: "created" };
  const options = { parameters };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.gatewayApi.createOrUpdate(
    resourceGroupName,
    serviceName,
    gatewayId,
    apiId,
    options
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/echo-api",
  "type": "Microsoft.ApiManagement/service/gateways/apis",
  "name": "echo-api",
  "properties": {
    "displayName": "EchoApi",
    "apiRevision": "1",
    "serviceUrl": "https://contoso.com/apis/echo",
    "path": "",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/echo-api",
  "type": "Microsoft.ApiManagement/service/gateways/apis",
  "name": "echo-api",
  "properties": {
    "displayName": "EchoApi",
    "apiRevision": "1",
    "serviceUrl": "https://contoso.com/apis/echo",
    "path": "",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

定義

名前	説明
ApiContactInformation	API の連絡先情報
ApiContract	API の詳細。
ApiLicenseInformation	API ライセンス情報
ApiType	API の種類。
ApiVersionSetContractDetails	API バージョン セットには、関連する一連の API バージョンの共通構成が含まれています
AssociationContract	関連付けエンティティの詳細。
AuthenticationSettingsContract	API 認証の設定。
bearerTokenSendingMethods	サーバーにトークンを送信する方法。
ErrorFieldContract	エラー フィールド コントラクト。
ErrorResponse	エラー応答。
OAuth2AuthenticationSettingsContract	API OAuth2 認証設定の詳細。
OpenIdAuthenticationSettingsContract	API OAuth2 認証設定の詳細。
Protocol	この API の操作を呼び出すことができるプロトコルを記述します。
ProvisioningState	プロビジョニングの状態。
SubscriptionKeyParameterNamesContract	サブスクリプション キー パラメーター名の詳細。
versioningScheme	API バージョン識別子が HTTP 要求内のどこに配置されるのかを決定する値。

ApiContactInformation

API の連絡先情報

名前	型	説明
email	string	連絡先/organizationのメール アドレス。 電子メール アドレスの形式にする必要があります
name	string	連絡先/organizationの識別名
url	string	連絡先情報を指す URL。 URL の形式にする必要があります

ApiContract

API の詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.apiRevision	string	API のリビジョンについて説明します。 値が指定されていない場合、既定のリビジョン 1 が作成されます
properties.apiRevisionDescription	string	API リビジョンの説明。
properties.apiVersion	string	API がバージョン管理されている場合の API のバージョン識別子を示します
properties.apiVersionDescription	string	API バージョンの説明。
properties.apiVersionSet	ApiVersionSetContractDetails	バージョン セットの詳細
properties.apiVersionSetId	string	関連する ApiVersionSet のリソース識別子。
properties.authenticationSettings	AuthenticationSettingsContract	この API に含まれる認証設定のコレクション。
properties.contact	ApiContactInformation	API の連絡先情報。
properties.description	string	API の説明。 HTML 書式設定タグを含めることができます。
properties.displayName	string	API 名。 1 から 300 文字の長さにする必要があります。
properties.isCurrent	boolean	API リビジョンが現在の API リビジョンであるかどうかを示します。
properties.isOnline	boolean	API リビジョンにゲートウェイ経由でアクセスできるかどうかを示します。
properties.license	ApiLicenseInformation	API のライセンス情報。
properties.path	string	API Management サービス インスタンス内のこの API とそのすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を作成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。
properties.protocols	Protocol[]	この API の操作を呼び出すことができるプロトコルを記述します。
properties.serviceUrl	string	この API を実装するバックエンド サービスの絶対 URL。 2,000 文字を超えることはできません。
properties.sourceApiId	string	ソース API の API 識別子。
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	API を使用できるようにするプロトコル。
properties.subscriptionRequired	boolean	API にアクセスするために API または製品サブスクリプションが必要かどうかを指定します。
properties.termsOfServiceUrl	string	API のサービス利用規約への URL。 URL の形式にする必要があります。
properties.type	ApiType	API の種類。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

API ライセンス情報

名前	型	説明
name	string	API に使用されるライセンス名
url	string	API に使用されるライセンスの URL。 URL の形式にする必要があります

ApiType

API の種類。

名前	型	説明
graphql	string
http	string
soap	string
websocket	string

ApiVersionSetContractDetails

API バージョン セットには、関連する一連の API バージョンの共通構成が含まれています

名前	型	説明
description	string	API バージョン セットの説明。
id	string	既存の API バージョン セットの識別子。 新しいバージョン セットを作成するには、この値を省略します。
name	string	API バージョン セットの表示名。
versionHeaderName	string	versioningScheme が に header設定されている場合に API バージョンを示す HTTP ヘッダー パラメーターの名前。
versionQueryName	string	versioningScheme が に query設定されている場合に API バージョンを示すクエリ パラメーターの名前。
versioningScheme	versioningScheme	API バージョン識別子が HTTP 要求内のどこに配置されるのかを決定する値。

AssociationContract

関連付けエンティティの詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.provisioningState	ProvisioningState	プロビジョニングの状態。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

AuthenticationSettingsContract

API 認証の設定。

名前	型	説明
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2 認証設定
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	この API に含まれる OAuth2 認証設定のコレクション。
openid	OpenIdAuthenticationSettingsContract	OpenID Connect の認証設定
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	この API に含まれる Open ID Connect 認証設定のコレクション。

bearerTokenSendingMethods

サーバーにトークンを送信する方法。

名前	型	説明
authorizationHeader	string	アクセス トークンは、ベアラー スキーマを使用して Authorization ヘッダーで送信されます
query	string	アクセス トークンはクエリ パラメーターとして送信されます。

ErrorFieldContract

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

名前	型	説明
code	string	プロパティ レベルのエラー コード。
message	string	プロパティ レベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

エラー応答。

名前	型	説明
error.code	string	サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message	string	人が判読できるエラーの表現。

OAuth2AuthenticationSettingsContract

API OAuth2 認証設定の詳細。

名前	型	説明
authorizationServerId	string	OAuth 承認サーバーの識別子。
scope	string	操作スコープ。

OpenIdAuthenticationSettingsContract

API OAuth2 認証設定の詳細。

名前	型	説明
bearerTokenSendingMethods	bearerTokenSendingMethods[]	サーバーにトークンを送信する方法。
openidProviderId	string	OAuth 承認サーバーの識別子。

Protocol

この API の操作を呼び出すことができるプロトコルを記述します。

名前	型	説明
http	string
https	string
ws	string
wss	string

ProvisioningState

プロビジョニングの状態。

名前	型	説明
created	string

SubscriptionKeyParameterNamesContract

サブスクリプション キー パラメーター名の詳細。

名前	型	説明
header	string	サブスクリプション キー ヘッダー名。
query	string	サブスクリプション キー クエリ文字列パラメーター名。

versioningScheme

API バージョン識別子が HTTP 要求内のどこに配置されるのかを決定する値。

名前	型	説明
Header	string	API バージョンは HTTP ヘッダーで渡されます。
Query	string	API バージョンはクエリ パラメーターで渡されます。
Segment	string	API バージョンはパス セグメントで渡されます。