Software Update Configurations - Get By Name

Serviço:

Automation

Versão da API:

2024-10-23

Obtenha uma única configuração de atualização de software por nome.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
automationAccountName	path	True	string	O nome da conta de automação.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
softwareUpdateConfigurationName	path	True	string	O nome da configuração de atualização de software a ser criada.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
clientRequestId		string	Identifica essa solicitação de cliente específica.

Respostas

Nome	Tipo	Description
200 OK	softwareUpdateConfiguration	A operação do Azure foi concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get software update configuration by name

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

200

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

Definições

Nome	Description
AdvancedSchedule	As propriedades da criação de Agenda avançada.
AdvancedScheduleMonthlyOccurrence	As propriedades da ocorrência mensal de criação de agendamento avançado.
AutomationErrorResponse	Resposta de erro de uma falha de operação
AzureQueryProperties	Consulta do Azure para a configuração de atualização.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
LinuxProperties	Configuração de atualização específica do Linux.
LinuxUpdateClasses	Atualizar classificações incluídas na configuração de atualização de software.
NonAzureQueryProperties	Consulta não Azure para a configuração de atualização.
OperatingSystemType	Sistema operacional alvo para a configuração da atualização de software.
ScheduleDay	Dia da ocorrência. Deve ser uma das segundas, terças, quartas, quintas, sextas, sábados, domingos.
ScheduleFrequency	Obtém ou define a frequência do agendamento.
softwareUpdateConfiguration	Propriedades de configuração de atualização de software.
softwareUpdateConfigurationTasks	Propriedades da tarefa da configuração de atualização de software.
SUCScheduleProperties	Definição de parâmetros de agendamento.
systemData	Metadados relativos à criação e última modificação do recurso.
TagOperators	Filtrar VMs por qualquer ou todas as marcas especificadas.
TagSettingsProperties	Informações de filtro de marca para a VM.
TargetProperties	Agrupar específico para a configuração de atualização.
taskProperties	Propriedades da tarefa da configuração de atualização de software.
updateConfiguration	Atualize propriedades específicas da configuração de atualização de software.
WindowsProperties	Configuração de atualização específica do Windows.
WindowsUpdateClasses	Classificação de atualização incluída na configuração de atualização de software. Uma cadeia de caracteres separada por vírgulas com valores necessários

AdvancedSchedule

Objeto

As propriedades da criação de Agenda avançada.

Nome	Tipo	Description
monthDays	integer[] (int32)	Dias do mês em que o trabalho deve ser executado. Deve estar entre 1 e 31.
monthlyOccurrences	AdvancedScheduleMonthlyOccurrence[]	Ocorrências de dias dentro de um mês.
weekDays	string[]	Dias da semana em que o trabalho deve ser executado.

AdvancedScheduleMonthlyOccurrence

Objeto

As propriedades da ocorrência mensal de criação de agendamento avançado.

Nome	Tipo	Description
day	ScheduleDay	Dia da ocorrência. Deve ser uma das segundas, terças, quartas, quintas, sextas, sábados, domingos.
occurrence	integer (int32)	Ocorrência da semana dentro do mês. Deve estar entre 1 e 5

AutomationErrorResponse

Objeto

Resposta de erro de uma falha de operação

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

AzureQueryProperties

Objeto

Consulta do Azure para a configuração de atualização.

Nome	Tipo	Description
locations	string[]	Lista de locais para os qual definir o escopo da consulta.
scope	string[]	Lista de IDs arm de grupo de recursos ou assinatura.
tagSettings	TagSettingsProperties	Configurações de marcação para a VM.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

LinuxProperties

Objeto

Configuração de atualização específica do Linux.

Nome	Tipo	Description
excludedPackageNameMasks	string[]	pacotes excluídos da configuração de atualização de software.
includedPackageClassifications	LinuxUpdateClasses	Atualizar classificações incluídas na configuração de atualização de software.
includedPackageNameMasks	string[]	pacotes incluídos na configuração de atualização de software.
rebootSetting	string	Configuração de reinicialização para a configuração de atualização de software.

LinuxUpdateClasses

Enumeração

Atualizar classificações incluídas na configuração de atualização de software.

Valor	Description
Unclassified	Não classificado
Critical	Crítico
Security	Segurança
Other	Outras

NonAzureQueryProperties

Objeto

Consulta não Azure para a configuração de atualização.

Nome	Tipo	Description
functionAlias	string	Nome da Pesquisa Salva do Log Analytics.
workspaceId	string	ID do workspace para o Log Analytics no qual a Pesquisa salva está resideda.

OperatingSystemType

Enumeração

Sistema operacional alvo para a configuração da atualização de software.

Valor	Description
Windows	Windows
Linux	Linux

ScheduleDay

Enumeração

Dia da ocorrência. Deve ser uma das segundas, terças, quartas, quintas, sextas, sábados, domingos.

Valor	Description
Monday	Segunda-feira
Tuesday	Terça-feira
Wednesday	Quarta-feira
Thursday	Quinta-feira
Friday	Sexta-feira
Saturday	sábado
Sunday	Domingo

ScheduleFrequency

Enumeração

Obtém ou define a frequência do agendamento.

Valor	Description
OneTime	Onetime
Day	Dia
Hour	Hora
Week	Semana
Month	Mês
Minute	O intervalo mínimo permitido para agendamentos de minuto é de 15 minutos.

softwareUpdateConfiguration

Objeto

Propriedades de configuração de atualização de software.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.createdBy	string	Propriedade CreatedBy, que aparece apenas na resposta.
properties.creationTime	string (date-time)	Hora de criação do recurso, que aparece apenas na resposta.
properties.error	AutomationErrorResponse	Detalhes do erro de provisionamento
properties.lastModifiedBy	string	Propriedade LastModifiedBy, que aparece apenas na resposta.
properties.lastModifiedTime	string (date-time)	Última vez em que o recurso foi modificado, que aparece apenas na resposta.
properties.provisioningState	string	Estado de provisionamento para a configuração de atualização de software, que aparece apenas na resposta.
properties.scheduleInfo	SUCScheduleProperties	Informações de agendamento para a configuração de atualização de software
properties.tasks	softwareUpdateConfigurationTasks	Informações de tarefas para a configuração de atualização de software.
properties.updateConfiguration	updateConfiguration	atualizar propriedades específicas para a configuração de atualização de software
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

softwareUpdateConfigurationTasks

Objeto

Propriedades da tarefa da configuração de atualização de software.

Nome	Tipo	Description
postTask	taskProperties	Postar propriedades da tarefa.
preTask	taskProperties	Propriedades de pré-tarefa.

SUCScheduleProperties

Objeto

Definição de parâmetros de agendamento.

Nome	Tipo	Description
advancedSchedule	AdvancedSchedule	Obtém ou define o agendamento avançado.
creationTime	string (date-time)	Obtém ou define o tempo de criação.
description	string	Obtém ou define a descrição.
expiryTime	string (date-time)	Obtém ou define a hora de término da agenda.
expiryTimeOffsetMinutes	number (double)	Obtém ou define o deslocamento do tempo de expiração em minutos.
frequency	ScheduleFrequency	Obtém ou define a frequência do agendamento.
interval	integer (int64)	Obtém ou define o intervalo da agenda.
isEnabled	boolean	Obtém ou define um valor que indica se esse agendamento está habilitado.
lastModifiedTime	string (date-time)	Obtém ou define a hora da última modificação.
nextRun	string (date-time)	Obtém ou define o próximo tempo de execução do agendamento.
nextRunOffsetMinutes	number (double)	Obtém ou define o deslocamento do próximo tempo de execução em minutos.
startTime	string (date-time)	Obtém ou define a hora de início da agenda.
startTimeOffsetMinutes	number (double)	Obtém o deslocamento da hora de início em minutos.
timeZone	string	Obtém ou define o fuso horário da agenda.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TagOperators

Enumeração

Filtrar VMs por qualquer ou todas as marcas especificadas.

Valor	Description
All	Todos
Any	Qualquer

TagSettingsProperties

Objeto

Informações de filtro de marca para a VM.

Nome	Tipo	Description
filterOperator	TagOperators	Filtrar VMs por qualquer ou todas as marcas especificadas.
tags	object	Dicionário de marcas com sua lista de valores.

TargetProperties

Objeto

Agrupar específico para a configuração de atualização.

Nome	Tipo	Description
azureQueries	AzureQueryProperties[]	Lista de consultas do Azure na configuração de atualização de software.
nonAzureQueries	NonAzureQueryProperties[]	Lista de consultas que não são do Azure na configuração de atualização de software.

taskProperties

Objeto

Propriedades da tarefa da configuração de atualização de software.

Nome	Tipo	Description
parameters	object	Obtém ou define os parâmetros da tarefa.
source	string	Obtém ou define o nome do runbook.

updateConfiguration

Objeto

Atualize propriedades específicas da configuração de atualização de software.

Nome	Tipo	Description
azureVirtualMachines	string[]	Lista de IDs de recursos do Azure para máquinas virtuais do Azure direcionadas pela configuração de atualização de software.
duration	string (duration)	Tempo máximo permitido para a execução da configuração de atualização de software. A duração precisa ser especificada usando o formato PT[n]H[n]M[n]S de acordo com ISO8601
linux	LinuxProperties	Configuração de atualização específica do Linux.
nonAzureComputerNames	string[]	Lista de nomes de computadores não azure direcionados pela configuração de atualização de software.
operatingSystem	OperatingSystemType	sistema operacional de computadores de destino
targets	TargetProperties	Destinos de grupo para a configuração de atualização de software.
windows	WindowsProperties	Configuração de atualização específica do Windows.

WindowsProperties

Objeto

Configuração de atualização específica do Windows.

Nome	Tipo	Description
excludedKbNumbers	string[]	Números de KB excluídos da configuração de atualização de software.
includedKbNumbers	string[]	Números de KB incluídos na configuração de atualização de software.
includedUpdateClassifications	WindowsUpdateClasses	Classificação de atualização incluída na configuração de atualização de software. Uma cadeia de caracteres separada por vírgulas com valores necessários
rebootSetting	string	Configuração de reinicialização para a configuração de atualização de software.

WindowsUpdateClasses

Enumeração

Classificação de atualização incluída na configuração de atualização de software. Uma cadeia de caracteres separada por vírgulas com valores necessários

Valor	Description
Unclassified	Não classificado
Critical	Crítico
Security	Segurança
UpdateRollup	UpdateRollup
FeaturePack	FeaturePack
ServicePack	ServicePack
Definition	Definição
Tools	Tools
Updates	Atualizações