Apply Updates - Create Or Update Or Cancel

Dienst:

Maintenance

API-Version:

2023-09-01-preview

Anwenden Updates auf Ressource
Anwenden von Wartungsupdates auf eine Ressource

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
applyUpdateName	path	True	string	ApplyUpdate-Name
providerName	path	True	string	Name des Ressourcenanbieters
resourceGroupName	path	True	string	Ressourcengruppenname
resourceName	path	True	string	Ressourcenbezeichner
resourceType	path	True	string	Ressourcentyp
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.lastUpdateTime	string	Zeitpunkt der letzten Aktualisierung
properties.resourceId	string	Die resourceId
properties.status	UpdateStatus	Status

Antworten

Name	Typ	Beschreibung
200 OK	ApplyUpdate	ApplyUpdate-Updateanforderung akzeptiert
201 Created	ApplyUpdate	ApplyUpdate-Erstellungsanforderung akzeptiert
Other Status Codes	MaintenanceError	BadRequest

Beispiele

ApplyUpdates_CreateOrUpdateOnly_NoCancellation

ApplyUpdates_CreateOrUpdateOrCancel

ApplyUpdates_CreateOrUpdateOnly_NoCancellation

Beispielanforderung

HTTP

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

{}

Python

No code sample is available. To request a 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_CreateOrUpdateOnly_NoCancellation.json
// this example is just showing the usage of "ApplyUpdates_CreateOrUpdateOrCancel" 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 MaintenanceApplyUpdateResource created on azure
// for more information of creating MaintenanceApplyUpdateResource, please refer to the document of MaintenanceApplyUpdateResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
string providerName = "Microsoft.Compute";
string resourceType = "virtualMachineScaleSets";
string resourceName = "smdtest1";
string applyUpdateName = "20230901121200";
ResourceIdentifier maintenanceApplyUpdateResourceId = MaintenanceApplyUpdateResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, providerName, resourceType, resourceName, applyUpdateName);
MaintenanceApplyUpdateResource maintenanceApplyUpdate = client.GetMaintenanceApplyUpdateResource(maintenanceApplyUpdateResourceId);

// invoke the operation
MaintenanceApplyUpdateData data = new MaintenanceApplyUpdateData();
ArmOperation<MaintenanceApplyUpdateResource> lro = await maintenanceApplyUpdate.UpdateAsync(WaitUntil.Completed, data);
MaintenanceApplyUpdateResource result = lro.Value;

// 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

Beispiel für eine Antwort

Statuscode:

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"
  }
}

Statuscode:

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"
  }
}

ApplyUpdates_CreateOrUpdateOrCancel

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/maintenanceConfig1/providers/Microsoft.Maintenance/applyUpdates/20230901121200?api-version=2023-09-01-preview

{
  "properties": {
    "status": "Cancel"
  }
}

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_cancel_maintenance.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_or_cancel(
        resource_group_name="examplerg",
        provider_name="Microsoft.Maintenance",
        resource_type="maintenanceConfigurations",
        resource_name="maintenanceConfig1",
        apply_update_name="20230901121200",
        apply_update={"properties": {"status": "Cancel"}},
    )
    print(response)


# x-ms-original-file: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/examples/ApplyUpdates_CreateOrUpdate_CancelMaintenance.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_CancelMaintenance.json
// this example is just showing the usage of "ApplyUpdates_CreateOrUpdateOrCancel" 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 MaintenanceApplyUpdateResource created on azure
// for more information of creating MaintenanceApplyUpdateResource, please refer to the document of MaintenanceApplyUpdateResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
string providerName = "Microsoft.Maintenance";
string resourceType = "maintenanceConfigurations";
string resourceName = "maintenanceConfig1";
string applyUpdateName = "20230901121200";
ResourceIdentifier maintenanceApplyUpdateResourceId = MaintenanceApplyUpdateResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, providerName, resourceType, resourceName, applyUpdateName);
MaintenanceApplyUpdateResource maintenanceApplyUpdate = client.GetMaintenanceApplyUpdateResource(maintenanceApplyUpdateResourceId);

// invoke the operation
MaintenanceApplyUpdateData data = new MaintenanceApplyUpdateData()
{
    Status = MaintenanceUpdateStatus.Cancel,
};
ArmOperation<MaintenanceApplyUpdateResource> lro = await maintenanceApplyUpdate.UpdateAsync(WaitUntil.Completed, data);
MaintenanceApplyUpdateResource result = lro.Value;

// 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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/microsoft.maintenance/maintenanceconfigurations/maintenanceconfig1/providers/microsoft.maintenance/applyupdates/20230901121200",
  "name": "maintenanceConfig1",
  "type": "Microsoft.Maintenance/applyUpdates",
  "properties": {
    "status": "Cancelled",
    "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/microsoft.maintenance/maintenanceconfigurations/maintenanceconfig1"
  }
}

Statuscode:

201

{
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/microsoft.maintenance/maintenanceconfigurations/maintenanceconfig1/providers/microsoft.maintenance/applyupdates/20230901121200",
  "name": "maintenanceConfig1",
  "type": "Microsoft.Maintenance/applyUpdates",
  "properties": {
    "status": "Cancelled",
    "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/microsoft.maintenance/maintenanceconfigurations/maintenanceconfig1"
  }
}

Definitionen

Name	Beschreibung
ApplyUpdate	Updateanforderung anwenden
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorDetails	Vom Azure-Wartungsdienst empfangene Fehlerantwortdetails.
MaintenanceError	Eine Vom Azure-Wartungsdienst empfangene Fehlerantwort.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
UpdateStatus	Status

ApplyUpdate

Updateanforderung anwenden

Name	Typ	Beschreibung
id	string	Vollqualifizierter Bezeichner der Ressource
name	string	Name der Ressource
properties.lastUpdateTime	string	Zeitpunkt der letzten Aktualisierung
properties.resourceId	string	Die resourceId
properties.status	UpdateStatus	Status
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string	Typ der Ressource

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Vom Azure-Wartungsdienst empfangene Fehlerantwortdetails.

Name	Typ	Beschreibung
code	string	Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
message	string	Lesbare Darstellung des Fehlers.

MaintenanceError

Eine Vom Azure-Wartungsdienst empfangene Fehlerantwort.

Name	Typ	Beschreibung
error	ErrorDetails	Details des Fehlers

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UpdateStatus

Status

Name	Typ	Beschreibung
Cancel	string	Brechen Sie den Zeitplan ab, und beenden Sie die Erstellung von PMR für Ressourcen, die teil davon sind. Gilt nur für den Ressourcentyp Wartungskonfiguration.
Cancelled	string	Senden Sie die Antwort "Abgebrochen" an den Benutzer, wenn die Anforderung zum Abbrechen des Zeitplans kam. Gilt nur für den Ressourcentyp Wartungskonfiguration.
Completed	string	Alle Updates wurden erfolgreich angewendet.
InProgress	string	Updates Installation wird ausgeführt.
NoUpdatesPending	string	Es stehen keine Updates aus.
Pending	string	Es gibt ausstehende Updates, die installiert werden müssen.
RetryLater	string	Updates Installation ist fehlgeschlagen und sollte später wiederholt werden.
RetryNow	string	Updates Installation fehlgeschlagen, können aber erneut versuchen.