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

az cosmosdb sql user-defined-function

管理 Azure Cosmos DB SQL 用户定义的函数。

命令

名称	说明	类型	Status
az cosmosdb sql user-defined-function create	在 Azure Cosmos DB SQL 容器下创建 SQL 用户定义的函数。	核心	GA
az cosmosdb sql user-defined-function delete	删除 Azure Cosmos DB SQL 容器下的 SQL 用户定义的函数。	核心	GA
az cosmosdb sql user-defined-function list	列出 Azure Cosmos DB SQL 容器下的 SQL 用户定义的函数。	核心	GA
az cosmosdb sql user-defined-function show	显示 Azure Cosmos DB SQL 容器下 SQL 用户定义的函数的详细信息。	核心	GA
az cosmosdb sql user-defined-function update	创建或汇报 Azure Cosmos DB SQL 用户定义的函数。	核心	GA

az cosmosdb sql user-defined-function create

在 Azure Cosmos DB SQL 容器下创建 SQL 用户定义的函数。

az cosmosdb sql user-defined-function create --account-name
                                             --body
                                             --container-name
                                             --database-name
                                             --name
                                             --resource-group

示例

创建 Azure Cosmos DB SQL 用户定义函数。

az cosmosdb sql user-defined-function create -g MyResourceGroup -a MyAccount -d MyDatabase -c MyContainer -n MyUserDefinedFunction -b UserDefinedFunctionBody

必需参数

--account-name -a

Cosmosdb 帐户名称。

--body -b

UserDefinedFunction 正文，可以将其输入为字符串或文件，例如 --body @udfbody-file.json。

--container-name -c

容器名称。

--database-name -d

数据库名称。

--name -n

UserDefinedFunction 名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az cosmosdb sql user-defined-function delete

删除 Azure Cosmos DB SQL 容器下的 SQL 用户定义的函数。

az cosmosdb sql user-defined-function delete --account-name
                                             --container-name
                                             --database-name
                                             --name
                                             --resource-group
                                             [--yes]

必需参数

--account-name -a

Cosmosdb 帐户名称。

--container-name -c

容器名称。

--database-name -d

数据库名称。

--name -n

UserDefinedFunction 名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az cosmosdb sql user-defined-function list

列出 Azure Cosmos DB SQL 容器下的 SQL 用户定义的函数。

az cosmosdb sql user-defined-function list --account-name
                                           --container-name
                                           --database-name
                                           --resource-group

必需参数

--account-name -a

Cosmosdb 帐户名称。

--container-name -c

容器名称。

--database-name -d

数据库名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az cosmosdb sql user-defined-function show

显示 Azure Cosmos DB SQL 容器下 SQL 用户定义的函数的详细信息。

az cosmosdb sql user-defined-function show --account-name
                                           --container-name
                                           --database-name
                                           --name
                                           --resource-group

必需参数

--account-name -a

Cosmosdb 帐户名称。

--container-name -c

容器名称。

--database-name -d

数据库名称。

--name -n

UserDefinedFunction 名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az cosmosdb sql user-defined-function update

创建或汇报 Azure Cosmos DB SQL 用户定义的函数。

az cosmosdb sql user-defined-function update --account-name
                                             --body
                                             --container-name
                                             --database-name
                                             --name
                                             --resource-group

必需参数

--account-name -a

Cosmosdb 帐户名称。

--body -b

UserDefinedFunction 正文，可以将其输入为字符串或文件，例如 --body @udfbody-file.json。

--container-name -c

容器名称。

--database-name -d

数据库名称。

--name -n

UserDefinedFunction 名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。