Updates - List Parent

Dienst:

Maintenance

API-Version:

2023-09-01-preview

Abrufen von Updates für Ressourcen.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
providerName	path	True	string	Name des Ressourcenanbieters
resourceGroupName	path	True	string	Ressourcengruppenname
resourceName	path	True	string	Ressourcenbezeichner
resourceParentName	path	True	string	Übergeordneter Ressourcenbezeichner
resourceParentType	path	True	string	Übergeordneter Ressourcentyp
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.

Antworten

Name	Typ	Beschreibung
200 OK	ListUpdatesResult	OKAY
Other Status Codes	MaintenanceError	Ungültige Anfrage

Beispiele

Updates_ListParent

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/1/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_parent.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_parent(
        resource_group_name="examplerg",
        provider_name="Microsoft.Compute",
        resource_parent_type="virtualMachineScaleSets",
        resource_parent_name="smdtest1",
        resource_type="virtualMachines",
        resource_name="1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/examples/Updates_ListParent.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_ListParent.json
// this example is just showing the usage of "Updates_ListParent" 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 resourceParentType = "virtualMachineScaleSets";
string resourceParentName = "smdtest1";
string resourceType = "virtualMachines";
string resourceName = "1";
await foreach (MaintenanceUpdate item in resourceGroupResource.GetUpdatesByParentAsync(providerName, resourceParentType, resourceParentName, 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

Beispiel für eine Antwort

Statuscode:

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/virtualMachines/1"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorDetails	Fehlerantwortdetails, die vom Azure-Wartungsdienst empfangen wurden.
ImpactType	Der Auswirkungstyp
ListUpdatesResult	Antwort auf Aktualisierungsliste
MaintenanceError	Eine Vom Azure-Wartungsdienst empfangene Fehlerantwort.
MaintenanceScope	Dient zum Abrufen oder Festlegen von MaintenanceScope der Konfiguration.
Update	Wartungsupdate für eine Ressource
UpdateStatus	Der Status

ErrorDetails

Objekt

Fehlerantwortdetails, die vom Azure-Wartungsdienst empfangen wurden.

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

ImpactType

Enumeration

Der Auswirkungstyp

Wert	Beschreibung
Freeze	Ausstehende Updates können den Netzwerk- oder Datenträger-E/A-Vorgang auf der Ressource fixieren.
None	Ausstehende Updates haben keine Auswirkungen auf die Ressource.
Redeploy	Ausstehende Updates können ressource erneut bereitstellen.
Restart	Ausstehende Updates können dazu führen, dass die Ressource neu gestartet wird.

ListUpdatesResult

Objekt

Antwort auf Aktualisierungsliste

Name	Typ	Beschreibung
value	Update[]	Die ausstehenden Updates

MaintenanceError

Objekt

Eine Vom Azure-Wartungsdienst empfangene Fehlerantwort.

Name	Typ	Beschreibung
error	ErrorDetails	Details des Fehlers

MaintenanceScope

Enumeration

Dient zum Abrufen oder Festlegen von MaintenanceScope der Konfiguration.

Wert	Beschreibung
Extension	Dieser Wartungsbereich steuert die Erweiterungsinstallation auf VM/VMSS
Host	Dieser Wartungsumfang steuert die Installation von Azure-Plattformupdates, d. h. Diensten auf physischen Knoten, die Kunden-VMs hosten.
InGuestPatch	Dieser Wartungsumfang steuert die Installation von Windows- und Linux-Paketen auf VM/VMSS
OSImage	Dieser Wartungsbereich steuert die Installation des Betriebssystemimages auf VM/VMSS
Resource	Dieser Wartungsbereich steuert die standardmäßige Aktualisierungswartung der Azure-Ressource.
SQLDB	Dieser Wartungsumfang steuert die Installation von SQL Server-Plattformupdates.
SQLManagedInstance	Dieser Wartungsbereich steuert die Installation des UPDATES der verwalteten SQL-Instanzplattform.

Update

Objekt

Wartungsupdate für eine Ressource

Name	Typ	Beschreibung
impactDurationInSec	integer (int32)	Dauer der Auswirkung in Sekunden
impactType	ImpactType	Der Auswirkungstyp
maintenanceScope	MaintenanceScope	Der Wirkungsbereich
notBefore	string (date-time)	Zeitpunkt, zu dem Azure Updates erzwingt, wenn sie vor diesem Zeitpunkt nicht vom Kunden selbst aktualisiert werden
properties.resourceId	string	Die resourceId
status	UpdateStatus	Der Status

UpdateStatus

Enumeration

Der Status

Wert	Beschreibung
Cancel	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	Senden Sie die Antwort "Abgebrochen" an den Benutzer, wenn die Anforderung zum Abbrechen des Zeitplans erfolgte. Gilt nur für den Ressourcentyp "Wartungskonfiguration".
Completed	Alle Updates werden erfolgreich angewendet.
InProgress	Die Installation von Updates wird ausgeführt.
NoUpdatesPending	Es stehen keine Updates aus.
Pending	Es stehen ausstehende Updates zur Installation bereit.
RetryLater	Fehler bei der Installation von Updates und sollte später erneut ausgeführt werden.
RetryNow	Fehler bei der Installation von Updates, können aber erneut versucht werden.