hcrp_assignment_reports

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

Overview

Name	hcrp_assignment_reports
Type	Resource
Id	azure.guest_configuration.hcrp_assignment_reports

Fields

The following fields are returned by SELECT queries:

get

OK. This response is due one of these two reasons: 1. Report was returned successfully 2. Guest configuration assignment was found, but machine is not registered yet, hence no report was returned.

Name	Datatype	Description
id	string	ARM resource id of the report for the guest configuration assignment.
name	string	GUID that identifies the guest configuration assignment report under a subscription, resource group.
properties	object	Properties of the guest configuration report.

list

OK. This response is due one of these two reasons: 1. Reports were returned successfully 2. Guest configuration assignment was found, but machine is not registered yet, hence no reports returned.

Name	Datatype	Description
id	string	ARM resource id of the report for the guest configuration assignment.
name	string	GUID that identifies the guest configuration assignment report under a subscription, resource group.
properties	object	Properties of the guest configuration report.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, guestConfigurationAssignmentName, reportId, subscriptionId, machineName		Get a report for the guest configuration assignment, by reportId.
list	select	resourceGroupName, guestConfigurationAssignmentName, subscriptionId, machineName		List all reports for the guest configuration assignment, latest report first.

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	The guest configuration assignment name.
machineName	string	The name of the ARC machine.
reportId	string	The GUID for the guest configuration assignment report.
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 a report for the guest configuration assignment, by reportId.

SELECT
id,
name,
properties
FROM azure.guest_configuration.hcrp_assignment_reports
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND guestConfigurationAssignmentName = '{{ guestConfigurationAssignmentName }}' -- required
AND reportId = '{{ reportId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND machineName = '{{ machineName }}' -- required
;

list

List all reports for the guest configuration assignment, latest report first.

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