az sql db threat-policy

Manage a database's threat detection policies.

Commands

az sql db threat-policy show Gets a database's threat detection policy.
az sql db threat-policy update Update a database's threat detection policy.

az sql db threat-policy show

Gets a database's threat detection policy.

az sql db threat-policy show --name
--resource-group
--server

Required Parameters

--name -n
Name of the Azure SQL Database.
--resource-group -g
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
--server -s
Name of the Azure SQL server.

az sql db threat-policy update

Update a database's threat detection policy.

az sql db threat-policy update --name
--resource-group
--server
[--add]
[--disabled-alerts]
[--email-account-admins {Disabled, Enabled}]
[--email-addresses]
[--remove]
[--retention-days]
[--set]
[--state {Disabled, Enabled, New}]
[--storage-account]
[--storage-endpoint]
[--storage-key]

Examples

Enable by storage account name.

az sql db threat-policy update -g mygroup -s myserver -n mydb     --state Enabled --storage-account mystorage

Enable by storage endpoint and key.

az sql db threat-policy update -g mygroup -s myserver -n mydb     --state Enabled --storage-endpoint https://mystorage.blob.core.windows.net     --storage-key MYKEY==

Disable a subset of alert types.

az sql db threat-policy update -g mygroup -s myserver -n mydb     --disabled-alerts Sql_Injection_Vulnerability Access_Anomaly

Configure email recipients for a policy.

az sql db threat-policy update -g mygroup -s myserver -n mydb     --email-addresses me@examlee.comyou@example.com     --email-account-admins Enabled

Disable a threat policy.

az sql db threat-policy update -g mygroup -s myserver -n mydb --state Disabled

Required Parameters

--name -n
Name of the Azure SQL Database.
--resource-group -g
Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
--server -s
Name of the Azure SQL server.

Optional Parameters

--add
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .
--disabled-alerts
List of disabled alerts.
--email-account-admins
Whether the alert is sent to the account administrators.
accepted values: Disabled, Enabled
--email-addresses
List of email addresses that alerts are sent to.
--remove
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
--retention-days
The number of days to retain threat detection logs.
--set
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
--state
Threat detection policy state.
accepted values: Disabled, Enabled, New
--storage-account
Name of the storage account.
--storage-endpoint
The storage account endpoint.
--storage-key
Access key for the storage account.