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

Служба Microsoft.ApiManagement/users 2022-08-01

  • Статья

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

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/users@2022-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'
  }
}

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

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

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

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

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

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

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

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

UserCreateParameterPropertiesOrUserContractPropertie...

Имя Описание Ценность
appType Определяет тип приложения, отправляющего запрос пользователя. По умолчанию используется устаревший портал. DeveloperPortal
"портал"
подтверждение Определяет тип сообщения электронной почты подтверждения, который будет отправлен только что созданному пользователю. "пригласить"
"регистрация"
Отправить по электронной почте Адрес электронной почты. Не должно быть пустым и должно быть уникальным в экземпляре службы. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 254
firstName Имя. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
Удостоверения Коллекция удостоверений пользователей. UserIdentityContract[]
lastName Фамилия. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
заметка Необязательное примечание о пользователе, заданном администратором. струна
пароль Пароль пользователя. Если значение не указано, создается пароль по умолчанию. струна
государство Состояние учетной записи. Указывает, является ли пользователь активным или нет. Заблокированные пользователи не могут войти на портал разработчика или вызвать все API подписываемых продуктов. Состояние по умолчанию — "Активный". "активный"
"заблокировано"
"удалено"
"ожидание"

UserIdentityContract

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

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

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

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

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

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service/users",
  "apiVersion": "2022-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"
apiVersion Версия API ресурсов '2022-08-01'
имя Имя ресурса

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

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

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

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

UserCreateParameterPropertiesOrUserContractPropertie...

Имя Описание Ценность
appType Определяет тип приложения, отправляющего запрос пользователя. По умолчанию используется устаревший портал. DeveloperPortal
"портал"
подтверждение Определяет тип сообщения электронной почты подтверждения, который будет отправлен только что созданному пользователю. "пригласить"
"регистрация"
Отправить по электронной почте Адрес электронной почты. Не должно быть пустым и должно быть уникальным в экземпляре службы. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 254
firstName Имя. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
Удостоверения Коллекция удостоверений пользователей. UserIdentityContract[]
lastName Фамилия. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
заметка Необязательное примечание о пользователе, заданном администратором. струна
пароль Пароль пользователя. Если значение не указано, создается пароль по умолчанию. струна
государство Состояние учетной записи. Указывает, является ли пользователь активным или нет. Заблокированные пользователи не могут войти на портал разработчика или вызвать все API подписываемых продуктов. Состояние по умолчанию — "Активный". "активный"
"заблокировано"
"удалено"
"ожидание"

UserIdentityContract

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

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

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

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

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/users@2022-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@2022-08-01"
имя Имя ресурса строка (обязательно)

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

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

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

UserCreateParameterPropertiesOrUserContractPropertie...

Имя Описание Ценность
appType Определяет тип приложения, отправляющего запрос пользователя. По умолчанию используется устаревший портал. DeveloperPortal
"портал"
подтверждение Определяет тип сообщения электронной почты подтверждения, который будет отправлен только что созданному пользователю. "пригласить"
"регистрация"
Отправить по электронной почте Адрес электронной почты. Не должно быть пустым и должно быть уникальным в экземпляре службы. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 254
firstName Имя. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
Удостоверения Коллекция удостоверений пользователей. UserIdentityContract[]
lastName Фамилия. строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
заметка Необязательное примечание о пользователе, заданном администратором. струна
пароль Пароль пользователя. Если значение не указано, создается пароль по умолчанию. струна
государство Состояние учетной записи. Указывает, является ли пользователь активным или нет. Заблокированные пользователи не могут войти на портал разработчика или вызвать все API подписываемых продуктов. Состояние по умолчанию — "Активный". "активный"
"заблокировано"
"удалено"
"ожидание"

UserIdentityContract

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