assessments

Creates, updates, deletes, gets or lists an assessments resource.

Overview

Name	assessments
Type	Resource
Id	azure.security.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 properties of an assessment.
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

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 properties of an assessment.
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	assessmentName	api-version, resourceId, $expand	Get a security assessment on your scanned resource
list	select	scope	api-version	Get security assessments on all your scanned resources inside a scope
create_or_update	insert	assessmentName	api-version, resourceId	Create a security assessment on your resource. An assessment metadata that describes this assessment must be predefined with the same name before inserting the assessment result
delete	delete	assessmentName	api-version, resourceId	Delete a security assessment on your resource. An assessment metadata that describes this assessment must be predefined with the same name before inserting the assessment result

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
assessmentName	string	The Assessment Key - Unique key for the assessment type
scope	string	The scope of the standard assignment. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'
$expand	string	OData expand. Optional.
api-version	string	API version for the operation
resourceId	string	Optional filter for listing the assignments of a specific resource.

SELECT examples

get

Get a security assessment on your scanned resource

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.assessments
WHERE assessmentName = '{{ assessmentName }}' -- required
AND api-version = '{{ api-version }}'
AND resourceId = '{{ resourceId }}'
AND $expand = '{{ $expand }}'
;

list

Get security assessments on all your scanned resources inside a scope

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.assessments
WHERE scope = '{{ scope }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Create a security assessment on your resource. An assessment metadata that describes this assessment must be predefined with the same name before inserting the assessment result

INSERT INTO azure.security.assessments (
data__properties,
assessmentName,
api-version,
resourceId
)
SELECT 
'{{ properties }}',
'{{ assessmentName }}',
'{{ api-version }}',
'{{ resourceId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: assessments
  props:
    - name: assessmentName
      value: string
      description: Required parameter for the assessments resource.
    - name: properties
      value: object
      description: |
        Describes properties of an assessment.
    - name: api-version
      value: string
      description: API version for the operation
    - name: resourceId
      value: string
      description: Optional filter for listing the assignments of a specific resource.

DELETE examples

delete

Delete a security assessment on your resource. An assessment metadata that describes this assessment must be predefined with the same name before inserting the assessment result

DELETE FROM azure.security.assessments
WHERE assessmentName = '{{ assessmentName }}' --required
AND api-version = '{{ api-version }}'
AND resourceId = '{{ resourceId }}'
;