Microsoft.Compute (preview:2018-01-20)

2025/06/26 • 5 new, 5 deleted methods

GuestConfigurationAssignments_CreateOrUpdate (new)
Description :  Creates an association between a VM and guest configuration
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}
{
guestConfigurationAssignmentName:
{
Description: Name of the guest configuration assignment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update guest configuration assignment. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Guest configuration assignment. ,
Required: False ,
}
{
guestConfiguration:
{
Description: The guest configuration to assign. ,
Required: False ,
}
{
kind:
{
Description: Kind of the guest configuration. For example:DSC ,
Enum:
{
DSC: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the guest configuration. ,
Required: False ,
}
string ,
type:
{
Description: Type of the guest configuration. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
{
value:
{
Description: Represents the list for configuration parameters. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NotCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
complianceReason:
{
Description: Reason for the complianceStatus for the assigned guest configuration. ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest guest configuration assignment report. ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
location:
{
Description: Region where VM is located. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Guest configuration assignment. ,
Required: False ,
}
{
guestConfiguration:
{
Description: The guest configuration to assign. ,
Required: False ,
}
{
kind:
{
Description: Kind of the guest configuration. For example:DSC ,
Enum:
{
DSC: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the guest configuration. ,
Required: False ,
}
string ,
type:
{
Description: Type of the guest configuration. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
{
value:
{
Description: Represents the list for configuration parameters. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NotCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
complianceReason:
{
Description: Reason for the complianceStatus for the assigned guest configuration. ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest guest configuration assignment report. ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
location:
{
Description: Region where VM is located. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Guest configuration assignment. ,
Required: False ,
}
{
guestConfiguration:
{
Description: The guest configuration to assign. ,
Required: False ,
}
{
kind:
{
Description: Kind of the guest configuration. For example:DSC ,
Enum:
{
DSC: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the guest configuration. ,
Required: False ,
}
string ,
type:
{
Description: Type of the guest configuration. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
{
value:
{
Description: Represents the list for configuration parameters. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NotCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
complianceReason:
{
Description: Reason for the complianceStatus for the assigned guest configuration. ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest guest configuration assignment report. ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
location:
{
Description: Region where VM is located. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Detail error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
GuestConfigurationAssignments_Get (new)
Description :  Get information about a guest configuration assignment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}
{
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
guestConfigurationAssignmentName:
{
Description: The guest configuration assignment name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Guest configuration assignment. ,
Required: False ,
}
{
guestConfiguration:
{
Description: The guest configuration to assign. ,
Required: False ,
}
{
kind:
{
Description: Kind of the guest configuration. For example:DSC ,
Enum:
{
DSC: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the guest configuration. ,
Required: False ,
}
string ,
type:
{
Description: Type of the guest configuration. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
{
value:
{
Description: Represents the list for configuration parameters. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NotCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
complianceReason:
{
Description: Reason for the complianceStatus for the assigned guest configuration. ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest guest configuration assignment report. ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
location:
{
Description: Region where VM is located. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Detail error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
GuestConfigurationAssignmentReports_List (new)
Description :  List all reports for the guest configuration assignment, latest report first.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports
{
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
guestConfigurationAssignmentName:
{
Description: The guest configuration assignment name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of reports for the guest configuration. Report contains information such as compliance status, reason and more. ,
Required: False ,
}
[
{
id:
{
Description: ARM resource id of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
reportId:
{
Description: GUID of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
type:
{
Description: Type of report, Consistency or Initial ,
Enum:
{
Consistency: No description available. ,
Initial: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the report for the guest configuration assignment. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the report for the guest configuration assignment. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last modified time report for the guest configuration assignment. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NotCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
refreshMode:
{
Description: Refresh mode of the node report, push or pull. ,
Enum:
{
Push: No description available. ,
Pull: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
rebootRequested:
{
Description: The value indicating whether reboot is requested for the report. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
reportFormatVersion:
{
Description: Report format version of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
configurationVersion:
{
Description: Configuration version of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Detail error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
GuestConfigurationAssignmentReports_Get (new)
Description :  Get a report for the guest configuration assignment, by reportId.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports/{reportId}
{
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
guestConfigurationAssignmentName:
{
Description: The guest configuration assignment name. ,
Required: True ,
}
string ,
reportId:
{
Description: The GUID for the guest configuration assignment report. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM resource id of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
reportId:
{
Description: GUID of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
type:
{
Description: Type of report, Consistency or Initial ,
Enum:
{
Consistency: No description available. ,
Initial: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the report for the guest configuration assignment. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the report for the guest configuration assignment. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last modified time report for the guest configuration assignment. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NotCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
refreshMode:
{
Description: Refresh mode of the node report, push or pull. ,
Enum:
{
Push: No description available. ,
Pull: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
rebootRequested:
{
Description: The value indicating whether reboot is requested for the report. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
reportFormatVersion:
{
Description: Report format version of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
configurationVersion:
{
Description: Configuration version of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Detail error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Lists all of the available GuestConfiguration REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.GuestConfiguration/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Automation operations supported by the Automation resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: For ex. providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/write or read ,
Required: False ,
}
string ,
display:
{
Description: Provider, Resource, Operation and description values. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.GuestConfiguration ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: For ex. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description about operation. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Provider, Resource, Operation and description values. ,
Required: False ,
}
{
statusCode:
{
Description: Service provider: Microsoft.GuestConfiguration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Detail error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
GuestConfigurationAssignments_CreateOrUpdate (removed)
Description :  Creates an association between a VM and guest configuration
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}
{
guestConfigurationAssignmentName:
{
Description: Name of the guest configuration assignment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update guest configuration assignment. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Guest configuration assignment. ,
Required: False ,
}
{
guestConfiguration:
{
Description: The guest configuration to assign. ,
Required: False ,
}
{
kind:
{
Description: Kind of the guest configuration. For example:DSC ,
Enum:
{
DSC: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the guest configuration. ,
Required: False ,
}
string ,
type:
{
Description: Type of the guest configuration. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
{
value:
{
Description: Represents the list for configuration parameters. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NotCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
complianceReason:
{
Description: Reason for the complianceStatus for the assigned guest configuration. ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest guest configuration assignment report. ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
location:
{
Description: Region where VM is located. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Guest configuration assignment. ,
Required: False ,
}
{
guestConfiguration:
{
Description: The guest configuration to assign. ,
Required: False ,
}
{
kind:
{
Description: Kind of the guest configuration. For example:DSC ,
Enum:
{
DSC: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the guest configuration. ,
Required: False ,
}
string ,
type:
{
Description: Type of the guest configuration. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
{
value:
{
Description: Represents the list for configuration parameters. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NotCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
complianceReason:
{
Description: Reason for the complianceStatus for the assigned guest configuration. ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest guest configuration assignment report. ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
location:
{
Description: Region where VM is located. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Guest configuration assignment. ,
Required: False ,
}
{
guestConfiguration:
{
Description: The guest configuration to assign. ,
Required: False ,
}
{
kind:
{
Description: Kind of the guest configuration. For example:DSC ,
Enum:
{
DSC: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the guest configuration. ,
Required: False ,
}
string ,
type:
{
Description: Type of the guest configuration. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
{
value:
{
Description: Represents the list for configuration parameters. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NotCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
complianceReason:
{
Description: Reason for the complianceStatus for the assigned guest configuration. ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest guest configuration assignment report. ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
location:
{
Description: Region where VM is located. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Detail error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
GuestConfigurationAssignments_Get (removed)
Description :  Get information about a guest configuration assignment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}
{
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
guestConfigurationAssignmentName:
{
Description: The guest configuration assignment name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Guest configuration assignment. ,
Required: False ,
}
{
guestConfiguration:
{
Description: The guest configuration to assign. ,
Required: False ,
}
{
kind:
{
Description: Kind of the guest configuration. For example:DSC ,
Enum:
{
DSC: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the guest configuration. ,
Required: False ,
}
string ,
type:
{
Description: Type of the guest configuration. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
{
value:
{
Description: Represents the list for configuration parameters. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NotCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
complianceReason:
{
Description: Reason for the complianceStatus for the assigned guest configuration. ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest guest configuration assignment report. ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
location:
{
Description: Region where VM is located. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Detail error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
GuestConfigurationAssignmentReports_List (removed)
Description :  List all reports for the guest configuration assignment, latest report first.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports
{
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
guestConfigurationAssignmentName:
{
Description: The guest configuration assignment name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of reports for the guest configuration. Report contains information such as compliance status, reason and more. ,
Required: False ,
}
[
{
id:
{
Description: ARM resource id of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
reportId:
{
Description: GUID of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
type:
{
Description: Type of report, Consistency or Initial ,
Enum:
{
Consistency: No description available. ,
Initial: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the report for the guest configuration assignment. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the report for the guest configuration assignment. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last modified time report for the guest configuration assignment. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NotCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
refreshMode:
{
Description: Refresh mode of the node report, push or pull. ,
Enum:
{
Push: No description available. ,
Pull: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
rebootRequested:
{
Description: The value indicating whether reboot is requested for the report. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
reportFormatVersion:
{
Description: Report format version of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
configurationVersion:
{
Description: Configuration version of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Detail error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
GuestConfigurationAssignmentReports_Get (removed)
Description :  Get a report for the guest configuration assignment, by reportId.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports/{reportId}
{
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
guestConfigurationAssignmentName:
{
Description: The guest configuration assignment name. ,
Required: True ,
}
string ,
reportId:
{
Description: The GUID for the guest configuration assignment report. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
vmName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ARM resource id of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
reportId:
{
Description: GUID of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
type:
{
Description: Type of report, Consistency or Initial ,
Enum:
{
Consistency: No description available. ,
Initial: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time of the report for the guest configuration assignment. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the report for the guest configuration assignment. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last modified time report for the guest configuration assignment. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NotCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
refreshMode:
{
Description: Refresh mode of the node report, push or pull. ,
Enum:
{
Push: No description available. ,
Pull: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
rebootRequested:
{
Description: The value indicating whether reboot is requested for the report. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
reportFormatVersion:
{
Description: Report format version of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
configurationVersion:
{
Description: Configuration version of the report for the guest configuration assignment. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Detail error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available GuestConfiguration REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.GuestConfiguration/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Automation operations supported by the Automation resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: For ex. providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/write or read ,
Required: False ,
}
string ,
display:
{
Description: Provider, Resource, Operation and description values. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.GuestConfiguration ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: For ex. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description about operation. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Provider, Resource, Operation and description values. ,
Required: False ,
}
{
statusCode:
{
Description: Service provider: Microsoft.GuestConfiguration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Detail error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}