Update Runs - List Top Level
Get the list of update runs.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Update.Admin/updateLocations/{updateLocation}/updateRuns?api-version=2016-05-01URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string |
Resource group name. |
|
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
|
update
|
path | True |
string |
The name of the update location. |
|
api-version
|
query | True |
string |
Client API Version. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| user_impersonation | impersonate your user account |
Examples
Get the list of update runs.
Sample Request
GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.Redmond/providers/Microsoft.Update.Admin/updateLocations/Redmond/updateRuns?api-version=2016-05-01
Sample Response
{
"value": [
{
"id": "/subscriptions/23d66fd1-4743-42ff-b391-e29dc51d799e/resourceGroups/System.Redmond/providers/Microsoft.Update.Admin/updateLocations/redmond/updates/Microsoft1.0.180302.1/updateRuns/407d9b8f-debf-4058-b374-a94a1bb4de30",
"name": "407d9b8f-debf-4058-b374-a94a1bb4de30",
"type": "Microsoft.Update.Admin/updateLocations/updates/updateRuns",
"location": "redmond",
"tags": {},
"properties": {
"progress": {
"name": "Unnamed step",
"description": "Update Azure Stack.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T09:25:37.4173123-08:00",
"endTimeUtc": "2018-03-03T00:09:04.9913191-08:00",
"steps": [
{
"name": "Pre-engine Update",
"description": "Perform pre-engine update.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T09:25:37.4798089-08:00",
"endTimeUtc": "2018-03-02T10:28:55.8289013-08:00",
"steps": [
{
"name": "PreUpdate Cloud",
"description": "Copy packages to NugetStore.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T09:25:41.9019404-08:00",
"endTimeUtc": "2018-03-02T09:57:50.1318779-08:00",
"steps": []
},
{
"name": "Update SeedRing SF Runtime",
"description": "Update SeedRing SF Runtime step.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T09:57:50.1475043-08:00",
"endTimeUtc": "2018-03-02T10:17:07.8319178-08:00",
"steps": []
},
{
"name": "Update SeedRing ECE",
"description": "Update SeedRing ECE step.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T10:17:07.8631688-08:00",
"endTimeUtc": "2018-03-02T10:28:55.7507724-08:00",
"steps": []
}
]
},
{
"name": "Engine Update",
"description": "Perform engine update.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T10:28:55.8601531-08:00",
"endTimeUtc": "2018-03-02T10:37:44.0480253-08:00",
"steps": [
{
"name": "PreUpdate Cloud",
"description": "Copy packages to NugetStore.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T10:28:59.500983-08:00",
"endTimeUtc": "2018-03-02T10:35:43.2198256-08:00",
"steps": []
},
{
"name": "Update SeedRing SF Runtime",
"description": "Update SeedRing SF Runtime step.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T10:35:43.2354458-08:00",
"endTimeUtc": "2018-03-02T10:36:14.5629258-08:00",
"steps": []
},
{
"name": "Update SeedRing ECE",
"description": "Update SeedRing ECE step.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T10:36:14.5941782-08:00",
"endTimeUtc": "2018-03-02T10:37:43.9698965-08:00",
"steps": []
}
]
},
{
"name": "Cloud Update",
"description": "Perform cloud update.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T10:37:44.079278-08:00",
"endTimeUtc": "2018-03-03T00:09:04.960067-08:00",
"steps": [
{
"name": "Update Domain",
"description": "Live Update on Domain.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T10:37:48.3763886-08:00",
"endTimeUtc": "2018-03-02T10:41:20.0340798-08:00",
"steps": []
},
{
"name": "Check Cloud Health",
"description": "Check the health of all roles in parallel before beginning update.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T10:41:20.0653266-08:00",
"endTimeUtc": "2018-03-02T10:56:10.4396313-08:00",
"steps": []
},
{
"name": "PreUpdate OEM.",
"description": "Copy OEM content to CloudMedia.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T10:56:10.4708828-08:00",
"endTimeUtc": "2018-03-02T10:56:16.1459718-08:00",
"steps": []
},
{
"name": "(DEP) Generate Code Integrity Policy",
"description": "Generates the Code Integrity Policy",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T10:56:16.1807685-08:00",
"endTimeUtc": "2018-03-02T10:57:07.0682796-08:00",
"steps": []
},
{
"name": "Update OEM S2D whitelist.",
"description": "Update S2D health service from StorageDisks.xml.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T10:57:07.0995306-08:00",
"endTimeUtc": "2018-03-02T10:57:14.7249566-08:00",
"steps": []
},
{
"name": "(FBI) Create new Storage Accounts",
"description": "Create newly introduced storage accounts to be used by different providers.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T10:57:14.7562105-08:00",
"endTimeUtc": "2018-03-02T10:58:34.4194385-08:00",
"steps": []
},
{
"name": "NC Auto Update Disable",
"description": "Disable EnableAutomaticUpdates flag on NC fabriccluster",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T10:58:34.4506838-08:00",
"endTimeUtc": "2018-03-02T11:00:13.6332139-08:00",
"steps": []
},
{
"name": "Install Update.",
"description": "Install Update on Hosts and Infra VMs.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T11:00:13.6644452-08:00",
"endTimeUtc": "2018-03-02T12:19:16.6339385-08:00",
"steps": []
},
{
"name": "(DEP) Generate base images for hosts and virtual machines.",
"description": "Creates and updates the base images needed by hosts and virtual machines.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T12:19:16.7901987-08:00",
"endTimeUtc": "2018-03-02T12:38:55.3959294-08:00",
"steps": []
},
{
"name": "(DEP) Generate host image.",
"description": "Build VHDs for the host at runtime and the backup WinPE for servicing.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T12:38:55.4115607-08:00",
"endTimeUtc": "2018-03-02T12:43:15.272197-08:00",
"steps": []
},
{
"name": "Update PrivilegedEndpoint whitelist",
"description": "Update PrivilegedEndpoint whitelist on SeedRing nodes.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T12:43:15.3034455-08:00",
"endTimeUtc": "2018-03-02T12:47:22.3519764-08:00",
"steps": []
},
{
"name": "Update Defender",
"description": "Update Defender signatures.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T12:47:22.3832322-08:00",
"endTimeUtc": "2018-03-02T12:48:07.0983871-08:00",
"steps": []
},
{
"name": "Update Node Sets",
"description": "Live Update all nodes in a node set.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T12:48:07.129639-08:00",
"endTimeUtc": "2018-03-02T13:51:45.6581291-08:00",
"steps": []
},
{
"name": "Update SeedRing IBC",
"description": "Update SeedRing IBC step.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T13:51:45.6934194-08:00",
"endTimeUtc": "2018-03-02T14:02:32.5586541-08:00",
"steps": []
},
{
"name": "Restart Storage Hosts",
"description": "Restart Storage Hosts step.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T14:02:32.5899091-08:00",
"endTimeUtc": "2018-03-02T18:53:35.1617531-08:00",
"steps": []
},
{
"name": "Restart CA.",
"description": "Restart CA to finish applying OS updates.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T18:53:35.1993965-08:00",
"endTimeUtc": "2018-03-02T19:00:23.0498989-08:00",
"steps": []
},
{
"name": "Restart NC.",
"description": "Restart NC VMs to finish applying OS updates and Update the NC ring app.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T19:00:23.1436539-08:00",
"endTimeUtc": "2018-03-02T20:53:58.2467744-08:00",
"steps": []
},
{
"name": "Restart SQL.",
"description": "Restart SQL VMs to finish applying OS updates and Update SQL servers.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T20:53:58.3717999-08:00",
"endTimeUtc": "2018-03-02T21:08:54.2948193-08:00",
"steps": []
},
{
"name": "Restart SLB.",
"description": "Restart SLB to finish applying OS updates.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T21:08:54.3260706-08:00",
"endTimeUtc": "2018-03-02T21:28:05.8095784-08:00",
"steps": []
},
{
"name": "Restart ACSFabric and Gateway",
"description": "Restart ACSFabric and Gateway to finish applying OS updates.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T21:28:05.8408311-08:00",
"endTimeUtc": "2018-03-02T22:27:56.0854925-08:00",
"steps": []
},
{
"name": "Restart WAS",
"description": "Restart WAS to finish applying OS updates.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T22:27:56.1479976-08:00",
"endTimeUtc": "2018-03-02T22:46:02.7735634-08:00",
"steps": []
},
{
"name": "Restart WASPUBLIC",
"description": "Restart WASPUBLIC to finish applying OS updates.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T22:46:02.8048171-08:00",
"endTimeUtc": "2018-03-02T23:15:02.30254-08:00",
"steps": []
},
{
"name": "Restart XRP FabricRing, PXE and ADFS, and SQL.",
"description": "Restart XRP FabricRing, PXE, ADFS, and SQL to finish applying OS updates.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T23:15:02.3337871-08:00",
"endTimeUtc": "2018-03-02T23:47:21.7605287-08:00",
"steps": []
},
{
"name": "Update OEM manifest.",
"description": "Update ECE manifest from OEM manifests.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T23:47:21.7917861-08:00",
"endTimeUtc": "2018-03-02T23:47:35.5958946-08:00",
"steps": []
},
{
"name": "Update Active Version on Node Sets",
"description": "Live Update all nodes active version.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-02T23:47:35.6271478-08:00",
"endTimeUtc": "2018-03-03T00:05:12.3530683-08:00",
"steps": []
},
{
"name": "Post Update Trace Collector.",
"description": "Switch Trace Collector to post update and validate the service is running.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-03T00:05:12.5405827-08:00",
"endTimeUtc": "2018-03-03T00:06:19.9796654-08:00",
"steps": []
},
{
"name": "Enable StartComponentCleanup on NC VMs",
"description": "Enable WU StartComponentCleanup on NC VMs",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-03T00:06:20.0265482-08:00",
"endTimeUtc": "2018-03-03T00:07:37.297809-08:00",
"steps": []
},
{
"name": "Update Cloud Security",
"description": "Update cloud security step",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-03T00:07:37.3446716-08:00",
"endTimeUtc": "2018-03-03T00:07:56.664821-08:00",
"steps": []
},
{
"name": "PostUpdate Cloud.",
"description": "Update Azure Stack Version.",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-03T00:07:56.6960734-08:00",
"endTimeUtc": "2018-03-03T00:08:19.7703032-08:00",
"steps": []
},
{
"name": "Update ExternalDNS",
"description": "Disable DNS Recursion on WASP VMs",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-03T00:08:19.8015565-08:00",
"endTimeUtc": "2018-03-03T00:08:28.0283394-08:00",
"steps": []
},
{
"name": "Close Active Alerts After LiveUdpate",
"description": "Query HRP service and close all existing active alerts",
"errorMessage": "",
"status": "Success",
"startTimeUtc": "2018-03-03T00:08:28.0595832-08:00",
"endTimeUtc": "2018-03-03T00:09:04.8819362-08:00",
"steps": []
}
]
}
]
},
"timeStarted": "2018-03-02T17:25:22.818Z",
"duration": "PT14H43M50.0644552S",
"state": "Succeeded"
}
}
],
"nextLink": null
}Definitions
| Name | Description |
|---|---|
| Step |
Information about each step of the update process. |
|
Update |
Representation of a update run resource. |
|
Update |
Pageable list of update runs. |
|
Update |
State of the update run. |
Step
Information about each step of the update process.
| Name | Type | Description |
|---|---|---|
| description |
string |
Description of the step. |
| endTimeUtc |
string |
Time at which this step stopped executing |
| errorMessage |
string |
Error message, if any. |
| name |
string |
Name of the step. |
| startTimeUtc |
string |
Time at which this step started executing |
| status |
string |
State of the step. |
| steps |
Step[] |
Inner steps |
UpdateRun
Representation of a update run resource.
| Name | Type | Description |
|---|---|---|
| id |
string |
URI of the resource. |
| location |
string |
Region location of resource. |
| name |
string |
Name of the resource. |
| properties.duration |
string |
Duration of the update. |
| properties.progress |
Current progress of the update run. |
|
| properties.state |
State of the update run. |
|
| properties.timeStarted |
string |
Update start time. |
| tags |
object |
List of key-value pairs. |
| type |
string |
Type of resource. |
UpdateRunList
Pageable list of update runs.
| Name | Type | Description |
|---|---|---|
| nextLink |
string |
URI to the next page. |
| value |
List of update runs. |
UpdateRunState
State of the update run.
| Name | Type | Description |
|---|---|---|
| Failed |
string |
|
| InProgress |
string |
|
| Succeeded |
string |
|
| Unknown |
string |