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_parent

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.
filter	object	Properties of the configuration assignment.
location	string	Location of the resource.
maintenanceConfigurationId	string	The maintenance configuration Id.
resourceId	string	The unique resourceId.
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_parent

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.
filter	object	Properties of the configuration assignment.
location	string	Location of the resource.
maintenanceConfigurationId	string	The maintenance configuration Id.
resourceId	string	The unique resourceId.
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".

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.
filter	object	Properties of the configuration assignment.
location	string	Location of the resource.
maintenanceConfigurationId	string	The maintenance configuration Id.
resourceId	string	The unique resourceId.
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.
filter	object	Properties of the configuration assignment.
location	string	Location of the resource.
maintenanceConfigurationId	string	The maintenance configuration Id.
resourceId	string	The unique resourceId.
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_parent	select	resource_group_name, provider_name, resource_parent_type, resource_parent_name, resource_type, resource_name, configuration_assignment_name, subscription_id		Get configuration assignment for resource..
list_parent	select	resource_group_name, provider_name, resource_parent_type, resource_parent_name, resource_type, resource_name, subscription_id		List configurationAssignments for resource.
get	select	resource_group_name, provider_name, resource_type, resource_name, configuration_assignment_name, subscription_id		Get configuration assignment for resource..
list	select	resource_group_name, provider_name, resource_type, resource_name, subscription_id		Get Configuration records within a subscription and resource group. Get Configuration records within a subscription and resource group.
create_or_update	insert	resource_group_name, provider_name, resource_type, resource_name, configuration_assignment_name, subscription_id		Register configuration for resource.
create_or_update	replace	resource_group_name, provider_name, resource_type, resource_name, configuration_assignment_name, subscription_id		Register configuration for resource.
delete	delete	resource_group_name, provider_name, resource_type, resource_name, configuration_assignment_name, subscription_id		Unregister configuration for resource.
create_or_update_parent	exec	resource_group_name, provider_name, resource_parent_type, resource_parent_name, resource_type, resource_name, configuration_assignment_name, subscription_id		Register configuration for resource.
delete_parent	exec	resource_group_name, provider_name, resource_parent_type, resource_parent_name, resource_type, resource_name, configuration_assignment_name, subscription_id		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
configuration_assignment_name	string	The name of the ConfigurationAssignment. Required.
provider_name	string	Resource provider name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	Resource name. Required.
resource_parent_name	string	Resource parent name. Required.
resource_parent_type	string	Resource parent type. Required.
resource_type	string	Resource type. Required.
subscription_id	string

SELECT examples

get_parent

Get configuration assignment for resource..

SELECT
id,
name,
filter,
location,
maintenanceConfigurationId,
resourceId,
systemData,
type
FROM azure.maintenance.configuration_assignments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND provider_name = '{{ provider_name }}' -- required
AND resource_parent_type = '{{ resource_parent_type }}' -- required
AND resource_parent_name = '{{ resource_parent_name }}' -- required
AND resource_type = '{{ resource_type }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND configuration_assignment_name = '{{ configuration_assignment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_parent

List configurationAssignments for resource.

SELECT
id,
name,
filter,
location,
maintenanceConfigurationId,
resourceId,
systemData,
type
FROM azure.maintenance.configuration_assignments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND provider_name = '{{ provider_name }}' -- required
AND resource_parent_type = '{{ resource_parent_type }}' -- required
AND resource_parent_name = '{{ resource_parent_name }}' -- required
AND resource_type = '{{ resource_type }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get configuration assignment for resource..

SELECT
id,
name,
filter,
location,
maintenanceConfigurationId,
resourceId,
systemData,
type
FROM azure.maintenance.configuration_assignments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND provider_name = '{{ provider_name }}' -- required
AND resource_type = '{{ resource_type }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND configuration_assignment_name = '{{ configuration_assignment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get Configuration records within a subscription and resource group. Get Configuration records within a subscription and resource group.

SELECT
id,
name,
filter,
location,
maintenanceConfigurationId,
resourceId,
systemData,
type
FROM azure.maintenance.configuration_assignments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND provider_name = '{{ provider_name }}' -- required
AND resource_type = '{{ resource_type }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Register configuration for resource.

INSERT INTO azure.maintenance.configuration_assignments (
properties,
location,
resource_group_name,
provider_name,
resource_type,
resource_name,
configuration_assignment_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ resource_group_name }}',
'{{ provider_name }}',
'{{ resource_type }}',
'{{ resource_name }}',
'{{ configuration_assignment_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: configuration_assignments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the configuration_assignments resource.
  - name: provider_name
    value: "{{ provider_name }}"
    description: Required parameter for the configuration_assignments resource.
  - name: resource_type
    value: "{{ resource_type }}"
    description: Required parameter for the configuration_assignments resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the configuration_assignments resource.
  - name: configuration_assignment_name
    value: "{{ configuration_assignment_name }}"
    description: Required parameter for the configuration_assignments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the configuration_assignments resource.
  - name: properties
    description: |
      Properties of the configuration assignment.
    value:
      maintenanceConfigurationId: "{{ maintenanceConfigurationId }}"
      resourceId: "{{ resourceId }}"
      filter:
        resourceTypes:
          - "{{ resourceTypes }}"
        resourceGroups:
          - "{{ resourceGroups }}"
        osTypes:
          - "{{ osTypes }}"
        locations:
          - "{{ locations }}"
        tagSettings:
          tags: "{{ tags }}"
          filterOperator: "{{ filterOperator }}"
  - name: location
    value: "{{ location }}"
    description: |
      Location of the resource.

REPLACE examples

create_or_update

Register configuration for resource.

REPLACE azure.maintenance.configuration_assignments
SET 
properties = '{{ properties }}',
location = '{{ location }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND provider_name = '{{ provider_name }}' --required
AND resource_type = '{{ resource_type }}' --required
AND resource_name = '{{ resource_name }}' --required
AND configuration_assignment_name = '{{ configuration_assignment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
type;

DELETE examples

delete

Unregister configuration for resource.

DELETE FROM azure.maintenance.configuration_assignments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND provider_name = '{{ provider_name }}' --required
AND resource_type = '{{ resource_type }}' --required
AND resource_name = '{{ resource_name }}' --required
AND configuration_assignment_name = '{{ configuration_assignment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

create_or_update_parent

Register configuration for resource.

EXEC azure.maintenance.configuration_assignments.create_or_update_parent 
@resource_group_name='{{ resource_group_name }}' --required, 
@provider_name='{{ provider_name }}' --required, 
@resource_parent_type='{{ resource_parent_type }}' --required, 
@resource_parent_name='{{ resource_parent_name }}' --required, 
@resource_type='{{ resource_type }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@configuration_assignment_name='{{ configuration_assignment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"location": "{{ location }}"
}'
;

delete_parent

Unregister configuration for resource.

EXEC azure.maintenance.configuration_assignments.delete_parent 
@resource_group_name='{{ resource_group_name }}' --required, 
@provider_name='{{ provider_name }}' --required, 
@resource_parent_type='{{ resource_parent_type }}' --required, 
@resource_parent_name='{{ resource_parent_name }}' --required, 
@resource_type='{{ resource_type }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@configuration_assignment_name='{{ configuration_assignment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;