sql_vulnerability_assessments_settings

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

Overview

Name	sql_vulnerability_assessments_settings
Type	Resource
Id	azure.sql.sql_vulnerability_assessments_settings

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.
state	string	Specifies the state of the SQL Vulnerability Assessment, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
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_by_server

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.
state	string	Specifies the state of the SQL Vulnerability Assessment, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
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_group_name, server_name, vulnerability_assessment_name, subscription_id		Gets SQL Vulnerability Assessment policy.
list_by_server	select	resource_group_name, server_name, subscription_id		Lists SQL Vulnerability Assessment policies associated with a server.
create_or_update	insert	resource_group_name, server_name, vulnerability_assessment_name, subscription_id		Creates or updates SQL Vulnerability Assessment policy.
create_or_update	replace	resource_group_name, server_name, vulnerability_assessment_name, subscription_id		Creates or updates SQL Vulnerability Assessment policy.

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_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string
vulnerability_assessment_name	string	The name of the SQL Vulnerability Assessment. "default" Required.

SELECT examples

get

Gets SQL Vulnerability Assessment policy.

SELECT
id,
name,
state,
systemData,
type
FROM azure.sql.sql_vulnerability_assessments_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND vulnerability_assessment_name = '{{ vulnerability_assessment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Lists SQL Vulnerability Assessment policies associated with a server.

SELECT
id,
name,
state,
systemData,
type
FROM azure.sql.sql_vulnerability_assessments_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates SQL Vulnerability Assessment policy.

INSERT INTO azure.sql.sql_vulnerability_assessments_settings (
properties,
resource_group_name,
server_name,
vulnerability_assessment_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ vulnerability_assessment_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: sql_vulnerability_assessments_settings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sql_vulnerability_assessments_settings resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the sql_vulnerability_assessments_settings resource.
  - name: vulnerability_assessment_name
    value: "{{ vulnerability_assessment_name }}"
    description: Required parameter for the sql_vulnerability_assessments_settings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sql_vulnerability_assessments_settings resource.
  - name: properties
    description: |
      Resource properties.
    value:
      state: "{{ state }}"

REPLACE examples

create_or_update

Creates or updates SQL Vulnerability Assessment policy.

REPLACE azure.sql.sql_vulnerability_assessments_settings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND vulnerability_assessment_name = '{{ vulnerability_assessment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;