sql_vulnerability_assessment_baseline_rules

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

Overview

Name	sql_vulnerability_assessment_baseline_rules
Type	Resource
Id	azure.security.sql_vulnerability_assessment_baseline_rules

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.
latestScan	boolean	Take results from latest scan.
results	array	Expected results in the baseline.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
latestScan	boolean	Take results from latest scan.
results	array	Expected results in the baseline.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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_id, rule_id	databaseName	Gets the results for a given rule in the Baseline. Gets the results for a given rule in the Baseline.
list	select	resource_id	databaseName	Gets the results for all rules in the Baseline. Gets the results for all rules in the Baseline.
create_or_update	insert	resource_id, rule_id	databaseName	Creates a Baseline for a rule in a database. Will overwrite any previously existing results. Creates a Baseline for a rule in a database. Will overwrite any previously existing results.
create_or_update	replace	resource_id, rule_id	databaseName	Creates a Baseline for a rule in a database. Will overwrite any previously existing results. Creates a Baseline for a rule in a database. Will overwrite any previously existing results.
delete	delete	resource_id, rule_id	databaseName	Deletes a rule from the Baseline of a given database. Deletes a rule from the Baseline of a given database.
add	exec	resource_id	databaseName	Set a list of baseline rules. Will overwrite any previously existing results (for all rules). Set a list of baseline rules. Will overwrite any previously existing results (for all rules).

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
resource_id	string	The fully qualified Azure Resource manager identifier of the resource. Required.
rule_id	string	The rule Id. Required.
databaseName	string	The name of the database to assess. Required when the API is called on the parent resource (e.g., server level) rather than on a specific database resource, since the database name is not part of the resource URI. This is the only way to assess system databases (e.g., master), which cannot be referenced directly in the resource URI. Default value is None.

SELECT examples

get

Gets the results for a given rule in the Baseline. Gets the results for a given rule in the Baseline.

SELECT
id,
name,
latestScan,
results,
systemData,
type
FROM azure.security.sql_vulnerability_assessment_baseline_rules
WHERE resource_id = '{{ resource_id }}' -- required
AND rule_id = '{{ rule_id }}' -- required
AND databaseName = '{{ databaseName }}'
;

list

Gets the results for all rules in the Baseline. Gets the results for all rules in the Baseline.

SELECT
id,
name,
latestScan,
results,
systemData,
type
FROM azure.security.sql_vulnerability_assessment_baseline_rules
WHERE resource_id = '{{ resource_id }}' -- required
AND databaseName = '{{ databaseName }}'
;

INSERT examples

create_or_update

Creates a Baseline for a rule in a database. Will overwrite any previously existing results. Creates a Baseline for a rule in a database. Will overwrite any previously existing results.

INSERT INTO azure.security.sql_vulnerability_assessment_baseline_rules (
latestScan,
results,
resource_id,
rule_id,
databaseName
)
SELECT 
{{ latestScan }},
'{{ results }}',
'{{ resource_id }}',
'{{ rule_id }}',
'{{ databaseName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: sql_vulnerability_assessment_baseline_rules
props:
  - name: resource_id
    value: "{{ resource_id }}"
    description: Required parameter for the sql_vulnerability_assessment_baseline_rules resource.
  - name: rule_id
    value: "{{ rule_id }}"
    description: Required parameter for the sql_vulnerability_assessment_baseline_rules resource.
  - name: latestScan
    value: {{ latestScan }}
    description: |
      Take results from latest scan.
  - name: results
    value:
      - "{{ results }}"
    description: |
      Expected results to be inserted into the baseline. Leave this field empty if latestScan == true.
  - name: databaseName
    value: "{{ databaseName }}"
    description: The name of the database to assess. Required when the API is called on the parent resource (e.g., server level) rather than on a specific database resource, since the database name is not part of the resource URI. This is the only way to assess system databases (e.g., master), which cannot be referenced directly in the resource URI. Default value is None.
    description: The name of the database to assess. Required when the API is called on the parent resource (e.g., server level) rather than on a specific database resource, since the database name is not part of the resource URI. This is the only way to assess system databases (e.g., master), which cannot be referenced directly in the resource URI. Default value is None.

REPLACE examples

create_or_update

Creates a Baseline for a rule in a database. Will overwrite any previously existing results. Creates a Baseline for a rule in a database. Will overwrite any previously existing results.

REPLACE azure.security.sql_vulnerability_assessment_baseline_rules
SET 
latestScan = {{ latestScan }},
results = '{{ results }}'
WHERE 
resource_id = '{{ resource_id }}' --required
AND rule_id = '{{ rule_id }}' --required
AND databaseName = '{{ databaseName}}'
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a rule from the Baseline of a given database. Deletes a rule from the Baseline of a given database.

DELETE FROM azure.security.sql_vulnerability_assessment_baseline_rules
WHERE resource_id = '{{ resource_id }}' --required
AND rule_id = '{{ rule_id }}' --required
AND databaseName = '{{ databaseName }}'
;

Lifecycle Methods

add

Set a list of baseline rules. Will overwrite any previously existing results (for all rules). Set a list of baseline rules. Will overwrite any previously existing results (for all rules).

EXEC azure.security.sql_vulnerability_assessment_baseline_rules.add 
@resource_id='{{ resource_id }}' --required, 
@databaseName='{{ databaseName }}' 
@@json=
'{
"latestScan": {{ latestScan }}, 
"results": "{{ results }}"
}'
;