通过

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

Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers/userDefinedFunctions 2024-05-15

  • 项目

Bicep 资源定义

可以使用目标操作部署 databaseAccounts/sqlDatabases/containers/userDefinedFunctions 资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2024-05-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      body: 'string'
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

AutoscaleSettings

名字 描述 价值
maxThroughput 表示最大吞吐量，资源可以纵向扩展。 int

CreateUpdateOptions

名字 描述 价值
autoscaleSettings 指定自动缩放设置。 注意：需要吞吐量或自动缩放设置，但不需要两者。 AutoscaleSettings
吞吐量 每秒请求单位数。 例如，“throughput”：10000。 int

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

名字 描述 价值
位置 资源所属的资源组的位置。 字符串
名字 资源名称 string （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：databaseAccounts/sqlDatabases/containers
性能 用于创建和更新 Azure Cosmos DB userDefinedFunction 的属性。 SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties（必需）
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

名字 描述 价值
选项 要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptions
资源 userDefinedFunction 的标准 JSON 格式 SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource（必需）

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

名字 描述 价值
身体 用户定义的函数的正文 字符串
id Cosmos DB SQL userDefinedFunction 的名称 string （必需）

标签

名字 描述 价值

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
创建 Azure Cosmos DB Core （SQL） API 存储过程 此模板创建一个用于 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": "2024-05-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "body": "string",
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

AutoscaleSettings

名字 描述 价值
maxThroughput 表示最大吞吐量，资源可以纵向扩展。 int

CreateUpdateOptions

名字 描述 价值
autoscaleSettings 指定自动缩放设置。 注意：需要吞吐量或自动缩放设置，但不需要两者。 AutoscaleSettings
吞吐量 每秒请求单位数。 例如，“throughput”：10000。 int

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

名字 描述 价值
apiVersion API 版本 '2024-05-15'
位置 资源所属的资源组的位置。 字符串
名字 资源名称 string （必需）
性能 用于创建和更新 Azure Cosmos DB userDefinedFunction 的属性。 SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties（必需）
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions'

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

名字 描述 价值
选项 要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptions
资源 userDefinedFunction 的标准 JSON 格式 SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource（必需）

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

名字 描述 价值
身体 用户定义的函数的正文 字符串
id Cosmos DB SQL userDefinedFunction 的名称 string （必需）

标签

名字 描述 价值

快速入门模板

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

模板 描述
创建 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@2024-05-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        body = "string"
        id = "string"
      }
    }
  })
}

属性值

AutoscaleSettings

名字 描述 价值
maxThroughput 表示最大吞吐量，资源可以纵向扩展。 int

CreateUpdateOptions

名字 描述 价值
autoscaleSettings 指定自动缩放设置。 注意：需要吞吐量或自动缩放设置，但不需要两者。 AutoscaleSettings
吞吐量 每秒请求单位数。 例如，“throughput”：10000。 int

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

名字 描述 价值
位置 资源所属的资源组的位置。 字符串
名字 资源名称 string （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：databaseAccounts/sqlDatabases/containers
性能 用于创建和更新 Azure Cosmos DB userDefinedFunction 的属性。 SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties（必需）
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2024-05-15”

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

名字 描述 价值
选项 要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptions
资源 userDefinedFunction 的标准 JSON 格式 SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource（必需）

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

名字 描述 价值
身体 用户定义的函数的正文 字符串
id Cosmos DB SQL userDefinedFunction 的名称 string （必需）

标签

名字 描述 价值