Public Maintenance Configurations - Get

Referenz

Dienst:: Maintenance

API-Version:: 2023-09-01-preview

Abrufen des Konfigurationsdatensatzes für öffentliche Wartung

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceName	path	True	string	Name der Wartungskonfiguration
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	MaintenanceConfiguration	OKAY
Other Status Codes	MaintenanceError	BadRequest

Beispiele

PublicMaintenanceConfigurations_GetForResource

Beispielanforderung

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/configuration1?api-version=2023-09-01-preview

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-maintenance
# USAGE
    python public_maintenance_configurations_get_for_resource.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.public_maintenance_configurations.get(
        resource_name="configuration1",
    )
    print(response)


# x-ms-original-file: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/examples/PublicMaintenanceConfigurations_GetForResource.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

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

// Generated from example definition: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/examples/PublicMaintenanceConfigurations_GetForResource.json
// this example is just showing the usage of "PublicMaintenanceConfigurations_Get" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this MaintenancePublicConfigurationResource
MaintenancePublicConfigurationCollection collection = subscriptionResource.GetMaintenancePublicConfigurations();

// invoke the operation
string resourceName = "configuration1";
NullableResponse<MaintenancePublicConfigurationResource> response = await collection.GetIfExistsAsync(resourceName);
MaintenancePublicConfigurationResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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
    MaintenanceConfigurationData 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/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/configuration1",
  "name": "configuration1",
  "location": "westus2",
  "properties": {
    "namespace": "Microsoft.Maintenance",
    "maintenanceScope": "SQLDB",
    "visibility": "Public",
    "maintenanceWindow": {
      "startDateTime": "2020-04-30 08:00",
      "expirationDateTime": "9999-12-31 00:00",
      "duration": "05:00",
      "timeZone": "Pacific Standard Time",
      "recurEvery": "2Weeks"
    }
  }
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorDetails	Fehlerantwortdetails, die vom Azure-Wartungsdienst empfangen wurden.
InputLinuxParameters	Eingabeeigenschaften für das Patchen eines Linux-Computers.
InputPatchConfiguration	Eingabekonfiguration für einen Patchlauf
InputWindowsParameters	Eingabeeigenschaften für das Patchen eines Windows-Computers.
MaintenanceConfiguration	Datensatztyp der Wartungskonfiguration
MaintenanceError	Eine Vom Azure-Wartungsdienst empfangene Fehlerantwort.
MaintenanceScope	Dient zum Abrufen oder Festlegen von MaintenanceScope der Konfiguration.
RebootOptions	Mögliche Neustarteinstellung gemäß definition des Benutzers, auf deren Grundlage es beschlossen würde, den Computer neu zu starten oder nicht, nachdem der Patchvorgang abgeschlossen wurde.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
Visibility	Ruft die Sichtbarkeit der Konfiguration ab oder legt sie fest. Der Standardwert ist "Benutzerdefiniert"

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

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.

InputLinuxParameters

Objekt

Eingabeeigenschaften für das Patchen eines Linux-Computers.

Name	Typ	Beschreibung
classificationsToInclude	string[]	Klassifizierungskategorie von Patches, die gepatcht werden sollen. Zulässige Werte sind "Kritisch", "Sicherheit" und "Sonstige".
packageNameMasksToExclude	string[]	Paketnamen, die für das Patchen ausgeschlossen werden sollen.
packageNameMasksToInclude	string[]	Paketnamen, die zum Patchen eingeschlossen werden sollen.

InputPatchConfiguration

Objekt

Eingabekonfiguration für einen Patchlauf

Name	Typ	Standardwert	Beschreibung
linuxParameters	InputLinuxParameters		Eingabeparameter, die für das Patchen eines Linux-Computers spezifisch sind. Übergeben Sie diese Eigenschaft für Windows-Computer nicht.
rebootSetting	RebootOptions	IfRequired	Mögliche Neustarteinstellung gemäß definition des Benutzers, auf deren Grundlage es beschlossen würde, den Computer neu zu starten oder nicht, nachdem der Patchvorgang abgeschlossen wurde.
windowsParameters	InputWindowsParameters		Eingabeparameter, die für das Patchen eines Windows-Computers spezifisch sind. Übergeben Sie diese Eigenschaft für Linux-Computer nicht.

InputWindowsParameters

Objekt

Eingabeeigenschaften für das Patchen eines Windows-Computers.

Name	Typ	Beschreibung
classificationsToInclude	string[]	Klassifizierungskategorie von Patches, die gepatcht werden sollen. Zulässige Werte sind "Critical", "Security", "UpdateRollup", "FeaturePack", "ServicePack", "Definition", "Tools" und "Updates".
excludeKbsRequiringReboot	boolean	Schließen Sie Patches aus, die neustarten müssen
kbNumbersToExclude	string[]	Windows KBID, die für das Patchen ausgeschlossen werden soll.
kbNumbersToInclude	string[]	Windows KBID, die zum Patchen enthalten sein soll.

MaintenanceConfiguration

Objekt

Datensatztyp der Wartungskonfiguration

Name	Typ	Beschreibung
id	string	Vollqualifizierter Bezeichner der Ressource
location	string	Ruft den Speicherort der Ressource ab oder legt sie fest.
name	string	Name der Ressource
properties.extensionProperties	object	Dient zum Abrufen oder Festlegen von ExtensionProperties der maintenanceConfiguration
properties.installPatches	InputPatchConfiguration	Die Eingabeparameter, die an den Patchausführungsvorgang übergeben werden sollen.
properties.maintenanceScope	MaintenanceScope	Dient zum Abrufen oder Festlegen von MaintenanceScope der Konfiguration.
properties.maintenanceWindow.duration	string	Dauer des Wartungsfensters im HH:mm-Format. Wenn nicht angegeben, wird der Standardwert basierend auf dem bereitgestellten Wartungsumfang verwendet. Beispiel: 05:00.
properties.maintenanceWindow.expirationDateTime	string	Effektives Ablaufdatum des Wartungsfensters im JJJJ-MM-DD hh:mm-Format. Das Fenster wird in der bereitgestellten Zeitzone erstellt und entsprechend dieser Zeitzone auf Sommereinsparungen angepasst. Das Ablaufdatum muss auf ein zukünftiges Datum festgelegt werden. Wenn nicht angegeben, wird sie auf die maximale Datumszeit 9999-12-31 23:59:59:59 festgelegt.
properties.maintenanceWindow.recurEvery	string	Rate, mit der ein Wartungsfenster wieder auftritt. Der Satz kann als tägliche, wöchentliche oder monatliche Zeitpläne ausgedrückt werden. Tageszeitplan wird als "recurEvery" formatiert: [Häufigkeit als ganze Zahl]['Tag(n)']. Wenn keine Häufigkeit angegeben wird, ist die Standardhäufigkeit 1. Beispiele für tägliche Zeitpläne sind recurEvery: Day, recurEvery: 3Days. Wochenplan wird als "recurEvery" formatiert: [Häufigkeit als ganze Zahl]['Woche(n)'] [Optionale durch Komma getrennte Liste der Wochentage Montag-Sonntag]. Wöchentliche Zeitplanbeispiele sind recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monatliche Zeitpläne werden als [Häufigkeit als ganze Zahl]['Monat(n)' [Durch Trennzeichen getrennte Liste der Monatstage] oder [Häufigkeit als ganze Zahl][Monatsmonat(s)] [Woche des Monats (Erste, Zweite, Dritte, Vierte, Letzte)] [Wochentag Montag-Sonntag] [Optional offset(No. of days)] formatiert. Der Offsetwert muss zwischen -6 und einschließlich 6 liegen. Beispiele für monatlichen Zeitplan sind recurEvery: Month, recurEvery: 2Months, recurEvery: Month day23,day24, recurEvery: Month Last Sunday, recurEvery: Month Fourth Montag, recurEvery: Month Last Sunday Offset-3, recurEvery: Month Third Sunday Offset6.
properties.maintenanceWindow.startDateTime	string	Effektives Startdatum des Wartungsfensters im JJJJ-MM-DD hh:mm-Format. Das Startdatum kann entweder auf das aktuelle Datum oder das zukünftige Datum festgelegt werden. Das Fenster wird in der bereitgestellten Zeitzone erstellt und entsprechend dieser Zeitzone auf Sommereinsparungen angepasst.
properties.maintenanceWindow.timeZone	string	Name der Zeitzone. Eine Liste der Zeitzonen kann durch Ausführen von [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell abgerufen werden. Beispiel: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australien Standardzeit.
properties.namespace	string	Ruft den Namespace der Ressource ab oder legt sie fest.
properties.visibility	Visibility	Ruft die Sichtbarkeit der Konfiguration ab oder legt sie fest. Der Standardwert ist "Benutzerdefiniert"
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Ruft Tags der Ressource ab oder legt sie fest.
type	string	Typ der Ressource

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.

RebootOptions

Enumeration

Mögliche Neustarteinstellung gemäß definition des Benutzers, auf deren Grundlage es beschlossen würde, den Computer neu zu starten oder nicht, nachdem der Patchvorgang abgeschlossen wurde.

Wert	Beschreibung
Always
IfRequired
Never

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	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 (date-time)	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.

Visibility

Enumeration

Ruft die Sichtbarkeit der Konfiguration ab oder legt sie fest. Der Standardwert ist "Benutzerdefiniert"

Wert	Beschreibung
Custom	Nur für Benutzer mit Berechtigungen sichtbar.
Public	Für alle Benutzer sichtbar.

Freigeben über

Public Maintenance Configurations - Get

URI-Parameter

Antworten

Beispiele

PublicMaintenanceConfigurations_GetForResource

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

ErrorDetails

InputLinuxParameters

InputPatchConfiguration

InputWindowsParameters

MaintenanceConfiguration

MaintenanceError

MaintenanceScope

RebootOptions

systemData

Visibility