通过

你当前正在访问 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' = {
  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”
“portal”
确认 确定将发送给新创建的用户的确认电子邮件的类型。 “invite”
“signup”
电子邮件 电子邮件地址。 不能为空，并且必须在服务实例中是唯一的。 字符串

约束：
最小长度 = 1
最大长度 = 254 （必需）
firstName 名字。 字符串

约束：
最小长度 = 1
最大长度 = 100 （必需）
身份 用户标识的集合。 UserIdentityContract[]
lastName 姓。 字符串

约束：
最小长度 = 1
最大长度 = 100 （必需）
注意 有关管理员设置的用户的可选说明。 字符串
密码 用户密码。 如果未提供任何值，则会生成默认密码。 字符串
州 帐户状态。 指定用户是否处于活动状态。 被阻止的用户无法登录到开发人员门户或调用已订阅产品的任何 API。 默认状态为“活动”。 “active”
“blocked”
“deleted”
“pending”

UserIdentityContract

名字 描述 价值
id 提供程序中的标识符值。 字符串
供应商 标识提供者名称。 字符串

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”
“portal”
确认 确定将发送给新创建的用户的确认电子邮件的类型。 “invite”
“signup”
电子邮件 电子邮件地址。 不能为空，并且必须在服务实例中是唯一的。 字符串

约束：
最小长度 = 1
最大长度 = 254 （必需）
firstName 名字。 字符串

约束：
最小长度 = 1
最大长度 = 100 （必需）
身份 用户标识的集合。 UserIdentityContract[]
lastName 姓。 字符串

约束：
最小长度 = 1
最大长度 = 100 （必需）
注意 有关管理员设置的用户的可选说明。 字符串
密码 用户密码。 如果未提供任何值，则会生成默认密码。 字符串
州 帐户状态。 指定用户是否处于活动状态。 被阻止的用户无法登录到开发人员门户或调用已订阅产品的任何 API。 默认状态为“活动”。 “active”
“blocked”
“deleted”
“pending”

UserIdentityContract

名字 描述 价值
id 提供程序中的标识符值。 字符串
供应商 标识提供者名称。 字符串

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 此资源的父资源的 ID。 类型资源的 ID：服务
性能 用户实体创建协定属性。 UserCreateParameterPropertiesOrUserContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/users@2022-08-01”

UserCreateParameterPropertiesOrUserContractProperties

名字 描述 价值
appType 确定发送创建用户请求的应用程序的类型。 默认值为旧门户。 “developerPortal”
“portal”
确认 确定将发送给新创建的用户的确认电子邮件的类型。 “invite”
“signup”
电子邮件 电子邮件地址。 不能为空，并且必须在服务实例中是唯一的。 字符串

约束：
最小长度 = 1
最大长度 = 254 （必需）
firstName 名字。 字符串

约束：
最小长度 = 1
最大长度 = 100 （必需）
身份 用户标识的集合。 UserIdentityContract[]
lastName 姓。 字符串

约束：
最小长度 = 1
最大长度 = 100 （必需）
注意 有关管理员设置的用户的可选说明。 字符串
密码 用户密码。 如果未提供任何值，则会生成默认密码。 字符串
州 帐户状态。 指定用户是否处于活动状态。 被阻止的用户无法登录到开发人员门户或调用已订阅产品的任何 API。 默认状态为“活动”。 “active”
“blocked”
“deleted”
“pending”

UserIdentityContract

名字 描述 价值
id 提供程序中的标识符值。 字符串
供应商 标识提供者名称。 字符串