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

Security standard successfully created

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	Properties of a security standard
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

Security standards list by scope

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	Properties of a security standard
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	scope, standardId		Get a specific security standard for the requested scope by standardId
list	select	scope		Get a list of all relevant security standards over a scope
create_or_update	insert	scope, standardId		Creates or updates a security standard over a given scope
delete	delete	scope, standardId		Delete a security standard over a given 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
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})'
standardId	string	The Security Standard key - unique key for the standard type

SELECT examples

get

Get a specific security standard for the requested scope by standardId

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

list

Get a list of all relevant security standards over a scope

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

INSERT examples

create_or_update

Creates or updates a security standard over a given scope

INSERT INTO azure.security.standards (
data__properties,
scope,
standardId
)
SELECT 
'{{ properties }}',
'{{ scope }}',
'{{ standardId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: standards
  props:
    - name: scope
      value: string
      description: Required parameter for the standards resource.
    - name: standardId
      value: string
      description: Required parameter for the standards resource.
    - name: properties
      value: object
      description: |
        Properties of a security standard

DELETE examples

delete

Delete a security standard over a given scope

DELETE FROM azure.security.standards
WHERE scope = '{{ scope }}' --required
AND standardId = '{{ standardId }}' --required
;