configuration_profile_assignments

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

Overview

Name	configuration_profile_assignments
Type	Resource
Id	azure.automanage.configuration_profile_assignments

Fields

The following fields are returned by SELECT queries:

get

OK. The configuration profile assignment was returned successfully.

Name	Datatype	Description
managedBy	string	Azure resource id. Indicates if this resource is managed by another Azure resource.
properties	object	Properties of the configuration profile assignment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

list_by_virtual_machines

OK. The list of configuration profile assignments were returned successfully.

Name	Datatype	Description
managedBy	string	Azure resource id. Indicates if this resource is managed by another Azure resource.
properties	object	Properties of the configuration profile assignment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

list_by_machine_name

OK. The list of configuration profile assignments were returned successfully.

Name	Datatype	Description
managedBy	string	Azure resource id. Indicates if this resource is managed by another Azure resource.
properties	object	Properties of the configuration profile assignment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

list_by_cluster_name

OK. The list of configuration profile assignments were returned successfully.

Name	Datatype	Description
managedBy	string	Azure resource id. Indicates if this resource is managed by another Azure resource.
properties	object	Properties of the configuration profile assignment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

list

OK. The list of configuration profile assignments were returned successfully.

Name	Datatype	Description
managedBy	string	Azure resource id. Indicates if this resource is managed by another Azure resource.
properties	object	Properties of the configuration profile assignment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

list_by_subscription

OK. The list of configuration profile assignments were returned successfully.

Name	Datatype	Description
managedBy	string	Azure resource id. Indicates if this resource is managed by another Azure resource.
properties	object	Properties of the configuration profile assignment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, configurationProfileAssignmentName, subscriptionId, vmName		Get information about a configuration profile assignment
list_by_virtual_machines	select	subscriptionId, resourceGroupName, vmName		Get list of configuration profile assignments
list_by_machine_name	select	subscriptionId, resourceGroupName, machineName		Get list of configuration profile assignments
list_by_cluster_name	select	subscriptionId, resourceGroupName, clusterName		Get list of configuration profile assignments
list	select	resourceGroupName, subscriptionId		Get list of configuration profile assignments
list_by_subscription	select	subscriptionId		Get list of configuration profile assignments under a given subscription
create_or_update	insert	configurationProfileAssignmentName, subscriptionId, resourceGroupName, vmName		Creates an association between a VM and Automanage configuration profile
delete	delete	resourceGroupName, configurationProfileAssignmentName, subscriptionId, vmName		Delete a configuration profile assignment

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
clusterName	string	The name of the Arc machine.
configurationProfileAssignmentName	string	Name of the configuration profile assignment
machineName	string	The name of the Arc machine.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
vmName	string	The name of the virtual machine.

SELECT examples

get

Get information about a configuration profile assignment

SELECT
managedBy,
properties,
systemData
FROM azure.automanage.configuration_profile_assignments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND configurationProfileAssignmentName = '{{ configurationProfileAssignmentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND vmName = '{{ vmName }}' -- required
;

list_by_virtual_machines

Get list of configuration profile assignments

SELECT
managedBy,
properties,
systemData
FROM azure.automanage.configuration_profile_assignments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vmName = '{{ vmName }}' -- required
;

list_by_machine_name

Get list of configuration profile assignments

SELECT
managedBy,
properties,
systemData
FROM azure.automanage.configuration_profile_assignments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND machineName = '{{ machineName }}' -- required
;

list_by_cluster_name

Get list of configuration profile assignments

SELECT
managedBy,
properties,
systemData
FROM azure.automanage.configuration_profile_assignments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;

list

Get list of configuration profile assignments

SELECT
managedBy,
properties,
systemData
FROM azure.automanage.configuration_profile_assignments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Get list of configuration profile assignments under a given subscription

SELECT
managedBy,
properties,
systemData
FROM azure.automanage.configuration_profile_assignments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates an association between a VM and Automanage configuration profile

INSERT INTO azure.automanage.configuration_profile_assignments (
data__properties,
configurationProfileAssignmentName,
subscriptionId,
resourceGroupName,
vmName
)
SELECT 
'{{ properties }}',
'{{ configurationProfileAssignmentName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vmName }}'
RETURNING
managedBy,
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: configuration_profile_assignments
  props:
    - name: configurationProfileAssignmentName
      value: string
      description: Required parameter for the configuration_profile_assignments resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the configuration_profile_assignments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the configuration_profile_assignments resource.
    - name: vmName
      value: string
      description: Required parameter for the configuration_profile_assignments resource.
    - name: properties
      value: object
      description: |
        Properties of the configuration profile assignment.

DELETE examples

delete

Delete a configuration profile assignment

DELETE FROM azure.automanage.configuration_profile_assignments
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND configurationProfileAssignmentName = '{{ configurationProfileAssignmentName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND vmName = '{{ vmName }}' --required
;