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

Служба и группы Microsoft.ApiManagement

  • Статья

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

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/groups@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    externalId: 'string'
    type: 'string'
  }
}

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

service/groups

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

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

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

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

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

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

GroupCreateParametersPropertiesOrGroupContractProper...

Имя Описание Ценность
описание Описание группы. струна
displayName Имя группы. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 300
externalId Идентификатор внешних групп, это свойство содержит идентификатор группы из внешнего поставщика удостоверений, например для Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; в противном случае значение равно NULL. струна
тип Тип группы. "custom"
"external"
"system"

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

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

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

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

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service/groups",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "externalId": "string",
    "type": "string"
  }
}

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

service/groups

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

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

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

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

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

GroupCreateParametersPropertiesOrGroupContractProper...

Имя Описание Ценность
описание Описание группы. струна
displayName Имя группы. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 300
externalId Идентификатор внешних групп, это свойство содержит идентификатор группы из внешнего поставщика удостоверений, например для Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; в противном случае значение равно NULL. струна
тип Тип группы. "custom"
"external"
"system"

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

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

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

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/groups@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      externalId = "string"
      type = "string"
    }
  })
}

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

service/groups

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

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

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

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

GroupCreateParametersPropertiesOrGroupContractProper...

Имя Описание Ценность
описание Описание группы. струна
displayName Имя группы. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 300
externalId Идентификатор внешних групп, это свойство содержит идентификатор группы из внешнего поставщика удостоверений, например для Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; в противном случае значение равно NULL. струна
тип Тип группы. "custom"
"external"
"system"