sql_pool_vulnerability_assessment_rule_baselines

Creates, updates, deletes, gets or lists a sql_pool_vulnerability_assessment_rule_baselines resource.

Overview

Name	sql_pool_vulnerability_assessment_rule_baselines
Type	Resource
Id	azure.synapse.sql_pool_vulnerability_assessment_rule_baselines

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
baselineResults	array	The rule baseline result.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, sql_pool_name, vulnerability_assessment_name, rule_id, baseline_name, subscription_id		Gets a SqlPool's vulnerability assessment rule baseline.
create_or_update	insert	resource_group_name, workspace_name, sql_pool_name, vulnerability_assessment_name, rule_id, baseline_name, subscription_id		Creates or updates a Sql pool's vulnerability assessment rule baseline.
create_or_update	replace	resource_group_name, workspace_name, sql_pool_name, vulnerability_assessment_name, rule_id, baseline_name, subscription_id		Creates or updates a Sql pool's vulnerability assessment rule baseline.
delete	delete	resource_group_name, workspace_name, sql_pool_name, vulnerability_assessment_name, rule_id, baseline_name, subscription_id		Removes the database's vulnerability assessment rule baseline.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
baseline_name	string	The name of the vulnerability assessment rule baseline (default implies a baseline on a Sql pool level rule and master for workspace level rule). Known values are: "master" and "default". Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
rule_id	string	The vulnerability assessment rule ID. Required.
sql_pool_name	string	SQL pool name. Required.
subscription_id	string
vulnerability_assessment_name	string	The name of the vulnerability assessment. "default" Required.
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Gets a SqlPool's vulnerability assessment rule baseline.

SELECT
id,
name,
baselineResults,
type
FROM azure.synapse.sql_pool_vulnerability_assessment_rule_baselines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND vulnerability_assessment_name = '{{ vulnerability_assessment_name }}' -- required
AND rule_id = '{{ rule_id }}' -- required
AND baseline_name = '{{ baseline_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Sql pool's vulnerability assessment rule baseline.

INSERT INTO azure.synapse.sql_pool_vulnerability_assessment_rule_baselines (
properties,
resource_group_name,
workspace_name,
sql_pool_name,
vulnerability_assessment_name,
rule_id,
baseline_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ sql_pool_name }}',
'{{ vulnerability_assessment_name }}',
'{{ rule_id }}',
'{{ baseline_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: sql_pool_vulnerability_assessment_rule_baselines
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sql_pool_vulnerability_assessment_rule_baselines resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the sql_pool_vulnerability_assessment_rule_baselines resource.
  - name: sql_pool_name
    value: "{{ sql_pool_name }}"
    description: Required parameter for the sql_pool_vulnerability_assessment_rule_baselines resource.
  - name: vulnerability_assessment_name
    value: "{{ vulnerability_assessment_name }}"
    description: Required parameter for the sql_pool_vulnerability_assessment_rule_baselines resource.
  - name: rule_id
    value: "{{ rule_id }}"
    description: Required parameter for the sql_pool_vulnerability_assessment_rule_baselines resource.
  - name: baseline_name
    value: "{{ baseline_name }}"
    description: Required parameter for the sql_pool_vulnerability_assessment_rule_baselines resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sql_pool_vulnerability_assessment_rule_baselines resource.
  - name: properties
    value:
      baselineResults:
        - result: "{{ result }}"

REPLACE examples

create_or_update

Creates or updates a Sql pool's vulnerability assessment rule baseline.

REPLACE azure.synapse.sql_pool_vulnerability_assessment_rule_baselines
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND sql_pool_name = '{{ sql_pool_name }}' --required
AND vulnerability_assessment_name = '{{ vulnerability_assessment_name }}' --required
AND rule_id = '{{ rule_id }}' --required
AND baseline_name = '{{ baseline_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Removes the database's vulnerability assessment rule baseline.

DELETE FROM azure.synapse.sql_pool_vulnerability_assessment_rule_baselines
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND sql_pool_name = '{{ sql_pool_name }}' --required
AND vulnerability_assessment_name = '{{ vulnerability_assessment_name }}' --required
AND rule_id = '{{ rule_id }}' --required
AND baseline_name = '{{ baseline_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;