Public Maintenance Configurations - Get

Service:: Maintenance

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

Obtenir un enregistrement de configuration de maintenance publique

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceName	path	True	string	Nom de la configuration de maintenance
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.

Réponses

Nom	Type	Description
200 OK	MaintenanceConfiguration	D’ACCORD
Other Status Codes	MaintenanceError	BadRequest

Exemples

PublicMaintenanceConfigurations_GetForResource

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
    }
  }
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorDetails	Détails de la réponse d’erreur reçus du service maintenance Azure.
InputLinuxParameters	Propriétés d’entrée pour la mise à jour corrective d’une machine Linux.
InputPatchConfiguration	Configuration d’entrée pour une exécution de correctif
InputWindowsParameters	Propriétés d’entrée pour la mise à jour corrective d’une machine Windows.
MaintenanceConfiguration	Type d’enregistrement de configuration de maintenance
MaintenanceError	Réponse d’erreur reçue du service Maintenance Azure.
MaintenanceScope	Obtient ou définit maintenanceScope de la configuration
RebootOptions	Préférence de redémarrage possible définie par l’utilisateur en fonction de laquelle il serait décidé de redémarrer l’ordinateur ou non une fois l’opération corrective terminée.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
Visibility	Obtient ou définit la visibilité de la configuration. La valeur par défaut est « Custom »

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorDetails

Object

Détails de la réponse d’erreur reçus du service maintenance Azure.

Nom	Type	Description
code	string	Code d’erreur défini par le service. Ce code sert de sous-état pour le code d’erreur HTTP spécifié dans la réponse.
message	string	Représentation lisible par l’homme de l’erreur.

InputLinuxParameters

Object

Propriétés d’entrée pour la mise à jour corrective d’une machine Linux.

Nom	Type	Description
classificationsToInclude	string[]	Catégorie de classification des correctifs à corriger. Les valeurs autorisées sont « Critique », « Sécurité » et « Autre ».
packageNameMasksToExclude	string[]	Noms de package à exclure pour la mise à jour corrective.
packageNameMasksToInclude	string[]	Noms de package à inclure pour la mise à jour corrective.

InputPatchConfiguration

Object

Configuration d’entrée pour une exécution de correctif

Nom	Type	Valeur par défaut	Description
linuxParameters	InputLinuxParameters		Paramètres d’entrée spécifiques à la mise à jour corrective de la machine Linux. Pour les machines Windows, ne passez pas cette propriété.
rebootSetting	RebootOptions	IfRequired	Préférence de redémarrage possible définie par l’utilisateur en fonction de laquelle il serait décidé de redémarrer l’ordinateur ou non une fois l’opération corrective terminée.
windowsParameters	InputWindowsParameters		Paramètres d’entrée spécifiques à la mise à jour corrective d’une machine Windows. Pour les machines Linux, ne transmettez pas cette propriété.

InputWindowsParameters

Object

Propriétés d’entrée pour la mise à jour corrective d’une machine Windows.

Nom	Type	Description
classificationsToInclude	string[]	Catégorie de classification des correctifs à corriger. Les valeurs autorisées sont « Critical », « Security », « UpdateRollup », « FeaturePack », « ServicePack », « Definition », « Tools » et « Updates ».
excludeKbsRequiringReboot	boolean	Exclure les correctifs qui nécessitent un redémarrage
kbNumbersToExclude	string[]	Id de base de connaissances Windows à exclure pour la mise à jour corrective.
kbNumbersToInclude	string[]	KBID Windows à inclure pour la mise à jour corrective.

MaintenanceConfiguration

Object

Type d’enregistrement de configuration de maintenance

Nom	Type	Description
id	string	Identificateur complet de la ressource
location	string	Obtient ou définit l’emplacement de la ressource
name	string	Nom de la ressource
properties.extensionProperties	object	Obtient ou définit extensionProperties de maintenanceConfiguration
properties.installPatches	InputPatchConfiguration	Paramètres d’entrée à passer à l’opération d’exécution du correctif.
properties.maintenanceScope	MaintenanceScope	Obtient ou définit maintenanceScope de la configuration
properties.maintenanceWindow.duration	string	Durée de la fenêtre de maintenance au format HH :mm. Si elle n’est pas fournie, la valeur par défaut est utilisée en fonction de l’étendue de maintenance fournie. Exemple : 05:00.
properties.maintenanceWindow.expirationDateTime	string	Date d’expiration effective de la fenêtre de maintenance au format aaaa-MM-DD hh :mm. La fenêtre sera créée dans le fuseau horaire fourni et ajustée aux économies d’été en fonction de ce fuseau horaire. La date d’expiration doit être définie sur une date ultérieure. S’il n’est pas fourni, il est défini sur la date maximale de datetime 9999-12-31 23:59:59.
properties.maintenanceWindow.recurEvery	string	Fréquence à laquelle une fenêtre maintenance est censée se reproduire. Le taux peut être exprimé sous forme de planifications quotidiennes, hebdomadaires ou mensuelles. La planification quotidienne est mise en forme sous forme de récurrité : [Fréquence en tant qu’entier]['Jour(s)']. Si aucune fréquence n’est fournie, la fréquence par défaut est 1. Les exemples de planification quotidienne sont recurEvery : Day, recurEvery : 3Days. La planification hebdomadaire est mise en forme sous forme de récurrité : [Fréquence en tant qu’entier]['Semaine(s)'] [Liste séparée par des virgules facultatives du lundi au dimanche]. Les exemples de planification hebdomadaire sont recurEvery : 3Weeks, recurEvery : Week Saturday,Sunday. Les planifications mensuelles sont mises en forme comme [Fréquence sous forme d’entier]['Mois(s)'] [Liste séparée par des virgules des jours du mois] ou [Fréquence sous forme d’entier]['Mois(s)'] [Semaine du mois (Premier, Deuxième, Troisième, Quatrième, Last)] [Lundi-dimanche en semaine] [Décalage facultatif (Non. jours)]. La valeur de décalage doit être comprise entre -6 et 6 inclus. Les exemples de planification mensuelle sont 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	Date de début effective de la fenêtre de maintenance au format aaaa-MM-DD hh :mm. La date de début peut être définie sur la date actuelle ou la date ultérieure. La fenêtre sera créée dans le fuseau horaire fourni et ajustée aux économies d’été en fonction de ce fuseau horaire.
properties.maintenanceWindow.timeZone	string	Nom du fuseau horaire. Vous pouvez obtenir la liste des fuseaux horaires en exécutant [System.TimeZoneInfo] ::GetSystemTimeZones() dans PowerShell. Exemple : Heure standard du Pacifique, UTC, W. Europe Standard Time, Corée Standard Time, Cen. Heure standard de l’Australie.
properties.namespace	string	Obtient ou définit l’espace de noms de la ressource
properties.visibility	Visibility	Obtient ou définit la visibilité de la configuration. La valeur par défaut est « Custom »
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Obtient ou définit des balises de la ressource
type	string	Type de la ressource

MaintenanceError

Object

Réponse d’erreur reçue du service Maintenance Azure.

Nom	Type	Description
error	ErrorDetails	Détails de l’erreur

MaintenanceScope

Énumération

Obtient ou définit maintenanceScope de la configuration

Valeur	Description
Host	Cette étendue de maintenance contrôle l’installation des mises à jour de plateforme Azure, c’est-à-dire les services sur les nœuds physiques hébergeant des machines virtuelles clientes.
Resource	Cette étendue de maintenance contrôle la maintenance des mises à jour par défaut de la ressource Azure
OSImage	Cette étendue de maintenance contrôle l’installation de l’image du système d’exploitation sur la machine virtuelle/VMSS
Extension	Cette étendue de maintenance contrôle l’installation de l’extension sur la machine virtuelle/VMSS
InGuestPatch	Cette étendue de maintenance contrôle l’installation des packages Windows et Linux sur la machine virtuelle/VMSS
SQLDB	Cette étendue de maintenance contrôle l’installation des mises à jour de la plateforme SQL Server.
SQLManagedInstance	Cette étendue de maintenance contrôle l’installation de la mise à jour de la plateforme SQL Managed Instance.

RebootOptions

Énumération

Préférence de redémarrage possible définie par l’utilisateur en fonction de laquelle il serait décidé de redémarrer l’ordinateur ou non une fois l’opération corrective terminée.

Valeur	Description
IfRequired
Never
Always

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Visibility

Énumération

Obtient ou définit la visibilité de la configuration. La valeur par défaut est « Custom »

Valeur	Description
Custom	Visible uniquement pour les utilisateurs disposant d’autorisations.
Public	Visible pour tous les utilisateurs.

Partager via

Public Maintenance Configurations - Get

Paramètres URI

Réponses

Exemples

PublicMaintenanceConfigurations_GetForResource

Exemple de requête

Exemple de réponse

Définitions

createdByType

ErrorDetails

InputLinuxParameters

InputPatchConfiguration

InputWindowsParameters

MaintenanceConfiguration

MaintenanceError

MaintenanceScope

RebootOptions

systemData

Visibility