configuration_assignments

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

Overview

Name	configuration_assignments
Type	Resource
Id	azure.maintenance.configuration_assignments

Fields

The following fields are returned by SELECT queries:

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
location	string	Location of the resource
properties	object	Properties of the configuration assignment
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 (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
location	string	Location of the resource
properties	object	Properties of the configuration assignment
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	subscriptionId, resourceGroupName, providerName, resourceType, resourceName, configurationAssignmentName		Get configuration assignment for resource..
list	select	subscriptionId, resourceGroupName, providerName, resourceType, resourceName		List configurationAssignments for resource.
create_or_update	insert	subscriptionId, resourceGroupName, providerName, resourceType, resourceName, configurationAssignmentName		Register configuration for resource.
delete	delete	subscriptionId, resourceGroupName, providerName, resourceType, resourceName, configurationAssignmentName		Unregister configuration for resource.

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
configurationAssignmentName	string	Unique configuration assignment name
providerName	string	Resource provider name
resourceGroupName	string	Resource group name
resourceName	string	Resource identifier
resourceType	string	Resource type
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get configuration assignment for resource..

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.maintenance.configuration_assignments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND providerName = '{{ providerName }}' -- required
AND resourceType = '{{ resourceType }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND configurationAssignmentName = '{{ configurationAssignmentName }}' -- required
;

list

List configurationAssignments for resource.

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.maintenance.configuration_assignments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND providerName = '{{ providerName }}' -- required
AND resourceType = '{{ resourceType }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

INSERT examples

create_or_update

Register configuration for resource.

INSERT INTO azure.maintenance.configuration_assignments (
data__location,
data__properties,
subscriptionId,
resourceGroupName,
providerName,
resourceType,
resourceName,
configurationAssignmentName
)
SELECT 
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ providerName }}',
'{{ resourceType }}',
'{{ resourceName }}',
'{{ configurationAssignmentName }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: configuration_assignments
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the configuration_assignments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the configuration_assignments resource.
    - name: providerName
      value: string
      description: Required parameter for the configuration_assignments resource.
    - name: resourceType
      value: string
      description: Required parameter for the configuration_assignments resource.
    - name: resourceName
      value: string
      description: Required parameter for the configuration_assignments resource.
    - name: configurationAssignmentName
      value: string
      description: Required parameter for the configuration_assignments resource.
    - name: location
      value: string
      description: |
        Location of the resource
    - name: properties
      value: object
      description: |
        Properties of the configuration assignment

DELETE examples

delete

Unregister configuration for resource.

DELETE FROM azure.maintenance.configuration_assignments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND providerName = '{{ providerName }}' --required
AND resourceType = '{{ resourceType }}' --required
AND resourceName = '{{ resourceName }}' --required
AND configurationAssignmentName = '{{ configurationAssignmentName }}' --required
;