Служба и подписки Microsoft.ApiManagement 2021-01-01-preview
- последние
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Определение ресурсов Bicep
Тип ресурса service/subscriptions можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/subscriptions, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2021-01-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
allowTracing: bool
displayName: 'string'
ownerId: 'string'
primaryKey: 'string'
scope: 'string'
secondaryKey: 'string'
state: 'string'
}
}
Значения свойств
Microsoft.ApiManagement/service/subscriptions
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Максимальная длина = 256 Pattern = ^[^*#&+:<>?]+$ (обязательно) |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: служба |
| свойства | Свойства контракта подписки. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| allowTracing | Определяет, можно ли включить трассировку | bool |
| displayName | Имя подписки. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 100 (обязательно) |
| ownerId | Пользователь (путь идентификатора пользователя), для которого создается подписка в форме /users/{userId} | струна |
| primaryKey | Первичный ключ подписки. Если ключ запроса не указан, будет создан автоматически. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 |
| размах | Область, например /products/{productId} или /apis или /apis/{apiId}. | строка (обязательно) |
| secondaryKey | Дополнительный ключ подписки. Если ключ запроса не указан, будет создан автоматически. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 |
| государство | Начальное состояние подписки. Если значение не указано, подписка создается с состоянием "Отправлено". Возможные состояния являются *активными — подписка активна, * приостановлена — подписка заблокирована, и подписчик не может вызывать какие-либо API продукта, * отправлено — запрос на подписку был сделан разработчиком, но еще не утвержден или отклонен, * отклонен — запрос на подписку был отклонен администратором, * отменен — подписка отменена разработчиком или администратором, * истек срок действия — подписка достигла срока действия и была деактивирована. | "активный" "отменено" "истек срок действия" "отклонено" "отправлено" "приостановлено" |
Определение ресурса шаблона ARM
Тип ресурса service/subscriptions можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/subscriptions, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/service/subscriptions",
"apiVersion": "2021-01-01-preview",
"name": "string",
"properties": {
"allowTracing": "bool",
"displayName": "string",
"ownerId": "string",
"primaryKey": "string",
"scope": "string",
"secondaryKey": "string",
"state": "string"
}
}
Значения свойств
Microsoft.ApiManagement/service/subscriptions
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2021-01-01-preview' |
| имя | Имя ресурса | струна Ограничения целостности: Максимальная длина = 256 Pattern = ^[^*#&+:<>?]+$ (обязательно) |
| свойства | Свойства контракта подписки. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
| тип | Тип ресурса | "Microsoft.ApiManagement/service/subscriptions" |
SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| allowTracing | Определяет, можно ли включить трассировку | bool |
| displayName | Имя подписки. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 100 (обязательно) |
| ownerId | Пользователь (путь идентификатора пользователя), для которого создается подписка в форме /users/{userId} | струна |
| primaryKey | Первичный ключ подписки. Если ключ запроса не указан, будет создан автоматически. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 |
| размах | Область, например /products/{productId} или /apis или /apis/{apiId}. | строка (обязательно) |
| secondaryKey | Дополнительный ключ подписки. Если ключ запроса не указан, будет создан автоматически. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 |
| государство | Начальное состояние подписки. Если значение не указано, подписка создается с состоянием "Отправлено". Возможные состояния являются *активными — подписка активна, * приостановлена — подписка заблокирована, и подписчик не может вызывать какие-либо API продукта, * отправлено — запрос на подписку был сделан разработчиком, но еще не утвержден или отклонен, * отклонен — запрос на подписку был отклонен администратором, * отменен — подписка отменена разработчиком или администратором, * истек срок действия — подписка достигла срока действия и была деактивирована. | "активный" "отменено" "истек срок действия" "отклонено" "отправлено" "приостановлено" |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса service/subscriptions можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/subscriptions, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/subscriptions@2021-01-01-preview"
name = "string"
body = jsonencode({
properties = {
allowTracing = bool
displayName = "string"
ownerId = "string"
primaryKey = "string"
scope = "string"
secondaryKey = "string"
state = "string"
}
})
}
Значения свойств
Microsoft.ApiManagement/service/subscriptions
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Максимальная длина = 256 Pattern = ^[^*#&+:<>?]+$ (обязательно) |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: службы |
| свойства | Свойства контракта подписки. | SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties |
| тип | Тип ресурса | "Microsoft.ApiManagement/service/subscriptions@2021-01-01-preview" |
SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| allowTracing | Определяет, можно ли включить трассировку | bool |
| displayName | Имя подписки. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 100 (обязательно) |
| ownerId | Пользователь (путь идентификатора пользователя), для которого создается подписка в форме /users/{userId} | струна |
| primaryKey | Первичный ключ подписки. Если ключ запроса не указан, будет создан автоматически. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 |
| размах | Область, например /products/{productId} или /apis или /apis/{apiId}. | строка (обязательно) |
| secondaryKey | Дополнительный ключ подписки. Если ключ запроса не указан, будет создан автоматически. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 |
| государство | Начальное состояние подписки. Если значение не указано, подписка создается с состоянием "Отправлено". Возможные состояния являются *активными — подписка активна, * приостановлена — подписка заблокирована, и подписчик не может вызывать какие-либо API продукта, * отправлено — запрос на подписку был сделан разработчиком, но еще не утвержден или отклонен, * отклонен — запрос на подписку был отклонен администратором, * отменен — подписка отменена разработчиком или администратором, * истек срок действия — подписка достигла срока действия и была деактивирована. | "активный" "отменено" "истек срок действия" "отклонено" "отправлено" "приостановлено" |