Служба Microsoft.ApiManagement/workspaces/products 2023-09-01-preview
- последние
- 2023-09-01-preview
Определение ресурсов Bicep
Тип ресурса service/workspaces/products можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/products, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/products@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
approvalRequired: bool
description: 'string'
displayName: 'string'
state: 'string'
subscriptionRequired: bool
subscriptionsLimit: int
terms: 'string'
}
}
Значения свойств
service/workspaces/products
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в Bicep. |
строка (обязательно) |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: рабочих областей |
| свойства | Свойства контракта сущности продукта. | ProductContractProperties |
ProductContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| утверждениеRequired | требуется ли утверждение подписки. Если значение false, новые подписки будут утверждены автоматически, что разработчики смогут вызывать API продукта сразу после подписки. Если задано значение true, администраторы должны вручную утвердить подписку, прежде чем разработчик сможет использовать любой из API продукта. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false. | bool |
| описание | Описание продукта. Может включать теги форматирования HTML. | струна Ограничения целостности: Максимальная длина = 1000 |
| displayName | Имя продукта. | строка (обязательно) Ограничения целостности: Минимальная длина = 1 Максимальная длина = 300 |
| государство | независимо от того, публикуется ли продукт или нет. Опубликованные продукты доступны пользователям портала разработчика. Не опубликованные продукты видны только администраторам. Состояние продукта по умолчанию не опубликовано. | NotPublished "опубликовано" |
| subscriptionRequired | Требуется ли подписка на продукт для доступа к API, включенным в этот продукт. Если значение true, продукт называется "защищенным", а действительный ключ подписки необходим для запроса к API, включенного в продукт, для успешного выполнения. Если значение false, продукт называется "открытым" и запросы к API, включенным в продукт, можно сделать без ключа подписки. Если свойство опущено при создании нового продукта, оно имеет значение true. | bool |
| subscriptionsLimit | Может ли количество подписок, которые пользователь может одновременно использовать для этого продукта. Установите значение NULL или опустить, чтобы разрешить неограниченное количество подписок пользователей. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false. | int |
| Условия | Условия использования продукта. Разработчики, пытающиеся подписаться на продукт, будут представлены и необходимы для принятия этих условий, прежде чем они смогут завершить процесс подписки. | струна |
Определение ресурса шаблона ARM
Тип ресурса service/workspaces/products можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/products, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/service/workspaces/products",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"approvalRequired": "bool",
"description": "string",
"displayName": "string",
"state": "string",
"subscriptionRequired": "bool",
"subscriptionsLimit": "int",
"terms": "string"
}
}
Значения свойств
service/workspaces/products
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса | "Microsoft.ApiManagement/service/workspaces/products" |
| apiVersion | Версия API ресурсов | '2023-09-01-preview' |
| имя | Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON. |
строка (обязательно) |
| свойства | Свойства контракта сущности продукта. | ProductContractProperties |
ProductContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| утверждениеRequired | требуется ли утверждение подписки. Если значение false, новые подписки будут утверждены автоматически, что разработчики смогут вызывать API продукта сразу после подписки. Если задано значение true, администраторы должны вручную утвердить подписку, прежде чем разработчик сможет использовать любой из API продукта. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false. | bool |
| описание | Описание продукта. Может включать теги форматирования HTML. | струна Ограничения целостности: Максимальная длина = 1000 |
| displayName | Имя продукта. | строка (обязательно) Ограничения целостности: Минимальная длина = 1 Максимальная длина = 300 |
| государство | независимо от того, публикуется ли продукт или нет. Опубликованные продукты доступны пользователям портала разработчика. Не опубликованные продукты видны только администраторам. Состояние продукта по умолчанию не опубликовано. | NotPublished "опубликовано" |
| subscriptionRequired | Требуется ли подписка на продукт для доступа к API, включенным в этот продукт. Если значение true, продукт называется "защищенным", а действительный ключ подписки необходим для запроса к API, включенного в продукт, для успешного выполнения. Если значение false, продукт называется "открытым" и запросы к API, включенным в продукт, можно сделать без ключа подписки. Если свойство опущено при создании нового продукта, оно имеет значение true. | bool |
| subscriptionsLimit | Может ли количество подписок, которые пользователь может одновременно использовать для этого продукта. Установите значение NULL или опустить, чтобы разрешить неограниченное количество подписок пользователей. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false. | int |
| Условия | Условия использования продукта. Разработчики, пытающиеся подписаться на продукт, будут представлены и необходимы для принятия этих условий, прежде чем они смогут завершить процесс подписки. | струна |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса service/workspaces/products можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/products, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/products@2023-09-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/workspaces/products
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса | "Microsoft.ApiManagement/service/workspaces/products@2023-09-01-preview" |
| имя | Имя ресурса | строка (обязательно) |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: рабочих областей |
| свойства | Свойства контракта сущности продукта. | ProductContractProperties |
ProductContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| утверждениеRequired | требуется ли утверждение подписки. Если значение false, новые подписки будут утверждены автоматически, что разработчики смогут вызывать API продукта сразу после подписки. Если задано значение true, администраторы должны вручную утвердить подписку, прежде чем разработчик сможет использовать любой из API продукта. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false. | bool |
| описание | Описание продукта. Может включать теги форматирования HTML. | струна Ограничения целостности: Максимальная длина = 1000 |
| displayName | Имя продукта. | строка (обязательно) Ограничения целостности: Минимальная длина = 1 Максимальная длина = 300 |
| государство | независимо от того, публикуется ли продукт или нет. Опубликованные продукты доступны пользователям портала разработчика. Не опубликованные продукты видны только администраторам. Состояние продукта по умолчанию не опубликовано. | "notPublished" "опубликовано" |
| subscriptionRequired | Требуется ли подписка на продукт для доступа к API, включенным в этот продукт. Если значение true, продукт называется "защищенным", а действительный ключ подписки необходим для запроса к API, включенного в продукт, для успешного выполнения. Если значение false, продукт называется "открытым" и запросы к API, включенным в продукт, можно сделать без ключа подписки. Если свойство опущено при создании нового продукта, оно имеет значение true. | bool |
| subscriptionsLimit | Может ли количество подписок, которые пользователь может одновременно использовать для этого продукта. Установите значение NULL или опустить, чтобы разрешить неограниченное количество подписок пользователей. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false. | int |
| Условия | Условия использования продукта. Разработчики, пытающиеся подписаться на продукт, будут представлены и необходимы для принятия этих условий, прежде чем они смогут завершить процесс подписки. | струна |