Public Maintenance Configurations - List

Referentie

Service:: Maintenance

API-versie:: 2023-09-01-preview

Openbare onderhoudsconfiguratierecords ophalen

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

URI-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	Abonnementsreferenties waarmee een Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.

Antwoorden

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

Voorbeelden

PublicMaintenanceConfigurations_List

Voorbeeldaanvraag

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/publicMaintenanceConfigurations?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_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.public_maintenance_configurations.list()
    for item in response:
        print(item)


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

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_List.json
// this example is just showing the usage of "PublicMaintenanceConfigurations_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 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 and iterate over the result
await foreach (MaintenancePublicConfigurationResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "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:00",
          "expirationDateTime": "9999-12-31 00:00:00",
          "duration": "05:00:00",
          "timeZone": "Pacific Standard Time",
          "recurEvery": "Week Saturday,Sunday"
        }
      }
    }
  ]
}

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorDetails	Details van een foutantwoord die zijn ontvangen van de Azure Maintenance-service.
InputLinuxParameters	Invoereigenschappen voor het patchen van een Linux-machine.
InputPatchConfiguration	Invoerconfiguratie voor een patchuitvoering
InputWindowsParameters	Invoereigenschappen voor het patchen van een Windows-computer.
ListMaintenanceConfigurationsResult	Antwoord voor de lijst MaintenanceConfigurations
MaintenanceConfiguration	Recordtype onderhoudsconfiguratie
MaintenanceError	Er is een foutbericht ontvangen van de Azure Maintenance-service.
MaintenanceScope	Hiermee haalt u maintenanceScope van de configuratie op of stelt u deze in
RebootOptions	Mogelijke voorkeur voor opnieuw opstarten zoals gedefinieerd door de gebruiker op basis waarvan wordt besloten de computer opnieuw op te starten of niet nadat de patchbewerking is voltooid.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
Visibility	Hiermee haalt u de zichtbaarheid van de configuratie op of stelt u deze in. De standaardwaarde is 'Aangepast'

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

ErrorDetails

Object

Details van een foutantwoord die zijn ontvangen van de Azure Maintenance-service.

Name	Type	Description
code	string	Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.
message	string	Leesbare weergave van de fout.

InputLinuxParameters

Object

Invoereigenschappen voor het patchen van een Linux-machine.

Name	Type	Description
classificationsToInclude	string[]	Classificatiecategorie van patches die moeten worden gepatcht. Toegestane waarden zijn Kritiek, Beveiliging en Overige.
packageNameMasksToExclude	string[]	Pakketnamen die moeten worden uitgesloten voor patching.
packageNameMasksToInclude	string[]	Pakketnamen die moeten worden opgenomen voor patching.

InputPatchConfiguration

Object

Invoerconfiguratie voor een patchuitvoering

Name	Type	Default value	Description
linuxParameters	InputLinuxParameters		Invoerparameters die specifiek zijn voor het patchen van linux-machines. Geef deze eigenschap niet door voor Windows-computers.
rebootSetting	RebootOptions	IfRequired	Mogelijke voorkeur voor opnieuw opstarten zoals gedefinieerd door de gebruiker op basis waarvan wordt besloten de computer opnieuw op te starten of niet nadat de patchbewerking is voltooid.
windowsParameters	InputWindowsParameters		Invoerparameters die specifiek zijn voor het patchen van een Windows-computer. Geef deze eigenschap niet door voor Linux-machines.

InputWindowsParameters

Object

Invoereigenschappen voor het patchen van een Windows-computer.

Name	Type	Description
classificationsToInclude	string[]	Classificatiecategorie van patches die moeten worden gepatcht. Toegestane waarden zijn 'Kritiek', 'Beveiliging', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definitie', 'Hulpprogramma's' en 'Updates'.
excludeKbsRequiringReboot	boolean	Patches uitsluiten die opnieuw moeten worden opgestart
kbNumbersToExclude	string[]	Windows KBID die moet worden uitgesloten voor patching.
kbNumbersToInclude	string[]	Windows KBID moet worden opgenomen voor patching.

ListMaintenanceConfigurationsResult

Object

Antwoord voor de lijst MaintenanceConfigurations

Name	Type	Description
value	MaintenanceConfiguration[]	De lijst met onderhoudsconfiguraties

MaintenanceConfiguration

Object

Recordtype onderhoudsconfiguratie

Name	Type	Description
id	string	Volledig gekwalificeerde id van de resource
location	string	Hiermee haalt u de locatie van de resource op of stelt u deze in
name	string	Naam van de resource
properties.extensionProperties	object	Hiermee haalt u extensionProperties van de maintenanceConfiguration op of stelt u deze in
properties.installPatches	InputPatchConfiguration	De invoerparameters die moeten worden doorgegeven aan de patchuitvoeringsbewerking.
properties.maintenanceScope	MaintenanceScope	Hiermee haalt u maintenanceScope van de configuratie op of stelt u deze in
properties.maintenanceWindow.duration	string	Duur van het onderhoudsvenster in HH:mm-formaat. Indien niet opgegeven, wordt de standaardwaarde gebruikt op basis van het opgegeven onderhoudsbereik. Voorbeeld: 05:00.
properties.maintenanceWindow.expirationDateTime	string	Effectieve vervaldatum van het onderhoudsvenster in JJJJ-MM-DD uu:mm-notatie. Het venster wordt gemaakt in de opgegeven tijdzone en aangepast aan zomertijd op basis van die tijdzone. De vervaldatum moet worden ingesteld op een toekomstige datum. Indien niet opgegeven, wordt deze ingesteld op de maximale datum/tijd 9999-12-31 23:59:59.
properties.maintenanceWindow.recurEvery	string	Snelheid waarmee een onderhoudsvenster naar verwachting opnieuw zal optreden. Het tarief kan worden uitgedrukt als dagelijkse, wekelijkse of maandelijkse schema's. De dagelijkse planning wordt opgemaakt als recurEvery: [Frequentie als geheel getal][Dag(en)]. Als er geen frequentie wordt opgegeven, is de standaardfrequentie 1. Voorbeelden van dagelijkse planningen zijn recurEvery: Day, recurEvery: 3Days. Wekelijkse planning wordt opgemaakt als recurEvery: [Frequentie als geheel getal][Week(en)] [Optionele door komma's gescheiden lijst met weekdagen maandag-zondag]. Wekelijkse planningsvoorbeelden zijn recurEvery: 3Weeks, recurEvery: Week zaterdag, zondag. Maandelijkse schema's zijn opgemaakt als [Frequentie als geheel getal][Maand(en)] [Door komma's gescheiden lijst met maanddagen] of [Frequentie als geheel getal][Maand(en)] [Week van maand (eerste, tweede, derde, vierde, laatste)] [weekdag maandag-zondag] [Optionele verschuiving(nee. van dagen)]. De verschuivingswaarde moet tussen -6 en 6 liggen. Maandelijkse schemavoorbeelden zijn recurEvery: Month, recurEvery: 2Months, recurEvery: Month day23,day24, recurEvery: Month Last Sunday, recurEvery: Month Fourth Monday, recurEvery: Month Last Sunday Offset-3, recurEvery: Month Third Sunday Offset6.
properties.maintenanceWindow.startDateTime	string	Effectieve begindatum van het onderhoudsvenster in JJJJ-MM-DD uu:mm formaat. De begindatum kan worden ingesteld op de huidige of toekomstige datum. Het venster wordt gemaakt in de opgegeven tijdzone en aangepast aan zomertijd op basis van die tijdzone.
properties.maintenanceWindow.timeZone	string	Naam van de tijdzone. Lijst met tijdzones kan worden verkregen door [System.TimeZoneInfo]::GetSystemTimeZones() uit te voeren in PowerShell. Voorbeeld: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australië Standaardtijd.
properties.namespace	string	Hiermee haalt u de naamruimte van de resource op of stelt u deze in
properties.visibility	Visibility	Hiermee haalt u de zichtbaarheid van de configuratie op of stelt u deze in. De standaardwaarde is 'Aangepast'
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object	Hiermee haalt u tags van de resource op of stelt u deze in
type	string	Type resource

MaintenanceError

Object

Er is een foutbericht ontvangen van de Azure Maintenance-service.

Name	Type	Description
error	ErrorDetails	Details van de fout

MaintenanceScope

Inventarisatie

Hiermee haalt u maintenanceScope van de configuratie op of stelt u deze in

Waarde	Description
Extension	Met dit onderhoudsbereik wordt de installatie van extensies op VM/VMSS bepaald
Host	Dit onderhoudsbereik bepaalt de installatie van Azure-platformupdates, zoals services op fysieke knooppunten die als host fungeren voor klant-VM's.
InGuestPatch	Dit onderhoudsbereik bepaalt de installatie van Windows- en Linux-pakketten op VM/VMSS
OSImage	Met dit onderhoudsbereik wordt de installatie van installatiekopieën van het besturingssysteem op VM/VMSS bepaald
Resource	Dit onderhoudsbereik bepaalt het standaardonderhoud van updates van de Azure-resource
SQLDB	Dit onderhoudsbereik bepaalt de installatie van updates van het SQL Server-platform.
SQLManagedInstance	Dit onderhoudsbereik bepaalt de installatie van de platformupdate van sql Managed Instance.

RebootOptions

Inventarisatie

Mogelijke voorkeur voor opnieuw opstarten zoals gedefinieerd door de gebruiker op basis waarvan wordt besloten de computer opnieuw op te starten of niet nadat de patchbewerking is voltooid.

Waarde	Description
Always
IfRequired
Never

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Visibility

Inventarisatie

Hiermee haalt u de zichtbaarheid van de configuratie op of stelt u deze in. De standaardwaarde is 'Aangepast'

Waarde	Description
Custom	Alleen zichtbaar voor gebruikers met machtigingen.
Public	Zichtbaar voor alle gebruikers.

Delen via

Public Maintenance Configurations - List

URI-parameters

Antwoorden

Voorbeelden

PublicMaintenanceConfigurations_List

Voorbeeldaanvraag

Voorbeeldrespons

Definities

createdByType

ErrorDetails

InputLinuxParameters

InputPatchConfiguration

InputWindowsParameters

ListMaintenanceConfigurationsResult

MaintenanceConfiguration

MaintenanceError

MaintenanceScope

RebootOptions

systemData

Visibility