assessments_metadata

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

Overview

Name	assessments_metadata
Type	Resource
Id	azure.security.assessments_metadata

Fields

vw_assessments_metadata

Name	Datatype	Description
id	text	Resource Id
name	text	Resource name
description	text	field from the properties object
assessmentMetadataName	text	field from the properties object
assessment_type	text	field from the properties object
categories	text	field from the properties object
display_name	text	field from the properties object
implementation_effort	text	field from the properties object
partner_data	text	field from the properties object
planned_deprecation_date	text	field from the properties object
policy_definition_id	text	field from the properties object
preview	text	field from the properties object
publish_dates	text	field from the properties object
remediation_description	text	field from the properties object
severity	text	field from the properties object
subscriptionId	text	field from the properties object
tactics	text	field from the properties object
techniques	text	field from the properties object
threats	text	field from the properties object
type	text	Resource type
user_impact	text	field from the properties object

assessments_metadata

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
properties	object	Describes properties of an assessment metadata response.
type	string	Resource type

Methods

Name	Accessible by	Required Params	Description
get	SELECT	assessmentMetadataName	Get metadata information on an assessment type
get_in_subscription	SELECT	assessmentMetadataName, subscriptionId	Get metadata information on an assessment type in a specific subscription
list	SELECT		Get metadata information on all assessment types
list_by_subscription	SELECT	subscriptionId	Get metadata information on all assessment types in a specific subscription
create_in_subscription	INSERT	assessmentMetadataName, subscriptionId	Create metadata information on an assessment type in a specific subscription
delete_in_subscription	DELETE	assessmentMetadataName, subscriptionId	Delete metadata information on an assessment type in a specific subscription, will cause the deletion of all the assessments of that type in that subscription

SELECT examples

Get metadata information on all assessment types

vw_assessments_metadata

SELECT
id,
name,
description,
assessmentMetadataName,
assessment_type,
categories,
display_name,
implementation_effort,
partner_data,
planned_deprecation_date,
policy_definition_id,
preview,
publish_dates,
remediation_description,
severity,
subscriptionId,
tactics,
techniques,
threats,
type,
user_impact
FROM azure.security.vw_assessments_metadata
;

assessments_metadata

SELECT
id,
name,
properties,
type
FROM azure.security.assessments_metadata
;

INSERT example

Use the following StackQL query and manifest file to create a new assessments_metadata resource.

All Properties

/*+ create */
INSERT INTO azure.security.assessments_metadata (
assessmentMetadataName,
subscriptionId,
properties
)
SELECT 
'{{ assessmentMetadataName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: publishDates
          value:
            - name: GA
              value: string
            - name: public
              value: string
        - name: plannedDeprecationDate
          value: string
        - name: tactics
          value:
            - string
        - name: techniques
          value:
            - string
        - name: displayName
          value: string
        - name: policyDefinitionId
          value: string
        - name: description
          value: string
        - name: remediationDescription
          value: string
        - name: categories
          value:
            - string
        - name: severity
          value: string
        - name: userImpact
          value: string
        - name: implementationEffort
          value: string
        - name: threats
          value:
            - string
        - name: preview
          value: boolean
        - name: assessmentType
          value: string
        - name: partnerData
          value:
            - name: partnerName
              value: string
            - name: productName
              value: string
            - name: secret
              value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string

DELETE example

Deletes the specified assessments_metadata resource.

/*+ delete */
DELETE FROM azure.security.assessments_metadata
WHERE assessmentMetadataName = '{{ assessmentMetadataName }}'
AND subscriptionId = '{{ subscriptionId }}';