通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.DocumentDB databaseAccounts/mongodbUserDefinitions 2022-08-15

  • 项目

Bicep 资源定义

databaseAccounts/mongodbUserDefinitions 资源类型可以使用以下目标操作进行部署：

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2022-08-15' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    customData: 'string'
    databaseName: 'string'
    mechanisms: 'string'
    password: 'string'
    roles: [
      {
        db: 'string'
        role: 'string'
      }
    ]
    userName: 'string'
  }
}

属性值

databaseAccounts/mongodbUserDefinitions

名称 说明 值
name 资源名称

了解如何在 Bicep 中为子资源设置名称和类型。		 字符串 (必需)
父级 (parent) 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源之外的子资源。		 类型为资源的符号名称： databaseAccounts
properties 用于创建和更新 Azure Cosmos DB Mongo 用户定义的属性。 MongoUserDefinitionResource

MongoUserDefinitionResource

名称 说明 值
customData USer 定义的自定义定义。 字符串
databaseName 要为此用户定义授予访问权限的数据库名称。 字符串
机制 Mongo 身份验证机制。 目前，我们仅支持身份验证机制 SCRAM-SHA-256。 字符串
password 用户定义的密码。 响应不包含用户密码。 字符串
角色 用户定义继承的角色集。 角色[]
userName 用户定义的用户名。 字符串

角色

名称 说明 值
db 应用角色的数据库名称。 字符串
角色 (role) 角色名称。 字符串

ARM 模板资源定义

databaseAccounts/mongodbUserDefinitions 资源类型可以使用以下目标操作进行部署：

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions",
  "apiVersion": "2022-08-15",
  "name": "string",
  "properties": {
    "customData": "string",
    "databaseName": "string",
    "mechanisms": "string",
    "password": "string",
    "roles": [
      {
        "db": "string",
        "role": "string"
      }
    ],
    "userName": "string"
  }
}

属性值

databaseAccounts/mongodbUserDefinitions

名称 说明 Value
type 资源类型 'Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions'
apiVersion 资源 API 版本 '2022-08-15'
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。		 字符串 (必需)
properties 用于创建和更新 Azure Cosmos DB Mongo 用户定义的属性。 MongoUserDefinitionResource

MongoUserDefinitionResource

名称 说明 值
customData USer 定义的自定义定义。 字符串
databaseName 要为此用户定义授予访问权限的数据库名称。 字符串
机制 Mongo 身份验证机制。 目前，我们仅支持身份验证机制 SCRAM-SHA-256。 字符串
password 用户定义的密码。 响应不包含用户密码。 字符串
角色 用户定义继承的角色集。 角色[]
userName 用户定义的用户名。 字符串

角色

名称 说明 值
db 应用角色的数据库名称。 字符串
角色 (role) 角色名称。 字符串

Terraform (AzAPI 提供程序) 资源定义

databaseAccounts/mongodbUserDefinitions 资源类型可以使用以下目标操作进行部署：

  • 资源组

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2022-08-15"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      customData = "string"
      databaseName = "string"
      mechanisms = "string"
      password = "string"
      roles = [
        {
          db = "string"
          role = "string"
        }
      ]
      userName = "string"
    }
  })
}

属性值

databaseAccounts/mongodbUserDefinitions

名称 说明 Value
type 资源类型 “Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2022-08-15”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源 ID。 类型为：databaseAccounts 的资源的 ID
properties 用于创建和更新 Azure Cosmos DB Mongo 用户定义的属性。 MongoUserDefinitionResource

MongoUserDefinitionResource

名称 说明 值
customData USer 定义的自定义定义。 字符串
databaseName 要为此用户定义授予访问权限的数据库名称。 字符串
机制 Mongo 身份验证机制。 目前，我们仅支持身份验证机制 SCRAM-SHA-256。 字符串
password 用户定义的密码。 响应不包含用户密码。 字符串
角色 用户定义继承的角色集。 角色[]
userName 用户定义的用户名。 字符串

角色

名称 说明 值
db 应用角色的数据库名称。 字符串
角色 (role) 角色名称。 字符串