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

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.
recurringScans	object	The recurring scans settings.
storageAccountAccessKey	string	Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall.
storageContainerPath	string	A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/ _). Required.
storageContainerSasKey	string	A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall.
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.
recurringScans	object	The recurring scans settings.
storageAccountAccessKey	string	Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall.
storageContainerPath	string	A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/ _). Required.
storageContainerSasKey	string	A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall.
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 the server's vulnerability assessment.
list_by_server	select	resource_group_name, server_name, subscription_id		Lists the vulnerability assessment policies associated with a server.
create_or_update	insert	resource_group_name, server_name, vulnerability_assessment_name, subscription_id		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 _.
create_or_update	replace	resource_group_name, server_name, vulnerability_assessment_name, subscription_id		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	resource_group_name, server_name, vulnerability_assessment_name, subscription_id		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
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 vulnerability assessment. "default" Required.

SELECT examples

get

Gets the server's vulnerability assessment.

SELECT
id,
name,
recurringScans,
storageAccountAccessKey,
storageContainerPath,
storageContainerSasKey,
systemData,
type
FROM azure.sql.server_vulnerability_assessments
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 the vulnerability assessment policies associated with a server.

SELECT
id,
name,
recurringScans,
storageAccountAccessKey,
storageContainerPath,
storageContainerSasKey,
systemData,
type
FROM azure.sql.server_vulnerability_assessments
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 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 (
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: server_vulnerability_assessments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the server_vulnerability_assessments resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the server_vulnerability_assessments resource.
  - name: vulnerability_assessment_name
    value: "{{ vulnerability_assessment_name }}"
    description: Required parameter for the server_vulnerability_assessments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_vulnerability_assessments resource.
  - name: properties
    description: |
      Resource properties.
    value:
      storageContainerPath: "{{ storageContainerPath }}"
      storageContainerSasKey: "{{ storageContainerSasKey }}"
      storageAccountAccessKey: "{{ storageAccountAccessKey }}"
      recurringScans:
        isEnabled: {{ isEnabled }}
        emailSubscriptionAdmins: {{ emailSubscriptionAdmins }}
        emails:
          - "{{ emails }}"

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

REPLACE azure.sql.server_vulnerability_assessments
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;

DELETE examples

delete

Removes the server's vulnerability assessment.

DELETE FROM azure.sql.server_vulnerability_assessments
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
;