az synapse sql pool threat-policy

Manage a SQL pool's threat detection policies.

Commands

Name	Description	Type	Status
az synapse sql pool threat-policy show	Get a SQL pool's threat detection policy.	Core	GA
az synapse sql pool threat-policy update	Update a SQL pool's threat detection policy.	Core	GA

az synapse sql pool threat-policy show

Get a SQL pool's threat detection policy.

az synapse sql pool threat-policy show --security-alert-policy-name
                                       [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]
                                       [--workspace-name]

Examples

Get a SQL pool's threat detection policy.

az synapse sql pool threat-policy show --name sqlpool --workspace-name testsynapseworkspace \
--resource-group rg --security-alert-policy-name threatpolicy

Required Parameters

--security-alert-policy-name -s

Name of the security alert policy.

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The SQL pool name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

The workspace name.

Property	Value
Parameter group:	Resource Id Arguments

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.

--verbose

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

Property	Value
Default value:	False

az synapse sql pool threat-policy update

Update a SQL pool's threat detection policy.

If the policy is being enabled, storage_account or both storage_endpoint and storage_account_access_key must be specified.

az synapse sql pool threat-policy update [--add]
                                         [--disabled-alerts]
                                         [--email-account-admins {false, true}]
                                         [--email-addresses]
                                         [--force-string]
                                         [--ids]
                                         [--name]
                                         [--remove]
                                         [--resource-group]
                                         [--retention-days]
                                         [--security-alert-policy-name]
                                         [--set]
                                         [--state {Disabled, Enabled, New}]
                                         [--storage-account]
                                         [--storage-endpoint]
                                         [--storage-key]
                                         [--subscription]
                                         [--workspace-name]

Examples

Enable by storage account name.

az synapse sql pool threat-policy update --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \
--state Enabled --storage-account mystorageaccount --security-alert-policy-name threatpolicy

Enable by storage endpoint and key.

az synapse sql pool threat-policy update --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \
--state Enabled --storage-endpoint https://mystorage.blob.core.windows.net --storage-key MYKEY== \
--security-alert-policy-name threatpolicy

Disable a subset of alert types.

az synapse sql pool threat-policy update --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \
--disabled-alerts Sql_Injection_Vulnerability Access_Anomaly --security-alert-policy-name threatpolicy

Configure email recipients for a policy.

az synapse sql pool threat-policy update --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \
--email-addresses me@examlee.com you@example.com --email-account-admins true \
--security-alert-policy-name threatpolicy

Disable a threat policy.

az synapse sql pool threat-policy update --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \
--state Disabled --security-alert-policy-name threatpolicy

Optional Parameters

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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	[]

--disabled-alerts

List of disabled alerts.

Property	Value
Parameter group:	Policy Arguments

--email-account-admins

Whether the alert is sent to the account administrators.

Property	Value
Parameter group:	Notification Arguments
Accepted values:	false, true

--email-addresses

List of email addresses that alerts are sent to.

Property	Value
Parameter group:	Notification Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	False

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The SQL pool name.

Property	Value
Parameter group:	Resource Id Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	[]

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--retention-days

The number of days to retain threat detection logs.

Property	Value
Parameter group:	Policy Arguments

--security-alert-policy-name -s

Name of the security alert policy.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	[]

--state

Threat detection policy state.

Property	Value
Parameter group:	Policy Arguments
Accepted values:	Disabled, Enabled, New

--storage-account

Name of the storage account.

Property	Value
Parameter group:	Storage Arguments

--storage-endpoint

The storage account endpoint.

Property	Value
Parameter group:	Storage Arguments

--storage-key

Access key for the storage account.

Property	Value
Parameter group:	Storage Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

The workspace name.

Property	Value
Parameter group:	Resource Id Arguments

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.

--verbose

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

Property	Value
Default value:	False