az cosmosdb sql user-defined-function
Manage Azure Cosmos DB SQL user defined functions.
Commands
| az cosmosdb sql user-defined-function create |
Create an SQL user defined function under an Azure Cosmos DB SQL container. |
| az cosmosdb sql user-defined-function delete |
Delete the SQL user defined function under an Azure Cosmos DB SQL container. |
| az cosmosdb sql user-defined-function list |
List the SQL user defined functions under an Azure Cosmos DB SQL container. |
| az cosmosdb sql user-defined-function show |
Show the details of a SQL user defined function under an Azure Cosmos DB SQL container. |
| az cosmosdb sql user-defined-function update |
Creates or Updates an Azure Cosmos DB SQL user defined function. |
az cosmosdb sql user-defined-function create
Create an SQL user defined function under an Azure Cosmos DB SQL container.
az cosmosdb sql user-defined-function create --account-name
--body
--container-name
--database-name
--name
--resource-group
[--subscription]Examples
Create an Azure Cosmos DB SQL user defined function.
az cosmosdb sql user-defined-function create -g MyResourceGroup -a MyAccount -d MyDatabase -c MyContainer -n MyUserDefinedFunction -b UserDefinedFunctionBodyRequired Parameters
Cosmosdb account name.
UserDefinedFunction body, you can enter it as a string or as a file, e.g., --body @udfbody-file.json.
Container name.
Database name.
UserDefinedFunction name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb sql user-defined-function delete
Delete the SQL user defined function under an Azure Cosmos DB SQL container.
az cosmosdb sql user-defined-function delete --account-name
--container-name
--database-name
--name
--resource-group
[--subscription]
[--yes]Required Parameters
Cosmosdb account name.
Container name.
Database name.
UserDefinedFunction name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb sql user-defined-function list
List the SQL user defined functions under an Azure Cosmos DB SQL container.
az cosmosdb sql user-defined-function list --account-name
--container-name
--database-name
--resource-group
[--query-examples]
[--subscription]Required Parameters
Cosmosdb account name.
Container name.
Database name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb sql user-defined-function show
Show the details of a SQL user defined function under an Azure Cosmos DB SQL container.
az cosmosdb sql user-defined-function show --account-name
--container-name
--database-name
--name
--resource-group
[--query-examples]
[--subscription]Required Parameters
Cosmosdb account name.
Container name.
Database name.
UserDefinedFunction name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb sql user-defined-function update
Creates or Updates an Azure Cosmos DB SQL user defined function.
az cosmosdb sql user-defined-function update --account-name
--body
--container-name
--database-name
--name
--resource-group
[--subscription]Required Parameters
Cosmosdb account name.
UserDefinedFunction body, you can enter it as a string or as a file, e.g., --body @udfbody-file.json.
Container name.
Database name.
UserDefinedFunction name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.