Microsoft.Compute (preview:2018-06-30)

2025/06/26 • 7 new, 7 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 ,
version:
{
Description: Version of the guest configuration. ,
Required: False ,
}
string ,
contentUri:
{
Description: Uri of the storage where guest configuration package is uploaded. ,
Required: False ,
}
string ,
contentHash:
{
Description: Combined hash of the guest configuration package and configuration parameters. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
configurationSetting:
{
Description: The configuration setting for the guest configuration. ,
Required: False ,
}
{
configurationMode:
{
Description: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. ,
Enum:
{
ApplyOnly: No description available. ,
ApplyAndMonitor: No description available. ,
ApplyAndAutoCorrect: No description available. ,
}
,
Required: False ,
}
enum ,
allowModuleOverwrite:
{
Description: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false ,
Required: False ,
}
boolean ,
actionAfterReboot:
{
Description: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration ,
Enum:
{
ContinueConfiguration: No description available. ,
StopConfiguration: No description available. ,
}
,
Required: False ,
}
enum ,
refreshFrequencyMins:
{
Description: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. ,
Required: False ,
}
number ,
rebootIfNeeded:
{
Description: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. ,
Required: False ,
}
boolean ,
configurationModeFrequencyMins:
{
Description: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. ,
Required: False ,
}
number ,
}
,
}
,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
lastComplianceStatusChecked:
{
Description: Date and time when last compliance status was checked. ,
Format: date-time ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest report for the guest configuration assignment. ,
Required: False ,
}
string ,
context:
{
Description: The source which initiated the guest configuration assignment. Ex: Azure Policy ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Created: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 ,
version:
{
Description: Version of the guest configuration. ,
Required: False ,
}
string ,
contentUri:
{
Description: Uri of the storage where guest configuration package is uploaded. ,
Required: False ,
}
string ,
contentHash:
{
Description: Combined hash of the guest configuration package and configuration parameters. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
configurationSetting:
{
Description: The configuration setting for the guest configuration. ,
Required: False ,
}
{
configurationMode:
{
Description: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. ,
Enum:
{
ApplyOnly: No description available. ,
ApplyAndMonitor: No description available. ,
ApplyAndAutoCorrect: No description available. ,
}
,
Required: False ,
}
enum ,
allowModuleOverwrite:
{
Description: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false ,
Required: False ,
}
boolean ,
actionAfterReboot:
{
Description: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration ,
Enum:
{
ContinueConfiguration: No description available. ,
StopConfiguration: No description available. ,
}
,
Required: False ,
}
enum ,
refreshFrequencyMins:
{
Description: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. ,
Required: False ,
}
number ,
rebootIfNeeded:
{
Description: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. ,
Required: False ,
}
boolean ,
configurationModeFrequencyMins:
{
Description: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. ,
Required: False ,
}
number ,
}
,
}
,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
lastComplianceStatusChecked:
{
Description: Date and time when last compliance status was checked. ,
Format: date-time ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest report for the guest configuration assignment. ,
Required: False ,
}
string ,
context:
{
Description: The source which initiated the guest configuration assignment. Ex: Azure Policy ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Created: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
version:
{
Description: Version of the guest configuration. ,
Required: False ,
}
string ,
contentUri:
{
Description: Uri of the storage where guest configuration package is uploaded. ,
Required: False ,
}
string ,
contentHash:
{
Description: Combined hash of the guest configuration package and configuration parameters. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
configurationSetting:
{
Description: The configuration setting for the guest configuration. ,
Required: False ,
}
{
configurationMode:
{
Description: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. ,
Enum:
{
ApplyOnly: No description available. ,
ApplyAndMonitor: No description available. ,
ApplyAndAutoCorrect: No description available. ,
}
,
Required: False ,
}
enum ,
allowModuleOverwrite:
{
Description: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false ,
Required: False ,
}
boolean ,
actionAfterReboot:
{
Description: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration ,
Enum:
{
ContinueConfiguration: No description available. ,
StopConfiguration: No description available. ,
}
,
Required: False ,
}
enum ,
refreshFrequencyMins:
{
Description: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. ,
Required: False ,
}
number ,
rebootIfNeeded:
{
Description: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. ,
Required: False ,
}
boolean ,
configurationModeFrequencyMins:
{
Description: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. ,
Required: False ,
}
number ,
}
,
}
,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
lastComplianceStatusChecked:
{
Description: Date and time when last compliance status was checked. ,
Format: date-time ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest report for the guest configuration assignment. ,
Required: False ,
}
string ,
context:
{
Description: The source which initiated the guest configuration assignment. Ex: Azure Policy ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Created: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
version:
{
Description: Version of the guest configuration. ,
Required: False ,
}
string ,
contentUri:
{
Description: Uri of the storage where guest configuration package is uploaded. ,
Required: False ,
}
string ,
contentHash:
{
Description: Combined hash of the guest configuration package and configuration parameters. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
configurationSetting:
{
Description: The configuration setting for the guest configuration. ,
Required: False ,
}
{
configurationMode:
{
Description: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. ,
Enum:
{
ApplyOnly: No description available. ,
ApplyAndMonitor: No description available. ,
ApplyAndAutoCorrect: No description available. ,
}
,
Required: False ,
}
enum ,
allowModuleOverwrite:
{
Description: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false ,
Required: False ,
}
boolean ,
actionAfterReboot:
{
Description: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration ,
Enum:
{
ContinueConfiguration: No description available. ,
StopConfiguration: No description available. ,
}
,
Required: False ,
}
enum ,
refreshFrequencyMins:
{
Description: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. ,
Required: False ,
}
number ,
rebootIfNeeded:
{
Description: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. ,
Required: False ,
}
boolean ,
configurationModeFrequencyMins:
{
Description: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. ,
Required: False ,
}
number ,
}
,
}
,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
lastComplianceStatusChecked:
{
Description: Date and time when last compliance status was checked. ,
Format: date-time ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest report for the guest configuration assignment. ,
Required: False ,
}
string ,
context:
{
Description: The source which initiated the guest configuration assignment. Ex: Azure Policy ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Created: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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_Delete (new)
Description :  Delete a guest configuration assignment
Reference :  Link ¶

⚼ Request

DELETE:  /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: Name of the guest configuration assignment ,
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)

{}

⚐ 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_List (new)
Description :  List all guest configuration assignments for a virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments
{
resourceGroupName:
{
Description: The resource group 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: Result of the list guest configuration assignment operation. ,
Required: False ,
}
[
{
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 ,
version:
{
Description: Version of the guest configuration. ,
Required: False ,
}
string ,
contentUri:
{
Description: Uri of the storage where guest configuration package is uploaded. ,
Required: False ,
}
string ,
contentHash:
{
Description: Combined hash of the guest configuration package and configuration parameters. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
configurationSetting:
{
Description: The configuration setting for the guest configuration. ,
Required: False ,
}
{
configurationMode:
{
Description: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. ,
Enum:
{
ApplyOnly: No description available. ,
ApplyAndMonitor: No description available. ,
ApplyAndAutoCorrect: No description available. ,
}
,
Required: False ,
}
enum ,
allowModuleOverwrite:
{
Description: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false ,
Required: False ,
}
boolean ,
actionAfterReboot:
{
Description: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration ,
Enum:
{
ContinueConfiguration: No description available. ,
StopConfiguration: No description available. ,
}
,
Required: False ,
}
enum ,
refreshFrequencyMins:
{
Description: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. ,
Required: False ,
}
number ,
rebootIfNeeded:
{
Description: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. ,
Required: False ,
}
boolean ,
configurationModeFrequencyMins:
{
Description: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. ,
Required: False ,
}
number ,
}
,
}
,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
lastComplianceStatusChecked:
{
Description: Date and time when last compliance status was checked. ,
Format: date-time ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest report for the guest configuration assignment. ,
Required: False ,
}
string ,
context:
{
Description: The source which initiated the guest configuration assignment. Ex: Azure Policy ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Created: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 ,
name:
{
Description: GUID that identifies the guest configuration assignment report under a subscription, resource group. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the guest configuration report. ,
Required: False ,
}
{
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
reportId:
{
Description: GUID that identifies the guest configuration assignment report under a subscription, resource group. ,
Required: False ,
}
string ,
assignment:
{
Description: Configuration details of the guest configuration assignment. ,
Required: False ,
}
{
name:
{
Description: Name of the guest configuration assignment. ,
Required: False ,
}
string ,
configuration:
{
Description: Information about the configuration. ,
Required: False ,
}
{
name:
{
Description: Name of the configuration. ,
Required: False ,
}
string ,
}
,
}
,
vm:
{
Description: Information about the VM. ,
Required: False ,
}
{
id:
{
Description: Azure resource Id of the VM. ,
Required: False ,
}
string ,
uuid:
{
Description: UUID(Universally Unique Identifier) of the VM. ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: Start date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
details:
{
Description: Details of the assignment report. ,
Required: False ,
}
{
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: GUID of the report. ,
Required: False ,
}
string ,
operationType:
{
Description: Type of report, Consistency or Initial ,
Enum:
{
Consistency: No description available. ,
Initial: No description available. ,
}
,
Required: False ,
}
enum ,
resources:
{
Description: The list of resources for which guest configuration assignment compliance is checked. ,
Required: False ,
}
[
{
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
reasons:
{
Description: Compliance reason and reason code for a resource. ,
Required: False ,
}
[
{
phrase:
{
Description: Reason for the compliance of the guest configuration assignment resource. ,
Required: False ,
}
string ,
code:
{
Description: Code for the compliance of the guest configuration assignment resource. ,
Required: False ,
}
string ,
}
,
]
,
properties:
{
Description: Properties of a guest configuration assignment resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ 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 ,
name:
{
Description: GUID that identifies the guest configuration assignment report under a subscription, resource group. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the guest configuration report. ,
Required: False ,
}
{
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
reportId:
{
Description: GUID that identifies the guest configuration assignment report under a subscription, resource group. ,
Required: False ,
}
string ,
assignment:
{
Description: Configuration details of the guest configuration assignment. ,
Required: False ,
}
{
name:
{
Description: Name of the guest configuration assignment. ,
Required: False ,
}
string ,
configuration:
{
Description: Information about the configuration. ,
Required: False ,
}
{
name:
{
Description: Name of the configuration. ,
Required: False ,
}
string ,
}
,
}
,
vm:
{
Description: Information about the VM. ,
Required: False ,
}
{
id:
{
Description: Azure resource Id of the VM. ,
Required: False ,
}
string ,
uuid:
{
Description: UUID(Universally Unique Identifier) of the VM. ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: Start date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
details:
{
Description: Details of the assignment report. ,
Required: False ,
}
{
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: GUID of the report. ,
Required: False ,
}
string ,
operationType:
{
Description: Type of report, Consistency or Initial ,
Enum:
{
Consistency: No description available. ,
Initial: No description available. ,
}
,
Required: False ,
}
enum ,
resources:
{
Description: The list of resources for which guest configuration assignment compliance is checked. ,
Required: False ,
}
[
{
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
reasons:
{
Description: Compliance reason and reason code for a resource. ,
Required: False ,
}
[
{
phrase:
{
Description: Reason for the compliance of the guest configuration assignment resource. ,
Required: False ,
}
string ,
code:
{
Description: Code for the compliance of the guest configuration assignment resource. ,
Required: False ,
}
string ,
}
,
]
,
properties:
{
Description: Properties of a guest configuration assignment resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ 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 ,
version:
{
Description: Version of the guest configuration. ,
Required: False ,
}
string ,
contentUri:
{
Description: Uri of the storage where guest configuration package is uploaded. ,
Required: False ,
}
string ,
contentHash:
{
Description: Combined hash of the guest configuration package and configuration parameters. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
configurationSetting:
{
Description: The configuration setting for the guest configuration. ,
Required: False ,
}
{
configurationMode:
{
Description: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. ,
Enum:
{
ApplyOnly: No description available. ,
ApplyAndMonitor: No description available. ,
ApplyAndAutoCorrect: No description available. ,
}
,
Required: False ,
}
enum ,
allowModuleOverwrite:
{
Description: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false ,
Required: False ,
}
boolean ,
actionAfterReboot:
{
Description: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration ,
Enum:
{
ContinueConfiguration: No description available. ,
StopConfiguration: No description available. ,
}
,
Required: False ,
}
enum ,
refreshFrequencyMins:
{
Description: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. ,
Required: False ,
}
number ,
rebootIfNeeded:
{
Description: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. ,
Required: False ,
}
boolean ,
configurationModeFrequencyMins:
{
Description: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. ,
Required: False ,
}
number ,
}
,
}
,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
lastComplianceStatusChecked:
{
Description: Date and time when last compliance status was checked. ,
Format: date-time ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest report for the guest configuration assignment. ,
Required: False ,
}
string ,
context:
{
Description: The source which initiated the guest configuration assignment. Ex: Azure Policy ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Created: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 ,
version:
{
Description: Version of the guest configuration. ,
Required: False ,
}
string ,
contentUri:
{
Description: Uri of the storage where guest configuration package is uploaded. ,
Required: False ,
}
string ,
contentHash:
{
Description: Combined hash of the guest configuration package and configuration parameters. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
configurationSetting:
{
Description: The configuration setting for the guest configuration. ,
Required: False ,
}
{
configurationMode:
{
Description: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. ,
Enum:
{
ApplyOnly: No description available. ,
ApplyAndMonitor: No description available. ,
ApplyAndAutoCorrect: No description available. ,
}
,
Required: False ,
}
enum ,
allowModuleOverwrite:
{
Description: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false ,
Required: False ,
}
boolean ,
actionAfterReboot:
{
Description: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration ,
Enum:
{
ContinueConfiguration: No description available. ,
StopConfiguration: No description available. ,
}
,
Required: False ,
}
enum ,
refreshFrequencyMins:
{
Description: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. ,
Required: False ,
}
number ,
rebootIfNeeded:
{
Description: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. ,
Required: False ,
}
boolean ,
configurationModeFrequencyMins:
{
Description: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. ,
Required: False ,
}
number ,
}
,
}
,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
lastComplianceStatusChecked:
{
Description: Date and time when last compliance status was checked. ,
Format: date-time ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest report for the guest configuration assignment. ,
Required: False ,
}
string ,
context:
{
Description: The source which initiated the guest configuration assignment. Ex: Azure Policy ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Created: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
version:
{
Description: Version of the guest configuration. ,
Required: False ,
}
string ,
contentUri:
{
Description: Uri of the storage where guest configuration package is uploaded. ,
Required: False ,
}
string ,
contentHash:
{
Description: Combined hash of the guest configuration package and configuration parameters. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
configurationSetting:
{
Description: The configuration setting for the guest configuration. ,
Required: False ,
}
{
configurationMode:
{
Description: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. ,
Enum:
{
ApplyOnly: No description available. ,
ApplyAndMonitor: No description available. ,
ApplyAndAutoCorrect: No description available. ,
}
,
Required: False ,
}
enum ,
allowModuleOverwrite:
{
Description: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false ,
Required: False ,
}
boolean ,
actionAfterReboot:
{
Description: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration ,
Enum:
{
ContinueConfiguration: No description available. ,
StopConfiguration: No description available. ,
}
,
Required: False ,
}
enum ,
refreshFrequencyMins:
{
Description: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. ,
Required: False ,
}
number ,
rebootIfNeeded:
{
Description: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. ,
Required: False ,
}
boolean ,
configurationModeFrequencyMins:
{
Description: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. ,
Required: False ,
}
number ,
}
,
}
,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
lastComplianceStatusChecked:
{
Description: Date and time when last compliance status was checked. ,
Format: date-time ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest report for the guest configuration assignment. ,
Required: False ,
}
string ,
context:
{
Description: The source which initiated the guest configuration assignment. Ex: Azure Policy ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Created: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
version:
{
Description: Version of the guest configuration. ,
Required: False ,
}
string ,
contentUri:
{
Description: Uri of the storage where guest configuration package is uploaded. ,
Required: False ,
}
string ,
contentHash:
{
Description: Combined hash of the guest configuration package and configuration parameters. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
configurationSetting:
{
Description: The configuration setting for the guest configuration. ,
Required: False ,
}
{
configurationMode:
{
Description: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. ,
Enum:
{
ApplyOnly: No description available. ,
ApplyAndMonitor: No description available. ,
ApplyAndAutoCorrect: No description available. ,
}
,
Required: False ,
}
enum ,
allowModuleOverwrite:
{
Description: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false ,
Required: False ,
}
boolean ,
actionAfterReboot:
{
Description: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration ,
Enum:
{
ContinueConfiguration: No description available. ,
StopConfiguration: No description available. ,
}
,
Required: False ,
}
enum ,
refreshFrequencyMins:
{
Description: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. ,
Required: False ,
}
number ,
rebootIfNeeded:
{
Description: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. ,
Required: False ,
}
boolean ,
configurationModeFrequencyMins:
{
Description: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. ,
Required: False ,
}
number ,
}
,
}
,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
lastComplianceStatusChecked:
{
Description: Date and time when last compliance status was checked. ,
Format: date-time ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest report for the guest configuration assignment. ,
Required: False ,
}
string ,
context:
{
Description: The source which initiated the guest configuration assignment. Ex: Azure Policy ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Created: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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_Delete (removed)
Description :  Delete a guest configuration assignment
Reference :  Link ¶

⚼ Request

DELETE:  /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: Name of the guest configuration assignment ,
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)

{}

⚐ 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_List (removed)
Description :  List all guest configuration assignments for a virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments
{
resourceGroupName:
{
Description: The resource group 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: Result of the list guest configuration assignment operation. ,
Required: False ,
}
[
{
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 ,
version:
{
Description: Version of the guest configuration. ,
Required: False ,
}
string ,
contentUri:
{
Description: Uri of the storage where guest configuration package is uploaded. ,
Required: False ,
}
string ,
contentHash:
{
Description: Combined hash of the guest configuration package and configuration parameters. ,
Required: False ,
}
string ,
configurationParameter:
{
Description: The configuration parameters for the guest configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the configuration parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value of the configuration parameter. ,
Required: False ,
}
string ,
}
,
]
,
configurationSetting:
{
Description: The configuration setting for the guest configuration. ,
Required: False ,
}
{
configurationMode:
{
Description: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. ,
Enum:
{
ApplyOnly: No description available. ,
ApplyAndMonitor: No description available. ,
ApplyAndAutoCorrect: No description available. ,
}
,
Required: False ,
}
enum ,
allowModuleOverwrite:
{
Description: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false ,
Required: False ,
}
boolean ,
actionAfterReboot:
{
Description: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration ,
Enum:
{
ContinueConfiguration: No description available. ,
StopConfiguration: No description available. ,
}
,
Required: False ,
}
enum ,
refreshFrequencyMins:
{
Description: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. ,
Required: False ,
}
number ,
rebootIfNeeded:
{
Description: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. ,
Required: False ,
}
boolean ,
configurationModeFrequencyMins:
{
Description: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. ,
Required: False ,
}
number ,
}
,
}
,
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
lastComplianceStatusChecked:
{
Description: Date and time when last compliance status was checked. ,
Format: date-time ,
Required: False ,
}
string ,
latestReportId:
{
Description: Id of the latest report for the guest configuration assignment. ,
Required: False ,
}
string ,
context:
{
Description: The source which initiated the guest configuration assignment. Ex: Azure Policy ,
Required: False ,
}
string ,
assignmentHash:
{
Description: Combined hash of the configuration package and parameters. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Created: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 ,
name:
{
Description: GUID that identifies the guest configuration assignment report under a subscription, resource group. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the guest configuration report. ,
Required: False ,
}
{
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
reportId:
{
Description: GUID that identifies the guest configuration assignment report under a subscription, resource group. ,
Required: False ,
}
string ,
assignment:
{
Description: Configuration details of the guest configuration assignment. ,
Required: False ,
}
{
name:
{
Description: Name of the guest configuration assignment. ,
Required: False ,
}
string ,
configuration:
{
Description: Information about the configuration. ,
Required: False ,
}
{
name:
{
Description: Name of the configuration. ,
Required: False ,
}
string ,
}
,
}
,
vm:
{
Description: Information about the VM. ,
Required: False ,
}
{
id:
{
Description: Azure resource Id of the VM. ,
Required: False ,
}
string ,
uuid:
{
Description: UUID(Universally Unique Identifier) of the VM. ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: Start date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
details:
{
Description: Details of the assignment report. ,
Required: False ,
}
{
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: GUID of the report. ,
Required: False ,
}
string ,
operationType:
{
Description: Type of report, Consistency or Initial ,
Enum:
{
Consistency: No description available. ,
Initial: No description available. ,
}
,
Required: False ,
}
enum ,
resources:
{
Description: The list of resources for which guest configuration assignment compliance is checked. ,
Required: False ,
}
[
{
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
reasons:
{
Description: Compliance reason and reason code for a resource. ,
Required: False ,
}
[
{
phrase:
{
Description: Reason for the compliance of the guest configuration assignment resource. ,
Required: False ,
}
string ,
code:
{
Description: Code for the compliance of the guest configuration assignment resource. ,
Required: False ,
}
string ,
}
,
]
,
properties:
{
Description: Properties of a guest configuration assignment resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ 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 ,
name:
{
Description: GUID that identifies the guest configuration assignment report under a subscription, resource group. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the guest configuration report. ,
Required: False ,
}
{
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
reportId:
{
Description: GUID that identifies the guest configuration assignment report under a subscription, resource group. ,
Required: False ,
}
string ,
assignment:
{
Description: Configuration details of the guest configuration assignment. ,
Required: False ,
}
{
name:
{
Description: Name of the guest configuration assignment. ,
Required: False ,
}
string ,
configuration:
{
Description: Information about the configuration. ,
Required: False ,
}
{
name:
{
Description: Name of the configuration. ,
Required: False ,
}
string ,
}
,
}
,
vm:
{
Description: Information about the VM. ,
Required: False ,
}
{
id:
{
Description: Azure resource Id of the VM. ,
Required: False ,
}
string ,
uuid:
{
Description: UUID(Universally Unique Identifier) of the VM. ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: Start date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
details:
{
Description: Details of the assignment report. ,
Required: False ,
}
{
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End date and time of the guest configuration assignment compliance status check. ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: GUID of the report. ,
Required: False ,
}
string ,
operationType:
{
Description: Type of report, Consistency or Initial ,
Enum:
{
Consistency: No description available. ,
Initial: No description available. ,
}
,
Required: False ,
}
enum ,
resources:
{
Description: The list of resources for which guest configuration assignment compliance is checked. ,
Required: False ,
}
[
{
complianceStatus:
{
Description: A value indicating compliance status of the virtual machine for the assigned guest configuration. ,
Enum:
{
Compliant: No description available. ,
NonCompliant: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
reasons:
{
Description: Compliance reason and reason code for a resource. ,
Required: False ,
}
[
{
phrase:
{
Description: Reason for the compliance of the guest configuration assignment resource. ,
Required: False ,
}
string ,
code:
{
Description: Code for the compliance of the guest configuration assignment resource. ,
Required: False ,
}
string ,
}
,
]
,
properties:
{
Description: Properties of a guest configuration assignment resource. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ 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 ,
}
,
}