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

Служба Microsoft.ApiManagement 2016-10-10

  • Статья

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

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service@2016-10-10' = {
  location: 'string'
  name: 'string'
  properties: {
    additionalLocations: [
      {
        location: 'string'
        skuType: 'string'
        skuUnitCount: int
        vpnconfiguration: {
          location: 'string'
          subnetResourceId: 'string'
        }
      }
    ]
    addresserEmail: 'string'
    customProperties: {
      {customized property}: 'string'
    }
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        hostname: 'string'
        type: 'string'
      }
    ]
    publisherEmail: 'string'
    publisherName: 'string'
    vpnconfiguration: {
      location: 'string'
      subnetResourceId: 'string'
    }
    vpnType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

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

Дополнительноеregion

Имя Описание Ценность
местоположение Имя расположения дополнительного региона среди регионов Центра обработки данных Azure. строка (обязательно)
skuType Номер SKU в расположении. 'Разработчик'
"Премиум"
"Стандартный" (обязательный)
skuUnitCount Количество единиц SKU в расположении. Максимальное число единиц SKU зависит от SkuType. Максимально допустимо для номера SKU разработчика— 1, для номера SKU уровня "Стандартный" — 4, а для номера SKU уровня "Премиум" — 10. int

Ограничения целостности:
Максимальное значение = 10
vpnconfiguration Конфигурация виртуальной сети для расположения. VirtualNetworkConfiguration

ApiManagementServiceProperties

Имя Описание Ценность
дополнительные расположения Дополнительные расположения центров обработки данных службы управления API. AdditionalRegion[]
addresserEmail Адресатор электронной почты. струна
customProperties Пользовательские свойства службы управления API, например отключение TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Настраиваемая конфигурация имени узла службы управления API. HostnameConfiguration[]
publisherEmail Электронная почта издателя. струна

Ограничения целостности:
Максимальная длина = (обязательно)
publisherName Имя издателя. строка (обязательно)
vpnconfiguration Конфигурация виртуальной сети службы управления API. VirtualNetworkConfiguration
vpnType Тип VPN, в котором необходимо настроить службу управления API. Нет (значение по умолчанию) означает, что служба управления API не является частью какой-либо виртуальной сети, внешняя означает, что развертывание управления API настраивается внутри виртуальной сети с конечной точкой виртуальной сети, имеющей только конечную точку с доступом к Интернету, и внутреннее означает, что развертывание управления API настраивается в виртуальной сети только с конечной точкой управления интрасетью. "Внешний"
"Внутренний"
"Нет"

ApiManagementServicePropertiesCustomProperties

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

ApiManagementServiceSkuProperties

Имя Описание Ценность
способность Емкость номера SKU (количество развернутых единиц SKU). Значение по умолчанию — 1. int
имя Имя SKU. 'Разработчик'
"Премиум"
"Стандартный" (обязательный)

CertificateInformation

Имя Описание Ценность
истечение Дата окончания срока действия сертификата. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ, как указано в стандарте ISO 8601. строка (обязательно)
Тема Тема сертификата. строка (обязательно)
Отпечаток Отпечаток сертификата. строка (обязательно)

HostnameConfiguration

Имя Описание Ценность
сертификат Сведения о сертификате. CertificateInformation (обязательно)
имя узла Имя узла. строка (обязательно)
тип Тип имени узла. "Управление"
"Портал"
"Прокси- сервер"
Scm (обязательно)

Microsoft.ApiManagement/service

Имя Описание Ценность
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 1
Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (обязательно)
свойства Свойства службы управления API. ApiManagementServiceProperties (обязательно)
SKU Свойства SKU службы управления API. ApiManagementServiceSkuProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

ResourceTags

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

VirtualNetworkConfiguration

Имя Описание Ценность
местоположение Расположение виртуальной сети. струна
subnetResourceId Полный идентификатор ресурса подсети в виртуальной сети для развертывания службы управления API. струна

Ограничения целостности:
Pattern = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

Примеры краткого руководства

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

Bicep-файл Описание
Шлюз приложений с внутренним управлением API и веб-приложения Шлюз приложений маршрутизации трафика Интернета в экземпляр управления API виртуальной сети (внутренний режим), который обслуживает веб-API, размещенный в веб-приложении Azure.
Создание экземпляра управления API уровня Premium с несколькими уровнями В этом шаблоне показано, как создать экземпляр службы управления API с дополнительными расположениями. Основное расположение совпадает с расположением группы ресурсов. Для дополнительных расположений шаблон отображает NorthCentralUs и восточную часть США2. Основное расположение должно отличаться от дополнительных расположений.
Создание экземпляра управления API с удостоверением MSI Этот шаблон создает экземпляр службы "Управление API Azure" с удостоверением MSI
создание экземпляра службы управления API с помощью шаблона Этот шаблон создает экземпляр службы "Управление API Azure" для разработчика
Создание службы управления API с частной конечной точкой Этот шаблон создаст службу управления API, виртуальную сеть и частную конечную точку, предоставляющую службе управления API виртуальную сеть.
Создание службы управления API с помощью SSL из KeyVault Этот шаблон развертывает службу управления API, настроенную с удостоверением, назначенным пользователем. Он использует это удостоверение для получения SSL-сертификата из KeyVault и сохраняет его обновление, проверяя каждые 4 часа.
создание управления API в внутренней виртуальной сети с шлюза приложений В этом шаблоне показано, как создать экземпляр службы "Управление API Azure" в частной сети, защищенной шлюзом приложений Azure.
развертывание управления API во внешней виртуальной сети с помощью общедоступных IP- В этом шаблоне показано, как создать экземпляр службы "Управление API Azure" на уровне "Премиум" в подсети виртуальной сети во внешнем режиме и настроить рекомендуемые правила NSG в подсети. Экземпляр развертывается в двух зонах доступности. Шаблон также настраивает общедоступный IP-адрес из подписки.
развертывание управления API в внутренней виртуальной сети с помощью общедоступных IP- В этом шаблоне показано, как создать экземпляр службы "Управление API Azure" на уровне "Премиум" в подсети виртуальной сети в внутреннем режиме и настроить рекомендуемые правила NSG в подсети. Экземпляр развертывается в двух зонах доступности. Шаблон также настраивает общедоступный IP-адрес из подписки.
развертывание управления API в зонах доступности Этот шаблон создает экземпляр службы "Премиум" службы "Управление API Azure" и развертывается в зоне доступности.
развернуть управление API с помощью внешнего кэша Azure для Redis В этом шаблоне показано, как создать экземпляр службы "Управление API Azure" на уровне потребления с внешним экземпляром кэша Azure для Redis в качестве внешнего кэша управления API.
Front Door Standard/Premium с источником управления API Этот шаблон создает front Door Premium и экземпляр службы управления API, а также использует группу безопасности сети и глобальную политику управления API для проверки того, что трафик прошел через источник Front Door.

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2016-10-10",
  "name": "string",
  "location": "string",
  "properties": {
    "additionalLocations": [
      {
        "location": "string",
        "skuType": "string",
        "skuUnitCount": "int",
        "vpnconfiguration": {
          "location": "string",
          "subnetResourceId": "string"
        }
      }
    ],
    "addresserEmail": "string",
    "customProperties": {
      "{customized property}": "string"
    },
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "hostname": "string",
        "type": "string"
      }
    ],
    "publisherEmail": "string",
    "publisherName": "string",
    "vpnconfiguration": {
      "location": "string",
      "subnetResourceId": "string"
    },
    "vpnType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

Дополнительноеregion

Имя Описание Ценность
местоположение Имя расположения дополнительного региона среди регионов Центра обработки данных Azure. строка (обязательно)
skuType Номер SKU в расположении. 'Разработчик'
"Премиум"
"Стандартный" (обязательный)
skuUnitCount Количество единиц SKU в расположении. Максимальное число единиц SKU зависит от SkuType. Максимально допустимо для номера SKU разработчика— 1, для номера SKU уровня "Стандартный" — 4, а для номера SKU уровня "Премиум" — 10. int

Ограничения целостности:
Максимальное значение = 10
vpnconfiguration Конфигурация виртуальной сети для расположения. VirtualNetworkConfiguration

ApiManagementServiceProperties

Имя Описание Ценность
дополнительные расположения Дополнительные расположения центров обработки данных службы управления API. AdditionalRegion[]
addresserEmail Адресатор электронной почты. струна
customProperties Пользовательские свойства службы управления API, например отключение TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Настраиваемая конфигурация имени узла службы управления API. HostnameConfiguration[]
publisherEmail Электронная почта издателя. струна

Ограничения целостности:
Максимальная длина = (обязательно)
publisherName Имя издателя. строка (обязательно)
vpnconfiguration Конфигурация виртуальной сети службы управления API. VirtualNetworkConfiguration
vpnType Тип VPN, в котором необходимо настроить службу управления API. Нет (значение по умолчанию) означает, что служба управления API не является частью какой-либо виртуальной сети, внешняя означает, что развертывание управления API настраивается внутри виртуальной сети с конечной точкой виртуальной сети, имеющей только конечную точку с доступом к Интернету, и внутреннее означает, что развертывание управления API настраивается в виртуальной сети только с конечной точкой управления интрасетью. "Внешний"
"Внутренний"
"Нет"

ApiManagementServicePropertiesCustomProperties

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

ApiManagementServiceSkuProperties

Имя Описание Ценность
способность Емкость номера SKU (количество развернутых единиц SKU). Значение по умолчанию — 1. int
имя Имя SKU. 'Разработчик'
"Премиум"
"Стандартный" (обязательный)

CertificateInformation

Имя Описание Ценность
истечение Дата окончания срока действия сертификата. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ, как указано в стандарте ISO 8601. строка (обязательно)
Тема Тема сертификата. строка (обязательно)
Отпечаток Отпечаток сертификата. строка (обязательно)

HostnameConfiguration

Имя Описание Ценность
сертификат Сведения о сертификате. CertificateInformation (обязательно)
имя узла Имя узла. строка (обязательно)
тип Тип имени узла. "Управление"
"Портал"
"Прокси- сервер"
Scm (обязательно)

Microsoft.ApiManagement/service

Имя Описание Ценность
apiVersion Версия API '2016-10-10'
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 1
Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (обязательно)
свойства Свойства службы управления API. ApiManagementServiceProperties (обязательно)
SKU Свойства SKU службы управления API. ApiManagementServiceSkuProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.ApiManagement/service"

ResourceTags

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

VirtualNetworkConfiguration

Имя Описание Ценность
местоположение Расположение виртуальной сети. струна
subnetResourceId Полный идентификатор ресурса подсети в виртуальной сети для развертывания службы управления API. струна

Ограничения целостности:
Pattern = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

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

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

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

развертывание в Azure		 Шлюз приложений маршрутизации трафика Интернета в экземпляр управления API виртуальной сети (внутренний режим), который обслуживает веб-API, размещенный в веб-приложении Azure.
Создание экземпляра управления API уровня Premium с несколькими уровнями

развертывание в Azure		 В этом шаблоне показано, как создать экземпляр службы управления API с дополнительными расположениями. Основное расположение совпадает с расположением группы ресурсов. Для дополнительных расположений шаблон отображает NorthCentralUs и восточную часть США2. Основное расположение должно отличаться от дополнительных расположений.
Создание экземпляра службы управления API и всех вложенных ресурсов с помощью шаблона

развертывание в Azure		 В этом шаблоне показано, как создать службу управления API и настроить вложенные сущности
Создание экземпляра управления API с удостоверением MSI

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

развертывание в Azure		 Этот шаблон создает экземпляр службы "Управление API Azure" для разработчика
Создание экземпляра службы управления API с пользовательскими именами узлов

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

развертывание в Azure		 Этот шаблон создаст службу управления API, виртуальную сеть и частную конечную точку, предоставляющую службе управления API виртуальную сеть.
Создание службы управления API с помощью SSL из KeyVault

развертывание в Azure		 Этот шаблон развертывает службу управления API, настроенную с удостоверением, назначенным пользователем. Он использует это удостоверение для получения SSL-сертификата из KeyVault и сохраняет его обновление, проверяя каждые 4 часа.
Создание и мониторинг экземпляра службы управления API

развертывание в Azure		 Этот шаблон создает экземпляр службы управления API Azure и рабочей области Log Analytics и настраивает мониторинг для службы управления API с помощью Log Analytics
создание управления API в внутренней виртуальной сети с шлюза приложений

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

развертывание в Azure		 В этом шаблоне показано, как создать экземпляр службы "Управление API Azure" и настроить пользовательское имя узла для прокси-сервера с ssl-сертификатом из keyvault.
создание Azure Front Door перед управления API Azure

развертывание в Azure		 В этом примере показано, как использовать Azure Front Door в качестве глобальной подсистемы балансировки нагрузки перед управлением API Azure.
развертывание управления API во внешней виртуальной сети с помощью общедоступных IP-

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

развертывание в Azure		 В этом шаблоне показано, как создать экземпляр службы "Управление API Azure" на уровне "Премиум" в подсети виртуальной сети в внутреннем режиме и настроить рекомендуемые правила NSG в подсети. Экземпляр развертывается в двух зонах доступности. Шаблон также настраивает общедоступный IP-адрес из подписки.
развертывание управления API в зонах доступности

развертывание в Azure		 Этот шаблон создает экземпляр службы "Премиум" службы "Управление API Azure" и развертывается в зоне доступности.
развернуть управление API с помощью внешнего кэша Azure для Redis

развертывание в Azure		 В этом шаблоне показано, как создать экземпляр службы "Управление API Azure" на уровне потребления с внешним экземпляром кэша Azure для Redis в качестве внешнего кэша управления API.
Front Door Standard/Premium с источником управления API

развертывание в Azure		 Этот шаблон создает front Door Premium и экземпляр службы управления API, а также использует группу безопасности сети и глобальную политику управления API для проверки того, что трафик прошел через источник Front Door.

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2016-10-10"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          location = "string"
          skuType = "string"
          skuUnitCount = int
          vpnconfiguration = {
            location = "string"
            subnetResourceId = "string"
          }
        }
      ]
      addresserEmail = "string"
      customProperties = {
        {customized property} = "string"
      }
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          hostname = "string"
          type = "string"
        }
      ]
      publisherEmail = "string"
      publisherName = "string"
      vpnconfiguration = {
        location = "string"
        subnetResourceId = "string"
      }
      vpnType = "string"
    }
  })
}

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

Дополнительноеregion

Имя Описание Ценность
местоположение Имя расположения дополнительного региона среди регионов Центра обработки данных Azure. строка (обязательно)
skuType Номер SKU в расположении. 'Разработчик'
"Премиум"
"Стандартный" (обязательный)
skuUnitCount Количество единиц SKU в расположении. Максимальное число единиц SKU зависит от SkuType. Максимально допустимо для номера SKU разработчика— 1, для номера SKU уровня "Стандартный" — 4, а для номера SKU уровня "Премиум" — 10. int

Ограничения целостности:
Максимальное значение = 10
vpnconfiguration Конфигурация виртуальной сети для расположения. VirtualNetworkConfiguration

ApiManagementServiceProperties

Имя Описание Ценность
дополнительные расположения Дополнительные расположения центров обработки данных службы управления API. AdditionalRegion[]
addresserEmail Адресатор электронной почты. струна
customProperties Пользовательские свойства службы управления API, например отключение TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Настраиваемая конфигурация имени узла службы управления API. HostnameConfiguration[]
publisherEmail Электронная почта издателя. струна

Ограничения целостности:
Максимальная длина = (обязательно)
publisherName Имя издателя. строка (обязательно)
vpnconfiguration Конфигурация виртуальной сети службы управления API. VirtualNetworkConfiguration
vpnType Тип VPN, в котором необходимо настроить службу управления API. Нет (значение по умолчанию) означает, что служба управления API не является частью какой-либо виртуальной сети, внешняя означает, что развертывание управления API настраивается внутри виртуальной сети с конечной точкой виртуальной сети, имеющей только конечную точку с доступом к Интернету, и внутреннее означает, что развертывание управления API настраивается в виртуальной сети только с конечной точкой управления интрасетью. "Внешний"
"Внутренний"
"Нет"

ApiManagementServicePropertiesCustomProperties

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

ApiManagementServiceSkuProperties

Имя Описание Ценность
способность Емкость номера SKU (количество развернутых единиц SKU). Значение по умолчанию — 1. int
имя Имя SKU. 'Разработчик'
"Премиум"
"Стандартный" (обязательный)

CertificateInformation

Имя Описание Ценность
истечение Дата окончания срока действия сертификата. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ, как указано в стандарте ISO 8601. строка (обязательно)
Тема Тема сертификата. строка (обязательно)
Отпечаток Отпечаток сертификата. строка (обязательно)

HostnameConfiguration

Имя Описание Ценность
сертификат Сведения о сертификате. CertificateInformation (обязательно)
имя узла Имя узла. строка (обязательно)
тип Тип имени узла. "Управление"
"Портал"
"Прокси- сервер"
Scm (обязательно)

Microsoft.ApiManagement/service

Имя Описание Ценность
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 1
Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (обязательно)
свойства Свойства службы управления API. ApiManagementServiceProperties (обязательно)
SKU Свойства SKU службы управления API. ApiManagementServiceSkuProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.ApiManagement/service@2016-10-10"

ResourceTags

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

VirtualNetworkConfiguration

Имя Описание Ценность
местоположение Расположение виртуальной сети. струна
subnetResourceId Полный идентификатор ресурса подсети в виртуальной сети для развертывания службы управления API. струна

Ограничения целостности:
Pattern = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$