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 do URI

Name	Em	Necessá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. O ID da assinatura faz parte do URI de cada chamada de serviço.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.

Respostas

Name	Tipo	Description
200 OK	MaintenanceConfiguration	OK
Other Status Codes	MaintenanceError	BadRequest

Exemplos

PublicMaintenanceConfigurations_GetForResource

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorDetails	Um detalhe de resposta de erro recebido do serviço de Manutenção do Azure.
InputLinuxParameters	Propriedades de entrada para aplicar patches em uma máquina Linux.
InputPatchConfiguration	Configuração de entrada para uma execução de patch
InputWindowsParameters	Propriedades de entrada para aplicar patches em uma máquina 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 manutençãoEscopo da configuração
RebootOptions	Possível preferência de reinicialização, conforme definido pelo usuário, com base no qual seria decidido reiniciar a máquina ou não após a operação de patch ser concluída.
systemData	Metadados referentes à criação e última modificação do recurso.
Visibility	Obtém ou define a visibilidade da configuração. O valor padrão é 'Custom'

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorDetails

Object

Um detalhe de resposta de erro recebido do serviço de Manutenção do Azure.

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

InputLinuxParameters

Object

Propriedades de entrada para aplicar patches em uma máquina Linux.

Name	Tipo	Description
classificationsToInclude	string[]	Categoria de classificação dos sistemas a corrigir. Os valores permitidos são 'Crítico', 'Segurança' e 'Outros'.
packageNameMasksToExclude	string[]	Nomes de pacotes a serem excluídos para aplicação de patches.
packageNameMasksToInclude	string[]	Nomes de pacotes a serem incluídos para aplicação de patches.

InputPatchConfiguration

Object

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

Name	Tipo	Default value	Description
linuxParameters	InputLinuxParameters		Parâmetros de entrada específicos para a aplicação de patches na máquina Linux. Para máquinas Windows, não passe esta propriedade.
rebootSetting	RebootOptions	IfRequired	Possível preferência de reinicialização, conforme definido pelo usuário, com base no qual seria decidido reiniciar a máquina ou não após a operação de patch ser concluída.
windowsParameters	InputWindowsParameters		Parâmetros de entrada específicos para aplicar patches em uma máquina Windows. Para máquinas Linux, não passe esta propriedade.

InputWindowsParameters

Object

Propriedades de entrada para aplicar patches em uma máquina Windows.

Name	Tipo	Description
classificationsToInclude	string[]	Categoria de classificação dos sistemas a corrigir. Os valores permitidos são 'Crítico', 'Segurança', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definição', 'Ferramentas' e 'Atualizações'.
excludeKbsRequiringReboot	boolean	Excluir patches que precisam ser reinicializados
kbNumbersToExclude	string[]	Windows KBID a ser excluído para aplicação de patches.
kbNumbersToInclude	string[]	Windows KBID a ser incluído para aplicação de patches.

MaintenanceConfiguration

Object

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

Name	Tipo	Description
id	string	Identificador totalmente qualificado do recurso
location	string	Obtém ou define a localização do recurso
name	string	Nome do recurso
properties.extensionProperties	object	Obtém ou define extensionProperties of the maintenanceConfiguration
properties.installPatches	InputPatchConfiguration	Os parâmetros de entrada a serem passados para a operação de execução do patch.
properties.maintenanceScope	MaintenanceScope	Obtém ou define manutençãoEscopo 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 expiração efetiva da janela de manutenção no formato AAAA-MM-DD hh:mm. A janela será criada no fuso horário fornecido e ajustada ao horário de verão de acordo com esse fuso horário. A data de expiração deve ser definida para uma data futura. Se não for fornecido, será definido para a data/hora máxima 9999-12-31 23:59:59.
properties.maintenanceWindow.recurEvery	string	Taxa na qual se espera que uma janela de Manutenção se repita. A taxa pode ser expressa em horários diários, semanais ou mensais. A programação diária é formatada como recorrente: [Frequência como inteiro]['Dia(s)']. Se nenhuma frequência for fornecida, a frequência padrão será 1. Exemplos de horários diários são recorrentes: Dia, recorrentes: 3Dias. A programação semanal é formatada como recorrente: [Frequência como inteiro]['Semana(s)'] [Lista opcional separada por vírgulas dos dias úteis de segunda a domingo]. Exemplos de programação semanal são recorrentes: 3Weeks, recurEvery: Semana sábado, domingo. As agendas mensais são formatadas como [Frequência como inteiro]['Mês(es)'] [Lista separada por vírgulas de dias do mês] ou [Frequência como inteiro]['Mês(es)'] [Semana do Mês (Primeiro, Segundo, Terceira, Quarta, Última, Última)] [Dia da Semana de Segunda a Domingo] [Compensação Opcional(Nº de dias)]. O valor de deslocamento deve estar entre -6 a 6, inclusive. Exemplos de programação mensal são recorrentesEvery: 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 AAAA-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 ao 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: Hora Padrão do Pacífico, UTC, Hora Padrão da Europa W., 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 é 'Custom'
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Obtém ou define tags do recurso
type	string	Tipo de recurso

MaintenanceError

Object

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

Name	Tipo	Description
error	ErrorDetails	Detalhes do erro

MaintenanceScope

Enumeração

Obtém ou define manutençãoEscopo da configuração

Valor	Description
Host	Esse escopo de manutenção controla a instalação de atualizações da plataforma azure, ou seja, serviços em nós físicos que hospedam VMs de clientes.
Resource	Este escopo de manutenção controla a manutenção de atualização padrão do Recurso do Azure
OSImage	Este escopo de manutenção controla a instalação da imagem no VM/VMSS
Extension	Este escopo de manutenção controla a instalação de extensão em VM/VMSS
InGuestPatch	Este 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 SQL.

RebootOptions

Enumeração

Possível preferência de reinicialização, conforme definido pelo usuário, com base no qual seria decidido reiniciar a máquina ou não após a operação de patch ser concluída.

Valor	Description
IfRequired
Never
Always

systemData

Object

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

Name	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 é 'Custom'

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

Partilhar via

Public Maintenance Configurations - Get

Parâmetros do URI

Respostas

Exemplos

PublicMaintenanceConfigurations_GetForResource

Pedido de amostra

Resposta da amostra

Definições

createdByType

ErrorDetails

InputLinuxParameters

InputPatchConfiguration

InputWindowsParameters

MaintenanceConfiguration

MaintenanceError

MaintenanceScope

RebootOptions

systemData

Visibility