az sql db audit-policy

Manage a database's auditing policy.

Commands

az sql db audit-policy show

Gets a database's blob auditing policy.

az sql db audit-policy update

Update a database's auditing policy.

az sql db audit-policy show

Gets a database's blob auditing policy.

az sql db audit-policy show [--ids]
                            [--name]
                            [--query-examples]
                            [--resource-group]
                            [--server]
                            [--subscription]

Optional Parameters

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

--name -n

Name of the Azure SQL Database.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--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. You can configure the default using az configure --defaults sql-server=<name>.

--subscription

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

az sql db audit-policy update

Update a database's auditing policy.

If the policy is being enabled, --storage-account or both --storage-endpoint and --storage-key must be specified.

az sql db audit-policy update [--actions]
                              [--add]
                              [--force-string]
                              [--ids]
                              [--name]
                              [--remove]
                              [--resource-group]
                              [--retention-days]
                              [--server]
                              [--set]
                              [--state {Disabled, Enabled}]
                              [--storage-account]
                              [--storage-endpoint]
                              [--storage-key]
                              [--subscription]

Examples

Enable by storage account name.

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

Enable by storage endpoint and key.

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

Set the list of audit actions.

az sql db audit-policy update -g mygroup -s myserver -n mydb \
    --actions FAILED_DATABASE_AUTHENTICATION_GROUP 'UPDATE on database::mydb by public'

Add an audit action.

az sql db audit-policy update -g mygroup -s myserver -n mydb \
    --add auditActionsAndGroups FAILED_DATABASE_AUTHENTICATION_GROUP

Remove an audit action by list index.

az sql db audit-policy update -g mygroup -s myserver -n mydb --remove auditActionsAndGroups 0

Disable an auditing policy.

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

Optional Parameters

--actions

List of actions and action groups to audit.

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

--force-string

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

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

--name -n

Name of the Azure SQL Database.

--remove

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

--resource-group -g

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

--retention-days

The number of days to retain audit logs.

--server -s

Name of the Azure SQL server. You can configure the default using az configure --defaults sql-server=<name>.

--set

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

--state

Auditing policy state.

accepted values: Disabled, Enabled
--storage-account

Name of the storage account.

--storage-endpoint

The storage account endpoint.

--storage-key

Access key for the storage account.

--subscription

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