Apply Updates - Create Or Update

Service:

Maintenance

API Version:

2023-09-01-preview

Apply Updates to resource
Apply maintenance updates to resource

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default?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	ApplyUpdate	ApplyUpdate update request accepted
201 Created	ApplyUpdate	ApplyUpdate create request accepted
Other Status Codes	MaintenanceError	BadRequest

Examples

ApplyUpdates_CreateOrUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/default?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 apply_updates_create_or_update.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.apply_updates.create_or_update(
        resource_group_name="examplerg",
        provider_name="Microsoft.Compute",
        resource_type="virtualMachineScaleSets",
        resource_name="smdtest1",
    )
    print(response)


# x-ms-original-file: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/examples/ApplyUpdates_CreateOrUpdate.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;
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/ApplyUpdates_CreateOrUpdate.json
// this example is just showing the usage of "ApplyUpdates_CreateOrUpdate" 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
string providerName = "Microsoft.Compute";
string resourceType = "virtualMachineScaleSets";
string resourceName = "smdtest1";
MaintenanceApplyUpdateResource result = await resourceGroupResource.CreateOrUpdateApplyUpdateAsync(providerName, resourceType, resourceName);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MaintenanceApplyUpdateData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6",
  "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6",
  "type": "Microsoft.Maintenance/applyUpdates",
  "properties": {
    "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1",
    "status": "Pending"
  }
}

Status code:

201

{
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6",
  "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6",
  "type": "Microsoft.Maintenance/applyUpdates",
  "properties": {
    "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1",
    "status": "Pending"
  }
}

Definitions

Name	Description
ApplyUpdate	Apply Update request
createdByType	The type of identity that created the resource.
ErrorDetails	An error response details received from the Azure Maintenance service.
MaintenanceError	An error response received from the Azure Maintenance service.
systemData	Metadata pertaining to creation and last modification of the resource.
UpdateStatus	The status

ApplyUpdate

Apply Update request

Name	Type	Description
id	string	Fully qualified identifier of the resource
name	string	Name of the resource
properties.lastUpdateTime	string	Last Update time
properties.resourceId	string	The resourceId
properties.status	UpdateStatus	The status
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	Type of the resource

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

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.

MaintenanceError

An error response received from the Azure Maintenance service.

Name	Type	Description
error	ErrorDetails	Details of the error

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UpdateStatus

The status

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