Guest Configuration Assignment Reports - Get
Get a report for the guest configuration assignment, by reportId.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports/{reportId}?api-version=2022-01-25
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
guest
|
path | True |
string |
The guest configuration assignment name. |
report
|
path | True |
string |
The GUID for the guest configuration assignment report. |
resource
|
path | True |
string |
The resource group name. Regex pattern: |
subscription
|
path | True |
string |
Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
vm
|
path | True |
string |
The name of the virtual machine. Regex pattern: |
api-version
|
query | True |
string |
Client Api Version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. This response is due one of these two reasons: 1. Report was returned successfully 2. Guest configuration assignment was found, but VM is not registered yet, hence no report was returned. |
|
Other Status Codes |
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
Get a guest configuration assignment report by Id for a virtual machine
Sample Request
GET https://management.azure.com/subscriptions/mySubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1?api-version=2022-01-25
Sample Response
{
"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",
"version": "1.0.0.0"
}
},
"reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1",
"vm": {
"id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm",
"uuid": "vmuuid"
},
"details": {
"complianceStatus": "Compliant",
"startTime": "2018-08-29T22:13:53Z",
"endTime": "2018-08-29T22:14:13Z",
"jobId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1",
"resources": [
{
"complianceStatus": "Compliant",
"reasons": [
{
"phrase": "Operation successful.",
"code": "DSC::RESOURCE::SUCCESS"
}
],
"properties": {
"ConfigurationName": "IsWebServerSecure",
"DependsOn": null,
"IsSingleInstance": "Yes",
"ModuleName": "SecureProtocolWebServer",
"ModuleVersion": "1.0.0.3",
"Protocols": [
{
"Ensure": "Absent",
"Protocol": "SSL 2.0"
},
{
"Ensure": "Absent",
"Protocol": "SSL 3.0"
},
{
"Ensure": "Absent",
"Protocol": "TLS 1.0"
},
{
"Ensure": "Absent",
"Protocol": "PCT 1.0"
},
{
"Ensure": "Absent",
"Protocol": "Multi-Protocol Unified Hello"
},
{
"Ensure": "Absent",
"Protocol": "TLS 1.1"
},
{
"Ensure": "Absent",
"Protocol": "TLS 1.2"
}
],
"PsDscRunAsCredential": null,
"Reasons": null,
"ResourceId": "[SecureWebServer]s1",
"SourceInfo": null
}
}
],
"operationType": "Consistency"
},
"startTime": "2018-08-29T22:13:53Z",
"endTime": "2018-08-29T22:14:13Z"
}
}
Definitions
Name | Description |
---|---|
Assignment |
Information about the guest configuration assignment. |
Assignment |
Details of the guest configuration assignment report. |
Assignment |
The guest configuration assignment resource. |
Assignment |
Reason and code for the compliance of the guest configuration assignment resource. |
compliance |
A value indicating compliance status of the machine for the assigned guest configuration. |
Configuration |
Information about the configuration. |
Error | |
Error |
Error response of an operation failure |
Guest |
Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more. |
Guest |
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 |
Information about the configuration. |
|
name |
string |
Name of the guest configuration assignment. |
AssignmentReportDetails
Details of the guest configuration assignment report.
Name | Type | Description |
---|---|---|
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 of report, Consistency or Initial |
|
resources |
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 |
A value indicating compliance status of the machine for the assigned guest configuration. |
|
properties |
object |
Properties of a guest configuration assignment resource. |
reasons |
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 |
GuestConfigurationAssignmentReport
Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more.
Name | Type | 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 |
Properties of the guest configuration report. |
GuestConfigurationAssignmentReportProperties
Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more.
Name | Type | Description |
---|---|---|
assignment |
Configuration details of the guest configuration assignment. |
|
complianceStatus |
A value indicating compliance status of the machine for the assigned guest configuration. |
|
details |
Details of the assignment report. |
|
endTime |
string |
End date and time of the guest configuration assignment compliance status check. |
reportId |
string |
GUID that identifies the guest configuration assignment report under a subscription, resource group. |
startTime |
string |
Start date and time of the guest configuration assignment compliance status check. |
vm |
Information about the VM. |
|
vmssResourceId |
string |
Azure resource Id of the VMSS. |
type
Type of report, Consistency or Initial
Name | Type | Description |
---|---|---|
Consistency |
string |
|
Initial |
string |
VMInfo
Information about the VM.
Name | Type | Description |
---|---|---|
id |
string |
Azure resource Id of the VM. |
uuid |
string |
UUID(Universally Unique Identifier) of the VM. |