Служба Microsoft.ApiManagement/users 2022-08-01
- последние
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Определение ресурсов Bicep
Тип ресурса службы или пользователей можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/users, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/service/users@2022-08-01' = {
parent: resourceSymbolicName
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
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 80 (обязательно) |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: служба |
| свойства | Сущность пользователя создает свойства контракта. | UserCreateParameterPropertiesOrUserContractProperties |
UserCreateParameterPropertiesOrUserContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| appType | Определяет тип приложения, отправляющего запрос пользователя. По умолчанию используется устаревший портал. | DeveloperPortal "портал" |
| подтверждение | Определяет тип сообщения электронной почты подтверждения, который будет отправлен только что созданному пользователю. | "пригласить" "регистрация" |
| Отправить по электронной почте | Адрес электронной почты. Не должно быть пустым и должно быть уникальным в экземпляре службы. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 254 (обязательно) |
| firstName | Имя. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 100 (обязательно) |
| Удостоверения | Коллекция удостоверений пользователей. | UserIdentityContract[] |
| lastName | Фамилия. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 100 (обязательно) |
| заметка | Необязательное примечание о пользователе, заданном администратором. | струна |
| пароль | Пароль пользователя. Если значение не указано, создается пароль по умолчанию. | струна |
| государство | Состояние учетной записи. Указывает, является ли пользователь активным или нет. Заблокированные пользователи не могут войти на портал разработчика или вызвать все API подписываемых продуктов. Состояние по умолчанию — "Активный". | "активный" "заблокировано" "удалено" "ожидание" |
UserIdentityContract
| Имя | Описание | Ценность |
|---|---|---|
| идентификатор | Значение идентификатора в поставщике. | струна |
| поставщик | Имя поставщика удостоверений. | струна |
Определение ресурса шаблона 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' |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 80 (обязательно) |
| свойства | Сущность пользователя создает свойства контракта. | UserCreateParameterPropertiesOrUserContractProperties |
| тип | Тип ресурса | "Microsoft.ApiManagement/service/users" |
UserCreateParameterPropertiesOrUserContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| appType | Определяет тип приложения, отправляющего запрос пользователя. По умолчанию используется устаревший портал. | DeveloperPortal "портал" |
| подтверждение | Определяет тип сообщения электронной почты подтверждения, который будет отправлен только что созданному пользователю. | "пригласить" "регистрация" |
| Отправить по электронной почте | Адрес электронной почты. Не должно быть пустым и должно быть уникальным в экземпляре службы. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 254 (обязательно) |
| firstName | Имя. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 100 (обязательно) |
| Удостоверения | Коллекция удостоверений пользователей. | UserIdentityContract[] |
| lastName | Фамилия. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 100 (обязательно) |
| заметка | Необязательное примечание о пользователе, заданном администратором. | струна |
| пароль | Пароль пользователя. Если значение не указано, создается пароль по умолчанию. | струна |
| государство | Состояние учетной записи. Указывает, является ли пользователь активным или нет. Заблокированные пользователи не могут войти на портал разработчика или вызвать все API подписываемых продуктов. Состояние по умолчанию — "Активный". | "активный" "заблокировано" "удалено" "ожидание" |
UserIdentityContract
| Имя | Описание | Ценность |
|---|---|---|
| идентификатор | Значение идентификатора в поставщике. | струна |
| поставщик | Имя поставщика удостоверений. | струна |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса службы или пользователей можно развернуть с помощью операций, предназначенных для следующих операций:
- Группа ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/users, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/users@2022-08-01"
name = "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
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 80 (обязательно) |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: службы |
| свойства | Сущность пользователя создает свойства контракта. | UserCreateParameterPropertiesOrUserContractProperties |
| тип | Тип ресурса | "Microsoft.ApiManagement/service/users@2022-08-01" |
UserCreateParameterPropertiesOrUserContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| appType | Определяет тип приложения, отправляющего запрос пользователя. По умолчанию используется устаревший портал. | DeveloperPortal "портал" |
| подтверждение | Определяет тип сообщения электронной почты подтверждения, который будет отправлен только что созданному пользователю. | "пригласить" "регистрация" |
| Отправить по электронной почте | Адрес электронной почты. Не должно быть пустым и должно быть уникальным в экземпляре службы. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 254 (обязательно) |
| firstName | Имя. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 100 (обязательно) |
| Удостоверения | Коллекция удостоверений пользователей. | UserIdentityContract[] |
| lastName | Фамилия. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 100 (обязательно) |
| заметка | Необязательное примечание о пользователе, заданном администратором. | струна |
| пароль | Пароль пользователя. Если значение не указано, создается пароль по умолчанию. | струна |
| государство | Состояние учетной записи. Указывает, является ли пользователь активным или нет. Заблокированные пользователи не могут войти на портал разработчика или вызвать все API подписываемых продуктов. Состояние по умолчанию — "Активный". | "активный" "заблокировано" "удалено" "ожидание" |
UserIdentityContract
| Имя | Описание | Ценность |
|---|---|---|
| идентификатор | Значение идентификатора в поставщике. | струна |
| поставщик | Имя поставщика удостоверений. | струна |