Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az security atp cosmosdb

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

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

az security atp cosmosdb update

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
 [--acquire-policy-token]
 [--change-reference]

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.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments

Feedback

Was this page helpful?