Public Maintenance Configurations - Get

Serviço:: Maintenance

Versão da API:: 2023-09-01-preview

Obter registro de Configuração de Manutenção Pública

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceName	path	True	string	Nome da configuração de manutenção
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.

Respostas

Nome	Tipo	Description
200 OK	MaintenanceConfiguration	OKEY
Other Status Codes	MaintenanceError	BadRequest

Exemplos

PublicMaintenanceConfigurations_GetForResource

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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"
    }
  }
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorDetails	Detalhes de resposta de erro recebidos do serviço de Manutenção do Azure.
InputLinuxParameters	Propriedades de entrada para aplicação de patch de um computador Linux.
InputPatchConfiguration	Configuração de entrada para uma execução de patch
InputWindowsParameters	Propriedades de entrada para aplicação de patch em um computador Windows.
MaintenanceConfiguration	Tipo de registro de configuração de manutenção
MaintenanceError	Uma resposta de erro recebida do serviço de Manutenção do Azure.
MaintenanceScope	Obtém ou define maintenanceScope da configuração
RebootOptions	Possível preferência de reinicialização, conforme definido pelo usuário com base no qual ele seria decidido reinicializar o computador ou não depois que a operação de patch for concluída.
systemData	Metadados relativos à criação e última modificação do recurso.
Visibility	Obtém ou define a visibilidade da configuração. O valor padrão é 'Personalizado'

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorDetails

Objeto

Detalhes de resposta de erro recebidos do serviço de Manutenção do Azure.

Nome	Tipo	Description
code	string	Código de erro definido pelo serviço. Esse código serve como um sub-status para o código de erro HTTP especificado na resposta.
message	string	Representação legível por humanos do erro.

InputLinuxParameters

Objeto

Propriedades de entrada para aplicação de patch de um computador Linux.

Nome	Tipo	Description
classificationsToInclude	string[]	Categoria de classificação de patches a serem corrigidos. Os valores permitidos são 'Crítico', 'Segurança' e 'Outro'.
packageNameMasksToExclude	string[]	Nomes de pacote a serem excluídos para aplicação de patch.
packageNameMasksToInclude	string[]	Nomes de pacote a serem incluídos para aplicação de patch.

InputPatchConfiguration

Objeto

Configuração de entrada para uma execução de patch

Nome	Tipo	Valor padrão	Description
linuxParameters	InputLinuxParameters		Parâmetros de entrada específicos para a aplicação de patch do computador Linux. Para computadores Windows, não passe essa propriedade.
rebootSetting	RebootOptions	IfRequired	Possível preferência de reinicialização, conforme definido pelo usuário com base no qual ele seria decidido reinicializar o computador ou não depois que a operação de patch for concluída.
windowsParameters	InputWindowsParameters		Parâmetros de entrada específicos para aplicação de patch em um computador Windows. Para computadores Linux, não passe essa propriedade.

InputWindowsParameters

Objeto

Propriedades de entrada para aplicação de patch em um computador Windows.

Nome	Tipo	Description
classificationsToInclude	string[]	Categoria de classificação de patches a serem corrigidos. Os valores permitidos são 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools' e 'Updates'.
excludeKbsRequiringReboot	boolean	Excluir patches que precisam ser reinicializados
kbNumbersToExclude	string[]	O KBID do Windows a ser excluído para aplicação de patch.
kbNumbersToInclude	string[]	O KBID do Windows a ser incluído para aplicação de patch.

MaintenanceConfiguration

Objeto

Tipo de registro de configuração de manutenção

Nome	Tipo	Description
id	string	Identificador totalmente qualificado do recurso
location	string	Obtém ou define o local do recurso
name	string	Nome do recurso
properties.extensionProperties	object	Obtém ou define extensionProperties da maintenanceConfiguration
properties.installPatches	InputPatchConfiguration	Os parâmetros de entrada a serem passados para a operação de execução de patch.
properties.maintenanceScope	MaintenanceScope	Obtém ou define maintenanceScope da configuração
properties.maintenanceWindow.duration	string	Duração da janela de manutenção no formato HH:mm. Se não for fornecido, o valor padrão será usado com base no escopo de manutenção fornecido. Exemplo: 05:00.
properties.maintenanceWindow.expirationDateTime	string	Data de validade efetiva da janela de manutenção no formato YYYY-MM-DD hh:mm. A janela será criada no fuso horário fornecido e ajustada para o horário de verão de acordo com esse fuso horário. A data de validade deve ser definida como uma data futura. Se não for fornecido, ele será definido como o datetime máximo 9999-12-31 23:59:59.
properties.maintenanceWindow.recurEvery	string	Taxa na qual espera-se que uma janela de manutenção se repita. A taxa pode ser expressa como agendas diárias, semanais ou mensais. A agenda diária é formatada como recurEvery: [Frequência como inteiro]['Dia(s)']. Se nenhuma frequência for fornecida, a frequência padrão será 1. Exemplos de agenda diária são recurEvery: Day, recurEvery: 3Days. A agenda semanal é formatada como recurEvery: [Frequência como inteiro]['Semana(s)'] [Lista opcional separada por vírgulas dos dias da semana de segunda a domingo]. Exemplos de agenda semanal são recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Os agendamentos mensais são formatados como [Frequência como inteiro]['Mês(s)'] [Lista separada por vírgulas de dias do mês] ou [Frequência como inteiro]['Mês(s)'] [Semana do Mês (Primeiro, Segundo, Terceiro, Quarto, Último)] [Dia da Semana De Segunda a Domingo] [Deslocamento Opcional(Não. de dias)]. O valor de deslocamento deve estar entre -6 e 6 inclusive. Exemplos de agenda mensal são 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 de início efetiva da janela de manutenção no formato YYYY-MM-DD hh:mm. A data de início pode ser definida como a data atual ou a data futura. A janela será criada no fuso horário fornecido e ajustada para o horário de verão de acordo com esse fuso horário.
properties.maintenanceWindow.timeZone	string	Nome do fuso horário. A lista de fusos horários pode ser obtida executando [System.TimeZoneInfo]::GetSystemTimeZones() no PowerShell. Exemplo: Horário Padrão do Pacífico, UTC, Horário Padrão da Europa, Hora Padrão da Coreia, Cen. Hora Padrão da Austrália.
properties.namespace	string	Obtém ou define o namespace do recurso
properties.visibility	Visibility	Obtém ou define a visibilidade da configuração. O valor padrão é 'Personalizado'
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object	Obtém ou define marcas do recurso
type	string	Tipo do recurso

MaintenanceError

Objeto

Uma resposta de erro recebida do serviço de Manutenção do Azure.

Nome	Tipo	Description
error	ErrorDetails	Detalhes do erro

MaintenanceScope

Enumeração

Obtém ou define maintenanceScope da configuração

Valor	Description
Host	Esse escopo de manutenção controla a instalação de atualizações da plataforma do Azure, ou seja, serviços em nós físicos que hospedam VMs do cliente.
Resource	Esse escopo de manutenção controla a manutenção de atualização padrão do Recurso do Azure
OSImage	Esse escopo de manutenção controla a instalação da imagem do sistema operacional na VM/VMSS
Extension	Esse escopo de manutenção controla a instalação da extensão na VM/VMSS
InGuestPatch	Esse escopo de manutenção controla a instalação de pacotes windows e linux em VM/VMSS
SQLDB	Esse escopo de manutenção controla a instalação de atualizações da plataforma do SQL Server.
SQLManagedInstance	Esse escopo de manutenção controla a instalação da atualização da plataforma de instância gerenciada de SQL.

RebootOptions

Enumeração

Possível preferência de reinicialização, conforme definido pelo usuário com base no qual ele seria decidido reinicializar o computador ou não depois que a operação de patch for concluída.

Valor	Description
IfRequired
Never
Always

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.

Visibility

Enumeração

Obtém ou define a visibilidade da configuração. O valor padrão é 'Personalizado'

Valor	Description
Custom	Visível somente para usuários com permissões.
Public	Visível para todos os usuários.

Compartilhar via

Public Maintenance Configurations - Get

Parâmetros de URI

Respostas

Exemplos

PublicMaintenanceConfigurations_GetForResource

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

ErrorDetails

InputLinuxParameters

InputPatchConfiguration

InputWindowsParameters

MaintenanceConfiguration

MaintenanceError

MaintenanceScope

RebootOptions

systemData

Visibility