Software Update Configuration Machine Runs - List

Reference

Service:: Automation

API Version:: 2023-11-01

Return list of software update configuration machine runs

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationMachineRuns?api-version=2023-11-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationMachineRuns?api-version=2023-11-01&$filter={$filter}&$skip={$skip}&$top={$top}

URI Parameters

Name	In	Required	Type	Description
automationAccountName	path	True	string	The name of the automation account.
resourceGroupName	path	True	string	Name of an Azure Resource group. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.
$filter	query		string	The filter to apply on the operation. You can use the following filters: 'properties/osType', 'properties/status', 'properties/startTime', and 'properties/softwareUpdateConfiguration/name'
$skip	query		string	number of entries you skip before returning results
$top	query		string	Maximum number of entries returned in the results collection

Request Header

Name	Required	Type	Description
clientRequestId		string	Identifies this specific client request.

Responses

Name	Type	Description
200 OK	softwareUpdateConfigurationMachineRunListResult	Return list of software update configuration machine runs.
Other Status Codes	ErrorResponse	Automation error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List software update configuration machine runs

List software update configuration machine runs for a specific software update configuration run

List software update configuration machine runs

Sample request

HTTP

GET https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns?api-version=2023-11-01

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns/ca440719-34a4-4234-a1a9-3f84faf7788f",
      "name": "ca440719-34a4-4234-a1a9-3f84faf7788f",
      "properties": {
        "targetComputer": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/myvm",
        "targetComputerType": "AzureVirtualMachines",
        "softwareUpdateConfiguration": {
          "name": "mypatch"
        },
        "status": "Succeeded",
        "osType": "Windows",
        "correlationId": "0b943e57-44d3-4f05-898c-6e92aa617e59",
        "sourceComputerId": "3d3f24bf-7037-424e-bfba-aae3b9752f8e",
        "startTime": "2017-10-23T02:33:30.7484961+00:00",
        "endTime": "2017-10-23T02:33:36.4166667+00:00",
        "configuredDuration": "PT2H",
        "job": {},
        "error": {},
        "creationTime": "2017-10-23T02:33:30.7484961+00:00",
        "lastModifiedBy": "",
        "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00"
      }
    },
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns/ca440719-34a4-4234-a1a9-3f84faf7789f",
      "name": "ca440719-34a4-4234-a1a9-3f84faf7789f",
      "properties": {
        "targetComputer": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/myvm2",
        "targetComputerType": "AzureVirtualMachines",
        "softwareUpdateConfiguration": {
          "name": "mypatch"
        },
        "status": "Succeeded",
        "osType": "Windows",
        "correlationId": "0b943e57-44d3-4f05-898c-6e92aa617e59",
        "sourceComputerId": "3d3f24bf-7037-424e-bfba-aae3b9752f8e",
        "startTime": "2017-10-23T02:33:30.7484961+00:00",
        "endTime": "2017-10-23T02:33:36.4166667+00:00",
        "configuredDuration": "PT2H",
        "job": {},
        "error": {},
        "creationTime": "2017-10-23T02:33:30.7484961+00:00",
        "lastModifiedBy": "",
        "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00"
      }
    }
  ],
  "nextLink": "https://management.azure.com:443/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns?api-version=2019-06-01&_=1508725900015&$skip=100"
}

List software update configuration machine runs for a specific software update configuration run

Sample request

HTTP

GET https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns?api-version=2023-11-01&$filter=$filter=properties/correlationId%20eq%200b943e57-44d3-4f05-898c-6e92aa617e59

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns/ca440719-34a4-4234-a1a9-3f84faf7788f",
      "name": "ca440719-34a4-4234-a1a9-3f84faf7788f",
      "properties": {
        "targetComputer": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/myvm",
        "targetComputerType": "AzureVirtualMachines",
        "softwareUpdateConfiguration": {
          "name": "mypatch"
        },
        "status": "Succeeded",
        "osType": "Windows",
        "correlationId": "0b943e57-44d3-4f05-898c-6e92aa617e59",
        "sourceComputerId": "3d3f24bf-7037-424e-bfba-aae3b9752f8e",
        "startTime": "2017-10-23T02:33:30.7484961+00:00",
        "endTime": "2017-10-23T02:33:36.4166667+00:00",
        "configuredDuration": "PT2H",
        "job": {},
        "error": {},
        "creationTime": "2017-10-23T02:33:30.7484961+00:00",
        "lastModifiedBy": "",
        "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00"
      }
    },
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns/ca440719-34a4-4234-a1a9-3f84faf7789f",
      "name": "ca440719-34a4-4234-a1a9-3f84faf7789f",
      "properties": {
        "targetComputer": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/myvm2",
        "targetComputerType": "AzureVirtualMachines",
        "softwareUpdateConfiguration": {
          "name": "mypatch"
        },
        "status": "Succeeded",
        "osType": "Windows",
        "correlationId": "0b943e57-44d3-4f05-898c-6e92aa617e59",
        "sourceComputerId": "3d3f24bf-7037-424e-bfba-aae3b9752f8e",
        "startTime": "2017-10-23T02:33:30.7484961+00:00",
        "endTime": "2017-10-23T02:33:36.4166667+00:00",
        "configuredDuration": "PT2H",
        "job": {},
        "error": {},
        "creationTime": "2017-10-23T02:33:30.7484961+00:00",
        "lastModifiedBy": "",
        "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00"
      }
    }
  ],
  "nextLink": "https://management.azure.com:443/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns?api-version=2019-06-01&_=1508725900015&$skip=100"
}

Definitions

Name	Description
ErrorResponse	Error response of an operation failure
jobNavigation	Software update configuration machine run job navigation properties.
softwareUpdateConfigurationMachineRun	Software update configuration machine run model.
softwareUpdateConfigurationMachineRunListResult	result of listing all software update configuration machine runs
updateConfigurationNavigation	Software update configuration Run Navigation model.

ErrorResponse

Error response of an operation failure

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

jobNavigation

Software update configuration machine run job navigation properties.

Name	Type	Description
id	string	Id of the job associated with the software update configuration run

softwareUpdateConfigurationMachineRun

Software update configuration machine run model.

Name	Type	Description
id	string	Resource Id of the software update configuration machine run
name	string	Name of the software update configuration machine run
properties.configuredDuration	string	configured duration for the software update configuration run.
properties.correlationId	string	correlation id of the software update configuration machine run
properties.createdBy	string	createdBy property, which only appears in the response.
properties.creationTime	string	Creation time of the resource, which only appears in the response.
properties.endTime	string	End time of the software update configuration machine run.
properties.error	ErrorResponse	Details of provisioning error
properties.job	jobNavigation	Job associated with the software update configuration machine run
properties.lastModifiedBy	string	lastModifiedBy property, which only appears in the response.
properties.lastModifiedTime	string	Last time resource was modified, which only appears in the response.
properties.osType	string	Operating system target of the software update configuration triggered this run
properties.softwareUpdateConfiguration	updateConfigurationNavigation	software update configuration triggered this run
properties.sourceComputerId	string	source computer id of the software update configuration machine run
properties.startTime	string	Start time of the software update configuration machine run.
properties.status	string	Status of the software update configuration machine run.
properties.targetComputer	string	name of the updated computer
properties.targetComputerType	string	type of the updated computer.

softwareUpdateConfigurationMachineRunListResult

result of listing all software update configuration machine runs

Name	Type	Description
nextLink	string	link to next page of results.
value	softwareUpdateConfigurationMachineRun[]	outer object returned when listing all software update configuration machine runs

updateConfigurationNavigation

Software update configuration Run Navigation model.

Name	Type	Description
name	string	Name of the software update configuration triggered the software update configuration run

Share via

Software Update Configuration Machine Runs - List

URI Parameters

Request Header

Responses

Security

azure_auth

Scopes

Examples

List software update configuration machine runs

Sample request

Sample response

List software update configuration machine runs for a specific software update configuration run

Sample request

Sample response

Definitions

ErrorResponse

jobNavigation

softwareUpdateConfigurationMachineRun

softwareUpdateConfigurationMachineRunListResult

updateConfigurationNavigation

Additional resources