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

Служба и шлюзы Microsoft.ApiManagement

  • Статья

Определение ресурсов Bicep

Тип ресурса service/gateways можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/gateways, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.ApiManagement/service/gateways@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    locationData: {
      city: 'string'
      countryOrRegion: 'string'
      district: 'string'
      name: 'string'
    }
  }
}

Значения свойств

службы и шлюзы

Имя Описание Ценность
имя Имя ресурса

Узнайте, как задать имена и типы дочерних ресурсов в Bicep.		 строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: служба
свойства Сведения о шлюзе. GatewayContractProperties

GatewayContractProperties

Имя Описание Ценность
описание Описание шлюза струна

Ограничения целостности:
Максимальная длина = 1000
locationData Расположение шлюза. ResourceLocationDataContract

ResourceLocationDataContract

Имя Описание Ценность
город Город или город, где находится ресурс. струна

Ограничения целостности:
Максимальная длина = 256
countryOrRegion Страна или регион, в котором находится ресурс. струна

Ограничения целостности:
Максимальная длина = 256
район Район, штат или провинция, где находится ресурс. струна

Ограничения целостности:
Максимальная длина = 256
имя Каноническое имя географического или физического расположения. строка (обязательно)

Ограничения целостности:
Максимальная длина = 256

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
создание управления API в внутренней виртуальной сети с шлюза приложений

развертывание в Azure		 В этом шаблоне показано, как создать экземпляр службы "Управление API Azure" в частной сети, защищенной шлюзом приложений Azure.

Определение ресурса шаблона ARM

Тип ресурса service/gateways можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/gateways, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.ApiManagement/service/gateways",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "locationData": {
      "city": "string",
      "countryOrRegion": "string",
      "district": "string",
      "name": "string"
    }
  }
}

Значения свойств

службы и шлюзы

Имя Описание Ценность
тип Тип ресурса "Microsoft.ApiManagement/service/gateways"
apiVersion Версия API ресурсов '2023-09-01-preview'
имя Имя ресурса

Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON.		 строка (обязательно)
свойства Сведения о шлюзе. GatewayContractProperties

GatewayContractProperties

Имя Описание Ценность
описание Описание шлюза струна

Ограничения целостности:
Максимальная длина = 1000
locationData Расположение шлюза. ResourceLocationDataContract

ResourceLocationDataContract

Имя Описание Ценность
город Город или город, где находится ресурс. струна

Ограничения целостности:
Максимальная длина = 256
countryOrRegion Страна или регион, в котором находится ресурс. струна

Ограничения целостности:
Максимальная длина = 256
район Район, штат или провинция, где находится ресурс. струна

Ограничения целостности:
Максимальная длина = 256
имя Каноническое имя географического или физического расположения. строка (обязательно)

Ограничения целостности:
Максимальная длина = 256

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
создание управления API в внутренней виртуальной сети с шлюза приложений

развертывание в Azure		 В этом шаблоне показано, как создать экземпляр службы "Управление API Azure" в частной сети, защищенной шлюзом приложений Azure.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса service/gateways можно развернуть с помощью операций, предназначенных для следующих целей:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/gateways, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/gateways@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      locationData = {
        city = "string"
        countryOrRegion = "string"
        district = "string"
        name = "string"
      }
    }
  })
}

Значения свойств

службы и шлюзы

Имя Описание Ценность
тип Тип ресурса "Microsoft.ApiManagement/service/gateways@2023-09-01-preview"
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: службы
свойства Сведения о шлюзе. GatewayContractProperties

GatewayContractProperties

Имя Описание Ценность
описание Описание шлюза струна

Ограничения целостности:
Максимальная длина = 1000
locationData Расположение шлюза. ResourceLocationDataContract

ResourceLocationDataContract

Имя Описание Ценность
город Город или город, где находится ресурс. струна

Ограничения целостности:
Максимальная длина = 256
countryOrRegion Страна или регион, в котором находится ресурс. струна

Ограничения целостности:
Максимальная длина = 256
район Район, штат или провинция, где находится ресурс. струна

Ограничения целостности:
Максимальная длина = 256
имя Каноническое имя географического или физического расположения. строка (обязательно)

Ограничения целостности:
Максимальная длина = 256