server_vulnerability_assessments

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

Overview

Name	server_vulnerability_assessments
Type	Resource
Id	azure.sql.server_vulnerability_assessments

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the server vulnerability assessment.

Name	Datatype	Description
properties	object	Resource properties.

list_by_server

Successfully retrieved the server vulnerability assessment policies.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, vulnerabilityAssessmentName, subscriptionId		Gets the server's vulnerability assessment.
list_by_server	select	resourceGroupName, serverName, subscriptionId		Lists the vulnerability assessment policies associated with a server.
create_or_update	insert	resourceGroupName, serverName, vulnerabilityAssessmentName, subscriptionId		Creates or updates the server's vulnerability assessment. Learn more about setting SQL vulnerability assessment with managed identity - https://docs.microsoft.com/azure/azure-sql/database/sql-database-vulnerability-assessment-storage
delete	delete	resourceGroupName, serverName, vulnerabilityAssessmentName, subscriptionId		Removes the server's vulnerability assessment.

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
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	string	The name of the server for which the vulnerability assessment is defined.
subscriptionId	string	The subscription ID that identifies an Azure subscription.
vulnerabilityAssessmentName	string	The name of the vulnerability assessment.

SELECT examples

get

Gets the server's vulnerability assessment.

SELECT
properties
FROM azure.sql.server_vulnerability_assessments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND vulnerabilityAssessmentName = '{{ vulnerabilityAssessmentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_server

Lists the vulnerability assessment policies associated with a server.

SELECT
properties
FROM azure.sql.server_vulnerability_assessments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates the server's vulnerability assessment. Learn more about setting SQL vulnerability assessment with managed identity - https://docs.microsoft.com/azure/azure-sql/database/sql-database-vulnerability-assessment-storage

INSERT INTO azure.sql.server_vulnerability_assessments (
data__properties,
resourceGroupName,
serverName,
vulnerabilityAssessmentName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ vulnerabilityAssessmentName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: server_vulnerability_assessments
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the server_vulnerability_assessments resource.
    - name: serverName
      value: string
      description: Required parameter for the server_vulnerability_assessments resource.
    - name: vulnerabilityAssessmentName
      value: string
      description: Required parameter for the server_vulnerability_assessments resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the server_vulnerability_assessments resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Removes the server's vulnerability assessment.

DELETE FROM azure.sql.server_vulnerability_assessments
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND vulnerabilityAssessmentName = '{{ vulnerabilityAssessmentName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;