Dela via


Public Maintenance Configurations - Get

Hämta post för konfiguration av offentligt underhåll

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceName
path True

string

Namn på underhållskonfiguration

subscriptionId
path True

string

Prenumerationsautentiseringsuppgifter som unikt identifierar en Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.

api-version
query True

string

Version av API:et som ska användas med klientbegäran.

Svar

Name Typ Description
200 OK

MaintenanceConfiguration

OKEJ

Other Status Codes

MaintenanceError

BadRequest

Exempel

PublicMaintenanceConfigurations_GetForResource

Exempelbegäran

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

Exempelsvar

{
  "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"
    }
  }
}

Definitioner

Name Description
createdByType

Den typ av identitet som skapade resursen.

ErrorDetails

Information om felsvar som tagits emot från Azure-underhållstjänsten.

InputLinuxParameters

Indataegenskaper för korrigering av en Linux-dator.

InputPatchConfiguration

Indatakonfiguration för en korrigeringskörning

InputWindowsParameters

Indataegenskaper för korrigering av en Windows-dator.

MaintenanceConfiguration

Typ av underhållskonfigurationspost

MaintenanceError

Ett felsvar som togs emot från Azure Maintenance Service.

MaintenanceScope

Hämtar eller ställer in underhållScope för konfigurationen

RebootOptions

Möjliga omstartsinställningar som definieras av användaren baserat på vilka det skulle beslutas att starta om datorn eller inte när korrigeringsåtgärden har slutförts.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Visibility

Hämtar eller anger synligheten för konfigurationen. Standardvärdet är "Anpassad"

createdByType

Den typ av identitet som skapade resursen.

Värde Description
User
Application
ManagedIdentity
Key

ErrorDetails

Information om felsvar som tagits emot från Azure-underhållstjänsten.

Name Typ Description
code

string

Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.

message

string

Mänsklig läsbar representation av felet.

InputLinuxParameters

Indataegenskaper för korrigering av en Linux-dator.

Name Typ Description
classificationsToInclude

string[]

Klassificeringskategori för korrigeringar som ska korrigeras. Tillåtna värden är "Kritisk", "Säkerhet" och "Övrigt".

packageNameMasksToExclude

string[]

Paketnamn som ska undantas för korrigering.

packageNameMasksToInclude

string[]

Paketnamn som ska inkluderas för korrigering.

InputPatchConfiguration

Indatakonfiguration för en korrigeringskörning

Name Typ Standardvärde Description
linuxParameters

InputLinuxParameters

Indataparametrar som är specifika för korrigering av Linux-dator. Skicka inte den här egenskapen för Windows-datorer.

rebootSetting

RebootOptions

IfRequired

Möjliga omstartsinställningar som definieras av användaren baserat på vilka det skulle beslutas att starta om datorn eller inte när korrigeringsåtgärden har slutförts.

windowsParameters

InputWindowsParameters

Indataparametrar som är specifika för korrigering av en Windows-dator. Skicka inte den här egenskapen för Linux-datorer.

InputWindowsParameters

Indataegenskaper för korrigering av en Windows-dator.

Name Typ Description
classificationsToInclude

string[]

Klassificeringskategori för korrigeringar som ska korrigeras. Tillåtna värden är "Critical", "Security", "UpdateRollup", "FeaturePack", "ServicePack", "Definition", "Tools" och "Updates".

excludeKbsRequiringReboot

boolean

Undanta korrigeringar som behöver startas om

kbNumbersToExclude

string[]

Windows KBID ska undantas för korrigering.

kbNumbersToInclude

string[]

Windows KBID som ska ingå för korrigering.

MaintenanceConfiguration

Typ av underhållskonfigurationspost

Name Typ Description
id

string

Fullständigt kvalificerad identifierare för resursen

location

string

Hämtar eller anger resursens plats

name

string

Resursens namn

properties.extensionProperties

object

Hämtar eller anger tilläggEgenskaper för underhållKonfiguration

properties.installPatches

InputPatchConfiguration

De indataparametrar som ska skickas till korrigeringskörningen.

properties.maintenanceScope

MaintenanceScope

Hämtar eller ställer in underhållScope för konfigurationen

properties.maintenanceWindow.duration

string

Varaktighet för underhållsperioden i HH:mm-format. Om det inte anges används standardvärdet baserat på det underhållsomfång som tillhandahålls. Exempel: 05:00.

properties.maintenanceWindow.expirationDateTime

string

Gällande förfallodatum för underhållsperioden i YYYY-MM-DD hh:mm-format. Fönstret skapas i den angivna tidszonen och justeras till sommartid enligt den tidszonen. Förfallodatum måste anges till ett framtida datum. Om det inte anges anges det till den maximala datetime 9999-12-31 23:59:59.

properties.maintenanceWindow.recurEvery

string

Hastighet med vilken ett underhållsperiod förväntas återkomma. Priset kan uttryckas som dagliga, veckovisa eller månatliga scheman. Det dagliga schemat formateras som recurEvery: [Frequency as integer]['Day(s)']. Om ingen frekvens anges är standardfrekvensen 1. Exempel på dagligt schema är recurEvery: Day, recurEvery: 3Days. Veckoschemat formateras som recurEvery: [Frequency as integer]['Week(s)'] [Valfri kommaavgränsad lista över vardagar måndag-söndag]. Exempel på veckoschema är recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Månadsscheman formateras som [Frekvens som heltal]['Month(s)'] [Kommaavgränsad lista över månadsdagar] eller [Frekvens som heltal]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Förskjutningsvärdet måste vara mellan -6 till 6 inklusive. Månatliga schemaexempel är 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

Gällande startdatum för underhållsfönstret i YYYY-MM-DD hh:mm-format. Startdatumet kan anges till antingen aktuellt datum eller framtida datum. Fönstret skapas i den angivna tidszonen och justeras till sommartid enligt den tidszonen.

properties.maintenanceWindow.timeZone

string

Namnet på tidszonen. Du kan hämta en lista över tidszoner genom att köra [System.TimeZoneInfo]::GetSystemTimeZones() i PowerShell. Exempel: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australien, standardtid.

properties.namespace

string

Hämtar eller anger resursens namnområde

properties.visibility

Visibility

Hämtar eller anger synligheten för konfigurationen. Standardvärdet är "Anpassad"

systemData

systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.

tags

object

Hämtar eller anger taggar för resursen

type

string

Typ av resurs

MaintenanceError

Ett felsvar som togs emot från Azure Maintenance Service.

Name Typ Description
error

ErrorDetails

Information om felet

MaintenanceScope

Hämtar eller ställer in underhållScope för konfigurationen

Värde Description
Host

Det här underhållsomfånget styr installationen av azure-plattformsuppdateringar, dvs. tjänster på fysiska noder som är värdar för virtuella kunddatorer.

Resource

Det här underhållsomfånget styr standarduppdateringsunderhållet av Azure-resursen

OSImage

Det här underhållsomfånget styr os-avbildningsinstallationen på virtuell dator/VMSS

Extension

Det här underhållsomfånget styr tilläggsinstallationen på virtuell dator/VMSS

InGuestPatch

Det här underhållsomfånget styr installationen av Windows- och Linux-paket på vm/VMSS

SQLDB

Det här underhållsomfånget styr installationen av SQL Server-plattformsuppdateringar.

SQLManagedInstance

Det här underhållsomfånget styr installationen av sql-hanterad instansplattformsuppdatering.

RebootOptions

Möjliga omstartsinställningar som definieras av användaren baserat på vilka det skulle beslutas att starta om datorn eller inte när korrigeringsåtgärden har slutförts.

Värde Description
IfRequired
Never
Always

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string (date-time)

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string (date-time)

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

Visibility

Hämtar eller anger synligheten för konfigurationen. Standardvärdet är "Anpassad"

Värde Description
Custom

Visas endast för användare med behörigheter.

Public

Synlig för alla användare.