server_vulnerability_assessment

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

Overview

Name	server_vulnerability_assessment
Type	Resource
Id	azure.security.server_vulnerability_assessment

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.
provisioningState	string	The provisioningState of the vulnerability assessment capability on the VM. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", and "Deprovisioning". (Succeeded, Failed, Canceled, Provisioning, Deprovisioning)
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, resource_namespace, resource_type, resource_name, subscription_id		Gets a server vulnerability assessment onboarding statuses on a given resource.
create_or_update	insert	resource_group_name, resource_namespace, resource_type, resource_name, subscription_id		Creating a server vulnerability assessment on a resource, which will onboard a resource for having a vulnerability assessment on it.
create_or_update	replace	resource_group_name, resource_namespace, resource_type, resource_name, subscription_id		Creating a server vulnerability assessment on a resource, which will onboard a resource for having a vulnerability assessment on it.
delete	delete	resource_group_name, resource_namespace, resource_type, resource_name, subscription_id		Removing server vulnerability assessment from a resource.
list_by_extended_resource	exec	resource_group_name, resource_namespace, resource_type, resource_name, subscription_id		Gets a list of server vulnerability assessment onboarding statuses on a given resource.

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.
resource_name	string	The name of the resource. Required.
resource_namespace	string	The parent resource provider namespace. Required.
resource_type	string	The type of the resource. Required.
subscription_id	string

SELECT examples

get

Gets a server vulnerability assessment onboarding statuses on a given resource.

SELECT
id,
name,
provisioningState,
systemData,
type
FROM azure.security.server_vulnerability_assessment
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_namespace = '{{ resource_namespace }}' -- required
AND resource_type = '{{ resource_type }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creating a server vulnerability assessment on a resource, which will onboard a resource for having a vulnerability assessment on it.

INSERT INTO azure.security.server_vulnerability_assessment (
resource_group_name,
resource_namespace,
resource_type,
resource_name,
subscription_id
)
SELECT 
'{{ resource_group_name }}',
'{{ resource_namespace }}',
'{{ resource_type }}',
'{{ resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_vulnerability_assessment
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the server_vulnerability_assessment resource.
  - name: resource_namespace
    value: "{{ resource_namespace }}"
    description: Required parameter for the server_vulnerability_assessment resource.
  - name: resource_type
    value: "{{ resource_type }}"
    description: Required parameter for the server_vulnerability_assessment resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the server_vulnerability_assessment resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_vulnerability_assessment resource.

REPLACE examples

create_or_update

Creating a server vulnerability assessment on a resource, which will onboard a resource for having a vulnerability assessment on it.

REPLACE azure.security.server_vulnerability_assessment
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_namespace = '{{ resource_namespace }}' --required
AND resource_type = '{{ resource_type }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Removing server vulnerability assessment from a resource.

DELETE FROM azure.security.server_vulnerability_assessment
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_namespace = '{{ resource_namespace }}' --required
AND resource_type = '{{ resource_type }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_by_extended_resource

Gets a list of server vulnerability assessment onboarding statuses on a given resource.

EXEC azure.security.server_vulnerability_assessment.list_by_extended_resource 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_namespace='{{ resource_namespace }}' --required, 
@resource_type='{{ resource_type }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;