Software Update Configuration Runs - List

Return list of software update configuration runs

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&$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

Return list of software update configurations runs.

Other Status Codes

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 run with status equal to 'Failed'
List software update configuration machine runs

List software update configuration machine run with status equal to 'Failed'

Sample Request

GET https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&$filter=properties/status%20eq%20'Failed'

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns/2bd77cfa-2e9c-41b4-a45b-684a77cfeca9",
      "name": "2bd77cfa-2e9c-41b4-a45b-684a77cfeca9",
      "properties": {
        "softwareUpdateConfiguration": {
          "name": "mypatch"
        },
        "status": "Failed",
        "configuredDuration": "PT2H",
        "osType": "Windows",
        "startTime": "2017-10-23T02:30:36.2401233+00:00",
        "endTime": "2017-10-23T02:30:42.8466667+00:00",
        "computerCount": 1,
        "failedCount": 0,
        "tasks": {
          "preTask": {
            "jobId": "be430e9e-2290-462e-8f86-686407c35fab",
            "source": "preRunbook",
            "status": "Completed"
          },
          "postTask": null
        },
        "creationTime": "2017-10-23T02:30:36.2401233+00:00",
        "lastModifiedBy": "",
        "lastModifiedTime": "2017-10-23T02:31:39.3966667+00:00"
      }
    },
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns/5dabff55-9812-4a58-af16-b0cb1d9384e8",
      "name": "5dabff55-9812-4a58-af16-b0cb1d9384e8",
      "properties": {
        "softwareUpdateConfiguration": {
          "name": "mypatch"
        },
        "status": "Failed",
        "configuredDuration": "PT2H",
        "osType": "Windows",
        "startTime": "2017-10-23T01:33:01.8818952+00:00",
        "endTime": "2017-10-23T01:33:08.1133333+00:00",
        "computerCount": 1,
        "failedCount": 0,
        "tasks": {
          "preTask": {
            "jobId": "be430e9e-2290-462e-8f86-686407c35fab",
            "source": "preRunbook",
            "status": "Completed"
          },
          "postTask": null
        },
        "creationTime": "2017-10-23T01:33:01.8818952+00:00",
        "lastModifiedBy": "",
        "lastModifiedTime": "2017-10-23T01:34:03.94+00:00"
      }
    }
  ],
  "nextLink": "https://management.azure.com:443/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/stas-wcus/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&_=1508725900015&$skip=100"
}

List software update configuration machine runs

Sample Request

GET https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns/2bd77cfa-2e9c-41b4-a45b-684a77cfeca9",
      "name": "2bd77cfa-2e9c-41b4-a45b-684a77cfeca9",
      "properties": {
        "softwareUpdateConfiguration": {
          "name": "mypatch"
        },
        "status": "Succeeded",
        "configuredDuration": "PT2H",
        "osType": "Windows",
        "startTime": "2017-10-23T02:30:36.2401233+00:00",
        "endTime": "2017-10-23T02:30:42.8466667+00:00",
        "computerCount": 1,
        "failedCount": 0,
        "tasks": {
          "preTask": {
            "jobId": "be430e9e-2290-462e-8f86-686407c35fab",
            "source": "preRunbook",
            "status": "Completed"
          },
          "postTask": null
        },
        "creationTime": "2017-10-23T02:30:36.2401233+00:00",
        "lastModifiedBy": "",
        "lastModifiedTime": "2017-10-23T02:31:39.3966667+00:00"
      }
    },
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns/5dabff55-9812-4a58-af16-b0cb1d9384e8",
      "name": "5dabff55-9812-4a58-af16-b0cb1d9384e8",
      "properties": {
        "softwareUpdateConfiguration": {
          "name": "mypatch"
        },
        "status": "Succeeded",
        "configuredDuration": "PT2H",
        "osType": "Windows",
        "startTime": "2017-10-23T01:33:01.8818952+00:00",
        "endTime": "2017-10-23T01:33:08.1133333+00:00",
        "computerCount": 1,
        "failedCount": 0,
        "tasks": {
          "preTask": {
            "jobId": "be430e9e-2290-462e-8f86-686407c35fab",
            "source": "preRunbook",
            "status": "Completed"
          },
          "postTask": null
        },
        "creationTime": "2017-10-23T01:33:01.8818952+00:00",
        "lastModifiedBy": "",
        "lastModifiedTime": "2017-10-23T01:34:03.94+00:00"
      }
    }
  ],
  "nextLink": "https://management.azure.com:443/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/stas-wcus/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&_=1508725900015&$skip=100"
}

Definitions

ErrorResponse

Error response of an operation failure

softareUpdateConfigurationRunTaskProperties

Task properties of the software update configuration.

softareUpdateConfigurationRunTasks

Software update configuration run tasks model.

softwareUpdateConfigurationRun

Software update configuration Run properties.

softwareUpdateConfigurationRunListResult

result of listing all software update configuration 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.

softareUpdateConfigurationRunTaskProperties

Task properties of the software update configuration.

Name Type Description
jobId
  • string

The job id of the task.

source
  • string

The name of the source of the task.

status
  • string

The status of the task.

softareUpdateConfigurationRunTasks

Software update configuration run tasks model.

Name Type Description
postTask

Post task properties.

preTask

Pre task properties.

softwareUpdateConfigurationRun

Software update configuration Run properties.

Name Type Description
id
  • string

Resource Id of the software update configuration run

name
  • string

Name of the software update configuration run.

properties.computerCount
  • integer

Number of computers in the software update configuration run.

properties.configuredDuration
  • string

Configured duration for the software update configuration 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 run.

properties.failedCount
  • integer

Number of computers with failed status.

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

software update configuration triggered this run

properties.startTime
  • string

Start time of the software update configuration run.

properties.status
  • string

Status of the software update configuration run.

properties.tasks

Software update configuration tasks triggered in this run

softwareUpdateConfigurationRunListResult

result of listing all software update configuration runs

Name Type Description
nextLink
  • string

link to next page of results.

value

outer object returned when listing all software update configuration 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