Set-AzDiagnosticSetting
Define as configurações de logs e métricas do recurso.
Sintaxe
OldSetDiagnosticSetting (Padrã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 granulação e log 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 para um recurso
PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $True
Esse comando habilita todas as métricas e logs disponíveis para o 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: Habilitar/desabilitar 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 um grão 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 PT1M de granulação de tempo.
Todas as outras categorias e grãos de tempo não são alteradas.
Exemplo 5: Usando o 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 para habilitar ou desabilitar, de acordo com o valor de Enabled .
Se nenhuma categoria for especificada, esse comando funcionará em todas as categorias com suporte.
Propriedades do parâmetro
Tipo: List<T> [ String ]
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: cf
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usadas para comunicação com o Azure
Propriedades do parâmetro
Tipo: IAzureContextContainer
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: AzContext, AzureRmContext, AzureCredential
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-Enabled
Indica se o diagnóstico deve ser habilitado.
Especifique $True para habilitar o diagnóstico ou $False desabilitar o diagnóstico.
Propriedades do parâmetro
Tipo: Boolean
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-EventHubAuthorizationRuleId
A ID da regra de autorização do hub de eventos
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-EventHubName
O nome do hub de eventos
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-ExportToResourceSpecific
Sinalizador indicando 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ó é eficaz quando o argumento -workspaceId também é fornecido.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
O objeto de entrada (possível do pipeline.) O nome e resourceId serão extraídos desse objeto.
NewSetDiagnosticSetting
Cargo: Named
Obrigatório: True
Valor do pipeline: True
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-MetricCategory
A lista de categorias de métricas.
Se nenhuma categoria for especificada, esse comando funcionará em todas as categorias com suporte.
Propriedades do parâmetro
Tipo: List<T> [ String ]
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-Name
O nome da configuração de diagnóstico. O valor padrão é o serviço .
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-ResourceId
Especifica a ID do recurso.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Cargo: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-RetentionEnabled
Indica se a retenção de informações de diagnóstico está habilitada.
Propriedades do parâmetro
Conjuntos de parâmetros
OldSetDiagnosticSetting
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-RetentionInDays
Especifica a política de retenção, em dias.
Propriedades do parâmetro
Tipo: Nullable<T> [ Int32 ]
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-ServiceBusRuleId
A ID da regra do Barramento de Serviço.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-StorageAccountId
Especifica a ID da conta de armazenamento na qual salvar os dados.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-Timegrain
Especifica os intervalos de tempo para habilitar ou desabilitar as métricas, de acordo com o valor de Enabled .
Se você não especificar um intervalo de tempo, esse comando operará em todos os grãos de tempo disponíveis.
Propriedades do parâmetro
Tipo: List<T> [ String ]
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: wi
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-WorkspaceId
A ID do recurso do workspace do Log Analytics para enviar logs/métricas para
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
OldSetDiagnosticSetting
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: 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