Public Maintenance Configurations - Get

Usługa:: Maintenance

Wersja interfejsu API:: 2023-09-01-preview

Uzyskiwanie rekordu konfiguracji konserwacji publicznej

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceName	path	True	string	Nazwa konfiguracji konserwacji
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	MaintenanceConfiguration	OK
Other Status Codes	MaintenanceError	BadRequest

Przykłady

PublicMaintenanceConfigurations_GetForResource

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  }
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorDetails	Szczegóły odpowiedzi na błąd odebrane z usługi Azure Maintenance.
InputLinuxParameters	Właściwości wejściowe do stosowania poprawek maszyny z systemem Linux.
InputPatchConfiguration	Konfiguracja danych wejściowych dla przebiegu poprawki
InputWindowsParameters	Właściwości wejściowe do stosowania poprawek maszyny z systemem Windows.
MaintenanceConfiguration	Typ rekordu konfiguracji konserwacji
MaintenanceError	Odebrano odpowiedź o błędzie z usługi Azure Maintenance.
MaintenanceScope	Pobiera lub ustawia konserwacjęZakres konfiguracji
RebootOptions	Możliwe preferencje ponownego rozruchu zdefiniowane przez użytkownika w oparciu o to, na podstawie którego podjęto decyzję o ponownym uruchomieniu maszyny lub nie po zakończeniu operacji poprawki.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
Visibility	Pobiera lub ustawia widoczność konfiguracji. Wartość domyślna to "Niestandardowy"

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorDetails

Objekt

Szczegóły odpowiedzi na błąd odebrane z usługi Azure Maintenance.

Nazwa	Typ	Opis
code	string	Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.
message	string	Czytelna dla człowieka reprezentacja błędu.

InputLinuxParameters

Objekt

Właściwości wejściowe do stosowania poprawek maszyny z systemem Linux.

Nazwa	Typ	Opis
classificationsToInclude	string[]	Kategoria klasyfikacji poprawek do stosowania poprawek. Dozwolone wartości to "Krytyczne", "Zabezpieczenia" i "Inne".
packageNameMasksToExclude	string[]	Nazwy pakietów, które mają być wykluczone do stosowania poprawek.
packageNameMasksToInclude	string[]	Nazwy pakietów do stosowania poprawek.

InputPatchConfiguration

Objekt

Konfiguracja danych wejściowych dla przebiegu poprawki

Nazwa	Typ	Domyślna wartość	Opis
linuxParameters	InputLinuxParameters		Parametry wejściowe specyficzne dla poprawiania maszyny z systemem Linux. W przypadku maszyn z systemem Windows nie przekazuj tej właściwości.
rebootSetting	RebootOptions	IfRequired	Możliwe preferencje ponownego rozruchu zdefiniowane przez użytkownika w oparciu o to, na podstawie którego podjęto decyzję o ponownym uruchomieniu maszyny lub nie po zakończeniu operacji poprawki.
windowsParameters	InputWindowsParameters		Parametry wejściowe specyficzne dla stosowania poprawek maszyny z systemem Windows. W przypadku maszyn z systemem Linux nie przekazuj tej właściwości.

InputWindowsParameters

Objekt

Właściwości wejściowe do stosowania poprawek maszyny z systemem Windows.

Nazwa	Typ	Opis
classificationsToInclude	string[]	Kategoria klasyfikacji poprawek do stosowania poprawek. Dozwolone wartości to "Krytyczne", "Zabezpieczenia", "UpdateRollup", "FeaturePack", "ServicePack", "Definition", "Tools" i "Updates".
excludeKbsRequiringReboot	boolean	Wykluczanie poprawek, które wymagają ponownego uruchomienia
kbNumbersToExclude	string[]	Identyfikator KBID systemu Windows, który ma zostać wykluczony do stosowania poprawek.
kbNumbersToInclude	string[]	Identyfikator KBID systemu Windows do stosowania poprawek.

MaintenanceConfiguration

Objekt

Typ rekordu konfiguracji konserwacji

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu
location	string	Pobiera lub ustawia lokalizację zasobu
name	string	Nazwa zasobu
properties.extensionProperties	object	Pobiera lub ustawia rozszerzenieWłaściwości konserwacjiKonfiguracja
properties.installPatches	InputPatchConfiguration	Parametry wejściowe, które mają zostać przekazane do operacji uruchamiania poprawek.
properties.maintenanceScope	MaintenanceScope	Pobiera lub ustawia konserwacjęZakres konfiguracji
properties.maintenanceWindow.duration	string	Czas trwania okna obsługi w formacie HH:mm. Jeśli nie zostanie podana, wartość domyślna będzie używana na podstawie podanego zakresu konserwacji. Przykład: 05:00.
properties.maintenanceWindow.expirationDateTime	string	Obowiązująca data wygaśnięcia okna obsługi w formacie RRRR-MM-DD hh:mm. Okno zostanie utworzone w podanej strefie czasowej i dostosowane do oszczędności światła dziennego zgodnie z tym strefą czasową. Data wygaśnięcia musi być ustawiona na datę przyszłej. Jeśli nie zostanie podana, zostanie ustawiona maksymalna data/godzina 9999-12-31 23:59:59.
properties.maintenanceWindow.recurEvery	string	Szybkość, z jaką okno obsługi ma się powtarzać. Stawka może być wyrażona jako harmonogramy dzienne, tygodniowe lub miesięczne. Harmonogram dzienny jest sformatowany jako recurEvery: [Frequency as integer]['Day(s)']. Jeśli nie podano żadnej częstotliwości, domyślna częstotliwość to 1. Przykłady harmonogramu codziennego są recurEvery: Day, recurEvery: 3Days. Harmonogram tygodniowy jest sformatowany jako recurEvery: [Frequency as integer]['Week(s)'] [Opcjonalna lista rozdzielana przecinkami dni powszednie poniedziałek-niedziela]. Przykłady harmonogramu tygodniowego to recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Harmonogramy miesięczne są formatowane jako [Częstotliwość jako liczba całkowita]['Month(s)'] [Rozdzielana przecinkami lista dni miesiąca] lub [Frequency as integer]['Month(s)'] [Week of Month(s)] [Week of Month(First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Wartość przesunięcia musi należeć między -6 a 6 włącznie. Przykłady harmonogramu miesięcznego to 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	Data rozpoczęcia okna obsługi w formacie RRRR-MM-DD hh:mm. Datę rozpoczęcia można ustawić na bieżącą datę lub datę przyszłą. Okno zostanie utworzone w podanej strefie czasowej i dostosowane do oszczędności światła dziennego zgodnie z tym strefą czasową.
properties.maintenanceWindow.timeZone	string	Nazwa strefy czasowej. Listę stref czasowych można uzyskać, wykonując polecenie [System.TimeZoneInfo]::GetSystemTimeZones() w programie PowerShell. Przykład: Pacyfik (czas standardowy), UTC, Europa (czas standardowy), Korea (czas standardowy), Cen (Cen). Australia (czas standardowy).
properties.namespace	string	Pobiera lub ustawia przestrzeń nazw zasobu
properties.visibility	Visibility	Pobiera lub ustawia widoczność konfiguracji. Wartość domyślna to "Niestandardowy"
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	object	Pobiera lub ustawia tagi zasobu
type	string	Typ zasobu

MaintenanceError

Objekt

Odebrano odpowiedź o błędzie z usługi Azure Maintenance.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu

MaintenanceScope

Wyliczanie

Pobiera lub ustawia konserwacjęZakres konfiguracji

Wartość	Opis
Host	Ten zakres konserwacji steruje instalacją aktualizacji platformy Azure, tj. usług w węzłach fizycznych hostującymi maszyny wirtualne klienta.
Resource	Ten zakres konserwacji kontroluje domyślną konserwację aktualizacji zasobu platformy Azure
OSImage	Ten zakres konserwacji steruje instalacją obrazu systemu operacyjnego na maszynie wirtualnej/w usłudze VMSS
Extension	Ten zakres konserwacji kontroluje instalację rozszerzenia na maszynie wirtualnej/maszynie wirtualnej
InGuestPatch	Ten zakres konserwacji steruje instalacją pakietów systemu Windows i Linux na maszynie wirtualnej/w systemie VMSS
SQLDB	Ten zakres konserwacji steruje instalacją aktualizacji platformy programu SQL Server.
SQLManagedInstance	Ten zakres konserwacji kontroluje instalację aktualizacji platformy wystąpienia zarządzanego SQL.

RebootOptions

Wyliczanie

Możliwe preferencje ponownego rozruchu zdefiniowane przez użytkownika w oparciu o to, na podstawie którego podjęto decyzję o ponownym uruchomieniu maszyny lub nie po zakończeniu operacji poprawki.

Wartość	Opis
IfRequired
Never
Always

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Visibility

Wyliczanie

Pobiera lub ustawia widoczność konfiguracji. Wartość domyślna to "Niestandardowy"

Wartość	Opis
Custom	Widoczne tylko dla użytkowników z uprawnieniami.
Public	Widoczne dla wszystkich użytkowników.

Udostępnij za pośrednictwem

Public Maintenance Configurations - Get

Parametry identyfikatora URI

Odpowiedzi

Przykłady

PublicMaintenanceConfigurations_GetForResource

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

createdByType

ErrorDetails

InputLinuxParameters

InputPatchConfiguration

InputWindowsParameters

MaintenanceConfiguration

MaintenanceError

MaintenanceScope

RebootOptions

systemData

Visibility