guest_configuration_assignments_vmss

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

Overview

Name	guest_configuration_assignments_vmss
Type	Resource
Id	azure.guest_config.guest_configuration_assignments_vmss

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	ARM resource id of the guest configuration assignment.
name	string	Name of the guest configuration assignment.
assignmentHash	string	Combined hash of the configuration package and parameters.
complianceStatus	string	A value indicating compliance status of the machine for the assigned guest configuration. Known values are: "Compliant", "NonCompliant", and "Pending".
context	string	The source which initiated the guest configuration assignment. Ex: Azure Policy.
guestConfiguration	object	The guest configuration to assign.
lastComplianceStatusChecked	string (date-time)	Date and time when last compliance status was checked.
latestAssignmentReport	object	Last reported guest configuration assignment report.
latestReportId	string	Id of the latest report for the guest configuration assignment.
location	string	Region where the VM is located.
parameterHash	string	parameter hash for the guest configuration assignment.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Succeeded", "Failed", "Canceled", and "Created".
resourceType	string	Type of the resource - VMSS / VM.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetResourceId	string	VM resource Id.
type	string	The type of the resource.
vmssVMList	array	The list of VM Compliance data for VMSS.

list

Name	Datatype	Description
id	string	ARM resource id of the guest configuration assignment.
name	string	Name of the guest configuration assignment.
assignmentHash	string	Combined hash of the configuration package and parameters.
complianceStatus	string	A value indicating compliance status of the machine for the assigned guest configuration. Known values are: "Compliant", "NonCompliant", and "Pending".
context	string	The source which initiated the guest configuration assignment. Ex: Azure Policy.
guestConfiguration	object	The guest configuration to assign.
lastComplianceStatusChecked	string (date-time)	Date and time when last compliance status was checked.
latestAssignmentReport	object	Last reported guest configuration assignment report.
latestReportId	string	Id of the latest report for the guest configuration assignment.
location	string	Region where the VM is located.
parameterHash	string	parameter hash for the guest configuration assignment.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Succeeded", "Failed", "Canceled", and "Created".
resourceType	string	Type of the resource - VMSS / VM.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetResourceId	string	VM resource Id.
type	string	The type of the resource.
vmssVMList	array	The list of VM Compliance data for VMSS.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, vmss_name, name, subscription_id		Get information about a guest configuration assignment for VMSS.
list	select	resource_group_name, vmss_name, subscription_id		List all guest configuration assignments for VMSS.
delete	delete	resource_group_name, vmss_name, name, subscription_id		Delete a guest configuration assignment for VMSS.

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
name	string	The guest configuration assignment name. Required.
resource_group_name	string	The resource group name. Required.
subscription_id	string
vmss_name	string	The name of the virtual machine scale set. Required.

SELECT examples

get

Get information about a guest configuration assignment for VMSS.

SELECT
id,
name,
assignmentHash,
complianceStatus,
context,
guestConfiguration,
lastComplianceStatusChecked,
latestAssignmentReport,
latestReportId,
location,
parameterHash,
provisioningState,
resourceType,
systemData,
targetResourceId,
type,
vmssVMList
FROM azure.guest_config.guest_configuration_assignments_vmss
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vmss_name = '{{ vmss_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all guest configuration assignments for VMSS.

SELECT
id,
name,
assignmentHash,
complianceStatus,
context,
guestConfiguration,
lastComplianceStatusChecked,
latestAssignmentReport,
latestReportId,
location,
parameterHash,
provisioningState,
resourceType,
systemData,
targetResourceId,
type,
vmssVMList
FROM azure.guest_config.guest_configuration_assignments_vmss
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vmss_name = '{{ vmss_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

delete

Delete a guest configuration assignment for VMSS.

DELETE FROM azure.guest_config.guest_configuration_assignments_vmss
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND vmss_name = '{{ vmss_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;