hcrp_assignments

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

Overview

Name	hcrp_assignments
Type	Resource
Id	azure.guest_configuration.hcrp_assignments

Fields

The following fields are returned by SELECT queries:

get

OK. The guest configuration assignment was returned successfully.

Name	Datatype	Description
properties	object	Properties of the Guest configuration assignment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.

list

Name	Datatype	Description
properties	object	Properties of the Guest configuration 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, guestConfigurationAssignmentName, subscriptionId, machineName		Get information about a guest configuration assignment
list	select	resourceGroupName, subscriptionId, machineName		List all guest configuration assignments for an ARC machine.
create_or_update	insert	guestConfigurationAssignmentName, subscriptionId, resourceGroupName, machineName		Creates an association between a ARC machine and guest configuration
delete	delete	resourceGroupName, guestConfigurationAssignmentName, subscriptionId, machineName		Delete a guest configuration 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
guestConfigurationAssignmentName	string	Name of the guest configuration assignment
machineName	string	The name of the ARC machine.
resourceGroupName	string	The resource group name.
subscriptionId	string	Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Get information about a guest configuration assignment

SELECT
properties,
systemData
FROM azure.guest_configuration.hcrp_assignments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND guestConfigurationAssignmentName = '{{ guestConfigurationAssignmentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND machineName = '{{ machineName }}' -- required
;

list

List all guest configuration assignments for an ARC machine.

SELECT
properties,
systemData
FROM azure.guest_configuration.hcrp_assignments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND machineName = '{{ machineName }}' -- required
;

INSERT examples

create_or_update

Creates an association between a ARC machine and guest configuration

INSERT INTO azure.guest_configuration.hcrp_assignments (
data__properties,
guestConfigurationAssignmentName,
subscriptionId,
resourceGroupName,
machineName
)
SELECT 
'{{ properties }}',
'{{ guestConfigurationAssignmentName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ machineName }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: hcrp_assignments
  props:
    - name: guestConfigurationAssignmentName
      value: string
      description: Required parameter for the hcrp_assignments resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the hcrp_assignments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the hcrp_assignments resource.
    - name: machineName
      value: string
      description: Required parameter for the hcrp_assignments resource.
    - name: properties
      value: object
      description: |
        Properties of the Guest configuration assignment.

DELETE examples

delete

Delete a guest configuration assignment

DELETE FROM azure.guest_configuration.hcrp_assignments
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND guestConfigurationAssignmentName = '{{ guestConfigurationAssignmentName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND machineName = '{{ machineName }}' --required
;