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

Microsoft.ApiManagement service/subscriptions

  • Статья

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

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    allowTracing: bool
    displayName: 'string'
    ownerId: 'string'
    primaryKey: 'string'
    scope: 'string'
    secondaryKey: 'string'
    state: 'string'
  }
}

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

службы и подписки

Имя Описание Значение
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.		 строка (обязательно)

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

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

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

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: service
properties Свойства контракта подписки. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Имя Описание Значение
allowTracing Определяет, можно ли включить трассировку bool
displayName Имя подписки. строка (обязательно)
ownerId Пользователь (путь к идентификатору пользователя), для которого создается подписка в форме /users/{userId} строка
primaryKey Первичный ключ подписки. Если ключ не указан во время запроса, будет создан автоматически. строка
область Область, например /products/{productId} или /apis или /apis/{apiId}. строка (обязательно)
secondaryKey Вторичный ключ подписки. Если ключ не указан во время запроса, будет создан автоматически. строка
Состояние Начальное состояние подписки. Если значение не указано, подписка создается с состоянием Отправлено. Возможные состояния: * активна — подписка активна, * приостановлена — подписка заблокирована, и подписчик не может вызывать API продукта, * отправлено — запрос на подписку был сделан разработчиком, но еще не утвержден или отклонен, * отклонен — запрос на подписку отклонен администратором, * отменен — подписка отменена разработчиком или администратором. * истек срок действия — срок действия подписки истек и был деактивирован. "активный"
"отменено"
"истек срок действия"
"отклонено"
"отправлено"
"suspended"

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

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

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

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

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "allowTracing": "bool",
    "displayName": "string",
    "ownerId": "string",
    "primaryKey": "string",
    "scope": "string",
    "secondaryKey": "string",
    "state": "string"
  }
}

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

службы и подписки

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

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.		 строка (обязательно)

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

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

Начинается с буквы и заканчивается буквенно-цифровым символом.
properties Свойства контракта подписки. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Имя Описание Значение
allowTracing Определяет, можно ли включить трассировку bool
displayName Имя подписки. строка (обязательно)
ownerId Пользователь (путь к идентификатору пользователя), для которого создается подписка в форме /users/{userId} строка
primaryKey Первичный ключ подписки. Если ключ не указан во время запроса, будет создан автоматически. строка
область Область, например /products/{productId} или /apis или /apis/{apiId}. строка (обязательно)
secondaryKey Вторичный ключ подписки. Если ключ не указан во время запроса, будет создан автоматически. строка
Состояние Начальное состояние подписки. Если значение не указано, подписка создается с состоянием Отправлено. Возможные состояния: * активна — подписка активна, * приостановлена — подписка заблокирована, и подписчик не может вызывать API продукта, * отправлено — запрос на подписку был сделан разработчиком, но еще не утвержден или отклонен, * отклонен — запрос на подписку отклонен администратором, * отменен — подписка отменена разработчиком или администратором. * истек срок действия — срок действия подписки истек и был деактивирован. "активный"
"отменено"
"истек срок действия"
"отклонено"
"отправлено"
"suspended"

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

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

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

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/subscriptions@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      allowTracing = bool
      displayName = "string"
      ownerId = "string"
      primaryKey = "string"
      scope = "string"
      secondaryKey = "string"
      state = "string"
    }
  })
}

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

службы и подписки

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

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

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

Начинается с буквы и заканчивается буквенно-цифровым символом.
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: service
properties Свойства контракта подписки. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Имя Описание Значение
allowTracing Определяет, можно ли включить трассировку bool
displayName Имя подписки. строка (обязательно)
ownerId Пользователь (путь к идентификатору пользователя), для которого создается подписка в форме /users/{userId} строка
primaryKey Первичный ключ подписки. Если ключ не указан во время запроса, будет создан автоматически. строка
область Область, например /products/{productId} или /apis или /apis/{apiId}. строка (обязательно)
secondaryKey Вторичный ключ подписки. Если ключ не указан во время запроса, будет создан автоматически. строка
Состояние Начальное состояние подписки. Если значение не указано, подписка создается с состоянием Отправлено. Возможные состояния: * активна — подписка активна, * приостановлена — подписка заблокирована, и подписчик не может вызывать API продукта, * отправлено — запрос на подписку был сделан разработчиком, но еще не утвержден или отклонен, * отклонен — запрос на подписку отклонен администратором, * отменен — подписка отменена разработчиком или администратором. * истек срок действия — срок действия подписки истек и был деактивирован. "активный"
"отменено"
"истек срок действия"
"отклонено"
"отправлено"
"suspended"