standard_assignments

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

Overview

Name	standard_assignments
Type	Resource
Id	azure.security.standard_assignments

Fields

The following fields are returned by SELECT queries:

get

Returns information about the standard assignment.

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 standard assignments assignment
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

Standard assignment 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 standard assignments assignment
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	select	standardAssignmentName	resourceId	This operation retrieves a single standard assignment, given its name and the scope it was created at.
list	select	scope		Get a list of all relevant standard assignments over a scope
create	insert	standardAssignmentName	resourceId	This operation creates or updates a standard assignment with the given scope and name. standard assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.
delete	delete	standardAssignmentName	resourceId	This operation deletes a standard assignment, given its name and the scope it was created in. The scope of a standard assignment is the part of its ID preceding '/providers/Microsoft.Security/standardAssignments/{standardAssignmentName}'.

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})'
standardAssignmentName	string	The standard assignments assignment key - unique key for the standard assignment
resourceId	string	Optional filter for listing the assignments of a specific resource.

SELECT examples

get

This operation retrieves a single standard assignment, given its name and the scope it was created at.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.standard_assignments
WHERE standardAssignmentName = '{{ standardAssignmentName }}' -- required
AND resourceId = '{{ resourceId }}'
;

list

Get a list of all relevant standard assignments over a scope

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

INSERT examples

create

This operation creates or updates a standard assignment with the given scope and name. standard assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.

INSERT INTO azure.security.standard_assignments (
data__properties,
standardAssignmentName,
resourceId
)
SELECT 
'{{ properties }}',
'{{ standardAssignmentName }}',
'{{ resourceId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: standard_assignments
  props:
    - name: standardAssignmentName
      value: string
      description: Required parameter for the standard_assignments resource.
    - name: properties
      value: object
      description: |
        Properties of a standard assignments assignment
    - name: resourceId
      value: string
      description: Optional filter for listing the assignments of a specific resource.

DELETE examples

delete

This operation deletes a standard assignment, given its name and the scope it was created in. The scope of a standard assignment is the part of its ID preceding '/providers/Microsoft.Security/standardAssignments/{standardAssignmentName}'.

DELETE FROM azure.security.standard_assignments
WHERE standardAssignmentName = '{{ standardAssignmentName }}' --required
AND resourceId = '{{ resourceId }}'
;