Служба Microsoft.ApiManagement

  • Статья

Определение ресурса Bicep

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service@2023-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
    {customized property}: 'string'
  sku: {
    capacity: int
    name: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    additionalLocations: [
      {
        disableGateway: bool
        location: 'string'
        natGatewayState: 'string'
        publicIpAddressId: 'string'
        sku: {
          capacity: int
          name: 'string'
        }
        virtualNetworkConfiguration: {
          subnetResourceId: 'string'
        }
        zones: [
          'string'
        ]
      }
    ]
    apiVersionConstraint: {
      minApiVersion: 'string'
    }
    certificates: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        encodedCertificate: 'string'
        storeName: 'string'
      }
    ]
    configurationApi: {
      legacyApi: 'string'
    }
    customProperties: {
      {customized property}: 'string'
    }
    developerPortalStatus: 'string'
    disableGateway: bool
    enableClientCertificate: bool
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        certificateSource: 'string'
        certificateStatus: 'string'
        defaultSslBinding: bool
        encodedCertificate: 'string'
        hostName: 'string'
        identityClientId: 'string'
        keyVaultId: 'string'
        negotiateClientCertificate: bool
        type: 'string'
      }
    ]
    legacyPortalStatus: 'string'
    natGatewayState: 'string'
    notificationSenderEmail: 'string'
    privateEndpointConnections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
        type: 'string'
      }
    ]
    publicIpAddressId: 'string'
    publicNetworkAccess: 'string'
    publisherEmail: 'string'
    publisherName: 'string'
    restore: bool
    virtualNetworkConfiguration: {
      subnetResourceId: 'string'
    }
    virtualNetworkType: 'string'
  }
  zones: [
    'string'
  ]
}

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

служба

Имя Описание Значение
name имя ресурса. string (обязательно)

Ограничение символов: 1-50

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Начинается с буквы и заканчивается буквенно-цифровым символом.

Имя ресурса должно быть уникальным в Azure.
location Расположение ресурса. string (обязательно)
tags Теги ресурсов. Словарь имен и значений тегов. См . раздел Теги в шаблонах
sku Свойства SKU службы Управление API. ApiManagementServiceSkuProperties (обязательно)
удостоверение Управляемое удостоверение службы управления API. ApiManagementServiceIdentity
properties Свойства службы Управление API. ApiManagementServiceProperties (обязательно)
зоны; Список зон доступности, обозначающих, откуда должен поступать ресурс. string[]

ApiManagementServiceIdentity

Имя Описание Значение
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned (обязательно)
userAssignedIdentities Список удостоверений пользователей, связанных с ресурсом. Удостоверение пользователя
Ссылки на ключи словаря будут иметь идентификаторы ресурсов ARM в формате :
/subscriptions/{ИД подписки}/resourceGroups/{имя группы ресурсов}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".
 ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Имя Описание Значение
{настраиваемое свойство} UserIdentityProperties

UserIdentityProperties

Имя Описание Значение
clientid Идентификатор клиента удостоверения, назначаемого пользователем. строка
principalId Идентификатор субъекта удостоверения, назначаемого пользователем. строка

ApiManagementServiceProperties

Имя Описание Значение
additionalLocations Дополнительные расположения центра обработки данных службы Управление API. AdditionalLocation[]
apiVersionConstraint Ограничение версии API уровня управления для службы Управление API. ApiVersionConstraint
certificates Список сертификатов, которые необходимо установить в службе Управление API. Максимальное число поддерживаемых сертификатов, которые можно установить, равно 10. CertificateConfiguration[]
configurationApi Конфигурация API конфигурации службы Управление API. ConfigurationApi
customProperties Пользовательские свойства службы Управление API.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 отключит TLS_RSA_WITH_3DES_EDE_CBC_SHA шифра для всех протоколов TLS(1.0, 1.1 и 1.2).
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 можно использовать для отключения только TLS 1.1.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 можно использовать для отключения TLS 1.0 в службе Управление API.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 можно использовать, чтобы отключить только TLS 1.1 для связи с внутренними серверами.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 можно использовать для отключения ПРОТОКОЛА TLS 1.0 для обмена данными с внутренними серверами.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 можно использовать для включения протокола HTTP2 в службе Управление API.
Если не указать ни одно из этих свойств в операции PATCH, значения опущенных свойств будут сброшены до значений по умолчанию. Для всех параметров, кроме Http2, значением по умолчанию является True , если служба была создана 1 апреля 2018 года или раньше, и False в противном случае. Значение по умолчанию параметра Http2 — False.

Вы можете отключить любой из следующих шифров с помощью параметров Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256 TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA. Например, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Значение по умолчанию — true для них.
Примечание. Следующие шифры нельзя отключить, так как они требуются для внутренних компонентов платформы: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256		 ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus Состояние портала разработчика в этой службе Управление API. "Отключено"
"Включено"
disableGateway Свойство допустимо только для службы управления API, развернутой в нескольких расположениях. Это можно использовать для отключения шлюза в master регионе. bool
enableClientCertificate Свойство предназначено только для службы SKU потребления. Это принудительно обеспечивает представление сертификата клиента при каждом запросе к шлюзу. Это также позволяет проверять подлинность сертификата в политике шлюза. bool
hostnameConfigurations Настраиваемая конфигурация имени узла службы Управление API. HostnameConfiguration[]
legacyPortalStatus Состояние устаревшего портала в службе Управление API. "Отключено"
"Включено"
natGatewayState Свойство можно использовать для включения шлюза NAT для этой службы Управление API. "Отключено"
"Включено"
notificationSenderEmail Email адрес, с которого будет отправлено уведомление. строка
privateEndpointConnections Список подключений к частной конечной точке этой службы. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId IP-адрес на основе общедоступного номера SKU SKU V4, связанный с виртуальная сеть развернутой службой в регионе. Поддерживается только для SKU "Разработчик" и "Премиум", развертываемых в виртуальная сеть. строка
publicNetworkAccess Разрешен ли доступ к общедоступной конечной точке для этой Управление API службы. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются монопольным методом доступа. Значение по умолчанию — "Включено". "Отключено"
"Включено"
publisherEmail Электронная почта издателя. string (обязательно)
publisherName Имя издателя. string (обязательно)
Восстановление Отмените удаление службы управления API, если она ранее была обратимо удалена. Если этот флаг указан и имеет значение True, все остальные свойства будут игнорироваться. bool
virtualNetworkConfiguration Конфигурация виртуальной сети службы Управление API. VirtualNetworkConfiguration
virtualNetworkType Тип VPN, в котором необходимо настроить службу Управление API. None (значение по умолчанию) означает, что служба Управление API не является частью какого-либо виртуальная сеть, external означает, что развертывание Управление API настроено внутри виртуальная сеть с конечной точкой с выходом в Интернет, а внутреннее означает, что Управление API развертывание настраивается внутри виртуальная сеть только с конечной точкой, обращенной к интрасети. "Внешний"
"Внутренний"
"Нет"

Дополнительное расположение

Имя Описание Значение
disableGateway Свойство допустимо только для службы управления API, развернутой в нескольких расположениях. Это можно использовать для отключения шлюза в этом дополнительном расположении. bool
location Имя расположения дополнительного региона между регионами центра обработки данных Azure. string (обязательно)
natGatewayState Свойство можно использовать для включения шлюза NAT для этой службы Управление API. "Отключено"
"Включено"
publicIpAddressId IP-адрес на основе общедоступного номера SKU категории "Стандартный" версии 4, который необходимо связать с виртуальная сеть развернутой службой в расположении. Поддерживается только для номера SKU уровня "Премиум", развертываемого в виртуальная сеть. строка
sku Свойства SKU службы Управление API. ApiManagementServiceSkuProperties (обязательно)
virtualNetworkConfiguration Конфигурация виртуальной сети для расположения. VirtualNetworkConfiguration
зоны; Список зон доступности, обозначающих, откуда должен поступать ресурс. string[]

ApiManagementServiceSkuProperties

Имя Описание Значение
Емкость Емкость номера SKU (количество развернутых единиц SKU). Для параметра Потребление емкость SKU должна быть указана как 0. int (обязательно)
name Имя номера SKU. "Базовый"
BasicV2
"Потребление"
"Разработчик"
"Изолированный"
"Премиум"
"Стандартный"
StandardV2 (обязательно)

VirtualNetworkConfiguration

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

ApiVersionConstraint

Имя Описание Значение
minApiVersion Ограничьте вызовы API уровня управления для Управление API службы с версией, равной или более поздней, чем это значение. строка

CertificateConfiguration

Имя Описание Значение
сертификат Сведения о сертификате. CertificateInformation
certificatePassword Пароль сертификата. строка
encodedCertificate Сертификат в кодировке Base64. строка
storeName Расположение хранилища сертификатов System.Security.Cryptography.x509certificates.StoreName. Допустимы только корневой каталог и certificateAuthority. CertificateAuthority
"Root" (обязательно)

CertificateInformation

Имя Описание Значение
expiry Дата окончания срока действия сертификата. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601. string (обязательно)
subject Субъект сертификата. string (обязательно)
thumbprint Отпечаток сертификата. string (обязательно)

ConfigurationApi

Имя Описание Значение
legacyApi Указывает, должен ли устаревший API конфигурации (версия 1) предоставляться в службе Управление API. Значение является необязательным, но должно иметь значение "Включено" или "Отключено". Если значение "Отключено", устаревший API конфигурации (версия 1) будет недоступен для локальных шлюзов. Значение по умолчанию — "Включено". "Отключено"
"Включено"

ApiManagementServiceBasePropertiesCustomProperties

Имя Описание Значение
{настраиваемое свойство} строка

HostnameConfiguration

Имя Описание Значение
сертификат Сведения о сертификате. CertificateInformation
certificatePassword Пароль сертификата. строка
certificateSource Источник сертификата. BuiltIn
"Пользовательский"
KeyVault
"Управляемый"
certificateStatus Состояние сертификата. "Завершено"
"Сбой"
InProgress
defaultSslBinding Укажите значение true, чтобы настроить сертификат, связанный с этим именем узла, в качестве SSL-сертификата по умолчанию. Если клиент не отправляет заголовок SNI, это будет сертификат, который будет оспорен. Свойство полезно, если в службе включено несколько пользовательских имен узлов и ей необходимо выбрать SSL-сертификат по умолчанию. Параметр применяется только к типу имени узла шлюза. bool
encodedCertificate Сертификат в кодировке Base64. строка
hostName Имя узла, настраиваемое в службе управления API. строка (обязательно)
identityClientId Системное или назначаемое пользователем управляемое удостоверение clientId, созданное Azure AD, которое имеет доступ GET к хранилищу ключей, содержащим SSL-сертификат. строка
keyVaultId URL-адрес секрета KeyVault, содержащего SSL-сертификат. Если указан абсолютный URL-адрес, содержащий версию, автоматическое обновление SSL-сертификата не будет работать. Для этого необходимо, чтобы служба управления API была настроена с помощью aka.ms/apimmsi. Секрет должен иметь тип application/x-pkcs12. строка
negotiateClientCertificate Укажите значение true, чтобы всегда согласовывать сертификат клиента по имени узла. Значение по умолчанию — false. bool
тип Тип имени узла. ConfigurationApi
DeveloperPortal
"Управление"
Портал
Прокси-сервер
Scm (обязательно)

RemotePrivateEndpointConnectionWrapper

Имя Описание Значение
идентификатор Идентификатор ресурса подключения к частной конечной точке строка
name Имя подключения к частной конечной точке строка
properties Свойства ресурса. PrivateEndpointConnectionWrapperProperties
тип Тип ресурса подключения к частной конечной точке строка

PrivateEndpointConnectionWrapperProperties

Имя Описание Значение
privateEndpoint Ресурс частной конечной точки. ArmIdWrapper
privateLinkServiceConnectionState Коллекция сведений о состоянии подключения между потребителем службы и поставщиком. PrivateLinkServiceConnectionState (обязательно)

ArmIdWrapper

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

PrivateLinkServiceConnectionState

Имя Описание Значение
ActionsRequired Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления на потребителе. строка
description Причина утверждения или отклонения подключения. строка
status Указывает, было ли подключение утверждено, отклонено или удалено владельцем службы. "Утверждено"
"Ожидание"
'Rejected'

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

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

Шаблон Описание
Create an API Management instance and all sub resources using template (Создание экземпляра службы "Управление API" и всех сопутствующих ресурсов с помощью шаблона)

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

Развертывание в Azure		 В этом шаблоне показано, как создать экземпляр azure Управление API на уровне "Потребление" с внешним экземпляром Кэш Azure для Redis в качестве Управление API внешнего кэша.
Развертывание Управление API во внешней виртуальной сети с общедоступным IP-адресом

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

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

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

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

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

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

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

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

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

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

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

Развертывание в Azure		 Этот шаблон создает экземпляр azure Управление API разработчика.
Front Door уровня "Стандартный" или "Премиум" с Управление API источником

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

Развертывание в Azure		 В этом примере показано, как использовать Azure Front Door в качестве глобальной подсистемы балансировки нагрузки перед azure Управление API.
Шлюз приложений с внутренним Управление API и веб-приложением

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

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
    "{customized property}": "string"
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "additionalLocations": [
      {
        "disableGateway": "bool",
        "location": "string",
        "natGatewayState": "string",
        "publicIpAddressId": "string",
        "sku": {
          "capacity": "int",
          "name": "string"
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "string"
        },
        "zones": [ "string" ]
      }
    ],
    "apiVersionConstraint": {
      "minApiVersion": "string"
    },
    "certificates": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "encodedCertificate": "string",
        "storeName": "string"
      }
    ],
    "configurationApi": {
      "legacyApi": "string"
    },
    "customProperties": {
      "{customized property}": "string"
    },
    "developerPortalStatus": "string",
    "disableGateway": "bool",
    "enableClientCertificate": "bool",
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "certificateSource": "string",
        "certificateStatus": "string",
        "defaultSslBinding": "bool",
        "encodedCertificate": "string",
        "hostName": "string",
        "identityClientId": "string",
        "keyVaultId": "string",
        "negotiateClientCertificate": "bool",
        "type": "string"
      }
    ],
    "legacyPortalStatus": "string",
    "natGatewayState": "string",
    "notificationSenderEmail": "string",
    "privateEndpointConnections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        },
        "type": "string"
      }
    ],
    "publicIpAddressId": "string",
    "publicNetworkAccess": "string",
    "publisherEmail": "string",
    "publisherName": "string",
    "restore": "bool",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "string"
    },
    "virtualNetworkType": "string"
  },
  "zones": [ "string" ]
}

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

служба

Имя Описание Значение
тип Тип ресурса Microsoft.ApiManagement/service
версия_API Версия API ресурсов '2023-05-01-preview'
name имя ресурса. string (обязательно)

Ограничение символов: 1-50

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Начинается с буквы и заканчивается буквенно-цифровым символом.

Имя ресурса должно быть уникальным в Azure.
location Расположение ресурса. string (обязательно)
tags Теги ресурсов. Словарь имен и значений тегов. См . раздел Теги в шаблонах
sku Свойства SKU службы Управление API. ApiManagementServiceSkuProperties (обязательно)
удостоверение Управляемое удостоверение службы управления API. ApiManagementServiceIdentity
properties Свойства службы Управление API. ApiManagementServiceProperties (обязательно)
зоны; Список зон доступности, обозначающих, откуда должен поступать ресурс. string[]

ApiManagementServiceIdentity

Имя Описание Значение
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned (обязательно)
userAssignedIdentities Список удостоверений пользователей, связанных с ресурсом. Удостоверение пользователя
Ссылки на ключи словаря будут иметь идентификаторы ресурсов ARM в формате :
/subscriptions/{ИД подписки}/resourceGroups/{имя группы ресурсов}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".
 ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Имя Описание Значение
{настраиваемое свойство} UserIdentityProperties

UserIdentityProperties

Имя Описание Значение
clientid Идентификатор клиента удостоверения, назначаемого пользователем. строка
principalId Идентификатор субъекта удостоверения, назначаемого пользователем. строка

ApiManagementServiceProperties

Имя Описание Значение
additionalLocations Дополнительные расположения центра обработки данных службы Управление API. AdditionalLocation[]
apiVersionConstraint Ограничение версии API уровня управления для службы Управление API. ApiVersionConstraint
certificates Список сертификатов, которые необходимо установить в службе Управление API. Максимальное число поддерживаемых сертификатов, которые можно установить, равно 10. CertificateConfiguration[]
configurationApi Конфигурация API конфигурации службы Управление API. ConfigurationApi
customProperties Пользовательские свойства службы Управление API.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 отключит TLS_RSA_WITH_3DES_EDE_CBC_SHA шифра для всех протоколов TLS(1.0, 1.1 и 1.2).
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 можно использовать для отключения только TLS 1.1.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 можно использовать для отключения TLS 1.0 в службе Управление API.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 можно использовать, чтобы отключить только TLS 1.1 для связи с внутренними серверами.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 можно использовать для отключения ПРОТОКОЛА TLS 1.0 для обмена данными с внутренними серверами.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 можно использовать для включения протокола HTTP2 в службе Управление API.
Если не указать ни одно из этих свойств в операции PATCH, значения опущенных свойств будут сброшены до значений по умолчанию. Для всех параметров, кроме Http2, значением по умолчанию является True , если служба была создана 1 апреля 2018 года или раньше, и False в противном случае. Значение по умолчанию параметра Http2 — False.

Вы можете отключить любой из следующих шифров с помощью параметров Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256 TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA. Например, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Значение по умолчанию — true для них.
Примечание. Следующие шифры нельзя отключить, так как они требуются для внутренних компонентов платформы: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256		 ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus Состояние портала разработчика в этой службе Управление API. "Отключено"
"Включено"
disableGateway Свойство допустимо только для службы управления API, развернутой в нескольких расположениях. Это можно использовать для отключения шлюза в master регионе. bool
enableClientCertificate Свойство предназначено только для службы SKU потребления. Это принудительно обеспечивает представление сертификата клиента при каждом запросе к шлюзу. Это также позволяет проверять подлинность сертификата в политике шлюза. bool
hostnameConfigurations Настраиваемая конфигурация имени узла службы Управление API. HostnameConfiguration[]
legacyPortalStatus Состояние устаревшего портала в службе Управление API. "Отключено"
"Включено"
natGatewayState Свойство можно использовать для включения шлюза NAT для этой службы Управление API. "Отключено"
"Включено"
notificationSenderEmail Email адрес, с которого будет отправлено уведомление. строка
privateEndpointConnections Список подключений к частной конечной точке этой службы. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId IP-адрес на основе общедоступного номера SKU SKU V4, связанный с виртуальная сеть развернутой службой в регионе. Поддерживается только для SKU "Разработчик" и "Премиум", развертываемых в виртуальная сеть. строка
publicNetworkAccess Разрешен ли доступ к общедоступной конечной точке для этой Управление API службы. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются монопольным методом доступа. Значение по умолчанию — "Включено". "Отключено"
"Включено"
publisherEmail Электронная почта издателя. string (обязательно)
publisherName Имя издателя. string (обязательно)
Восстановление Отмените удаление службы управления API, если она ранее была обратимо удалена. Если этот флаг указан и имеет значение True, все остальные свойства будут игнорироваться. bool
virtualNetworkConfiguration Конфигурация виртуальной сети службы Управление API. VirtualNetworkConfiguration
virtualNetworkType Тип VPN, в котором необходимо настроить службу Управление API. None (значение по умолчанию) означает, что служба Управление API не является частью какого-либо виртуальная сеть, external означает, что развертывание Управление API настроено внутри виртуальная сеть с конечной точкой с выходом в Интернет, а внутреннее означает, что Управление API развертывание настраивается внутри виртуальная сеть только с конечной точкой, обращенной к интрасети. "Внешний"
"Внутренний"
"Нет"

Дополнительное расположение

Имя Описание Значение
disableGateway Свойство допустимо только для службы управления API, развернутой в нескольких расположениях. Это можно использовать для отключения шлюза в этом дополнительном расположении. bool
location Имя расположения дополнительного региона между регионами центра обработки данных Azure. string (обязательно)
natGatewayState Свойство можно использовать для включения шлюза NAT для этой службы Управление API. "Отключено"
"Включено"
publicIpAddressId IP-адрес на основе общедоступного номера SKU категории "Стандартный" версии 4, который необходимо связать с виртуальная сеть развернутой службой в расположении. Поддерживается только для номера SKU уровня "Премиум", развертываемого в виртуальная сеть. строка
sku Свойства SKU службы Управление API. ApiManagementServiceSkuProperties (обязательно)
virtualNetworkConfiguration Конфигурация виртуальной сети для расположения. VirtualNetworkConfiguration
зоны; Список зон доступности, обозначающих, откуда должен поступать ресурс. string[]

ApiManagementServiceSkuProperties

Имя Описание Значение
Емкость Емкость номера SKU (количество развернутых единиц SKU). Для параметра Потребление емкость SKU должна быть указана как 0. int (обязательно)
name Имя номера SKU. "Базовый"
BasicV2
"Потребление"
"Разработчик"
"Изолированный"
"Премиум"
"Стандартный"
StandardV2 (обязательно)

VirtualNetworkConfiguration

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

ApiVersionConstraint

Имя Описание Значение
minApiVersion Ограничьте вызовы API уровня управления для Управление API службы с версией, равной или более поздней, чем это значение. строка

CertificateConfiguration

Имя Описание Значение
сертификат Сведения о сертификате. CertificateInformation
certificatePassword Пароль сертификата. строка
encodedCertificate Сертификат в кодировке Base64. строка
storeName Расположение хранилища сертификатов System.Security.Cryptography.x509certificates.StoreName. Допустимы только корневой каталог и certificateAuthority. CertificateAuthority
"Root" (обязательно)

CertificateInformation

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

ConfigurationApi

Имя Описание Значение
legacyApi Указывает, следует ли предоставлять устаревший API конфигурации (версия 1) в службе Управление API. Значение является необязательным, но должно быть "Включено" или "Отключено". Если значение "Отключено", устаревший API конфигурации (версия 1) будет недоступен для локальных шлюзов. Значение по умолчанию — "Включено". "Отключено"
"Включено"

ApiManagementServiceBasePropertiesCustomProperties

Имя Описание Значение
{настроенное свойство} строка

HostnameConfiguration

Имя Описание Значение
сертификат Сведения о сертификате. CertificateInformation
certificatePassword Пароль сертификата. строка
certificateSource Источник сертификата. BuiltIn
"Пользовательский"
KeyVault
"Управляемый"
certificateStatus Состояние сертификата. "Завершено"
"Сбой"
InProgress
defaultSslBinding Укажите значение true, чтобы настроить сертификат, связанный с этим именем узла, в качестве SSL-сертификата по умолчанию. Если клиент не отправляет заголовок SNI, это будет сертификат, который будет оспорен. Свойство полезно, если в службе включено несколько пользовательских имен узлов и ей необходимо выбрать SSL-сертификат по умолчанию. Параметр применяется только к типу имени узла шлюза. bool
encodedCertificate Сертификат в кодировке Base64. строка
hostName Имя узла, настраиваемое в службе управления API. строка (обязательно)
identityClientId Системное или назначаемое пользователем управляемое удостоверение clientId, созданное Azure AD, которое имеет доступ GET к хранилищу ключей, содержащим SSL-сертификат. строка
keyVaultId URL-адрес секрета KeyVault, содержащего SSL-сертификат. Если указан абсолютный URL-адрес, содержащий версию, автоматическое обновление SSL-сертификата не будет работать. Для этого необходимо, чтобы служба управления API была настроена с помощью aka.ms/apimmsi. Секрет должен иметь тип application/x-pkcs12. строка
negotiateClientCertificate Укажите значение true, чтобы всегда согласовывать сертификат клиента по имени узла. Значение по умолчанию — false. bool
тип Тип имени узла. ConfigurationApi
DeveloperPortal
"Управление"
Портал
Прокси-сервер
Scm (обязательно)

RemotePrivateEndpointConnectionWrapper

Имя Описание Значение
идентификатор Идентификатор ресурса подключения к частной конечной точке строка
name Имя подключения к частной конечной точке строка
properties Свойства ресурса. PrivateEndpointConnectionWrapperProperties
тип Тип ресурса подключения к частной конечной точке строка

PrivateEndpointConnectionWrapperProperties

Имя Описание Значение
privateEndpoint Ресурс частной конечной точки. ArmIdWrapper
privateLinkServiceConnectionState Коллекция сведений о состоянии подключения между потребителем службы и поставщиком. PrivateLinkServiceConnectionState (обязательно)

ArmIdWrapper

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

PrivateLinkServiceConnectionState

Имя Описание Значение
ActionsRequired Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления на потребителе. строка
description Причина утверждения или отклонения подключения. строка
status Указывает, было ли подключение утверждено, отклонено или удалено владельцем службы. "Утверждено"
"Ожидание"
'Rejected'

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

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

Шаблон Описание
Create an API Management instance and all sub resources using template (Создание экземпляра службы "Управление API" и всех сопутствующих ресурсов с помощью шаблона)

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

Развертывание в Azure		 В этом шаблоне показано, как создать экземпляр azure Управление API на уровне "Потребление" с внешним экземпляром Кэш Azure для Redis в качестве Управление API внешнего кэша.
Развертывание Управление API во внешней виртуальной сети с общедоступным IP-адресом

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

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

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

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

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

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

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

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

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

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

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

Развертывание в Azure		 Этот шаблон создает экземпляр azure Управление API разработчика
Front Door уровня "Стандартный" или "Премиум" с источником Управление API

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

Развертывание в Azure		 В этом примере показано, как использовать Azure Front Door в качестве глобальной подсистемы балансировки нагрузки перед azure Управление API.
Шлюз приложений с внутренним Управление API и веб-приложением

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

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

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

  • Группы ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2023-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
    {customized property} = "string"
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          disableGateway = bool
          location = "string"
          natGatewayState = "string"
          publicIpAddressId = "string"
          sku = {
            capacity = int
            name = "string"
          }
          virtualNetworkConfiguration = {
            subnetResourceId = "string"
          }
          zones = [
            "string"
          ]
        }
      ]
      apiVersionConstraint = {
        minApiVersion = "string"
      }
      certificates = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          certificatePassword = "string"
          encodedCertificate = "string"
          storeName = "string"
        }
      ]
      configurationApi = {
        legacyApi = "string"
      }
      customProperties = {
        {customized property} = "string"
      }
      developerPortalStatus = "string"
      disableGateway = bool
      enableClientCertificate = bool
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          certificatePassword = "string"
          certificateSource = "string"
          certificateStatus = "string"
          defaultSslBinding = bool
          encodedCertificate = "string"
          hostName = "string"
          identityClientId = "string"
          keyVaultId = "string"
          negotiateClientCertificate = bool
          type = "string"
        }
      ]
      legacyPortalStatus = "string"
      natGatewayState = "string"
      notificationSenderEmail = "string"
      privateEndpointConnections = [
        {
          id = "string"
          name = "string"
          properties = {
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
          type = "string"
        }
      ]
      publicIpAddressId = "string"
      publicNetworkAccess = "string"
      publisherEmail = "string"
      publisherName = "string"
      restore = bool
      virtualNetworkConfiguration = {
        subnetResourceId = "string"
      }
      virtualNetworkType = "string"
    }
    zones = [
      "string"
    ]
    sku = {
      capacity = int
      name = "string"
    }
  })
}

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

служба

Имя Описание Значение
тип Тип ресурса "Microsoft.ApiManagement/service@2023-05-01-preview"
name имя ресурса. строка (обязательно)

Ограничение символов: 1–50

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Начинается с буквы и заканчивается буквенно-цифровым символом.

Имя ресурса должно быть уникальным в Azure.
location Расположение ресурса. строка (обязательно)
parent_id Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов. строка (обязательно)
tags Теги ресурсов. Словарь имен и значений тегов.
sku Свойства SKU службы Управление API. ApiManagementServiceSkuProperties (обязательно)
удостоверение Управляемое удостоверение службы управления API. ApiManagementServiceIdentity
properties Свойства службы Управление API. ApiManagementServiceProperties (обязательно)
зоны; Список зон доступности, обозначающих, откуда должен поступать ресурс. string[]

ApiManagementServiceIdentity

Имя Описание Значение
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из службы. "SystemAssigned"
"SystemAssigned, UserAssigned"
UserAssigned (обязательно)
identity_ids Список удостоверений пользователей, связанных с ресурсом. Удостоверение пользователя
Ссылки на ключ словаря будут иметь идентификаторы ресурсов ARM в виде:
/subscriptions/{ИД подписки}/resourceGroups/{имя группы ресурсов}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 Массив идентификаторов удостоверений пользователей.

ApiManagementServiceIdentityUserAssignedIdentities

Имя Описание Значение
{настроенное свойство} UserIdentityProperties

UserIdentityProperties

Имя Описание Значение
clientid Идентификатор клиента удостоверения, назначаемого пользователем. строка
principalId Идентификатор субъекта удостоверения, назначаемого пользователем. строка

ApiManagementServiceProperties

Имя Описание Значение
additionalLocations Дополнительные расположения центра обработки данных службы Управление API. AdditionalLocation[]
apiVersionConstraint Ограничение версии API уровня управления для службы Управление API. ApiVersionConstraint
certificates Список сертификатов, которые необходимо установить в службе Управление API. Максимальное число поддерживаемых сертификатов, которые можно установить, равно 10. CertificateConfiguration[]
configurationApi Конфигурация API конфигурации службы Управление API. ConfigurationApi
customProperties Пользовательские свойства службы Управление API.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 отключает TLS_RSA_WITH_3DES_EDE_CBC_SHA шифра для всех протоколов TLS(1.0, 1.1 и 1.2).
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 можно использовать для отключения только TLS 1.1.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 можно использовать для отключения TLS 1.0 в службе Управление API.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 можно использовать, чтобы отключить только TLS 1.1 для связи с серверными серверами.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 можно использовать для отключения TLS 1.0 для обмена данными с серверной частью.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 можно использовать для включения протокола HTTP2 в службе Управление API.
Если не указать ни одно из этих свойств в операции PATCH, значения опущенных свойств будут сброшены до значений по умолчанию. Для всех параметров, кроме Http2, значением по умолчанию является True значение , если служба была создана 1 апреля 2018 False года или раньше. Значение по умолчанию параметра Http2 — False.

Вы можете отключить любой из следующих шифров с помощью параметров Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA. Например, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Значение по умолчанию — true для них.
Примечание. Следующие шифры нельзя отключить, так как они требуются для внутренних компонентов платформы: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256		 ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus Состояние портала разработчика в этой службе Управление API. "Отключено"
"Включено"
disableGateway Свойство допустимо только для службы управления API, развернутой в нескольких расположениях. Его можно использовать для отключения шлюза в master регионе. bool
enableClientCertificate Свойство предназначено только для службы SKU потребления. При этом сертификат клиента должен отображаться при каждом запросе к шлюзу. Это также позволяет проверять подлинность сертификата в политике шлюза. bool
hostnameConfigurations Настраиваемая конфигурация имени узла службы Управление API. HostnameConfiguration[]
legacyPortalStatus Состояние устаревшего портала в службе Управление API. "Отключено"
"Включено"
natGatewayState Свойство можно использовать для включения шлюза NAT для этой службы Управление API. "Отключено"
"Включено"
notificationSenderEmail Email адрес, с которого будет отправлено уведомление. строка
privateEndpointConnections Список подключений к частной конечной точке этой службы. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Ip-адрес на основе общедоступного номера SKU "Стандартный" версии 4, который будет связан с виртуальная сеть развернутой службой в регионе. Поддерживается только для SKU developer и Premium, развертываемых в виртуальная сеть. строка
publicNetworkAccess Разрешен ли доступ к общедоступной конечной точке для этой службы Управление API. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". При отключении частные конечные точки являются монопольным методом доступа. Значение по умолчанию — "Включено". "Отключено"
"Включено"
publisherEmail Электронная почта издателя. строка (обязательно)
publisherName Имя издателя. строка (обязательно)
Восстановление Отмените удаление службы управления API, если она ранее была обратимо удалена. Если этот флаг указан и имеет значение True, все остальные свойства будут игнорироваться. bool
virtualNetworkConfiguration Конфигурация виртуальной сети службы Управление API. VirtualNetworkConfiguration
virtualNetworkType Тип VPN, в котором необходимо настроить службу Управление API. None (значение по умолчанию) означает, что служба Управление API не является частью какой-либо виртуальная сеть, external означает, что развертывание Управление API настроено внутри виртуальная сеть с конечной точкой с выходом в Интернет, а внутреннее означает, что Управление API Развертывание настраивается внутри виртуальная сеть только с конечной точкой, подключенной к интрасети. "Внешний"
"Внутренний"
"None"

Дополнительное расположение

Имя Описание Значение
disableGateway Свойство допустимо только для службы управления API, развернутой в нескольких расположениях. Его можно использовать для отключения шлюза в этом дополнительном расположении. bool
location Имя расположения дополнительного региона среди регионов центра обработки данных Azure. строка (обязательно)
natGatewayState Свойство можно использовать для включения шлюза NAT для этой службы Управление API. "Отключено"
"Включено"
publicIpAddressId IP-адрес на основе общедоступного номера SKU "Стандартный" версии 4, который будет связан с виртуальная сеть развернутой службой в расположении. Поддерживается только для номера SKU "Премиум", развертываемого в виртуальная сеть. строка
sku Свойства SKU службы Управление API. ApiManagementServiceSkuProperties (обязательно)
virtualNetworkConfiguration Конфигурация виртуальной сети для расположения. VirtualNetworkConfiguration
зоны; Список зон доступности, обозначающих, откуда должен поступать ресурс. string[]

ApiManagementServiceSkuProperties

Имя Описание Значение
Емкость Емкость номера SKU (количество развернутых единиц SKU). Для параметра Потребление SKU емкость должна быть указана как 0. int (обязательно)
name Имя номера SKU. "Basic"
"BasicV2"
"Потребление"
"Разработчик"
"Изолированный"
"Премиум"
"Стандартный"
"StandardV2" (обязательно)

VirtualNetworkConfiguration

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

ApiVersionConstraint

Имя Описание Значение
minApiVersion Ограничьте вызовы API уровня управления к Управление API службе с версией, равной этому значению или более поздней. строка

CertificateConfiguration

Имя Описание Значение
сертификат Сведения о сертификате. CertificateInformation
certificatePassword Пароль сертификата. строка
encodedCertificate Сертификат в кодировке Base64. строка
storeName Расположение хранилища сертификатов System.Security.Cryptography.x509certificates.StoreName. Допустимыми расположениями являются только Root и CertificateAuthority. CertificateAuthority
"Root" (обязательно)

CertificateInformation

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

ConfigurationApi

Имя Описание Значение
legacyApi Указывает, следует ли предоставлять устаревший API конфигурации (версия 1) в службе Управление API. Значение является необязательным, но должно быть "Включено" или "Отключено". Если значение "Отключено", устаревший API конфигурации (версия 1) будет недоступен для локальных шлюзов. Значение по умолчанию — "Включено". "Отключено"
"Включено"

ApiManagementServiceBasePropertiesCustomProperties

Имя Описание Значение
{настроенное свойство} строка

HostnameConfiguration

Имя Описание Значение
сертификат Сведения о сертификате. CertificateInformation
certificatePassword Пароль сертификата. строка
certificateSource Источник сертификата. "BuiltIn"
"Custom"
KeyVault
"Управляемая"
certificateStatus Состояние сертификата. "Завершено"
"Сбой"
"InProgress"
defaultSslBinding Укажите значение true, чтобы настроить сертификат, связанный с этим именем узла, в качестве SSL-сертификата по умолчанию. Если клиент не отправляет заголовок SNI, это будет сертификат, который будет оспорен. Свойство полезно, если в службе включено несколько пользовательских имен узлов и ей необходимо выбрать SSL-сертификат по умолчанию. Параметр применяется только к типу имени узла шлюза. bool
encodedCertificate Сертификат в кодировке Base64. строка
hostName Имя узла, настраиваемое в службе управления API. строка (обязательно)
identityClientId Системное или назначаемое пользователем управляемое удостоверение clientId, созданное Azure AD, которое имеет доступ GET к хранилищу ключей, содержащим SSL-сертификат. строка
keyVaultId URL-адрес секрета KeyVault, содержащего SSL-сертификат. Если указан абсолютный URL-адрес, содержащий версию, автоматическое обновление SSL-сертификата не будет работать. Для этого необходимо, чтобы служба управления API была настроена с помощью aka.ms/apimmsi. Секрет должен иметь тип application/x-pkcs12. строка
negotiateClientCertificate Укажите значение true, чтобы всегда согласовывать сертификат клиента по имени узла. Значение по умолчанию — false. bool
тип Тип имени узла. ConfigurationApi
"DeveloperPortal"
"Управление"
"Портал"
"Прокси-сервер"
"Scm" (обязательно)

RemotePrivateEndpointConnectionWrapper

Имя Описание Значение
идентификатор Идентификатор ресурса подключения к частной конечной точке строка
name Имя подключения к частной конечной точке строка
properties Свойства ресурса. PrivateEndpointConnectionWrapperProperties
тип Тип ресурса подключения к частной конечной точке строка

PrivateEndpointConnectionWrapperProperties

Имя Описание Значение
privateEndpoint Ресурс частной конечной точки. ArmIdWrapper
privateLinkServiceConnectionState Коллекция сведений о состоянии подключения между потребителем службы и поставщиком. PrivateLinkServiceConnectionState (обязательно)

ArmIdWrapper

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

PrivateLinkServiceConnectionState

Имя Описание Значение
ActionsRequired Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления на потребителе. строка
description Причина утверждения или отклонения подключения. строка
status Указывает, было ли подключение утверждено, отклонено или удалено владельцем службы. "Утверждено"
"Ожидание"
"Отклонено"