Share via

Microsoft.ApiManagement service/workspaces/products 2023-05-01-preview

  • Статья

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

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/products@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    approvalRequired: bool
    description: 'string'
    displayName: 'string'
    state: 'string'
    subscriptionRequired: bool
    subscriptionsLimit: int
    terms: 'string'
  }
}

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

service/workspaces/products

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

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

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

ProductContractProperties

Имя Описание Значение
approvalRequired требуется ли утверждение подписки. Если значение равно false, новые подписки будут автоматически утверждены, что позволит разработчикам вызывать API продукта сразу после подписки. Если задано значение true, администраторы должны вручную утвердить подписку, прежде чем разработчик сможет использовать любой из API продукта. Может присутствовать только в том случае, если свойство subscriptionRequired имеет значение false. bool
description Описание продукта. Может содержать теги форматирования HTML. строка
displayName Название продукта. string (обязательно)
Состояние публикуется ли продукт или нет. Опубликованные продукты могут обнаруживать пользователи портала разработчика. Неопубликуемые продукты видны только администраторам. Состояние продукта по умолчанию не опубликовано. 'notPublished'
"опубликовано"
subscriptionRequired Требуется ли подписка на продукт для доступа к API, включенным в этот продукт. Если значение равно true, продукт называется защищенным, а для успешного выполнения запроса к API, включенного в продукт, требуется действительный ключ подписки. Если значение равно false, продукт называется "открытым", и запросы к API, включенной в продукт, могут выполняться без ключа подписки. Если свойство опущено при создании нового продукта, предполагается, что значение имеет значение true. bool
subscriptionsLimit Указывает, может ли пользователь одновременно иметь количество подписок на этот продукт. Задайте значение NULL или опустить, чтобы разрешить неограниченное количество подписок на пользователя. Может присутствовать только в том случае, если свойство subscriptionRequired имеет значение false. INT
terms Условия использования продукта. Они будут представлены разработчикам во время оформления подписки на продукт. Им понадобится принять эти условия, чтобы завершить процедуру оформления. строка

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service/workspaces/products",
  "apiVersion": "2023-05-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
версия_API Версия API ресурсов '2023-05-01-preview'
name имя ресурса.

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

ProductContractProperties

Имя Описание Значение
approvalRequired требуется ли утверждение подписки. Если значение равно false, новые подписки будут автоматически утверждены, что позволит разработчикам вызывать API продукта сразу после подписки. Если задано значение true, администраторы должны вручную утвердить подписку, прежде чем разработчик сможет использовать любой из API продукта. Может присутствовать только в том случае, если свойство subscriptionRequired имеет значение false. bool
description Описание продукта. Может содержать теги форматирования HTML. строка
displayName Название продукта. string (обязательно)
Состояние публикуется ли продукт или нет. Опубликованные продукты могут обнаруживать пользователи портала разработчика. Неопубликуемые продукты видны только администраторам. Состояние продукта по умолчанию не опубликовано. 'notPublished'
"опубликовано"
subscriptionRequired Требуется ли подписка на продукт для доступа к API, включенным в этот продукт. Если значение равно true, продукт называется защищенным, а для успешного выполнения запроса к API, включенного в продукт, требуется действительный ключ подписки. Если значение равно false, продукт называется "открытым", и запросы к API, включенной в продукт, могут выполняться без ключа подписки. Если свойство опущено при создании нового продукта, предполагается, что значение имеет значение true. bool
subscriptionsLimit Указывает, может ли пользователь одновременно иметь количество подписок на этот продукт. Задайте значение NULL или опустить, чтобы разрешить неограниченное количество подписок на пользователя. Может присутствовать только в том случае, если свойство subscriptionRequired имеет значение false. INT
terms Условия использования продукта. Они будут представлены разработчикам во время оформления подписки на продукт. Им понадобится принять эти условия, чтобы завершить процедуру оформления. строка

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/products@2023-05-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-05-01-preview"
name имя ресурса. string (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: workspaces
properties Свойства контракта сущности продукта. ProductContractProperties

ProductContractProperties

Имя Описание Значение
approvalRequired требуется ли утверждение подписки. Если значение равно false, новые подписки будут автоматически утверждены, что позволит разработчикам вызывать API продукта сразу после подписки. Если задано значение true, администраторы должны вручную утвердить подписку, прежде чем разработчик сможет использовать любой из API продукта. Может присутствовать только в том случае, если свойство subscriptionRequired имеет значение false. bool
description Описание продукта. Может содержать теги форматирования HTML. строка
displayName Название продукта. string (обязательно)
Состояние публикуется ли продукт или нет. Опубликованные продукты могут обнаруживать пользователи портала разработчика. Неопубликуемые продукты видны только администраторам. Состояние продукта по умолчанию не опубликовано. "notPublished"
"опубликовано"
subscriptionRequired Требуется ли подписка на продукт для доступа к API, включенным в этот продукт. Если значение равно true, продукт называется защищенным, а для успешного выполнения запроса к API, включенного в продукт, требуется действительный ключ подписки. Если значение равно false, продукт называется "открытым", и запросы к API, включенной в продукт, могут выполняться без ключа подписки. Если свойство опущено при создании нового продукта, предполагается, что значение имеет значение true. bool
subscriptionsLimit Указывает, может ли пользователь одновременно иметь количество подписок на этот продукт. Задайте значение NULL или опустить, чтобы разрешить неограниченное количество подписок на пользователя. Может присутствовать только в том случае, если свойство subscriptionRequired имеет значение false. INT
terms Условия использования продукта. Они будут представлены разработчикам во время оформления подписки на продукт. Им понадобится принять эти условия, чтобы завершить процедуру оформления. строка