Share via

Gateway - Create Or Update

  • Reference
Service:
API Management
API Version:
2024-05-01

Creates or updates a Gateway to be used in Api Management instance.

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

URI Parameters

Name In Required Type Description
gatewayId
 path True

string

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
resourceGroupName
 path True

string

The name of the resource group. The name is case insensitive.
serviceName
 path True

string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

uuid

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

The API version to use for this operation.

Request Header

Name Required Type Description
If-Match

string

ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Request Body

Name Type Description
properties.description

string

Gateway description
properties.locationData

ResourceLocationDataContract

Gateway location.

Responses

Name Type Description
200 OK

GatewayContract

The Gateway details were successfully updated.

Headers

ETag: string
201 Created

GatewayContract

The new Gateway was successfully added.

Headers

ETag: string
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementCreateGateway

Sample request

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

{
  "properties": {
    "description": "my gateway 1",
    "locationData": {
      "name": "my location"
    }
  }
}

Sample response

Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1",
  "type": "Microsoft.ApiManagement/service/gateways",
  "name": "a1",
  "properties": {
    "description": "my gateway 1",
    "locationData": {
      "name": "my location"
    }
  }
}
Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1",
  "type": "Microsoft.ApiManagement/service/gateways",
  "name": "a1",
  "properties": {
    "description": "my gateway 1",
    "locationData": {
      "name": "my location"
    }
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
GatewayContract

Gateway details.
ResourceLocationDataContract

Resource location data properties.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

GatewayContract

Gateway details.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

The name of the resource
properties.description

string

Gateway description
properties.locationData

ResourceLocationDataContract

Gateway location.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ResourceLocationDataContract

Resource location data properties.

Name Type Description
city

string

The city or locality where the resource is located.
countryOrRegion

string

The country or region where the resource is located.
district

string

The district, state, or province where the resource is located.
name

string

A canonical name for the geographic or physical location.