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

Служба и подписки Microsoft.ApiManagement 2023-09-01-preview

  • Статья

Определение ресурсов Bicep

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

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

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

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

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

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

service/subscriptions

Имя Описание Ценность
имя Имя ресурса

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

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

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

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

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

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Имя Описание Ценность
allowTracing Определяет, можно ли включить трассировку bool
displayName Имя подписки. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
ownerId Пользователь (путь идентификатора пользователя), для которого создается подписка в форме /users/{userId} струна
primaryKey Первичный ключ подписки. Если ключ запроса не указан, будет создан автоматически. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 256
размах Область, например /products/{productId} или /apis или /apis/{apiId}. строка (обязательно)
secondaryKey Дополнительный ключ подписки. Если ключ запроса не указан, будет создан автоматически. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 256
государство Начальное состояние подписки. Если значение не указано, подписка создается с состоянием "Отправлено". Возможные состояния являются *активными — подписка активна, * приостановлена — подписка заблокирована, и подписчик не может вызывать какие-либо API продукта, * отправлено — запрос на подписку был сделан разработчиком, но еще не утвержден или отклонен, * отклонен — запрос на подписку был отклонен администратором, * отменен — подписка отменена разработчиком или администратором, * истек срок действия — подписка достигла срока действия и была деактивирована. "активный"
"отменено"
"истек срок действия"
"отклонено"
"отправлено"
"приостановлено"

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

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

Шаблон Описание
Создание экземпляра службы управления API и всех вложенных ресурсов с помощью шаблона

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

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

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

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

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

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

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

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

service/subscriptions

Имя Описание Ценность
тип Тип ресурса "Microsoft.ApiManagement/service/subscriptions"
apiVersion Версия API ресурсов '2023-09-01-preview'
имя Имя ресурса

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

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

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

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

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Имя Описание Ценность
allowTracing Определяет, можно ли включить трассировку bool
displayName Имя подписки. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
ownerId Пользователь (путь идентификатора пользователя), для которого создается подписка в форме /users/{userId} струна
primaryKey Первичный ключ подписки. Если ключ запроса не указан, будет создан автоматически. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 256
размах Область, например /products/{productId} или /apis или /apis/{apiId}. строка (обязательно)
secondaryKey Дополнительный ключ подписки. Если ключ запроса не указан, будет создан автоматически. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 256
государство Начальное состояние подписки. Если значение не указано, подписка создается с состоянием "Отправлено". Возможные состояния являются *активными — подписка активна, * приостановлена — подписка заблокирована, и подписчик не может вызывать какие-либо API продукта, * отправлено — запрос на подписку был сделан разработчиком, но еще не утвержден или отклонен, * отклонен — запрос на подписку был отклонен администратором, * отменен — подписка отменена разработчиком или администратором, * истек срок действия — подписка достигла срока действия и была деактивирована. "активный"
"отменено"
"истек срок действия"
"отклонено"
"отправлено"
"приостановлено"

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

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

Шаблон Описание
Создание экземпляра службы управления API и всех вложенных ресурсов с помощью шаблона

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

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

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

  • групп ресурсов

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

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

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

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

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

service/subscriptions

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

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

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

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

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Имя Описание Ценность
allowTracing Определяет, можно ли включить трассировку bool
displayName Имя подписки. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
ownerId Пользователь (путь идентификатора пользователя), для которого создается подписка в форме /users/{userId} струна
primaryKey Первичный ключ подписки. Если ключ запроса не указан, будет создан автоматически. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 256
размах Область, например /products/{productId} или /apis или /apis/{apiId}. строка (обязательно)
secondaryKey Дополнительный ключ подписки. Если ключ запроса не указан, будет создан автоматически. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 256
государство Начальное состояние подписки. Если значение не указано, подписка создается с состоянием "Отправлено". Возможные состояния являются *активными — подписка активна, * приостановлена — подписка заблокирована, и подписчик не может вызывать какие-либо API продукта, * отправлено — запрос на подписку был сделан разработчиком, но еще не утвержден или отклонен, * отклонен — запрос на подписку был отклонен администратором, * отменен — подписка отменена разработчиком или администратором, * истек срок действия — подписка достигла срока действия и была деактивирована. "активный"
"отменено"
"истек срок действия"
"отклонено"
"отправлено"
"приостановлено"