assessments_metadata

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

Overview

Name	assessments_metadata
Type	Resource
Id	azure.security.assessments_metadata

Fields

The following fields are returned by SELECT queries:

get_in_subscription

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 metadata response.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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 metadata response.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_subscription

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 metadata response.
systemData	object	Metadata pertaining to creation and last modification of the resource.
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 metadata response.
systemData	object	Metadata pertaining to creation and last modification of the resource.
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_in_subscription	select	assessmentMetadataName, subscriptionId	api-version	Get metadata information on an assessment type in a specific subscription
get	select	assessmentMetadataName	api-version	Get metadata information on an assessment type
list_by_subscription	select	subscriptionId	api-version	Get metadata information on all assessment types in a specific subscription
list	select		api-version	Get metadata information on all assessment types
create_in_subscription	insert	assessmentMetadataName, subscriptionId	api-version	Create metadata information on an assessment type in a specific subscription
delete_in_subscription	delete	assessmentMetadataName, subscriptionId	api-version	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

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
assessmentMetadataName	string	The Assessment Key - Unique key for the assessment type
subscriptionId	string	Azure subscription ID
api-version	string	API version for the operation

SELECT examples

get_in_subscription

Get metadata information on an assessment type in a specific subscription

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

get

Get metadata information on an assessment type

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

list_by_subscription

Get metadata information on all assessment types in a specific subscription

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

list

Get metadata information on all assessment types

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

INSERT examples

create_in_subscription

Create metadata information on an assessment type in a specific subscription

INSERT INTO azure.security.assessments_metadata (
data__properties,
assessmentMetadataName,
subscriptionId,
api-version
)
SELECT 
'{{ properties }}',
'{{ assessmentMetadataName }}',
'{{ subscriptionId }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: assessments_metadata
  props:
    - name: assessmentMetadataName
      value: string
      description: Required parameter for the assessments_metadata resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the assessments_metadata resource.
    - name: properties
      value: object
      description: |
        Describes properties of an assessment metadata response.
    - name: api-version
      value: string
      description: API version for the operation

DELETE examples

delete_in_subscription

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

DELETE FROM azure.security.assessments_metadata
WHERE assessmentMetadataName = '{{ assessmentMetadataName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND api-version = '{{ api-version }}'
;