security_standards

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

Overview

Name	security_standards
Type	Resource
Id	azure.security.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.
assessments	array	List of assessment keys to apply to standard scope.
cloudProviders	array	List of all standard supported clouds.
description	string	Description of the standard.
displayName	string	Display name of the standard, equivalent to the standardId.
metadata	object	The security standard metadata.
policySetDefinitionId	string	The policy set definition id associated with the standard.
standardType	string	Standard type (Custom or Default or Compliance only currently). Known values are: "Custom", "Default", and "Compliance". (Custom, Default, Compliance)
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.
assessments	array	List of assessment keys to apply to standard scope.
cloudProviders	array	List of all standard supported clouds.
description	string	Description of the standard.
displayName	string	Display name of the standard, equivalent to the standardId.
metadata	object	The security standard metadata.
policySetDefinitionId	string	The policy set definition id associated with the standard.
standardType	string	Standard type (Custom or Default or Compliance only currently). Known values are: "Custom", "Default", and "Compliance". (Custom, Default, Compliance)
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, standard_id		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, standard_id		Creates or updates a security standard over a given scope.
create_or_update	replace	scope, standard_id		Creates or updates a security standard over a given scope.
delete	delete	scope, standard_id		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 fully qualified Azure Resource manager identifier of the resource. Required.
standard_id	string	The Security Standard key - unique key for the standard type. Required.

SELECT examples

get

Get a specific security standard for the requested scope by standardId.

SELECT
id,
name,
assessments,
cloudProviders,
description,
displayName,
metadata,
policySetDefinitionId,
standardType,
systemData,
type
FROM azure.security.security_standards
WHERE scope = '{{ scope }}' -- required
AND standard_id = '{{ standard_id }}' -- required
;

list

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

SELECT
id,
name,
assessments,
cloudProviders,
description,
displayName,
metadata,
policySetDefinitionId,
standardType,
systemData,
type
FROM azure.security.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.security_standards (
properties,
scope,
standard_id
)
SELECT 
'{{ properties }}',
'{{ scope }}',
'{{ standard_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: security_standards
props:
  - name: scope
    value: "{{ scope }}"
    description: Required parameter for the security_standards resource.
  - name: standard_id
    value: "{{ standard_id }}"
    description: Required parameter for the security_standards resource.
  - name: properties
    description: |
      Properties of a security standard.
    value:
      displayName: "{{ displayName }}"
      standardType: "{{ standardType }}"
      description: "{{ description }}"
      assessments:
        - assessmentKey: "{{ assessmentKey }}"
      cloudProviders:
        - "{{ cloudProviders }}"
      policySetDefinitionId: "{{ policySetDefinitionId }}"
      metadata:
        createdBy: "{{ createdBy }}"
        createdOn: "{{ createdOn }}"
        lastUpdatedBy: "{{ lastUpdatedBy }}"
        lastUpdatedOn: "{{ lastUpdatedOn }}"

REPLACE examples

create_or_update

Creates or updates a security standard over a given scope.

REPLACE azure.security.security_standards
SET 
properties = '{{ properties }}'
WHERE 
scope = '{{ scope }}' --required
AND standard_id = '{{ standard_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a security standard over a given scope.

DELETE FROM azure.security.security_standards
WHERE scope = '{{ scope }}' --required
AND standard_id = '{{ standard_id }}' --required
;