Gateway Api - Create Or Update

서비스:

API Management

API 버전:

2021-08-01

지정된 게이트웨이에 API를 추가합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
apiId	path	True	string	API ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
gatewayId	path	True	string	게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.
resourceGroupName	path	True	string	리소스 그룹의 이름.
serviceName	path	True	string	API Management 서비스의 이름입니다. regex 패턴: ^[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	형식	Description
properties.provisioningState	ProvisioningState	프로비저닝 상태.

응답

Name	형식	Description
200 OK	ApiContract	지정된 API가 게이트웨이에 이미 추가되었습니다.
201 Created	ApiContract	API가 게이트웨이에 성공적으로 추가되었습니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementCreateGatewayApi

샘플 요청

HTTP

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

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

Java

import com.azure.core.util.Context;
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/2021-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),
                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/2021-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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-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/2021-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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateGatewayApi.json
// this example is just showing the usage of "GatewayApi_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementGatewayResource created on azure
// for more information of creating ApiManagementGatewayResource, please refer to the document of ApiManagementGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string gatewayId = "gw1";
ResourceIdentifier apiManagementGatewayResourceId = ApiManagementGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, gatewayId);
ApiManagementGatewayResource apiManagementGateway = client.GetApiManagementGatewayResource(apiManagementGatewayResourceId);

// invoke the operation
string apiId = "echo-api";
AssociationContract associationContract = new AssociationContract()
{
    ProvisioningState = AssociationEntityProvisioningState.Created,
};
GatewayApiData result = await apiManagementGateway.CreateOrUpdateGatewayApiAsync(apiId, associationContract: associationContract);

Console.WriteLine($"Succeeded: {result}");

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

샘플 응답

상태 코드:

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

상태 코드:

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

정의

Name	Description
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	구독 키 매개 변수 이름 세부 정보입니다.

ApiContactInformation

API 연락처 정보

Name	형식	Description
email	string	연락처/organization 전자 메일 주소입니다. 전자 메일 주소 형식이어야 합니다.
name	string	연락처/organization 식별 이름
url	string	연락처 정보를 가리키는 URL입니다. URL 형식이어야 합니다.

ApiContract

API 세부 정보.

Name	형식	Description
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입니다. 2000자를 초과할 수 없습니다.
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	형식	Description
name	string	API에 사용되는 라이선스 이름
url	string	API에 사용되는 라이선스의 URL입니다. URL 형식이어야 합니다.

ApiType

API의 유형입니다.

Name	형식	Description
graphql	string
http	string
soap	string
websocket	string

ApiVersionSetContractDetails

API 버전 집합에는 관련된 API 버전 집합에 대한 공통 구성이 포함되어 있습니다.

Name	형식	Description
description	string	API 버전 집합에 대한 설명입니다.
id	string	기존 API 버전 집합의 식별자입니다. 이 값을 생략하여 새 버전 집합을 만듭니다.
name	string	API 버전 집합의 표시 이름입니다.
versionHeaderName	string	versioningScheme이 로 설정된 header경우 API 버전을 나타내는 HTTP 헤더 매개 변수의 이름입니다.
versionQueryName	string	versioningScheme이 로 설정된 query경우 API 버전을 나타내는 쿼리 매개 변수의 이름입니다.
versioningScheme	enum: Header Query Segment	API 버전 식별자가 HTTP 요청에 위치할 위치를 결정하는 값입니다.

AssociationContract

연결 엔터티 세부 정보입니다.

Name	형식	Description
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 인증 설정.

Name	형식	Description
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2 인증 설정
openid	OpenIdAuthenticationSettingsContract	OpenID Connect 인증 설정

bearerTokenSendingMethods

서버에 토큰을 보내는 방법입니다.

Name	형식	Description
authorizationHeader	string	액세스 토큰은 전달자 스키마를 사용하여 권한 부여 헤더에 전송됩니다.
query	string	액세스 토큰은 쿼리 매개 변수로 전송됩니다.

ErrorFieldContract

오류 필드 계약.

Name	형식	Description
code	string	속성 수준 오류 코드입니다.
message	string	사람이 읽을 수 있는 속성 수준 오류 표현입니다.
target	string	속성 이름입니다.

ErrorResponse

오류 응답.

Name	형식	Description
error.code	string	서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.
error.details	ErrorFieldContract[]	유효성 검사 오류가 발생한 경우 요청에 잘못된 필드가 전송됩니다.
error.message	string	사람이 읽을 수 있는 오류 표현입니다.

OAuth2AuthenticationSettingsContract

API OAuth2 인증 설정 세부 정보

Name	형식	Description
authorizationServerId	string	OAuth 권한 부여 서버 식별자입니다.
scope	string	작업 scope.

OpenIdAuthenticationSettingsContract

API OAuth2 인증 설정 세부 정보

Name	형식	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	서버에 토큰을 보내는 방법입니다.
openidProviderId	string	OAuth 권한 부여 서버 식별자입니다.

Protocol

이 API의 작업을 호출할 수 있는 프로토콜을 설명합니다.

Name	형식	Description
http	string
https	string
ws	string
wss	string

ProvisioningState

프로비저닝 상태.

Name	형식	Description
created	string

SubscriptionKeyParameterNamesContract

구독 키 매개 변수 이름 세부 정보입니다.

Name	형식	Description
header	string	구독 키 헤더 이름입니다.
query	string	구독 키 쿼리 문자열 매개 변수 이름입니다.