Set-AzDiagnosticSetting
Define as configurações de logs e métricas para o recurso.
Sintaxe
OldSetDiagnosticSetting (Predefinição)
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>]
NewSetDiagnosticSetting
Set-AzDiagnosticSetting
-InputObject <PSServiceDiagnosticSettings>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Set-AzDiagnosticSetting habilita ou desabilita cada categoria de log e grão de tempo para o recurso específico.
Os logs e métricas são armazenados na conta de armazenamento especificada.
Este cmdlet implementa o padrão ShouldProcess, ou seja, pode solicitar confirmação do usuário antes de realmente criar, modificar ou remover o recurso.
Exemplos
Exemplo 1: Habilitar todas as métricas e logs para um recurso
PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $True
Este comando habilita todas as métricas e logs disponíveis para Resource01.
Exemplo 2: Desativar todas as métricas e logs
PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $False
Este comando desativa 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
Este comando desativa as categorias de métricas chamadas Categoria1 e Categoria2.
Todas as outras categorias permanecem as mesmas.
Exemplo 4: Ativar/desativar 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
Este comando habilita Categoria1 e Categoria2.
Todas as outras métricas e categorias de logs permanecem as mesmas.
Exemplo 4: Habilitar um grão de tempo e várias categorias
PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $True -Category Category1,Category2 -Timegrain PT1M
Este comando habilita apenas Categoria1, Categoria2 e granulação de tempo PT1M.
Todos os outros grãos e categorias de tempo permanecem inalterados.
Exemplo 5: Usando pipeline
PS C:\>Get-AzDiagnosticSetting -ResourceId "Resource01" | Set-AzDiagnosticSetting -Enabled $True -Category Category1,Category2
Este 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 Enabled .
Se nenhuma categoria for especificada, esse comando será operado em todas as categorias suportadas.
Propriedades dos parâmetros
Tipo: List<T> [ String ]
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
-Confirm
Solicita confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Aliases: Cf.
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure
Propriedades dos parâmetros
Tipo: IAzureContextContainer
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Aliases: AzContext, AzureRmContext, AzureCredential
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Enabled
Indica se o diagnóstico deve ser habilitado.
Especifique $True para habilitar diagnósticos ou $False desabilitar diagnósticos.
Propriedades dos parâmetros
Tipo: Boolean
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
-EventHubAuthorizationRuleId
A ID da regra de autorização do hub de eventos
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
-EventHubName
O nome do hub de eventos
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
-ExportToResourceSpecific
Sinalizador que indica que a exportação para LA deve ser feita para uma tabela específica de 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 só é efetivo quando o argumento -workspaceId também é fornecido.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
O objeto de entrada (possível a partir do pipeline.) O nome e resourceId serão extraídos deste objeto.
NewSetDiagnosticSetting
Position: Named
Obrigatório: True
Valor do pipeline: True
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-MetricCategory
A lista de categorias métricas.
Se nenhuma categoria for especificada, esse comando será operado em todas as categorias suportadas.
Propriedades dos parâmetros
Tipo: List<T> [ String ]
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
-Name
O nome da configuração de diagnóstico. O valor padrão é service .
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
-ResourceId
Especifica a ID do recurso.
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Position: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
-RetentionEnabled
Indica se a retenção de informações de diagnóstico está habilitada.
Propriedades dos parâmetros
Tipo: Nullable<T> [ Boolean ]
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
-RetentionInDays
Especifica a política de retenção, em dias.
Propriedades dos parâmetros
Tipo: Nullable<T> [ Int32 ]
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
-ServiceBusRuleId
A ID da Regra do Service Bus.
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
-StorageAccountId
Especifica a ID da conta de armazenamento na qual salvar os dados.
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
-Timegrain
Especifica os grãos de tempo a serem habilitados ou desabilitados para métricas, de acordo com o valor de Enabled .
Se você não especificar um grão de tempo, esse comando operará em todos os grãos de tempo disponíveis.
Propriedades dos parâmetros
Tipo: List<T> [ String ]
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Aliases: Wi
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-WorkspaceId
O ID do recurso do espaço de trabalho do Log Analytics para enviar logs/métricas para
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: True
Valor dos restantes argumentos: False
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters .
Saídas