server_vulnerability_assessments

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

Overview

Name	server_vulnerability_assessments
Type	Resource
Id	azure.security.server_vulnerability_assessments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	describes ServerVulnerabilityAssessment properties.
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_extended_resource

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	describes ServerVulnerabilityAssessment properties.
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	subscriptionId, resourceGroupName, resourceNamespace, resourceType, resourceName, serverVulnerabilityAssessment	api-version	Gets a server vulnerability assessment onboarding statuses on a given resource.
list_by_extended_resource	select	subscriptionId, resourceGroupName, resourceNamespace, resourceType, resourceName	api-version	Gets a list of server vulnerability assessment onboarding statuses on a given resource.
create_or_update	insert	subscriptionId, resourceGroupName, resourceNamespace, resourceType, resourceName, serverVulnerabilityAssessment	api-version	Creating a server vulnerability assessment on a resource, which will onboard a resource for having a vulnerability assessment on it
delete	delete	subscriptionId, resourceGroupName, resourceNamespace, resourceType, resourceName, serverVulnerabilityAssessment	api-version	Removing server vulnerability assessment from a 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
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
resourceName	string	Name of the resource.
resourceNamespace	string	The Namespace of the resource.
resourceType	string	The type of the resource.
serverVulnerabilityAssessment	string	ServerVulnerabilityAssessment status. only a 'default' value is supported.
subscriptionId	string	Azure subscription ID
api-version	string	API version for the operation

SELECT examples

get

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

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.server_vulnerability_assessments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceNamespace = '{{ resourceNamespace }}' -- required
AND resourceType = '{{ resourceType }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND serverVulnerabilityAssessment = '{{ serverVulnerabilityAssessment }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_extended_resource

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

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.server_vulnerability_assessments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceNamespace = '{{ resourceNamespace }}' -- required
AND resourceType = '{{ resourceType }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND api-version = '{{ api-version }}'
;

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_assessments (
subscriptionId,
resourceGroupName,
resourceNamespace,
resourceType,
resourceName,
serverVulnerabilityAssessment,
api-version
)
SELECT 
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceNamespace }}',
'{{ resourceType }}',
'{{ resourceName }}',
'{{ serverVulnerabilityAssessment }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_vulnerability_assessments
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the server_vulnerability_assessments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the server_vulnerability_assessments resource.
    - name: resourceNamespace
      value: string
      description: Required parameter for the server_vulnerability_assessments resource.
    - name: resourceType
      value: string
      description: Required parameter for the server_vulnerability_assessments resource.
    - name: resourceName
      value: string
      description: Required parameter for the server_vulnerability_assessments resource.
    - name: serverVulnerabilityAssessment
      value: string
      description: Required parameter for the server_vulnerability_assessments resource.
    - name: api-version
      value: string
      description: API version for the operation

DELETE examples

delete

Removing server vulnerability assessment from a resource.

DELETE FROM azure.security.server_vulnerability_assessments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceNamespace = '{{ resourceNamespace }}' --required
AND resourceType = '{{ resourceType }}' --required
AND resourceName = '{{ resourceName }}' --required
AND serverVulnerabilityAssessment = '{{ serverVulnerabilityAssessment }}' --required
AND api-version = '{{ api-version }}'
;