assignments

Creates, updates, deletes, gets or lists an assignments resource.

Overview

Name	assignments
Type	Resource
Id	azure.guest_configuration.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, vmName		Get information about a guest configuration assignment
list	select	resourceGroupName, subscriptionId, vmName		List all guest configuration assignments for a virtual machine.
create_or_update	insert	guestConfigurationAssignmentName, subscriptionId, resourceGroupName, vmName		Creates an association between a VM and guest configuration
delete	delete	resourceGroupName, guestConfigurationAssignmentName, subscriptionId, vmName		Delete a guest configuration assignment
subscription_list	exec	subscriptionId		List all guest configuration assignments for a subscription.
rg_list	exec	resourceGroupName, subscriptionId		List all guest configuration assignments for a resource group.

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
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.
vmName	string	The name of the virtual machine.

SELECT examples

get

Get information about a guest configuration assignment

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

list

List all guest configuration assignments for a virtual machine.

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

INSERT examples

create_or_update

Creates an association between a VM and guest configuration

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

Manifest

# Description fields are for documentation purposes
- name: assignments
  props:
    - name: guestConfigurationAssignmentName
      value: string
      description: Required parameter for the assignments resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the assignments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the assignments resource.
    - name: vmName
      value: string
      description: Required parameter for the 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.assignments
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND guestConfigurationAssignmentName = '{{ guestConfigurationAssignmentName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND vmName = '{{ vmName }}' --required
;

Lifecycle Methods

subscription_list

List all guest configuration assignments for a subscription.

EXEC azure.guest_configuration.assignments.subscription_list 
@subscriptionId='{{ subscriptionId }}' --required
;

rg_list

List all guest configuration assignments for a resource group.

EXEC azure.guest_configuration.assignments.rg_list 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;