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

Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers/userDefinedFunctions 2023-09-15-preview

Bicep 资源定义

可以使用面向以下操作部署 databaseAccounts/sqlDatabases/containers/userDefinedFunctions 资源类型:

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

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2023-09-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      body: 'string'
      id: 'string'
    }
  }
}

属性值

databaseAccounts/sqlDatabases/containers/userDefined...

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
字符串 (必需)
location 资源所属的资源组的位置。 字符串
标记 标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 标记名称和值的字典。 请参阅 模板中的标记
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型的资源的符号名称: 容器
标识 资源的标识。 ManagedServiceIdentity
properties 用于创建和更新 Azure Cosmos DB userDefinedFunction 的属性。 SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... 所需的 ()

ManagedServiceIdentity

名称 说明 Value
type 用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典键引用将是 ARM 资源 ID,格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名称 说明
{customized property} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

名称 说明 Value
options 要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptions
resource userDefinedFunction 的标准 JSON 格式 SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... 所需的 ()

CreateUpdateOptions

名称 说明
autoscaleSettings 指定自动缩放设置。 注意:吞吐量或自动缩放设置是必需的,但不是两者兼而有之。 AutoscaleSettings
throughput 每秒请求单位数。 例如,“吞吐量”:10000。 int

AutoscaleSettings

名称 说明
maxThroughput 表示资源可纵向扩展的最大吞吐量。 int

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

名称 说明
body 用户定义函数的主体 string
id Cosmos DB SQL userDefinedFunction 的名称 字符串 (必需)

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
创建 Azure Cosmos DB Core (SQL) API 存储过程

部署到 Azure
此模板为 Core (SQL) API 创建 Azure Cosmos DB 帐户,并使用存储过程、触发器和用户定义的函数创建容器。

ARM 模板资源定义

databaseAccounts/sqlDatabases/containers/userDefinedFunctions 资源类型可以使用面向以下对象的操作进行部署:

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

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions",
  "apiVersion": "2023-09-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "body": "string",
      "id": "string"
    }
  }
}

属性值

databaseAccounts/sqlDatabases/containers/userDefined...

名称 说明 Value
type 资源类型 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions'
apiVersion 资源 API 版本 “2023-09-15-preview”
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。
字符串 (必需)
location 资源所属的资源组的位置。 字符串
标记 标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可以为一个资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 标记名称和值的字典。 请参阅 模板中的标记
标识 资源的标识。 ManagedServiceIdentity
properties 用于创建和更新 Azure Cosmos DB userDefinedFunction 的属性。 SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... 所需的 ()

ManagedServiceIdentity

名称 说明 Value
type 用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典键引用将是 ARM 资源 ID,格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名称 说明
{customized property} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

名称 说明 Value
options 要应用于请求的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptions
resource userDefinedFunction 的标准 JSON 格式 SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... 所需的 ()

CreateUpdateOptions

名称 说明
autoscaleSettings 指定自动缩放设置。 注意:需要吞吐量或 autoscaleSettings,但不能同时满足这两项要求。 AutoscaleSettings
throughput 每秒请求单位数。 例如,“throughput”:10000。 int

AutoscaleSettings

名称 说明
maxThroughput 表示资源可以纵向扩展到的最大吞吐量。 int

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

名称 说明
body 用户定义函数的主体 string
id Cosmos DB SQL userDefinedFunction 的名称 字符串 (必需)

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
创建 Azure Cosmos DB Core (SQL) API 存储过程

部署到 Azure
此模板为 Core (SQL) API 创建 Azure Cosmos DB 帐户,以及一个包含存储过程、触发器和用户定义的函数的容器。

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

可以使用面向以下操作部署 databaseAccounts/sqlDatabases/containers/userDefinedFunctions 资源类型:

  • 资源组

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

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2023-09-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        body = "string"
        id = "string"
      }
    }
  })
}

属性值

databaseAccounts/sqlDatabases/containers/userDefined...

名称 说明 Value
type 资源类型 “Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2023-09-15-preview”
name 资源名称 字符串 (必需)
location 资源所属的资源组的位置。 字符串
parent_id 此资源的父资源的 ID。 类型为的资源的 ID: 容器
标记 标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 标记名称和值的字典。
标识 资源的标识。 ManagedServiceIdentity
properties 用于创建和更新 Azure Cosmos DB userDefinedFunction 的属性。 SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... 所需的 ()

ManagedServiceIdentity

名称 说明 Value
type 用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。 “SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
identity_ids 与资源关联的用户标识列表。 用户标识字典密钥引用将是 ARM 资源 ID,格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 用户标识 ID 数组。

ManagedServiceIdentityUserAssignedIdentities

名称 说明
{customized property} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

名称 说明 Value
options 要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptions
resource userDefinedFunction 的标准 JSON 格式 SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... 所需的 ()

CreateUpdateOptions

名称 说明
autoscaleSettings 指定自动缩放设置。 注意:吞吐量或自动缩放设置是必需的,但不是两者兼而有之。 AutoscaleSettings
throughput 每秒请求单位数。 例如,“吞吐量”:10000。 int

AutoscaleSettings

名称 说明
maxThroughput 表示资源可纵向扩展的最大吞吐量。 int

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

名称 说明
body 用户定义函数的主体 string
id Cosmos DB SQL userDefinedFunction 的名称 字符串 (必需)