Updates - List

Service:

Maintenance

API Version:

2023-09-01-preview

Get updates to resources.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/updates?api-version=2023-09-01-preview

URI Parameters

Name	In	Required	Type	Description
providerName	path	True	string	Resource provider name
resourceGroupName	path	True	string	Resource group name
resourceName	path	True	string	Resource identifier
resourceType	path	True	string	Resource type
subscriptionId	path	True	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Version of the API to be used with the client request.

Responses

Name	Type	Description
200 OK	ListUpdatesResult	OK
Other Status Codes	MaintenanceError	BadRequest

Examples

Updates_List

Sample request

HTTP

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/updates?api-version=2023-09-01-preview

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.maintenance import MaintenanceManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-maintenance
# USAGE
    python updates_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MaintenanceManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
    )

    response = client.updates.list(
        resource_group_name="examplerg",
        provider_name="Microsoft.Compute",
        resource_type="virtualMachineScaleSets",
        resource_name="smdtest1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/examples/Updates_List.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Maintenance;
using Azure.ResourceManager.Maintenance.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/examples/Updates_List.json
// this example is just showing the usage of "Updates_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// invoke the operation and iterate over the result
string providerName = "Microsoft.Compute";
string resourceType = "virtualMachineScaleSets";
string resourceName = "smdtest1";
await foreach (MaintenanceUpdate item in resourceGroupResource.GetUpdatesAsync(providerName, resourceType, resourceName))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "maintenanceScope": "Resource",
      "status": "Pending",
      "impactType": "Reboot",
      "impactDurationInSec": 1440,
      "notBefore": "2018-10-09T06:17:44.235Z",
      "properties": {
        "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1"
      }
    }
  ]
}

Definitions

Name	Description
ErrorDetails	An error response details received from the Azure Maintenance service.
ImpactType	The impact type
ListUpdatesResult	Response for Updates list
MaintenanceError	An error response received from the Azure Maintenance service.
MaintenanceScope	Gets or sets maintenanceScope of the configuration
Update	Maintenance update on a resource
UpdateStatus	The status

ErrorDetails

Object

An error response details received from the Azure Maintenance service.

Name	Type	Description
code	string	Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
message	string	Human-readable representation of the error.

ImpactType

Enumeration

The impact type

Value	Description
None	Pending updates has no impact on resource.
Freeze	Pending updates can freeze network or disk io operation on resource.
Restart	Pending updates can cause resource to restart.
Redeploy	Pending updates can redeploy resource.

ListUpdatesResult

Object

Response for Updates list

Name	Type	Description
value	Update[]	The pending updates

MaintenanceError

Object

An error response received from the Azure Maintenance service.

Name	Type	Description
error	ErrorDetails	Details of the error

MaintenanceScope

Enumeration

Gets or sets maintenanceScope of the configuration

Value	Description
Host	This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs.
Resource	This maintenance scope controls the default update maintenance of the Azure Resource
OSImage	This maintenance scope controls os image installation on VM/VMSS
Extension	This maintenance scope controls extension installation on VM/VMSS
InGuestPatch	This maintenance scope controls installation of windows and linux packages on VM/VMSS
SQLDB	This maintenance scope controls installation of SQL server platform updates.
SQLManagedInstance	This maintenance scope controls installation of SQL managed instance platform update.

Update

Object

Maintenance update on a resource

Name	Type	Description
impactDurationInSec	integer (int32)	Duration of impact in seconds
impactType	ImpactType	The impact type
maintenanceScope	MaintenanceScope	The impact area
notBefore	string (date-time)	Time when Azure will start force updates if not self-updated by customer before this time
properties.resourceId	string	The resourceId
status	UpdateStatus	The status

UpdateStatus

Enumeration

The status

Value	Description
Pending	There are pending updates to be installed.
InProgress	Updates installation are in progress.
Completed	All updates are successfully applied.
RetryNow	Updates installation failed but are ready to retry again.
RetryLater	Updates installation failed and should be retried later.
NoUpdatesPending	No updates are pending.
Cancel	Cancel the schedule and stop creating PMR for resources part of it. Applicable to Maintenance Configuration resource type only.
Cancelled	Send the Cancelled response to the user if request came to cancel the schedule. Applicable to Maintenance Configuration resource type only.