Share via

Microsoft.ApiManagement service/users 2021-08-01

  • Статья

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

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/users@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    appType: 'string'
    confirmation: 'string'
    email: 'string'
    firstName: 'string'
    identities: [
      {
        id: 'string'
        provider: 'string'
      }
    ]
    lastName: 'string'
    note: 'string'
    password: 'string'
    state: 'string'
  }
}

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

служба/пользователи

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

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

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

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

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

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

UserCreateParameterPropertiesOrUserContractPropertie...

Имя Описание Значение
appType Определяет тип приложения, отправляющего запрос пользователя на создание. По умолчанию используется устаревший портал. 'developerPortal'
"портал"
Подтверждение Определяет тип сообщения электронной почты с подтверждением, которое будет отправлено только что созданному пользователю. "пригласить"
'Signup'
email Электронная почта. Не может быть пустым и должно быть уникальным в пределах экземпляра службы. string (обязательно)
firstName Имя. string (обязательно)
удостоверения; Коллекция удостоверений пользователей. UserIdentityContract[]
lastName Фамилия. string (обязательно)
Примечание Дополнительное примечание о пользователе, заданном администратором. строка
password Пароль пользователя. Если значение не указано, создается пароль по умолчанию. строка
Состояние Состояние учетной записи. Указывает, активен пользователь или нет. Заблокированные пользователи не могут войти на портал разработчиков или вызвать API продуктов с подпиской. Состояние по умолчанию — Активно. "активный"
"заблокировано"
"deleted"
"pending"

UserIdentityContract

Имя Описание Значение
идентификатор Значение идентификатора в поставщике. строка
поставщик Имя поставщика удостоверений. строка

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

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

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

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

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service/users",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "appType": "string",
    "confirmation": "string",
    "email": "string",
    "firstName": "string",
    "identities": [
      {
        "id": "string",
        "provider": "string"
      }
    ],
    "lastName": "string",
    "note": "string",
    "password": "string",
    "state": "string"
  }
}

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

служба/пользователи

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

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

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

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

Начинается с буквы и заканчивается буквенно-цифровым символом.
properties Пользовательские сущности создают свойства контракта. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Имя Описание Значение
appType Определяет тип приложения, отправляющего запрос пользователя на создание. По умолчанию используется устаревший портал. 'developerPortal'
"портал"
Подтверждение Определяет тип сообщения электронной почты с подтверждением, которое будет отправлено только что созданному пользователю. "пригласить"
'Signup'
email Электронная почта. Не может быть пустым и должно быть уникальным в пределах экземпляра службы. string (обязательно)
firstName Имя. string (обязательно)
удостоверения; Коллекция удостоверений пользователей. UserIdentityContract[]
lastName Фамилия. string (обязательно)
Примечание Дополнительное примечание о пользователе, заданном администратором. строка
password Пароль пользователя. Если значение не указано, создается пароль по умолчанию. строка
Состояние Состояние учетной записи. Указывает, активен пользователь или нет. Заблокированные пользователи не могут войти на портал разработчиков или вызвать API продуктов с подпиской. Состояние по умолчанию — Активно. "активный"
"заблокировано"
"deleted"
"pending"

UserIdentityContract

Имя Описание Значение
идентификатор Значение идентификатора в поставщике. строка
поставщик Имя поставщика удостоверений. строка

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

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

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

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/users@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      appType = "string"
      confirmation = "string"
      email = "string"
      firstName = "string"
      identities = [
        {
          id = "string"
          provider = "string"
        }
      ]
      lastName = "string"
      note = "string"
      password = "string"
      state = "string"
    }
  })
}

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

служба/пользователи

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

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

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

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

UserCreateParameterPropertiesOrUserContractPropertie...

Имя Описание Значение
appType Определяет тип приложения, отправляющего запрос пользователя на создание. По умолчанию используется устаревший портал. "developerPortal"
"портал"
Подтверждение Определяет тип сообщения электронной почты с подтверждением, которое будет отправлено только что созданному пользователю. "пригласить"
"signup"
email Электронная почта. Не может быть пустым и должно быть уникальным в пределах экземпляра службы. строка (обязательно)
firstName Имя. строка (обязательно)
удостоверения; Коллекция удостоверений пользователей. UserIdentityContract[]
lastName Фамилия. строка (обязательно)
Примечание Дополнительное примечание о пользователе, заданном администратором. строка
password Пароль пользователя. Если значение не указано, создается пароль по умолчанию. строка
Состояние Состояние учетной записи. Указывает, активен пользователь или нет. Заблокированные пользователи не могут войти на портал разработчиков или вызвать API продуктов с подпиской. Состояние по умолчанию — Активно. "активный"
"заблокировано"
"deleted"
"pending"

UserIdentityContract

Имя Описание Значение
идентификатор Значение идентификатора в поставщике. строка
поставщик Имя поставщика удостоверений. строка