az security atp cosmosdb

  • Reference

View and manage Advanced Threat Protection settings for Cosmos DB accounts.

Commands

Name Description Type Status
az security atp cosmosdb show

Display Advanced Threat Protection settings for an Azure Cosmos DB account.

 Core GA
az security atp cosmosdb update

Toggle status of Advanced Threat Protection for an Azure Cosmos DB account.

 Core GA

az security atp cosmosdb show

Edit

Display Advanced Threat Protection settings for an Azure Cosmos DB account.

az security atp cosmosdb show --cosmosdb-account
                              --resource-group

Examples

Retrieve Advanced Threat Protection settings for an Azure Cosmos DB account on a subscription scope.

az security atp cosmosdb show --resource-group MyResourceGroup --cosmosdb-account MyCosmosDbAccount

Required Parameters

--cosmosdb-account

Name of an existing Cosmos DB account.

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az security atp cosmosdb update

Edit

Toggle status of Advanced Threat Protection for an Azure Cosmos DB account.

az security atp cosmosdb update --cosmosdb-account
                                --is-enabled {false, true}
                                --resource-group

Examples

Enable Advanced Threat Protection for an Azure Cosmos DB account on a subscription scope.

az security atp cosmosdb update --resource-group MyResourceGroup --cosmosdb-account MyCosmosDbAccount --is-enabled true

Disable Advanced Threat Protection for an Azure Cosmos DB account on a subscription scope.

az security atp cosmosdb update --resource-group MyResourceGroup --cosmosdb-account MyCosmosDbAccount --is-enabled false

Required Parameters

--cosmosdb-account

Name of an existing Cosmos DB account.

--is-enabled

Enable or disable Advanced Threat Protection for a received storage or Cosmos DB account.

Accepted values: false, true
--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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.