Api Gateway - Create Or Update

서비스:: API Management

API 버전:: 2024-05-01

API Management 게이트웨이를 만들거나 업데이트합니다. 이 작업은 장기 실행 작업이며 완료하는 데 몇 분 정도 걸릴 수 있습니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
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 버전입니다.

요청 본문

Name	필수	형식	Description
location	True	string	리소스 위치입니다.
sku	True	ApiManagementGatewaySkuProperties	API Management 게이트웨이의 SKU 속성입니다.
properties.backend		BackendConfiguration	게이트웨이를 백 엔드 시스템과 통합하는 방법에 대한 정보입니다.
properties.configurationApi		GatewayConfigurationApi	API Management 게이트웨이의 구성 API에 대한 정보입니다. 표준 SKU를 사용하는 API 게이트웨이에만 적용됩니다.
properties.frontend		FrontendConfiguration	게이트웨이를 노출하는 방법에 대한 정보입니다.
properties.virtualNetworkType		VirtualNetworkType	API Management 게이트웨이를 구성해야 하는 VPN 유형입니다.
tags		object	리소스 태그.

응답

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

보안

azure_auth

Azure Active Directory OAuth2 흐름.

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

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementCreateStandardGateway

ApiManagementCreateWorkspacePremiumGateway

ApiManagementCreateStandardGateway

샘플 요청

HTTP

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

{
  "properties": {
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    }
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "location": "South Central US",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  }
}

샘플 응답

상태 코드:: 201

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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateway",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmRAM=",
  "properties": {
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    }
  },
  "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"
  }
}

상태 코드:: 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"
  }
}

ApiManagementCreateWorkspacePremiumGateway

샘플 요청

HTTP

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

{
  "properties": {
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "WorkspaceGatewayPremium",
    "capacity": 1
  },
  "location": "South Central US",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  }
}

샘플 응답

상태 코드:: 201

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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateway",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmRAM=",
  "properties": {
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "WorkspaceGatewayPremium",
    "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"
  }
}

상태 코드:: 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",
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "WorkspaceGatewayPremium",
    "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"
  }
}

정의

Name	Description
ApiGatewaySkuType	Sku의 이름입니다.
ApiManagementGatewayResource	목록 또는 응답 가져오기의 단일 API Management 게이트웨이 리소스입니다.
ApiManagementGatewaySkuProperties	API Management 게이트웨이 리소스 SKU 속성입니다.
BackendConfiguration	게이트웨이를 백 엔드 시스템과 통합하는 방법에 대한 정보입니다.
BackendSubnetConfiguration	게이트웨이를 삽입해야 하는 서브넷에 대한 정보입니다.
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
FrontendConfiguration	게이트웨이를 노출하는 방법에 대한 정보입니다.
GatewayConfigurationApi	API Management 게이트웨이의 구성 API에 대한 정보입니다. 표준 SKU를 사용하는 API 게이트웨이에만 적용됩니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
VirtualNetworkType	API Management 게이트웨이를 구성해야 하는 VPN 유형입니다.

ApiGatewaySkuType

열거형

Sku의 이름입니다.

값	Description
Standard	API 게이트웨이의 표준 SKU입니다.
WorkspaceGatewayStandard	작업 영역에서 사용할 API 게이트웨이의 표준 SKU입니다.
WorkspaceGatewayPremium	작업 영역에서 사용할 API 게이트웨이의 프리미엄 SKU입니다.

ApiManagementGatewayResource

Object

목록 또는 응답 가져오기의 단일 API Management 게이트웨이 리소스입니다.

Name	형식	Description
etag	string	리소스의 ETag입니다.
id	string	리소스 ID입니다.
location	string	리소스 위치입니다.
name	string	리소스 이름입니다.
properties.backend	BackendConfiguration	게이트웨이를 백 엔드 시스템과 통합하는 방법에 대한 정보입니다.
properties.configurationApi	GatewayConfigurationApi	API Management 게이트웨이의 구성 API에 대한 정보입니다. 표준 SKU를 사용하는 API 게이트웨이에만 적용됩니다.
properties.createdAtUtc	string (date-time)	API Management 게이트웨이의 생성 UTC 날짜입니다. 날짜는 ISO 8601 표준에 지정된 `yyyy-MM-ddTHH:mm:ssZ` 형식을 준수합니다.
properties.frontend	FrontendConfiguration	게이트웨이를 노출하는 방법에 대한 정보입니다.
properties.provisioningState	string	생성/활성화/성공/업데이트/실패/중지/종료/TerminatFailed/Deleted 중 하나일 수 있는 API Management 게이트웨이의 현재 프로비전 상태입니다.
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 속성입니다.

Name	형식	Description
capacity	integer (int32)	SKU의 용량(SKU의 배포된 단위 수)
name	ApiGatewaySkuType	Sku의 이름입니다.

BackendConfiguration

Object

게이트웨이를 백 엔드 시스템과 통합하는 방법에 대한 정보입니다.

Name	형식	Description
subnet	BackendSubnetConfiguration	요청을 보낼 수 있는 데이터 평면 게이트웨이의 기본 호스트 이름입니다.

BackendSubnetConfiguration

Object

게이트웨이를 삽입해야 하는 서브넷에 대한 정보입니다.

Name	형식	Description
id	string	백 엔드 시스템이 호스트되는 서브넷의 ARM ID입니다.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

FrontendConfiguration

Object

게이트웨이를 노출하는 방법에 대한 정보입니다.

Name	형식	Description
defaultHostname	string	요청을 보낼 수 있는 데이터 평면 게이트웨이의 기본 호스트 이름입니다. 표준 SKU를 사용하는 API 게이트웨이에만 적용됩니다.

GatewayConfigurationApi

Object

API Management 게이트웨이의 구성 API에 대한 정보입니다. 표준 SKU를 사용하는 API 게이트웨이에만 적용됩니다.

Name	형식	Description
hostname	string	에이전트가 연결하여 구성을 클라우드로 전파하는 호스트 이름입니다.

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
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 유형입니다.

값	Description
None	API Management 게이트웨이는 Virtual Network에 속하지 않습니다.
External	API Management 게이트웨이는 Virtual Network의 일부이며 인터넷에서 액세스할 수 있습니다.
Internal	API Management 게이트웨이는 Virtual Network의 일부이며 가상 네트워크 내에서만 액세스할 수 있습니다.

다음을 통해 공유

Api Gateway - Create Or Update

URI 매개 변수

요청 본문

응답

보안

azure_auth

범위

예제

ApiManagementCreateStandardGateway

샘플 요청

샘플 응답

ApiManagementCreateWorkspacePremiumGateway

샘플 요청

샘플 응답

정의

ApiGatewaySkuType

ApiManagementGatewayResource

ApiManagementGatewaySkuProperties

BackendConfiguration

BackendSubnetConfiguration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FrontendConfiguration

GatewayConfigurationApi

systemData

VirtualNetworkType