az synapse sql audit-policy

Manage SQL auditing policy.

Commands

Name	Description	Type	Status
az synapse sql audit-policy show	Get a SQL's auditing policy.	Core	GA
az synapse sql audit-policy update	Update a SQL's auditing policy.	Core	GA
az synapse sql audit-policy wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az synapse sql audit-policy show

Edit

Get a SQL's auditing policy.

az synapse sql audit-policy show --resource-group
                                 --workspace-name

Examples

Get a SQL's auditing policy.

az synapse sql audit-policy show --workspace-name testsynapseworkspace --resource-group rg

Required Parameters

--resource-group -g

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

--workspace-name

The workspace name.

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.

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

Property	Value
Default value:	False

az synapse sql audit-policy update

Edit

Update a SQL's auditing policy.

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

az synapse sql audit-policy update --resource-group
                                   --workspace-name
                                   [--actions]
                                   [--add]
                                   [--blob-auditing-policy-name]
                                   [--blob-storage-target-state --bsts {Disabled, Enabled}]
                                   [--eh --event-hub]
                                   [--ehari --event-hub-authorization-rule-id]
                                   [--ehts --event-hub-target-state {Disabled, Enabled}]
                                   [--enable-azure-monitor {false, true}]
                                   [--force-string]
                                   [--lats --log-analytics-target-state {Disabled, Enabled}]
                                   [--lawri --log-analytics-workspace-resource-id]
                                   [--no-wait]
                                   [--queue-delay-milliseconds --queue-delay-time]
                                   [--remove]
                                   [--retention-days]
                                   [--set]
                                   [--state {Disabled, Enabled}]
                                   [--storage-account]
                                   [--storage-endpoint]
                                   [--storage-key]
                                   [--storage-subscription]
                                   [--use-secondary-key {false, true}]

Examples

Enable by storage account name.

az synapse sql audit-policy update --workspace-name testsynapseworkspace --resource-group rg --state Enabled \
    --blob-storage-target-state Enabled --storage-account mystorage

Enable by storage endpoint and key.

az synapse sql audit-policy update --workspace-name testsynapseworkspace --resource-group rg --state Enabled \
    --blob-storage-target-state Enabled --storage-endpoint https://mystorage.blob.core.windows.net \
    --storage-key MYKEY==

Set the list of audit actions.

az synapse sql audit-policy update --workspace-name testsynapseworkspace --resource-group rg \
--actions SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP 'UPDATE on database::mydb by public'

Disable an auditing policy.

az synapse sql audit-policy update --workspace-name testsynapseworkspace --resource-group rg \
--state Disabled

Disable a blob storage auditing policy.

az synapse sql audit-policy update --workspace-name testsynapseworkspace --resource-group rg \
--blob-storage-target-state Disabled

Enable a log analytics auditing policy.

az synapse sql audit-policy update --resource-group mygroup --workspace-name myws --state Enabled \
    --log-analytics-target-state Enabled --log-analytics-workspace-resource-id myworkspaceresourceid

Disable a log analytics auditing policy.

az synapse sql audit-policy update --resource-group mygroup --workspace-name myws --state Enabled
    --log-analytics-target-state Disabled

Enable an event hub auditing policy.

az synapse sql audit-policy update --resource-group mygroup --workspace-name myws --state Enabled \
    --event-hub-target-state Enabled \
    --event-hub-authorization-rule-id eventhubauthorizationruleid \
    --event-hub eventhubname

Enable an event hub auditing policy for default event hub.

az synapse sql audit-policy update --resource-group mygroup --workspace-name myws --state Enabled \
    --event-hub-target-state Enabled \
    --event-hub-authorization-rule-id eventhubauthorizationruleid

Disable an event hub auditing policy.

az synapse sql audit-policy update --resource-group mygroup --workspace-name myws
   --state Enabled --event-hub-target-state Disabled

Required Parameters

--resource-group -g

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

--workspace-name

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

--actions

List of actions and action groups to audit.

Property	Value
Parameter group:	Policy Arguments

--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:	[]

--blob-auditing-policy-name

Property	Value
Default value:	default

--blob-storage-target-state --bsts

Indicate whether blob storage is a destination for audit records.

Property	Value
Parameter group:	Storage Arguments
Accepted values:	Disabled, Enabled

--eh --event-hub

The name of the event hub. If none is specified when providing event_hub_authorization_rule_id, the default event hub will be selected.

Property	Value
Parameter group:	Event Hub Arguments

--ehari --event-hub-authorization-rule-id

The resource Id for the event hub authorization rule.

Property	Value
Parameter group:	Event Hub Arguments

--ehts --event-hub-target-state

Indicate whether event hub is a destination for audit records.

Property	Value
Parameter group:	Event Hub Arguments
Accepted values:	Disabled, Enabled

--enable-azure-monitor

Whether enabling azure monitor target or not.

Property	Value
Accepted values:	false, true

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

--lats --log-analytics-target-state

Indicate whether log analytics is a destination for audit records.

Property	Value
Parameter group:	Log Analytics Arguments
Accepted values:	Disabled, Enabled

--lawri --log-analytics-workspace-resource-id

The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Audit Logs.

Property	Value
Parameter group:	Log Analytics Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--queue-delay-milliseconds --queue-delay-time

The amount of time in milliseconds that can elapse before audit actions are forced to be processed.

--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:	[]

--retention-days

The number of days to retain audit logs.

Property	Value
Parameter group:	Policy Arguments

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

Auditing policy state.

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

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

--storage-subscription

The subscription id of storage account.

Property	Value
Parameter group:	Storage Arguments

--use-secondary-key

Indicates whether using the secondary storeage key or not.

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

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.

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

Property	Value
Default value:	False

az synapse sql audit-policy wait

Edit

Place the CLI in a waiting state until a condition is met.

az synapse sql audit-policy wait --blob-auditing-policy-name
                                 --resource-group
                                 --workspace-name
                                 [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--interval]
                                 [--timeout]
                                 [--updated]

Required Parameters

--blob-auditing-policy-name

The name of the blob auditing policy.

--resource-group -g

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

--workspace-name

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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.

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

Property	Value
Default value:	False

Κοινή χρήση μέσω

az synapse sql audit-policy

Commands

az synapse sql audit-policy show

Examples

Required Parameters

az synapse sql audit-policy update

Examples

Required Parameters

Optional Parameters

az synapse sql audit-policy wait

Required Parameters

Optional Parameters

Σχόλια