Software Update Configurations - Create

Servizio:: Automation

Versione API:: 2024-10-23

Creare una nuova configurazione di aggiornamento software con il nome specificato nell'URI.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations/{softwareUpdateConfigurationName}?api-version=2024-10-23

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
automationAccountName	path	True	string	Nome dell'account di automazione.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nome di un gruppo di risorse di Azure.
softwareUpdateConfigurationName	path	True	string	Nome della configurazione dell'aggiornamento software da creare.
subscriptionId	path	True	string	Ottiene le credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione dell'API client.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
clientRequestId		string	Identifica questa richiesta client specifica.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.scheduleInfo	True	SUCScheduleProperties	Pianificare le informazioni per la configurazione dell'aggiornamento software
properties.updateConfiguration	True	updateConfiguration	aggiornare proprietà specifiche per la configurazione dell'aggiornamento software
properties.error		ErrorResponse	Dettagli dell'errore di provisioning
properties.tasks		softwareUpdateConfigurationTasks	Informazioni sulle attività per la configurazione dell'aggiornamento software.

Risposte

Nome	Tipo	Descrizione
200 OK	softwareUpdateConfiguration	La configurazione degli aggiornamenti software con lo stesso nome e le stesse proprietà esistono già.
201 Created	softwareUpdateConfiguration	Viene creata la configurazione dell'aggiornamento software.
Other Status Codes	ErrorResponse	Risposta di errore di automazione che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create software update configuration

Esempio di richiesta

HTTP

PUT https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch?api-version=2024-10-23

{
  "properties": {
    "updateConfiguration": {
      "operatingSystem": "Windows",
      "duration": "PT2H0M",
      "windows": {
        "excludedKbNumbers": [
          "168934",
          "168973"
        ],
        "includedUpdateClassifications": "Critical",
        "rebootSetting": "IfRequired"
      },
      "azureVirtualMachines": [
        "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01",
        "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02",
        "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03"
      ],
      "nonAzureComputerNames": [
        "box1.contoso.com",
        "box2.contoso.com"
      ],
      "targets": {
        "azureQueries": [
          {
            "scope": [
              "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources",
              "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067"
            ],
            "tagSettings": {
              "tags": {
                "tag1": [
                  "tag1Value1",
                  "tag1Value2",
                  "tag1Value3"
                ],
                "tag2": [
                  "tag2Value1",
                  "tag2Value2",
                  "tag2Value3"
                ]
              },
              "filterOperator": "All"
            },
            "locations": [
              "Japan East",
              "UK South"
            ]
          }
        ],
        "nonAzureQueries": [
          {
            "functionAlias": "SavedSearch1",
            "workspaceId": "WorkspaceId1"
          },
          {
            "functionAlias": "SavedSearch2",
            "workspaceId": "WorkspaceId2"
          }
        ]
      }
    },
    "scheduleInfo": {
      "frequency": "Hour",
      "startTime": "2017-10-19T12:22:57+00:00",
      "timeZone": "America/Los_Angeles",
      "interval": 1,
      "expiryTime": "2018-11-09T11:22:57+00:00",
      "advancedSchedule": {
        "weekDays": [
          "Monday",
          "Thursday"
        ]
      }
    },
    "tasks": {
      "preTask": {
        "source": "HelloWorld",
        "parameters": {
          "COMPUTERNAME": "Computer1"
        }
      },
      "postTask": {
        "source": "GetCache",
        "parameters": null
      }
    }
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "name": "testpatch",
  "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch",
  "properties": {
    "updateConfiguration": {
      "operatingSystem": "Windows",
      "windows": {
        "includedUpdateClassifications": "Critical",
        "excludedKbNumbers": [
          "168934",
          "168973"
        ]
      },
      "linux": {},
      "targets": {
        "azureQueries": [
          {
            "scope": [
              "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0",
              "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d"
            ],
            "tagSettings": {
              "tags": {
                "tag1": [
                  "tag1Value1",
                  "tag1Value2"
                ],
                "tag2": [
                  "tag2Value1",
                  "tag2Value2"
                ]
              },
              "filterOperator": "All"
            },
            "locations": [
              "Japan East",
              "UK South"
            ]
          }
        ]
      },
      "duration": "PT2H",
      "azureVirtualMachines": [
        "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01",
        "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02",
        "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03"
      ],
      "nonAzureComputerNames": [
        "box1.contoso.com",
        "box2.contoso.com"
      ]
    },
    "scheduleInfo": {
      "description": "",
      "startTime": "2017-10-19T12:22:00-07:00",
      "startTimeOffsetMinutes": -420,
      "expiryTime": "2018-11-09T11:22:00-08:00",
      "expiryTimeOffsetMinutes": -480,
      "isEnabled": true,
      "nextRun": "2017-10-19T12:22:00-07:00",
      "nextRunOffsetMinutes": -420,
      "interval": 1,
      "frequency": "Week",
      "creationTime": "2017-10-19T18:54:50.5233333+00:00",
      "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00",
      "timeZone": "America/Los_Angeles",
      "advancedSchedule": {}
    },
    "tasks": {
      "preTask": {
        "source": "HelloWorld",
        "parameters": {
          "COMPUTERNAME": "Computer1"
        }
      },
      "postTask": {
        "source": "GetCache",
        "parameters": null
      }
    },
    "provisioningState": "Provisioning",
    "error": {},
    "creationTime": "2017-10-19T18:54:50.5233333+00:00",
    "createdBy": "adam@contoso.com",
    "lastModifiedBy": "adam@contoso.com",
    "lastModifiedTime": "2017-10-19T18:54:50.68+00:00"
  }
}

Codice di stato:: 201

{
  "name": "testpatch",
  "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch",
  "properties": {
    "updateConfiguration": {
      "operatingSystem": "Windows",
      "windows": {
        "includedUpdateClassifications": "Critical",
        "excludedKbNumbers": [
          "168934",
          "168973"
        ]
      },
      "linux": {},
      "targets": {
        "azureQueries": [
          {
            "scope": [
              "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0",
              "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d"
            ],
            "tagSettings": {
              "tags": {
                "tag1": [
                  "tag1Value1",
                  "tag1Value2"
                ],
                "tag2": [
                  "tag2Value1",
                  "tag2Value2"
                ]
              },
              "filterOperator": "All"
            },
            "locations": [
              "Japan East",
              "UK South"
            ]
          }
        ]
      },
      "duration": "PT2H",
      "azureVirtualMachines": [
        "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01",
        "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02",
        "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03"
      ],
      "nonAzureComputerNames": [
        "box1.contoso.com",
        "box2.contoso.com"
      ]
    },
    "scheduleInfo": {
      "description": "",
      "startTime": "2017-10-19T12:22:00-07:00",
      "startTimeOffsetMinutes": -420,
      "expiryTime": "2018-11-09T11:22:00-08:00",
      "expiryTimeOffsetMinutes": -480,
      "isEnabled": true,
      "nextRun": "2017-10-19T12:22:00-07:00",
      "nextRunOffsetMinutes": -420,
      "interval": 1,
      "frequency": "Week",
      "creationTime": "2017-10-19T18:54:50.5233333+00:00",
      "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00",
      "timeZone": "America/Los_Angeles"
    },
    "tasks": {
      "preTask": {
        "source": "HelloWorld",
        "parameters": {
          "COMPUTERNAME": "Computer1"
        }
      },
      "postTask": {
        "source": "GetCache",
        "parameters": null
      }
    },
    "provisioningState": "Provisioning",
    "error": {},
    "creationTime": "2017-10-19T18:54:50.5233333+00:00",
    "lastModifiedBy": "",
    "lastModifiedTime": "2017-10-19T18:54:50.68+00:00"
  }
}

Definizioni

Nome	Descrizione
AdvancedSchedule	Proprietà della creazione della pianificazione avanzata.
AdvancedScheduleMonthlyOccurrence	Proprietà della creazione di un'occorrenza mensile di pianificazione avanzata.
AzureQueryProperties	Query di Azure per la configurazione dell'aggiornamento.
ErrorResponse	Risposta di errore di un errore dell'operazione
LinuxProperties	Configurazione dell'aggiornamento specifica di Linux.
LinuxUpdateClasses	Classificazioni degli aggiornamenti incluse nella configurazione degli aggiornamenti software.
NonAzureQueryProperties	Query non di Azure per la configurazione dell'aggiornamento.
OperatingSystemType	sistema operativo dei computer di destinazione
ScheduleDay	Giorno dell'occorrenza. Deve essere uno di lunedì, martedì, mercoledì, giovedì, venerdì, sabato, domenica.
ScheduleFrequency	Ottiene o imposta la frequenza della pianificazione.
softwareUpdateConfiguration	Proprietà di configurazione degli aggiornamenti software.
softwareUpdateConfigurationTasks	Proprietà dell'attività della configurazione dell'aggiornamento software.
SUCScheduleProperties	Definizione dei parametri di pianificazione.
TagOperators	Filtrare le macchine virtuali in base a qualsiasi o a tutti i tag specificati.
TagSettingsProperties	Informazioni sul filtro dei tag per la macchina virtuale.
TargetProperties	Gruppo specifico della configurazione dell'aggiornamento.
taskProperties	Proprietà dell'attività della configurazione dell'aggiornamento software.
updateConfiguration	Aggiornare proprietà specifiche della configurazione dell'aggiornamento software.
WindowsProperties	Configurazione dell'aggiornamento specifica di Windows.
WindowsUpdateClasses	Classificazione degli aggiornamenti inclusa nella configurazione degli aggiornamenti software. Stringa delimitata da virgole con valori obbligatori

AdvancedSchedule

Object

Proprietà della creazione della pianificazione avanzata.

Nome	Tipo	Descrizione
monthDays	integer[] (int32)	Giorni del mese in cui deve essere eseguito il processo. Deve essere compreso tra 1 e 31.
monthlyOccurrences	AdvancedScheduleMonthlyOccurrence[]	Occorrenze di giorni entro un mese.
weekDays	string[]	Giorni della settimana in cui deve essere eseguito il processo.

AdvancedScheduleMonthlyOccurrence

Object

Proprietà della creazione di un'occorrenza mensile di pianificazione avanzata.

Nome	Tipo	Descrizione
day	ScheduleDay	Giorno dell'occorrenza. Deve essere uno di lunedì, martedì, mercoledì, giovedì, venerdì, sabato, domenica.
occurrence	integer (int32)	Occorrenza della settimana entro il mese. Deve essere compreso tra 1 e 5

AzureQueryProperties

Object

Query di Azure per la configurazione dell'aggiornamento.

Nome	Tipo	Descrizione
locations	string[]	Elenco di posizioni in cui definire l'ambito della query.
scope	string[]	Elenco di ID ARM di sottoscrizione o gruppo di risorse.
tagSettings	TagSettingsProperties	Impostazioni dei tag per la macchina virtuale.

ErrorResponse

Object

Risposta di errore di un errore dell'operazione

Nome	Tipo	Descrizione
code	string	Codice di errore
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

LinuxProperties

Object

Configurazione dell'aggiornamento specifica di Linux.

Nome	Tipo	Descrizione
excludedPackageNameMasks	string[]	pacchetti esclusi dalla configurazione dell'aggiornamento software.
includedPackageClassifications	LinuxUpdateClasses	Classificazioni degli aggiornamenti incluse nella configurazione degli aggiornamenti software.
includedPackageNameMasks	string[]	pacchetti inclusi nella configurazione dell'aggiornamento software.
rebootSetting	string	Impostazione di riavvio per la configurazione dell'aggiornamento software.

LinuxUpdateClasses

Enumerazione

Classificazioni degli aggiornamenti incluse nella configurazione degli aggiornamenti software.

Valore	Descrizione
Unclassified
Critical
Security
Other

NonAzureQueryProperties

Object

Query non di Azure per la configurazione dell'aggiornamento.

Nome	Tipo	Descrizione
functionAlias	string	Nome della ricerca salvata in Log Analytics.
workspaceId	string	ID area di lavoro per Log Analytics in cui risiede la ricerca salvata.

OperatingSystemType

Enumerazione

sistema operativo dei computer di destinazione

Valore	Descrizione
Windows
Linux

ScheduleDay

Enumerazione

Giorno dell'occorrenza. Deve essere uno di lunedì, martedì, mercoledì, giovedì, venerdì, sabato, domenica.

Valore	Descrizione
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

ScheduleFrequency

Enumerazione

Ottiene o imposta la frequenza della pianificazione.

Valore	Descrizione
OneTime
Day
Hour
Week
Month
Minute	L'intervallo minimo consentito per le pianificazioni dei minuti è di 15 minuti.

softwareUpdateConfiguration

Object

Proprietà di configurazione degli aggiornamenti software.

Nome	Tipo	Descrizione
id	string	ID risorsa.
name	string	Nome risorsa.
properties.createdBy	string	Proprietà CreatedBy, che viene visualizzata solo nella risposta.
properties.creationTime	string (date-time)	Ora di creazione della risorsa, visualizzata solo nella risposta.
properties.error	ErrorResponse	Dettagli dell'errore di provisioning
properties.lastModifiedBy	string	Proprietà LastModifiedBy, che viene visualizzata solo nella risposta.
properties.lastModifiedTime	string (date-time)	Ultima modifica della risorsa, visualizzata solo nella risposta.
properties.provisioningState	string	Stato di provisioning per la configurazione dell'aggiornamento software, visualizzato solo nella risposta.
properties.scheduleInfo	SUCScheduleProperties	Pianificare le informazioni per la configurazione dell'aggiornamento software
properties.tasks	softwareUpdateConfigurationTasks	Informazioni sulle attività per la configurazione dell'aggiornamento software.
properties.updateConfiguration	updateConfiguration	aggiornare proprietà specifiche per la configurazione dell'aggiornamento software
type	string	Tipo di risorsa

softwareUpdateConfigurationTasks

Object

Proprietà dell'attività della configurazione dell'aggiornamento software.

Nome	Tipo	Descrizione
postTask	taskProperties	Pubblicare le proprietà dell'attività.
preTask	taskProperties	Proprietà pre-attività.

SUCScheduleProperties

Object

Definizione dei parametri di pianificazione.

Nome	Tipo	Valore predefinito	Descrizione
advancedSchedule	AdvancedSchedule		Ottiene o imposta la pianificazione avanzata.
creationTime	string (date-time)		Ottiene o imposta l'ora di creazione.
description	string		Ottiene o imposta la descrizione.
expiryTime	string (date-time)		Ottiene o imposta l'ora di fine della pianificazione.
expiryTimeOffsetMinutes	number (double)		Ottiene o imposta l'offset dell'ora di scadenza in minuti.
frequency	ScheduleFrequency		Ottiene o imposta la frequenza della pianificazione.
interval	integer (int64)		Ottiene o imposta l'intervallo della pianificazione.
isEnabled	boolean	False	Ottiene o imposta un valore che indica se questa pianificazione è abilitata.
lastModifiedTime	string (date-time)		Ottiene o imposta l'ora dell'ultima modifica.
nextRun	string (date-time)		Ottiene o imposta l'ora di esecuzione successiva della pianificazione.
nextRunOffsetMinutes	number (double)		Ottiene o imposta l'offset del tempo di esecuzione successivo in minuti.
startTime	string (date-time)		Ottiene o imposta l'ora di inizio della pianificazione.
startTimeOffsetMinutes	number (double)		Ottiene l'offset dell'ora di inizio in minuti.
timeZone	string		Ottiene o imposta il fuso orario della pianificazione.

TagOperators

Enumerazione

Filtrare le macchine virtuali in base a qualsiasi o a tutti i tag specificati.

Valore	Descrizione
All
Any

TagSettingsProperties

Object

Informazioni sul filtro dei tag per la macchina virtuale.

Nome	Tipo	Descrizione
filterOperator	TagOperators	Filtrare le macchine virtuali in base a qualsiasi o a tutti i tag specificati.
tags	object	Dizionario dei tag con il relativo elenco di valori.

TargetProperties

Object

Gruppo specifico della configurazione dell'aggiornamento.

Nome	Tipo	Descrizione
azureQueries	AzureQueryProperties[]	Elenco di query di Azure nella configurazione dell'aggiornamento software.
nonAzureQueries	NonAzureQueryProperties[]	Elenco di query non di Azure nella configurazione dell'aggiornamento software.

taskProperties

Object

Proprietà dell'attività della configurazione dell'aggiornamento software.

Nome	Tipo	Descrizione
parameters	object	Ottiene o imposta i parametri dell'attività.
source	string	Ottiene o imposta il nome del runbook.

updateConfiguration

Object

Aggiornare proprietà specifiche della configurazione dell'aggiornamento software.

Nome	Tipo	Descrizione
azureVirtualMachines	string[]	Elenco degli ID risorsa di Azure per le macchine virtuali di Azure di destinazione della configurazione dell'aggiornamento software.
duration	string (duration)	Tempo massimo consentito per l'esecuzione della configurazione dell'aggiornamento software. La durata deve essere specificata usando il formato PT[n]H[n]M[n]S in base a ISO8601
linux	LinuxProperties	Configurazione dell'aggiornamento specifica di Linux.
nonAzureComputerNames	string[]	Elenco dei nomi di computer non azure di destinazione della configurazione dell'aggiornamento software.
operatingSystem	OperatingSystemType	sistema operativo dei computer di destinazione
targets	TargetProperties	Destinazioni di gruppo per la configurazione dell'aggiornamento software.
windows	WindowsProperties	Configurazione dell'aggiornamento specifica di Windows.

WindowsProperties

Object

Configurazione dell'aggiornamento specifica di Windows.

Nome	Tipo	Descrizione
excludedKbNumbers	string[]	Numeri kb esclusi dalla configurazione dell'aggiornamento software.
includedKbNumbers	string[]	Numeri kb inclusi nella configurazione dell'aggiornamento software.
includedUpdateClassifications	WindowsUpdateClasses	Classificazione degli aggiornamenti inclusa nella configurazione degli aggiornamenti software. Stringa delimitata da virgole con valori obbligatori
rebootSetting	string	Impostazione di riavvio per la configurazione dell'aggiornamento software.

WindowsUpdateClasses

Enumerazione

Classificazione degli aggiornamenti inclusa nella configurazione degli aggiornamenti software. Stringa delimitata da virgole con valori obbligatori

Valore	Descrizione
Unclassified
Critical
Security
UpdateRollup
FeaturePack
ServicePack
Definition
Tools
Updates

Condividi tramite

Software Update Configurations - Create

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

Create software update configuration

Esempio di richiesta

Risposta di esempio

Definizioni

AdvancedSchedule

AdvancedScheduleMonthlyOccurrence

AzureQueryProperties

ErrorResponse

LinuxProperties

LinuxUpdateClasses

NonAzureQueryProperties

OperatingSystemType

ScheduleDay

ScheduleFrequency

softwareUpdateConfiguration

softwareUpdateConfigurationTasks

SUCScheduleProperties

TagOperators

TagSettingsProperties

TargetProperties

taskProperties

updateConfiguration

WindowsProperties

WindowsUpdateClasses