Microsoft.ApiManagement service/products 2023-05-01-preview
Определение ресурса Bicep
Тип ресурса service/products можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.ApiManagement/service/products, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/service/products@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
approvalRequired: bool
description: 'string'
displayName: 'string'
state: 'string'
subscriptionRequired: bool
subscriptionsLimit: int
terms: 'string'
}
}
Значения свойств
услуги и продукты
| Имя | Описание | Значение |
|---|---|---|
| name | имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep. |
строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые символы и дефисы. Начинается с буквы и заканчивается буквенно-цифровым символом. |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: service |
| properties | Свойства контракта сущности продукта. | ProductContractProperties |
ProductContractProperties
| Имя | Описание | Значение |
|---|---|---|
| approvalRequired | требуется ли утверждение подписки. Если задано значение false, новые подписки будут автоматически утверждены, что позволит разработчикам вызывать API продукта сразу после подписки. Если значение равно true, администраторы должны вручную утвердить подписку, прежде чем разработчик сможет использовать любой api продукта. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false. | bool |
| description | Описание продукта. Может содержать теги форматирования HTML. | строка |
| displayName | Название продукта. | строка (обязательно) |
| Состояние | независимо от того, опубликован ли продукт. Опубликованные продукты могут обнаруживать пользователи портала разработчика. Не опубликованные продукты видны только администраторам. Состояние продукта по умолчанию — notPublished. | NotPublished "опубликовано" |
| subscriptionRequired | Требуется ли подписка на продукт для доступа к API, включенным в этот продукт. Если значение равно true, продукт называется защищенным, и для успешного выполнения запроса к API, включенного в продукт, требуется действительный ключ подписки. Если задано значение false, продукт называется "открытым", и запросы к API, включенного в продукт, могут выполняться без ключа подписки. Если свойство опущено при создании нового продукта, предполагается, что оно имеет значение true. | bool |
| subscriptionsLimit | Указывает, может ли пользователь одновременно иметь количество подписок на этот продукт. Задайте значение NULL или опустите, чтобы разрешить неограниченное количество подписок на пользователя. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false. | INT |
| terms | Условия использования продукта. Они будут представлены разработчикам во время оформления подписки на продукт. Им понадобится принять эти условия, чтобы завершить процедуру оформления. | строка |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
Create an API Management instance and all sub resources using template (Создание экземпляра службы "Управление API" и всех сопутствующих ресурсов с помощью шаблона) |
В этом шаблоне показано, как создать службу Управление API и настроить вложенные сущности. |
| Создание Azure Front Door перед azure Управление API |
В этом примере показано, как использовать Azure Front Door в качестве глобальной подсистемы балансировки нагрузки перед azure Управление API. |
Определение ресурса шаблона ARM
Тип ресурса service/products можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.ApiManagement/service/products, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/service/products",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"approvalRequired": "bool",
"description": "string",
"displayName": "string",
"state": "string",
"subscriptionRequired": "bool",
"subscriptionsLimit": "int",
"terms": "string"
}
}
Значения свойств
услуги и продукты
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | Microsoft.ApiManagement/service/products |
| версия_API | Версия API ресурсов | '2023-05-01-preview' |
| name | имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM. |
string (обязательно) Ограничение символов: 1-80 Допустимые символы: Буквенно-цифровые символы и дефисы. Начинается с буквы и заканчивается буквенно-цифровым символом. |
| properties | Свойства контракта сущности продукта. | ProductContractProperties |
ProductContractProperties
| Имя | Описание | Значение |
|---|---|---|
| approvalRequired | требуется ли утверждение подписки. Если значение равно false, новые подписки будут автоматически утверждены, что позволит разработчикам вызывать API продукта сразу после подписки. Если задано значение true, администраторы должны вручную утвердить подписку, прежде чем разработчик сможет использовать любой из API продукта. Может присутствовать только в том случае, если свойство subscriptionRequired имеет значение false. | bool |
| description | Описание продукта. Может содержать теги форматирования HTML. | строка |
| displayName | Название продукта. | string (обязательно) |
| Состояние | публикуется ли продукт или нет. Опубликованные продукты могут обнаруживать пользователи портала разработчика. Неопубликуемые продукты видны только администраторам. Состояние продукта по умолчанию не опубликовано. | 'notPublished' "опубликовано" |
| subscriptionRequired | Требуется ли подписка на продукт для доступа к API, включенным в этот продукт. Если значение равно true, продукт называется защищенным, а для успешного выполнения запроса к API, включенного в продукт, требуется действительный ключ подписки. Если значение равно false, продукт называется "открытым", и запросы к API, включенной в продукт, могут выполняться без ключа подписки. Если свойство опущено при создании нового продукта, предполагается, что значение имеет значение true. | bool |
| subscriptionsLimit | Указывает, может ли пользователь одновременно иметь количество подписок на этот продукт. Задайте значение NULL или опустить, чтобы разрешить неограниченное количество подписок на пользователя. Может присутствовать только в том случае, если свойство subscriptionRequired имеет значение false. | INT |
| terms | Условия использования продукта. Они будут представлены разработчикам во время оформления подписки на продукт. Им понадобится принять эти условия, чтобы завершить процедуру оформления. | строка |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
| Create an API Management instance and all sub resources using template (Создание экземпляра службы "Управление API" и всех сопутствующих ресурсов с помощью шаблона) |
В этом шаблоне показано, как создать службу Управление API и настроить вложенные сущности. |
| Создание Azure Front Door перед azure Управление API |
В этом примере показано, как использовать Azure Front Door в качестве глобальной подсистемы балансировки нагрузки перед azure Управление API. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса service/products можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.ApiManagement/service/products, добавьте следующую terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/products@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
approvalRequired = bool
description = "string"
displayName = "string"
state = "string"
subscriptionRequired = bool
subscriptionsLimit = int
terms = "string"
}
})
}
Значения свойств
service/products
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | "Microsoft.ApiManagement/service/products@2023-05-01-preview" |
| name | имя ресурса. | string (обязательно) Ограничение символов: 1-80 Допустимые символы: Буквенно-цифровые символы и дефисы. Начинается с буквы и заканчивается буквенно-цифровым символом. |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: service |
| properties | Свойства контракта сущности продукта. | ProductContractProperties |
ProductContractProperties
| Имя | Описание | Значение |
|---|---|---|
| approvalRequired | требуется ли утверждение подписки. Если значение равно false, новые подписки будут автоматически утверждены, что позволит разработчикам вызывать API продукта сразу после подписки. Если значение равно true, администраторы должны вручную утвердить подписку, прежде чем разработчик сможет использовать любой api продукта. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false. | bool |
| description | Описание продукта. Может содержать теги форматирования HTML. | строка |
| displayName | Название продукта. | строка (обязательно) |
| Состояние | независимо от того, опубликован ли продукт. Опубликованные продукты могут обнаруживать пользователи портала разработчика. Не опубликованные продукты видны только администраторам. Состояние продукта по умолчанию — notPublished. | "notPublished" "опубликовано" |
| subscriptionRequired | Требуется ли подписка на продукт для доступа к API, включенным в этот продукт. Если значение равно true, продукт называется защищенным, и для успешного выполнения запроса к API, включенного в продукт, требуется действительный ключ подписки. Если задано значение false, продукт называется "открытым", и запросы к API, включенного в продукт, могут выполняться без ключа подписки. Если свойство опущено при создании нового продукта, предполагается, что оно имеет значение true. | bool |
| subscriptionsLimit | Указывает, может ли пользователь одновременно иметь количество подписок на этот продукт. Задайте значение NULL или опустите, чтобы разрешить неограниченное количество подписок на пользователя. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false. | INT |
| terms | Условия использования продукта. Они будут представлены разработчикам во время оформления подписки на продукт. Им понадобится принять эти условия, чтобы завершить процедуру оформления. | строка |