standards

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

Overview

Name	standards
Type	Resource
Id	azure.security.standards

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.
category	string	category of the standard provided.
components	array	List of component objects containing component unique keys (such as assessment keys) to apply to standard scope. Currently only supports assessment keys.
description	string	description of the standard.
displayName	string	display name of the standard, equivalent to the standardId.
etag	string	Entity tag is used for comparing two or more entities from the same requested resource.
kind	string	Kind of the resource.
location	string	The geo-location where the resource lives.
standardType	string	standard type (Custom or BuiltIn only currently).
supportedClouds	array	List of all standard supported clouds.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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.
category	string	category of the standard provided.
components	array	List of component objects containing component unique keys (such as assessment keys) to apply to standard scope. Currently only supports assessment keys.
description	string	description of the standard.
displayName	string	display name of the standard, equivalent to the standardId.
etag	string	Entity tag is used for comparing two or more entities from the same requested resource.
kind	string	Kind of the resource.
location	string	The geo-location where the resource lives.
standardType	string	standard type (Custom or BuiltIn only currently).
supportedClouds	array	List of all standard supported clouds.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
category	string	category of the standard provided.
components	array	List of component objects containing component unique keys (such as assessment keys) to apply to standard scope. Currently only supports assessment keys.
description	string	description of the standard.
displayName	string	display name of the standard, equivalent to the standardId.
etag	string	Entity tag is used for comparing two or more entities from the same requested resource.
kind	string	Kind of the resource.
location	string	The geo-location where the resource lives.
standardType	string	standard type (Custom or BuiltIn only currently).
supportedClouds	array	List of all standard supported clouds.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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_group_name, standard_id, subscription_id		Get a specific security standard for the requested scope.
list	select	resource_group_name, subscription_id		Get security standards on all your resources inside a scope.
list_by_subscription	select	subscription_id		Get a list of all relevant security standards over a subscription level scope.
create_or_update	insert	resource_group_name, standard_id, subscription_id		Create a security standard on the given scope. Available only for custom standards. Will create/update the required standard definitions.
create_or_update	replace	resource_group_name, standard_id, subscription_id		Create a security standard on the given scope. Available only for custom standards. Will create/update the required standard definitions.
delete	delete	resource_group_name, standard_id, subscription_id		Delete a security standard on a scope.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
standard_id	string	The Security Standard key - unique key for the standard type. Required.
subscription_id	string

SELECT examples

get

Get a specific security standard for the requested scope.

SELECT
id,
name,
category,
components,
description,
displayName,
etag,
kind,
location,
standardType,
supportedClouds,
systemData,
tags,
type
FROM azure.security.standards
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND standard_id = '{{ standard_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get security standards on all your resources inside a scope.

SELECT
id,
name,
category,
components,
description,
displayName,
etag,
kind,
location,
standardType,
supportedClouds,
systemData,
tags,
type
FROM azure.security.standards
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Get a list of all relevant security standards over a subscription level scope.

SELECT
id,
name,
category,
components,
description,
displayName,
etag,
kind,
location,
standardType,
supportedClouds,
systemData,
tags,
type
FROM azure.security.standards
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a security standard on the given scope. Available only for custom standards. Will create/update the required standard definitions.

INSERT INTO azure.security.standards (
properties,
tags,
location,
kind,
etag,
resource_group_name,
standard_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ kind }}',
'{{ etag }}',
'{{ resource_group_name }}',
'{{ standard_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: standards
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the standards resource.
  - name: standard_id
    value: "{{ standard_id }}"
    description: Required parameter for the standards resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the standards resource.
  - name: properties
    description: |
      Properties of a security standard.
    value:
      displayName: "{{ displayName }}"
      standardType: "{{ standardType }}"
      description: "{{ description }}"
      category: "{{ category }}"
      components:
        - key: "{{ key }}"
      supportedClouds:
        - "{{ supportedClouds }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives.
  - name: kind
    value: "{{ kind }}"
    description: |
      Kind of the resource.
  - name: etag
    value: "{{ etag }}"
    description: |
      Entity tag is used for comparing two or more entities from the same requested resource.

REPLACE examples

create_or_update

Create a security standard on the given scope. Available only for custom standards. Will create/update the required standard definitions.

REPLACE azure.security.standards
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
location = '{{ location }}',
kind = '{{ kind }}',
etag = '{{ etag }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND standard_id = '{{ standard_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a security standard on a scope.

DELETE FROM azure.security.standards
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND standard_id = '{{ standard_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;