az cosmosdb sql stored-procedure

Manage Azure Cosmos DB SQL stored procedures.

Commands

Name	Description	Type	Status
az cosmosdb sql stored-procedure create	Create an SQL stored procedure under an Azure Cosmos DB SQL container.	Core	GA
az cosmosdb sql stored-procedure delete	Delete the SQL stored procedure under an Azure Cosmos DB SQL container.	Core	GA
az cosmosdb sql stored-procedure list	List the SQL stored procedures under an Azure Cosmos DB SQL container.	Core	GA
az cosmosdb sql stored-procedure show	Show the details of a SQL stored procedure under an Azure Cosmos DB SQL container.	Core	GA
az cosmosdb sql stored-procedure update	Creates or Updates an Azure Cosmos DB SQL stored procedure.	Core	GA

az cosmosdb sql stored-procedure create

Edit

Create an SQL stored procedure under an Azure Cosmos DB SQL container.

az cosmosdb sql stored-procedure create --account-name
                                        --body
                                        --container-name
                                        --database-name
                                        --name
                                        --resource-group

Examples

Create an Azure Cosmos DB SQL stored procedure.

az cosmosdb sql stored-procedure create -g MyResourceGroup -a MyAccount -d MyDatabase -c MyContainer -n MyStoredProcedure -b StoredProcedureBody

Required Parameters

--account-name -a

Cosmosdb account name.

--body -b

StoredProcedure body, you can enter it as a string or as a file, e.g., --body @sprocbody-file.json.

--container-name -c

Container name.

--database-name -d

Database name.

--name -n

StoredProcedure name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cosmosdb sql stored-procedure delete

Edit

Delete the SQL stored procedure under an Azure Cosmos DB SQL container.

az cosmosdb sql stored-procedure delete --account-name
                                        --container-name
                                        --database-name
                                        --name
                                        --resource-group
                                        [--yes]

Required Parameters

--account-name -a

Cosmosdb account name.

--container-name -c

Container name.

--database-name -d

Database name.

--name -n

StoredProcedure name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cosmosdb sql stored-procedure list

Edit

List the SQL stored procedures under an Azure Cosmos DB SQL container.

az cosmosdb sql stored-procedure list --account-name
                                      --container-name
                                      --database-name
                                      --resource-group

Required Parameters

--account-name -a

Cosmosdb account name.

--container-name -c

Container name.

--database-name -d

Database name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cosmosdb sql stored-procedure show

Edit

Show the details of a SQL stored procedure under an Azure Cosmos DB SQL container.

az cosmosdb sql stored-procedure show --account-name
                                      --container-name
                                      --database-name
                                      --name
                                      --resource-group

Required Parameters

--account-name -a

Cosmosdb account name.

--container-name -c

Container name.

--database-name -d

Database name.

--name -n

StoredProcedure name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cosmosdb sql stored-procedure update

Edit

Creates or Updates an Azure Cosmos DB SQL stored procedure.

az cosmosdb sql stored-procedure update --account-name
                                        --body
                                        --container-name
                                        --database-name
                                        --name
                                        --resource-group

Required Parameters

--account-name -a

Cosmosdb account name.

--body -b

StoredProcedure body, you can enter it as a string or as a file, e.g., --body @sprocbody-file.json.

--container-name -c

Container name.

--database-name -d

Database name.

--name -n

StoredProcedure name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False