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

Статья
07/24/2024

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

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

группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/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/products

Имя	Описание	Ценность
имя	Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в Bicep.	строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые и дефисы. Начните с буквы и заканчивается буквенно-цифровым.
родитель	В 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
Условия	Условия использования продукта. Разработчики, пытающиеся подписаться на продукт, будут представлены и необходимы для принятия этих условий, прежде чем они смогут завершить процесс подписки.	струна

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

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

Шаблон	Описание
Создание экземпляра службы управления API и всех вложенных ресурсов с помощью шаблона развертывание	В этом шаблоне показано, как создать службу управления API и настроить вложенные сущности
создание Azure Front Door перед управления API Azure развертывание	В этом примере показано, как использовать Azure Front Door в качестве глобальной подсистемы балансировки нагрузки перед управлением API Azure.

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

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

группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "approvalRequired": "bool",
    "description": "string",
    "displayName": "string",
    "state": "string",
    "subscriptionRequired": "bool",
    "subscriptionsLimit": "int",
    "terms": "string"
  }
}

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

service/products

Имя	Описание	Ценность
тип	Тип ресурса	"Microsoft.ApiManagement/service/products"
apiVersion	Версия API ресурсов	'2023-09-01-preview'
имя	Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON.	строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые и дефисы. Начните с буквы и заканчивается буквенно-цифровым.
свойства	Свойства контракта сущности продукта.	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
Условия	Условия использования продукта. Разработчики, пытающиеся подписаться на продукт, будут представлены и необходимы для принятия этих условий, прежде чем они смогут завершить процесс подписки.	струна

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

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

Шаблон	Описание
Создание экземпляра службы управления API и всех вложенных ресурсов с помощью шаблона развертывание	В этом шаблоне показано, как создать службу управления API и настроить вложенные сущности
создание Azure Front Door перед управления API Azure развертывание	В этом примере показано, как использовать Azure Front Door в качестве глобальной подсистемы балансировки нагрузки перед управлением API Azure.

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/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/products

Имя	Описание	Ценность
тип	Тип ресурса	"Microsoft.ApiManagement/service/products@2023-09-01-preview"
имя	Имя ресурса	строка (обязательно) Ограничение символов: 1–80 Допустимые символы: Буквенно-цифровые и дефисы. Начните с буквы и заканчивается буквенно-цифровым.
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
Условия	Условия использования продукта. Разработчики, пытающиеся подписаться на продукт, будут представлены и необходимы для принятия этих условий, прежде чем они смогут завершить процесс подписки.	струна

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

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

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

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

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

service/products

ProductContractProperties

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

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

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

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

service/products

ProductContractProperties

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

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

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

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

service/products

ProductContractProperties

Обратная связь

Дополнительные ресурсы