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	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalData	object	Additional data regarding the assessment.
displayName	string	User friendly display name of the assessment.
links	object	Links relevant to the assessment.
metadata	object	Describes properties of an assessment metadata.
partnersData	object	Data regarding 3rd party partner integration.
resourceDetails	object	Details of the resource that was assessed. Required.
risk	object	External model of risk result.
status	object	The result of the assessment. Required.
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	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalData	object	Additional data regarding the assessment.
displayName	string	User friendly display name of the assessment.
links	object	Links relevant to the assessment.
metadata	object	Describes properties of an assessment metadata.
partnersData	object	Data regarding 3rd party partner integration.
resourceDetails	object	Details of the resource that was assessed. Required.
risk	object	External model of risk result.
status	object	The result of the assessment. Required.
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_id, assessment_name	$expand	Get a security assessment on your scanned resource.
list	select	scope		Get security assessments on all your scanned resources inside a scope.
create_or_update	insert	resource_id, assessment_name		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.
create_or_update	replace	resource_id, assessment_name		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	resource_id, assessment_name		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
assessment_name	string	The Assessment Key - Unique key for the assessment type. Required.
resource_id	string	The fully qualified Azure Resource manager identifier of the resource. Required.
scope	string	The fully qualified Azure Resource manager identifier of the resource. Required.
$expand	string	OData expand. Optional. Known values are: "links" and "metadata". Default value is None.

SELECT examples

get

Get a security assessment on your scanned resource.

SELECT
id,
name,
additionalData,
displayName,
links,
metadata,
partnersData,
resourceDetails,
risk,
status,
systemData,
type
FROM azure.security.assessments
WHERE resource_id = '{{ resource_id }}' -- required
AND assessment_name = '{{ assessment_name }}' -- required
AND $expand = '{{ $expand }}'
;

list

Get security assessments on all your scanned resources inside a scope.

SELECT
id,
name,
additionalData,
displayName,
links,
metadata,
partnersData,
resourceDetails,
risk,
status,
systemData,
type
FROM azure.security.assessments
WHERE scope = '{{ scope }}' -- required
;

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 (
properties,
resource_id,
assessment_name
)
SELECT 
'{{ properties }}',
'{{ resource_id }}',
'{{ assessment_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: assessments
props:
  - name: resource_id
    value: "{{ resource_id }}"
    description: Required parameter for the assessments resource.
  - name: assessment_name
    value: "{{ assessment_name }}"
    description: Required parameter for the assessments resource.
  - name: properties
    description: |
      Describes properties of an assessment.
    value:
      risk:
        riskFactors:
          - "{{ riskFactors }}"
        level: "{{ level }}"
        attackPathsReferences:
          - "{{ attackPathsReferences }}"
        paths:
          - id: "{{ id }}"
            nodes: "{{ nodes }}"
            edges: "{{ edges }}"
        isContextualRisk: {{ isContextualRisk }}
      resourceDetails:
        source: "{{ source }}"
      displayName: "{{ displayName }}"
      additionalData: "{{ additionalData }}"
      links:
        azurePortalUri: "{{ azurePortalUri }}"
      metadata:
        displayName: "{{ displayName }}"
        policyDefinitionId: "{{ policyDefinitionId }}"
        description: "{{ description }}"
        remediationDescription: "{{ remediationDescription }}"
        categories:
          - "{{ categories }}"
        severity: "{{ severity }}"
        userImpact: "{{ userImpact }}"
        implementationEffort: "{{ implementationEffort }}"
        threats:
          - "{{ threats }}"
        preview: {{ preview }}
        assessmentType: "{{ assessmentType }}"
        partnerData:
          partnerName: "{{ partnerName }}"
          productName: "{{ productName }}"
          secret: "{{ secret }}"
      partnersData:
        partnerName: "{{ partnerName }}"
        secret: "{{ secret }}"
      status:
        code: "{{ code }}"
        cause: "{{ cause }}"
        description: "{{ description }}"

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

REPLACE azure.security.assessments
SET 
properties = '{{ properties }}'
WHERE 
resource_id = '{{ resource_id }}' --required
AND assessment_name = '{{ assessment_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

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 resource_id = '{{ resource_id }}' --required
AND assessment_name = '{{ assessment_name }}' --required
;