Compartir a través de

Set-AzureRmDiagnosticSetting

  • Referencia
Módulo:
AzureRM.Insights

Establece la configuración de registros y métricas del recurso.

Advertencia

El módulo de PowerShell de AzureRM ha quedado en desuso oficialmente a partir del 29 de febrero de 2024. Se recomienda a los usuarios migrar de AzureRM al módulo Az PowerShell para seguir recibiendo soporte técnico y actualizaciones.

Aunque el módulo AzureRM puede seguir funcionando, ya no se mantiene ni se admite, colocando cualquier uso continuado a discreción y riesgo del usuario. Consulte nuestros recursos de migración para ver una guía sobre la transición al módulo Az.

Syntax

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

Description

El cmdlet Set-AzureRmDiagnosticSetting habilita o deshabilita cada categoría de intervalo de tiempo y registro del recurso determinado. Los registros y las métricas se almacenan en la cuenta de almacenamiento especificada. Este cmdlet implementa el patrón ShouldProcess, es decir, podría solicitar confirmación del usuario antes de crear, modificar o quitar el recurso realmente.

Ejemplos

Ejemplo 1: Habilitación de todas las métricas y registros de un recurso

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

Este comando habilita todas las métricas y registros disponibles para Resource01.

Ejemplo 2: Deshabilitar todas las métricas y registros

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

Este comando deshabilita todas las métricas y registros disponibles para el recurso Resource01.

Ejemplo 3: Habilitar o deshabilitar varias categorías de métricas

PS C:\>Set-AzureRmDiagnosticSetting -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 habilita las categorías de métricas denominadas Category1 y Category2. Todas las demás categorías siguen siendo las mismas.

Ejemplo 4: Habilitar o deshabilitar varias categorías de registro

PS C:\>Set-AzureRmDiagnosticSetting -ResourceId "Resource01" -Enabled $True -Categories 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 Category1 y Category2. Todas las demás métricas y categorías de registros siguen siendo las mismas.

Ejemplo 4: Habilitar un intervalo de tiempo y varias categorías

PS C:\>Set-AzureRmDiagnosticSetting -ResourceId "Resource01" -Enabled $True -Categories Category1,Category2 -Timegrains PT1M

Este comando solo habilita Category1, Category2 y time grain PT1M. El resto de granos y categorías de tiempo no se modifican.

Ejemplo 5: Uso de la canalización

PS C:\>Get-AzureRmDiagnosticSetting -ResourceId "Resource01" | Set-AzureRmDiagnosticSetting

Este comando usa la canalización de PowerShell para establecer (no cambiar) una configuración de diagnóstico.

Parámetros

-Categories

Especifica la lista de categorías de registro que se van a habilitar o deshabilitar, según el valor de Habilitado. Si no se especifica ninguna categoría, este comando funciona en todas las categorías admitidas.

Tipo:List<T>[String]
Aliases:Category
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure

Tipo:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:False
Accept wildcard characters:False

-Enabled

Indica si se habilitan los diagnósticos. Especifique $True para habilitar diagnósticos o $False para deshabilitar los diagnósticos.

Tipo:Boolean
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:True
Accept wildcard characters:False

-EventHubAuthorizationRuleId

Identificador de la regla de autorización del centro de eventos

Tipo:String
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:True
Accept wildcard characters:False

-EventHubName

Nombre del centro de eventos

Tipo:String
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Objeto de entrada (posible desde la canalización). El nombre y resourceId se extraerán de este objeto.

Tipo:PSServiceDiagnosticSettings
Position:Named
valor predeterminado:None
Requerido:True
Accept pipeline input:True
Accept wildcard characters:False

-MetricCategory

Lista de categorías de métricas. Si no se especifica ninguna categoría, este comando funciona en todas las categorías admitidas.

Tipo:List<T>[String]
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Nombre de la configuración de diagnóstico. El valor predeterminado es service.

Tipo:String
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

Especifica el identificador del recurso.

Tipo:String
Position:Named
valor predeterminado:None
Requerido:True
Accept pipeline input:True
Accept wildcard characters:False

-RetentionEnabled

Indica si está habilitada la retención de información de diagnóstico.

Tipo:Nullable<T>[Boolean]
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:True
Accept wildcard characters:False

-RetentionInDays

Especifica la directiva de retención, en días.

Tipo:Nullable<T>[Int32]
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:True
Accept wildcard characters:False

-ServiceBusRuleId

Identificador de regla de Service Bus.

Tipo:String
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageAccountId

Especifica el identificador de la cuenta de almacenamiento en la que se guardarán los datos.

Tipo:String
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:True
Accept wildcard characters:False

-Timegrains

Especifica los granos de tiempo que se van a habilitar o deshabilitar para las métricas, según el valor de Habilitado. Si no especifica un intervalo de tiempo, este comando funciona en todos los granos de tiempo disponibles.

Tipo:List<T>[String]
Aliases:Timegrain
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

Tipo:SwitchParameter
Aliases:wi
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceId

Identificador del área de trabajo

Tipo:String
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:True
Accept wildcard characters:False

Entradas

PSServiceDiagnosticSettings

Parámetros: InputObject (ByValue)

String

Boolean

List<T>[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Nullable<T>[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Nullable<T>[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Salidas

PSServiceDiagnosticSettings