hci_reports

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

Overview

Name	hci_reports
Type	Resource
Id	azure.automanage.hci_reports

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configurationProfile	string	The configurationProfile linked to the assignment.
duration	string	Duration of the configuration profile assignment processing.
endTime	string	End time of the configuration profile assignment processing.
error	object	Error message, if any, returned by the configuration profile assignment processing.
lastModifiedTime	string	Last modified time of the configuration profile assignment processing.
reportFormatVersion	string	Version of the report format.
resources	array	List of resources processed by the configuration profile assignment.
startTime	string	Start time of the configuration profile assignment processing.
status	string	The status of the configuration profile assignment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_configuration_profile_assignments

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configurationProfile	string	The configurationProfile linked to the assignment.
duration	string	Duration of the configuration profile assignment processing.
endTime	string	End time of the configuration profile assignment processing.
error	object	Error message, if any, returned by the configuration profile assignment processing.
lastModifiedTime	string	Last modified time of the configuration profile assignment processing.
reportFormatVersion	string	Version of the report format.
resources	array	List of resources processed by the configuration profile assignment.
startTime	string	Start time of the configuration profile assignment processing.
status	string	The status of the configuration profile assignment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, configuration_profile_assignment_name, report_name, subscription_id		Get information about a report associated with a configuration profile assignment run.
list_by_configuration_profile_assignments	select	resource_group_name, cluster_name, configuration_profile_assignment_name, subscription_id		Retrieve a list of reports within a given 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
cluster_name	string	The name of the Arc machine. Required.
configuration_profile_assignment_name	string	The configuration profile assignment name. Required.
report_name	string	The report name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get information about a report associated with a configuration profile assignment run.

SELECT
id,
name,
configurationProfile,
duration,
endTime,
error,
lastModifiedTime,
reportFormatVersion,
resources,
startTime,
status,
systemData,
type
FROM azure.automanage.hci_reports
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND configuration_profile_assignment_name = '{{ configuration_profile_assignment_name }}' -- required
AND report_name = '{{ report_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_configuration_profile_assignments

Retrieve a list of reports within a given configuration profile assignment.

SELECT
id,
name,
configurationProfile,
duration,
endTime,
error,
lastModifiedTime,
reportFormatVersion,
resources,
startTime,
status,
systemData,
type
FROM azure.automanage.hci_reports
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND configuration_profile_assignment_name = '{{ configuration_profile_assignment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;