Api Gateway - Create Or Update

Служба:: API Management

Версия API:: 2024-05-01

Создает или обновляет шлюз управления API. Это длительная операция и может занять несколько минут.

PUT 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.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Текст запроса

Имя	Обязательно	Тип	Описание
location	True	string	Расположение ресурса.
sku	True	ApiManagementGatewaySkuProperties	Свойства SKU шлюза управления API.
properties.backend		BackendConfiguration	Сведения о том, как шлюз должен интегрироваться с внутренними системами.
properties.configurationApi		GatewayConfigurationApi	Сведения об API конфигурации шлюза управления API. Это применимо только для шлюза API со стандартным номером SKU.
properties.frontend		FrontendConfiguration	Сведения о том, как должен предоставляться шлюз.
properties.virtualNetworkType		VirtualNetworkType	Тип VPN, в котором необходимо настроить шлюз управления API.
tags		object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	ApiManagementGatewayResource	Шлюз успешно настроен.
201 Created	ApiManagementGatewayResource	Созданный
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
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"
  }
}

Определения

Имя	Описание
ApiGatewaySkuType	Имя SKU.
ApiManagementGatewayResource	Один ресурс шлюза управления API в списке или получении ответа.
ApiManagementGatewaySkuProperties	Свойства SKU ресурса шлюза управления API.
BackendConfiguration	Сведения о том, как шлюз должен интегрироваться с внутренними системами.
BackendSubnetConfiguration	Сведения о том, как следует внедрить подсеть, в которую следует внедрить шлюз.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
FrontendConfiguration	Сведения о том, как должен предоставляться шлюз.
GatewayConfigurationApi	Сведения об API конфигурации шлюза управления API. Это применимо только для шлюза API со стандартным номером SKU.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
VirtualNetworkType	Тип VPN, в котором необходимо настроить шлюз управления API.

ApiGatewaySkuType

Перечисление

Имя SKU.

Значение	Описание
Standard	Стандартный номер SKU шлюза API.
WorkspaceGatewayStandard	Стандартный номер SKU шлюза API для использования в рабочих областях.
WorkspaceGatewayPremium	Номер SKU уровня "Премиум" шлюза API, который будет использоваться в рабочих областях.

ApiManagementGatewayResource

Object

Один ресурс шлюза управления API в списке или получении ответа.

Имя	Тип	Описание
etag	string	ETag ресурса.
id	string	Идентификатор ресурса.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.backend	BackendConfiguration	Сведения о том, как шлюз должен интегрироваться с внутренними системами.
properties.configurationApi	GatewayConfigurationApi	Сведения об API конфигурации шлюза управления API. Это применимо только для шлюза API со стандартным номером SKU.
properties.createdAtUtc	string (date-time)	Дата создания в формате UTC шлюза управления API. Дата соответствует следующему формату: `yyyy-MM-ddTHH:mm:ssZ`, как указано в стандарте ISO 8601.
properties.frontend	FrontendConfiguration	Сведения о том, как должен предоставляться шлюз.
properties.provisioningState	string	Текущее состояние подготовки шлюза управления API, которое может быть одним из следующих вариантов: Create/Activating/Succeeded/Failed/Failed/Stopped/Terminating/TerminationFailed/Deleted.
properties.targetProvisioningState	string	Состояние подготовки шлюза управления API, предназначенного для длительной операции, запущенной на шлюзе.
properties.virtualNetworkType	VirtualNetworkType	Тип VPN, в котором необходимо настроить шлюз управления API.
sku	ApiManagementGatewaySkuProperties	Свойства SKU шлюза управления API.
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
tags	object	Теги ресурсов.
type	string	Тип ресурса управления API имеет значение Microsoft.ApiManagement.

ApiManagementGatewaySkuProperties

Object

Свойства SKU ресурса шлюза управления API.

Имя	Тип	Описание
capacity	integer (int32)	Емкость номера SKU (количество развернутых единиц SKU)
name	ApiGatewaySkuType	Имя SKU.

BackendConfiguration

Object

Сведения о том, как шлюз должен интегрироваться с внутренними системами.

Имя	Тип	Описание
subnet	BackendSubnetConfiguration	Имя узла по умолчанию шлюза плоскости данных, в который можно отправлять запросы.

BackendSubnetConfiguration

Object

Сведения о том, как следует внедрить подсеть, в которую следует внедрить шлюз.

Имя	Тип	Описание
id	string	Идентификатор ARM подсети, в которой размещаются серверные системы.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

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	Имя узла по умолчанию шлюза плоскости данных, в который можно отправлять запросы. Это применимо только для шлюза API со стандартным номером SKU.

GatewayConfigurationApi

Object

Сведения об API конфигурации шлюза управления API. Это применимо только для шлюза API со стандартным номером SKU.

Имя	Тип	Описание
hostname	string	Имя узла, к которому агент подключается к распространению конфигурации в облако.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

VirtualNetworkType

Перечисление

Тип VPN, в котором необходимо настроить шлюз управления API.

Значение	Описание
None	Шлюз управления API не является частью любой виртуальной сети.
External	Шлюз управления API является частью виртуальной сети и доступен из Интернета.
Internal	Шлюз управления API является частью виртуальной сети, и он доступен только из виртуальной сети.

Поделиться через

Api Gateway - Create Or Update

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

ApiManagementCreateStandardGateway

Образец запроса

Пример ответа

ApiManagementCreateWorkspacePremiumGateway

Образец запроса

Пример ответа

Определения

ApiGatewaySkuType

ApiManagementGatewayResource

ApiManagementGatewaySkuProperties

BackendConfiguration

BackendSubnetConfiguration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FrontendConfiguration

GatewayConfigurationApi

systemData

VirtualNetworkType