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


Microsoft.CustomProviders resourceProviders

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

Тип ресурса resourceProviders можно развернуть в:

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

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

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

resource symbolicname 'Microsoft.CustomProviders/resourceProviders@2018-09-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    actions: [
      {
        endpoint: 'string'
        name: 'string'
        routingType: 'Proxy'
      }
    ]
    resourceTypes: [
      {
        endpoint: 'string'
        name: 'string'
        routingType: 'string'
      }
    ]
    validations: [
      {
        specification: 'string'
        validationType: 'Swagger'
      }
    ]
  }
}

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

resourceProviders

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

Ограничение символов: 3–64

Допустимые символы:
Нельзя использовать:
%&\\?/ или управляющие символы.

Не может заканчиваться точкой или пробелом.
location Расположение ресурса строка (обязательно)
tags Теги ресурсов Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties Манифест настраиваемого поставщика ресурсов CustomRPManifestProperties

CustomRPManifestProperties

Имя Описание Значение
actions Список действий, которые реализует пользовательский поставщик ресурсов. CustomRPActionRouteDefinition[]
resourceTypes Список типов ресурсов, которые реализует пользовательский поставщик ресурсов. CustomRPResourceTypeRouteDefinition[]
проверки Список проверок, выполняемых в запросах настраиваемого поставщика ресурсов. CustomRPValidations[]

CustomRPActionRouteDefinition

Имя Описание Значение
endpoint URI конечной точки определения маршрута, к которому пользовательский поставщик ресурсов будет выполнять прокси-запросы. Он может быть в виде неструктурированного URI (например, "https://testendpoint/") или может указывать для маршрутизации по пути (например, "https://testendpoint/{requestPath}") строка (обязательно)
name Имя определения маршрута. Он становится именем расширения ARM (например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}). строка (обязательно)
routingType Типы маршрутизации, поддерживаемые для запросов действий. Прокси-сервер

CustomRPResourceTypeRouteDefinition

Имя Описание Значение
endpoint URI конечной точки определения маршрута, к которому пользовательский поставщик ресурсов будет выполнять прокси-запросы. Он может быть в виде неструктурированного URI (например, "https://testendpoint/") или может указывать для маршрутизации по пути (например, "https://testendpoint/{requestPath}") строка (обязательно)
name Имя определения маршрута. Он становится именем расширения ARM (например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}). строка (обязательно)
routingType Типы маршрутизации, поддерживаемые для запросов ресурсов. Прокси-сервер
"Прокси-сервер, кэш"

CustomRPValidations

Имя Описание Значение
спецификация Ссылка на спецификацию проверки. Спецификация должна размещаться в raw.githubusercontent.com. строка (обязательно)
validationType Тип проверки, выполняемой для соответствующего запроса. "Swagger"

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

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

Шаблон Описание
Расширение существующих ресурсов Azure с помощью настраиваемых поставщиков

Развертывание в Azure
В этом примере подробно описано, как расширить существующие ресурсы Azure и Resource Manager шаблонов для добавления в пользовательские рабочие нагрузки.
Создание приложения-функции и его вызов с помощью пользовательского ресурса

Развертывание в Azure
Этот шаблон создает приложение-функцию, используемое в качестве рабочей нагрузки для настраиваемого поставщика ресурсов в развертывании шаблона.
Создание настраиваемого ресурса для шаблонов с помощью настраиваемых поставщиков

Развертывание в Azure
В этом примере показано, как добавить пользовательские ресурсы в шаблоны Resource Manager с помощью настраиваемых поставщиков и приложений логики.

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

Тип ресурса resourceProviders можно развернуть в:

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

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

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

{
  "type": "Microsoft.CustomProviders/resourceProviders",
  "apiVersion": "2018-09-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "actions": [
      {
        "endpoint": "string",
        "name": "string",
        "routingType": "Proxy"
      }
    ],
    "resourceTypes": [
      {
        "endpoint": "string",
        "name": "string",
        "routingType": "string"
      }
    ],
    "validations": [
      {
        "specification": "string",
        "validationType": "Swagger"
      }
    ]
  }
}

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

resourceProviders

Имя Описание Значение
тип Тип ресурса Microsoft.CustomProviders/resourceProviders
версия_API Версия API ресурсов '2018-09-01-preview'
name имя ресурса. строка (обязательно)

Ограничение символов: 3–64

Допустимые символы:
Нельзя использовать:
%&\\?/ или управляющие символы.

Не может заканчиваться точкой или пробелом.
location Расположение ресурса строка (обязательно)
tags Теги ресурсов Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties Манифест настраиваемого поставщика ресурсов CustomRPManifestProperties

CustomRPManifestProperties

Имя Описание Значение
actions Список действий, которые реализует пользовательский поставщик ресурсов. CustomRPActionRouteDefinition[]
resourceTypes Список типов ресурсов, которые реализует пользовательский поставщик ресурсов. CustomRPResourceTypeRouteDefinition[]
проверки Список проверок, выполняемых в запросах настраиваемого поставщика ресурсов. CustomRPValidations[]

CustomRPActionRouteDefinition

Имя Описание Значение
endpoint URI конечной точки определения маршрута, к которому пользовательский поставщик ресурсов будет выполнять прокси-запросы. Он может быть в виде неструктурированного URI (например, "https://testendpoint/") или может указывать для маршрутизации по пути (например, "https://testendpoint/{requestPath}") строка (обязательно)
name Имя определения маршрута. Он становится именем расширения ARM (например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}). строка (обязательно)
routingType Типы маршрутизации, поддерживаемые для запросов действий. Прокси-сервер

CustomRPResourceTypeRouteDefinition

Имя Описание Значение
endpoint URI конечной точки определения маршрута, к которому пользовательский поставщик ресурсов будет выполнять прокси-запросы. Он может быть в виде неструктурированного URI (например, "https://testendpoint/") или может указывать для маршрутизации по пути (например, "https://testendpoint/{requestPath}") строка (обязательно)
name Имя определения маршрута. Он становится именем расширения ARM (например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}). строка (обязательно)
routingType Типы маршрутизации, поддерживаемые для запросов ресурсов. Прокси-сервер
"Прокси-сервер, кэш"

CustomRPValidations

Имя Описание Значение
спецификация Ссылка на спецификацию проверки. Спецификация должна размещаться в raw.githubusercontent.com. строка (обязательно)
validationType Тип проверки, выполняемой для соответствующего запроса. "Swagger"

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

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

Шаблон Описание
Расширение существующих ресурсов Azure с помощью настраиваемых поставщиков

Развертывание в Azure
В этом примере подробно описано, как расширить существующие ресурсы Azure и Resource Manager шаблонов для добавления в пользовательские рабочие нагрузки.
Создание приложения-функции и его вызов с помощью пользовательского ресурса

Развертывание в Azure
Этот шаблон создает приложение-функцию, используемое в качестве рабочей нагрузки для пользовательского поставщика ресурсов в развертывании шаблона.
Создание настраиваемого ресурса для шаблонов с помощью настраиваемых поставщиков

Развертывание в Azure
В этом примере показано, как добавить пользовательские ресурсы в шаблоны Resource Manager с помощью настраиваемых поставщиков и приложений логики.

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

Тип ресурса resourceProviders можно развернуть в следующих объектах:

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

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

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

Чтобы создать ресурс Microsoft.CustomProviders/resourceProviders, добавьте следующую terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.CustomProviders/resourceProviders@2018-09-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      actions = [
        {
          endpoint = "string"
          name = "string"
          routingType = "Proxy"
        }
      ]
      resourceTypes = [
        {
          endpoint = "string"
          name = "string"
          routingType = "string"
        }
      ]
      validations = [
        {
          specification = "string"
          validationType = "Swagger"
        }
      ]
    }
  })
}

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

resourceProviders

Имя Описание Значение
тип Тип ресурса "Microsoft.CustomProviders/resourceProviders@2018-09-01-preview"
name имя ресурса. string (обязательно)

Ограничение символов: 3-64

Допустимые символы:
Нельзя использовать:
%&\\?/ или управляющие символы.

Не может заканчиваться точкой или пробелом.
location Расположение ресурса string (обязательно)
parent_id Для развертывания в группе ресурсов используйте идентификатор этой группы ресурсов. string (обязательно)
tags Теги ресурсов Словарь имен и значений тегов.
properties Манифест для настраиваемого поставщика ресурсов CustomRPManifestProperties

CustomRPManifestProperties

Имя Описание Значение
actions Список действий, которые реализует пользовательский поставщик ресурсов. CustomRPActionRouteDefinition[]
resourceTypes Список типов ресурсов, которые реализует пользовательский поставщик ресурсов. CustomRPResourceTypeRouteDefinition[]
проверки Список проверок для выполнения запросов настраиваемого поставщика ресурсов. CustomRPValidations[]

CustomRPActionRouteDefinition

Имя Описание Значение
endpoint URI конечной точки определения маршрута, к которому пользовательский поставщик ресурсов будет выполнять запросы прокси-сервера. Это может быть плоский URI (например, "https://testendpoint/") или указать маршрут по пути (например, "https://testendpoint/{requestPath}") string (обязательно)
name Имя определения маршрута. Он становится именем расширения ARM (например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}' string (обязательно)
routingType Типы маршрутизации, поддерживаемые для запросов на действия. "Прокси-сервер"

CustomRPResourceTypeRouteDefinition

Имя Описание Значение
endpoint URI конечной точки определения маршрута, к которому пользовательский поставщик ресурсов будет выполнять запросы прокси-сервера. Это может быть плоский URI (например, "https://testendpoint/") или указать маршрут по пути (например, "https://testendpoint/{requestPath}") string (обязательно)
name Имя определения маршрута. Он становится именем расширения ARM (например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}' string (обязательно)
routingType Типы маршрутизации, поддерживаемые для запросов ресурсов. "Прокси-сервер"
"Прокси-сервер,кэш"

CustomRPValidations

Имя Описание Значение
спецификация Ссылка на спецификацию проверки. Спецификация должна размещаться на raw.githubusercontent.com. string (обязательно)
validationType Тип проверки, выполняемой для соответствующего запроса. "Swagger"