Guest Configuration Assignment Reports - List

Reference

Service:: Guest Configuration

API Version:: 2022-01-25

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports?api-version=2022-01-25

URI Parameters

Name	In	Required	Type	Description
guestConfigurationAssignmentName	path	True	string	The guest configuration assignment name.
resourceGroupName	path	True	string	The resource group name. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vmName	path	True	string	The name of the virtual machine. Regex pattern: `^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$`
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	GuestConfigurationAssignmentReportList	OK. This response is due one of these two reasons: 1. Reports were returned successfully 2. Guest configuration assignment was found, but VM is not registered yet, hence no reports returned.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List all guest configuration assignments for a virtual machine

Sample Request

GET https://management.azure.com/subscriptions/mySubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports?api-version=2022-01-25

package armguestconfiguration_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/guestconfiguration/armguestconfiguration"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2022-01-25/examples/listAllGuestConfigurationAssignmentReports.json
func ExampleAssignmentReportsClient_List() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armguestconfiguration.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAssignmentReportsClient().List(ctx, "myResourceGroupName", "AuditSecureProtocol", "myVMName", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AssignmentReportList = armguestconfiguration.AssignmentReportList{
	// 	Value: []*armguestconfiguration.AssignmentReport{
	// 		{
	// 			Name: to.Ptr("7367cbb8-ae99-47d0-a33b-a283564d2cb1"),
	// 			ID: to.Ptr("/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1"),
	// 			Properties: &armguestconfiguration.AssignmentReportProperties{
	// 				Assignment: &armguestconfiguration.AssignmentInfo{
	// 					Name: to.Ptr("AuditSecureProtocol"),
	// 					Configuration: &armguestconfiguration.ConfigurationInfo{
	// 						Name: to.Ptr("AuditSecureProtocol"),
	// 					},
	// 				},
	// 				ComplianceStatus: to.Ptr(armguestconfiguration.ComplianceStatusCompliant),
	// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-29T22:14:13.000Z"); return t}()),
	// 				ReportID: to.Ptr("7367cbb8-ae99-47d0-a33b-a283564d2cb1"),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-29T22:13:53.000Z"); return t}()),
	// 				VM: &armguestconfiguration.VMInfo{
	// 					ID: to.Ptr("/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm"),
	// 					UUID: to.Ptr("vmuuid"),
	// 				},
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("41ee2caf-48f9-4999-a793-82ec7c6beb2c"),
	// 			ID: to.Ptr("/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c"),
	// 			Properties: &armguestconfiguration.AssignmentReportProperties{
	// 				Assignment: &armguestconfiguration.AssignmentInfo{
	// 					Name: to.Ptr("AuditSecureProtocol"),
	// 					Configuration: &armguestconfiguration.ConfigurationInfo{
	// 						Name: to.Ptr("AuditSecureProtocol"),
	// 					},
	// 				},
	// 				ComplianceStatus: to.Ptr(armguestconfiguration.ComplianceStatusCompliant),
	// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-29T20:14:13.000Z"); return t}()),
	// 				ReportID: to.Ptr("41ee2caf-48f9-4999-a793-82ec7c6beb2c"),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-29T20:13:53.000Z"); return t}()),
	// 				VM: &armguestconfiguration.VMInfo{
	// 					ID: to.Ptr("/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm"),
	// 					UUID: to.Ptr("vmuuid"),
	// 				},
	// 			},
	// 	}},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.GuestConfiguration;
using Azure.ResourceManager.GuestConfiguration.Models;

// Generated from example definition: specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2022-01-25/examples/listAllGuestConfigurationAssignmentReports.json
// this example is just showing the usage of "GuestConfigurationAssignmentReports_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this GuestConfigurationVmAssignmentResource created on azure
// for more information of creating GuestConfigurationVmAssignmentResource, please refer to the document of GuestConfigurationVmAssignmentResource
string subscriptionId = "mySubscriptionid";
string resourceGroupName = "myResourceGroupName";
string vmName = "myVMName";
string guestConfigurationAssignmentName = "AuditSecureProtocol";
ResourceIdentifier guestConfigurationVmAssignmentResourceId = GuestConfigurationVmAssignmentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName, guestConfigurationAssignmentName);
GuestConfigurationVmAssignmentResource guestConfigurationVmAssignment = client.GetGuestConfigurationVmAssignmentResource(guestConfigurationVmAssignmentResourceId);

// invoke the operation and iterate over the result
await foreach (GuestConfigurationAssignmentReport item in guestConfigurationVmAssignment.GetReportsAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1",
      "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1",
      "properties": {
        "complianceStatus": "Compliant",
        "assignment": {
          "name": "AuditSecureProtocol",
          "configuration": {
            "name": "AuditSecureProtocol"
          }
        },
        "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1",
        "vm": {
          "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm",
          "uuid": "vmuuid"
        },
        "details": null,
        "startTime": "2018-08-29T22:13:53Z",
        "endTime": "2018-08-29T22:14:13Z"
      }
    },
    {
      "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c",
      "name": "41ee2caf-48f9-4999-a793-82ec7c6beb2c",
      "properties": {
        "complianceStatus": "Compliant",
        "assignment": {
          "name": "AuditSecureProtocol",
          "configuration": {
            "name": "AuditSecureProtocol"
          }
        },
        "reportId": "41ee2caf-48f9-4999-a793-82ec7c6beb2c",
        "vm": {
          "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm",
          "uuid": "vmuuid"
        },
        "details": null,
        "startTime": "2018-08-29T20:13:53Z",
        "endTime": "2018-08-29T20:14:13Z"
      }
    }
  ]
}

Definitions

Name	Description
AssignmentInfo	Information about the guest configuration assignment.
AssignmentReportDetails	Details of the guest configuration assignment report.
AssignmentReportResource	The guest configuration assignment resource.
AssignmentReportResourceComplianceReason	Reason and code for the compliance of the guest configuration assignment resource.
complianceStatus	A value indicating compliance status of the machine for the assigned guest configuration.
ConfigurationInfo	Information about the configuration.
Error
ErrorResponse	Error response of an operation failure
GuestConfigurationAssignmentReport	Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more.
GuestConfigurationAssignmentReportList	List of guest configuration assignment reports.
GuestConfigurationAssignmentReportProperties	Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more.
type	Type of report, Consistency or Initial
VMInfo	Information about the VM.

AssignmentInfo

Information about the guest configuration assignment.

Name	Type	Description
configuration	ConfigurationInfo	Information about the configuration.
name	string	Name of the guest configuration assignment.

AssignmentReportDetails

Details of the guest configuration assignment report.

Name	Type	Description
complianceStatus	complianceStatus	A value indicating compliance status of the machine for the assigned guest configuration.
endTime	string	End date and time of the guest configuration assignment compliance status check.
jobId	string	GUID of the report.
operationType	type	Type of report, Consistency or Initial
resources	AssignmentReportResource[]	The list of resources for which guest configuration assignment compliance is checked.
startTime	string	Start date and time of the guest configuration assignment compliance status check.

AssignmentReportResource

The guest configuration assignment resource.

Name	Type	Description
complianceStatus	complianceStatus	A value indicating compliance status of the machine for the assigned guest configuration.
properties	object	Properties of a guest configuration assignment resource.
reasons	AssignmentReportResourceComplianceReason[]	Compliance reason and reason code for a resource.
resourceId	string	Name of the guest configuration assignment resource setting.

AssignmentReportResourceComplianceReason

Reason and code for the compliance of the guest configuration assignment resource.

Name	Type	Description
code	string	Code for the compliance of the guest configuration assignment resource.
phrase	string	Reason for the compliance of the guest configuration assignment resource.

complianceStatus

A value indicating compliance status of the machine for the assigned guest configuration.

Name	Type	Description
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

Information about the configuration.

Name	Type	Description
name	string	Name of the configuration.
version	string	Version of the configuration.

Error

Name	Type	Description
code	string	Error code.
message	string	Detail error message indicating why the operation failed.

ErrorResponse

Error response of an operation failure

Name	Type	Description
error	Error