Set-AzDiagnosticSetting

  • Referência
Módulo:
Az.Monitor

Define as configurações de logs e métricas para o recurso.

Sintaxe

Set-AzDiagnosticSetting
   -ResourceId <String>
   [-Name <String>]
   [-StorageAccountId <String>]
   [-ServiceBusRuleId <String>]
   [-EventHubName <String>]
   [-EventHubAuthorizationRuleId <String>]
   [-Enabled <Boolean>]
   [-Category <System.Collections.Generic.List`1[System.String]>]
   [-MetricCategory <System.Collections.Generic.List`1[System.String]>]
   [-Timegrain <System.Collections.Generic.List`1[System.String]>]
   [-RetentionEnabled <Boolean>]
   [-WorkspaceId <String>]
   [-ExportToResourceSpecific]
   [-RetentionInDays <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDiagnosticSetting
   -InputObject <PSServiceDiagnosticSettings>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

O cmdlet Set-AzDiagnosticSetting habilita ou desabilita cada categoria de granularidade e log de cada vez para o recurso específico. Os logs e as métricas são armazenados na conta de armazenamento especificada. Esse cmdlet implementa o padrão ShouldProcess, ou seja, ele pode solicitar a confirmação do usuário antes de realmente criar, modificar ou remover o recurso.

Exemplos

Exemplo 1: Habilitar todas as métricas e logs de um recurso

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $True

Esse comando habilita todas as métricas e logs disponíveis para Resource01.

Exemplo 2: Desabilitar todas as métricas e logs

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $False

Esse comando desabilita todas as métricas e logs disponíveis para o recurso Resource01.

Exemplo 3: Ativar/desativar várias categorias de métricas

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $False -MetricCategory MetricCategory1,MetricCategory2
StorageAccountId   : <storageAccountId>
StorageAccountName : <storageAccountName>
Metrics
   Enabled   : False
   Category  : MetricCategory1
   Timegrain : PT1M
   Enabled   : False
   Category  : MetricCategory2
   Timegrain : PT1H
   Enabled   : True
   Category  : MetricCategory3
   Timegrain : PT1H
Logs
   Enabled  : True
   Category : Category1
   Enabled  : True
   Category : Category2
   Enabled  : True
   Category : Category3
   Enabled  : False
   Category : Category4

Esse comando desabilita as categorias de métricas chamadas Categoria1 e Categoria2. Todas as outras categorias permanecem as mesmas.

Exemplo 4: Habilitar/desabilitar várias categorias de log

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $True -Category Category1,Category2
StorageAccountId   : <storageAccountId>
StorageAccountName : <storageAccountName>
Metrics
   Enabled   : False
   Category  : MetricCategory1
   Timegrain : PT1M
   Enabled   : False
   Category  : MetricCategory2
   Timegrain : PT1H
   Enabled   : True
   Category  : MetricCategory3
   Timegrain : PT1H
Logs
   Enabled  : True
   Category : Category1
   Enabled  : True
   Category : Category2
   Enabled  : True
   Category : Category3
   Enabled  : False
   Category : Category4

Esse comando habilita Categoria1 e Categoria2. Todas as outras categorias de métricas e logs permanecem as mesmas.

Exemplo 4: Habilitar uma granularidade de tempo e várias categorias

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $True -Category Category1,Category2 -Timegrain PT1M

Esse comando habilita apenas Categoria1, Categoria2 e granulação temporal PT1M. Todas as outras granularidades e categorias de tempo permanecem inalteradas.

Exemplo 5: Usando pipeline

PS C:\>Get-AzDiagnosticSetting -ResourceId "Resource01" | Set-AzDiagnosticSetting -Enabled $True -Category Category1,Category2

Esse comando usa o pipeline do PowerShell para definir (nenhuma alteração feita) uma configuração de diagnóstico.

Parâmetros

-Category

Especifica a lista de categorias de log a serem habilitadas ou desabilitadas, de acordo com o valor de Habilitado. Se nenhuma categoria for especificada, esse comando operará em todas as categorias suportadas.

Tipo:List<T>[String]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usadas para comunicação com o Azure

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Enabled

Indica se o diagnóstico deve ser habilitado. Especifique $True para habilitar o diagnóstico ou $False para desabilitar o diagnóstico.

Tipo:Boolean
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-EventHubAuthorizationRuleId

A ID da regra de autorização do hub de eventos

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-EventHubName

O nome do hub de eventos

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ExportToResourceSpecific

Sinalizador que indica que a exportação para LA deve ser feita para uma tabela específica do recurso, também conhecida como tabela de esquema dedicada ou fixa, em oposição à tabela de esquema dinâmico padrão chamada AzureDiagnostics.

Esse argumento é efetivo somente quando o argumento -workspaceId também é fornecido.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-InputObject

O objeto de entrada (possível do pipeline.) O nome e resourceId serão extraídos desse objeto.

Tipo:PSServiceDiagnosticSettings
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-MetricCategory

A lista de categorias de métricas. Se nenhuma categoria for especificada, esse comando operará em todas as categorias suportadas.

Tipo:List<T>[String]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Name

O nome da configuração de diagnóstico. O valor padrão é service.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ResourceId

Especifica a ID do recurso.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-RetentionEnabled

Indica se a retenção de informações de diagnóstico está habilitada.

Tipo:Nullable<T>[Boolean]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-RetentionInDays

Especifica a política de retenção, em dias.

Tipo:Nullable<T>[Int32]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ServiceBusRuleId

A ID da Regra do Barramento de Serviço.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-StorageAccountId

Especifica a ID da conta de armazenamento na qual salvar os dados.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Timegrain

Especifica as granularidades de tempo a serem habilitadas ou desabilitadas para métricas, de acordo com o valor de Enabled. Se você não especificar uma granularidade de tempo, esse comando operará em todas as granularidades de tempo disponíveis.

Tipo:List<T>[String]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WorkspaceId

A ID do recurso do workspace do Log Analytics para o qual enviar logs/métricas

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

Entradas

PSServiceDiagnosticSettings

String

Boolean

List<T>[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Nullable<T>[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Saídas

PSServiceDiagnosticSettings