az cosmosdb sql trigger

Manage Azure Cosmos DB SQL triggers.

Commands

Name	Description	Type	Status
az cosmosdb sql trigger create	Create an SQL trigger under an Azure Cosmos DB SQL container.	Core	GA
az cosmosdb sql trigger delete	Delete the SQL trigger under an Azure Cosmos DB SQL container.	Core	GA
az cosmosdb sql trigger list	List the SQL triggers under an Azure Cosmos DB SQL container.	Core	GA
az cosmosdb sql trigger show	Show the details of a SQL trigger under an Azure Cosmos DB SQL container.	Core	GA
az cosmosdb sql trigger update	Updates an Azure Cosmos DB SQL trigger.	Core	GA

az cosmosdb sql trigger create

Edit

Create an SQL trigger under an Azure Cosmos DB SQL container.

az cosmosdb sql trigger create --account-name
                               --body
                               --container-name
                               --database-name
                               --name
                               --resource-group
                               [--operation {All, Create, Delete, Replace, Update}]
                               [--type {Post, Pre}]

Examples

Create an Azure Cosmos DB SQL trigger.

az cosmosdb sql trigger create -g MyResourceGroup -a MyAccount -d MyDatabase -c MyContainer -n MyTrigger -b TriggerBody

Required Parameters

--account-name -a

Cosmosdb account name.

--body -b

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

--container-name -c

Container name.

--database-name -d

Database name.

--name -n

Trigger 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.

--operation

The operation of the trigger.

Property	Value
Accepted values:	All, Create, Delete, Replace, Update

--type -t

Trigger type.

Property	Value
Accepted values:	Post, Pre

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 trigger delete

Edit

Delete the SQL trigger under an Azure Cosmos DB SQL container.

az cosmosdb sql trigger 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

Trigger 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 trigger list

Edit

List the SQL triggers under an Azure Cosmos DB SQL container.

az cosmosdb sql trigger 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 trigger show

Edit

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

az cosmosdb sql trigger 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

Trigger 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 trigger update

Edit

Updates an Azure Cosmos DB SQL trigger.

az cosmosdb sql trigger update --account-name
                               --container-name
                               --database-name
                               --name
                               --resource-group
                               [--body]
                               [--operation {All, Create, Delete, Replace, Update}]
                               [--type {Post, Pre}]

Required Parameters

--account-name -a

Cosmosdb account name.

--container-name -c

Container name.

--database-name -d

Database name.

--name -n

Trigger 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.

--body -b

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

--operation

The operation of the trigger.

Property	Value
Accepted values:	All, Create, Delete, Replace, Update

--type -t

Trigger type.

Property	Value
Accepted values:	Post, Pre

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

Feedback

Was this page helpful?