你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.ApiManagement 服务/用户 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'
}
}
属性值
service/users
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 了解如何在 Bicep 中为子资源设置名称和类型。 |
字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| 父级 (parent) | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。 |
类型为“服务”的资源的符号名称 |
| properties | 用户实体创建协定属性。 | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| 名称 | 说明 | 值 |
|---|---|---|
| appType | 确定发送创建用户请求的应用程序的类型。 默认值为旧门户。 | “developerPortal” “portal” |
| 确认 | 确定将发送给新创建用户的确认电子邮件的类型。 | “邀请” “注册” |
| 电子邮件 | 电子邮件地址。 不得为空，且必须在服务实例中唯一。 | 字符串 (必需) |
| firstName | 名字。 | 字符串 (必需) |
| identities | 用户标识的集合。 | UserIdentityContract[] |
| lastName | 姓氏。 | 字符串 (必需) |
| 备注 | 有关管理员设置的用户的可选备注。 | 字符串 |
| password | 用户密码。 如果未提供任何值，则会生成默认密码。 | string |
| state | 帐户状态。 指定用户是否处于活动状态。 被阻止的用户无法登录开发人员门户或调用已订阅产品的任何 API。 默认状态为“活动”。 | “active” “阻止” “deleted” “pending” |
UserIdentityContract
| 名称 | 说明 | Value |
|---|---|---|
| id | 提供程序中的标识符值。 | 字符串 |
| provider | 标识提供者名称。 | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
使用模板创建 API 管理实例和所有子资源 |
此模板演示如何创建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"
}
}
属性值
service/users
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | 'Microsoft.ApiManagement/service/users' |
| apiVersion | 资源 API 版本 | '2022-08-01' |
| name | 资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。 |
字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| properties | 用户实体创建协定属性。 | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| 名称 | 说明 | 值 |
|---|---|---|
| appType | 确定发送创建用户请求的应用程序的类型。 默认为旧门户。 | 'developerPortal' “portal” |
| 确认 | 确定将发送给新创建的用户的确认电子邮件的类型。 | “邀请” “signup” |
| 电子邮件 | 电子邮件地址。 不得为空，且必须在服务实例中唯一。 | 字符串 (必需) |
| firstName | 名字。 | 字符串 (必需) |
| identities | 用户标识的集合。 | UserIdentityContract[] |
| lastName | 姓氏。 | 字符串 (必需) |
| 备注 | 有关管理员设置的用户的可选备注。 | 字符串 |
| password | 用户密码。 如果未提供任何值，则会生成默认密码。 | string |
| state | 帐户状态。 指定用户是否处于活动状态。 被阻止的用户无法登录开发人员门户或调用已订阅产品的任何 API。 默认状态为“活动”。 | 'active' 'blocked' 'deleted' 'pending' |
UserIdentityContract
| 名称 | 说明 | Value |
|---|---|---|
| id | 提供程序中的标识符值。 | 字符串 |
| provider | 标识提供者名称。 | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
| 使用模板创建 API 管理实例和所有子资源 |
此模板演示如何创建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"
}
})
}
属性值
service/users
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.ApiManagement/service/users@2022-08-01” |
| name | 资源名称 | 字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| parent_id | 此资源的父资源 ID。 | 类型为“服务”的资源的 ID |
| properties | 用户实体创建协定属性。 | UserCreateParameterPropertiesOrUserContractPropertie... |
UserCreateParameterPropertiesOrUserContractPropertie...
| 名称 | 说明 | 值 |
|---|---|---|
| appType | 确定发送创建用户请求的应用程序的类型。 默认值为旧门户。 | “developerPortal” “portal” |
| 确认 | 确定将发送给新创建用户的确认电子邮件的类型。 | “邀请” “注册” |
| 电子邮件 | 电子邮件地址。 不得为空，且必须在服务实例中唯一。 | 字符串 (必需) |
| firstName | 名字。 | 字符串 (必需) |
| identities | 用户标识的集合。 | UserIdentityContract[] |
| lastName | 姓氏。 | 字符串 (必需) |
| 备注 | 有关管理员设置的用户的可选备注。 | 字符串 |
| password | 用户密码。 如果未提供任何值，则会生成默认密码。 | string |
| state | 帐户状态。 指定用户是否处于活动状态。 被阻止的用户无法登录开发人员门户或调用已订阅产品的任何 API。 默认状态为“活动”。 | “active” “阻止” “deleted” “pending” |
UserIdentityContract
| 名称 | 说明 | Value |
|---|---|---|
| id | 提供程序中的标识符值。 | 字符串 |
| provider | 标识提供者名称。 | 字符串 |