workspace_managed_sql_server_vulnerability_assessments

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

Overview

Name	workspace_managed_sql_server_vulnerability_assessments
Type	Resource
Id	azure.synapse.workspace_managed_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.
storageContainerPath	string	A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).
storageContainerSasKey	string	A shared access signature (SAS Key) that has read and write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.
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.
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.
storageContainerPath	string	A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).
storageContainerSasKey	string	A shared access signature (SAS Key) that has read and write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.
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, vulnerability_assessment_name, subscription_id		Get server's vulnerability assessment. Get workspace managed sql server's vulnerability assessment.
list	select	resource_group_name, workspace_name, subscription_id		Lists the vulnerability assessment policies associated with a server. Lists the vulnerability assessment policies associated with a workspace managed sql server.
create_or_update	insert	resource_group_name, workspace_name, vulnerability_assessment_name, subscription_id		Create or Update server's vulnerability assessment. Create or Update workspace managed sql server's vulnerability assessment.
create_or_update	replace	resource_group_name, workspace_name, vulnerability_assessment_name, subscription_id		Create or Update server's vulnerability assessment. Create or Update workspace managed sql server's vulnerability assessment.
delete	delete	resource_group_name, workspace_name, vulnerability_assessment_name, subscription_id		Remove server's vulnerability assessment. Remove workspace managed sql 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.
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

Get server's vulnerability assessment. Get workspace managed sql server's vulnerability assessment.

SELECT
id,
name,
recurringScans,
storageAccountAccessKey,
storageContainerPath,
storageContainerSasKey,
type
FROM azure.synapse.workspace_managed_sql_server_vulnerability_assessments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND vulnerability_assessment_name = '{{ vulnerability_assessment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists the vulnerability assessment policies associated with a server. Lists the vulnerability assessment policies associated with a workspace managed sql server.

SELECT
id,
name,
recurringScans,
storageAccountAccessKey,
storageContainerPath,
storageContainerSasKey,
type
FROM azure.synapse.workspace_managed_sql_server_vulnerability_assessments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or Update server's vulnerability assessment. Create or Update workspace managed sql server's vulnerability assessment.

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

Manifest

# Description fields are for documentation purposes
- name: workspace_managed_sql_server_vulnerability_assessments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_managed_sql_server_vulnerability_assessments resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the workspace_managed_sql_server_vulnerability_assessments resource.
  - name: vulnerability_assessment_name
    value: "{{ vulnerability_assessment_name }}"
    description: Required parameter for the workspace_managed_sql_server_vulnerability_assessments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_managed_sql_server_vulnerability_assessments resource.
  - name: properties
    value:
      storageContainerPath: "{{ storageContainerPath }}"
      storageContainerSasKey: "{{ storageContainerSasKey }}"
      storageAccountAccessKey: "{{ storageAccountAccessKey }}"
      recurringScans:
        isEnabled: {{ isEnabled }}
        emailSubscriptionAdmins: {{ emailSubscriptionAdmins }}
        emails:
          - "{{ emails }}"

REPLACE examples

create_or_update

Create or Update server's vulnerability assessment. Create or Update workspace managed sql server's vulnerability assessment.

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

DELETE examples

delete

Remove server's vulnerability assessment. Remove workspace managed sql server's vulnerability assessment.

DELETE FROM azure.synapse.workspace_managed_sql_server_vulnerability_assessments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND vulnerability_assessment_name = '{{ vulnerability_assessment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;