Set-AzDiagnosticSetting

Модуль:: Az.Monitor Module

Sets the logs and metrics settings for the resource.

Синтаксис

OldSetDiagnosticSetting (по умолчанию)

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>]

Описание

The Set-AzDiagnosticSetting cmdlet enables or disables each time grain and log category for the particular resource. The logs and metrics are stored in the specified storage account. This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource.

Примеры

Example 1: Enable all metrics and logs for a resource

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

This command enables all available metrics and logs for Resource01.

Example 2: Disable all metrics and logs

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

This command disables all available metrics and logs for the resource Resource01.

Example 3: Enable/disable multiple metrics categories

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

This command disables the metrics categories called Category1 and Category2. All the other categories remain the same.

Example 4: Enable/disable multiple log categories

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

This command enables Category1 and Category2. All the other metrics and logs categories remain the same.

Example 4: Enable a time grain and multiple categories

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

This command enables only Category1, Category2, and time grain PT1M. All other time grains and categories are unchanged.

Example 5: Using pipeline

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

This command uses the PowerShell pipeline to set (no change made) a diagnostic setting.

Параметры

-Category

Specifies the list of log categories to enable or disable, according to the value of Enabled. If no category is specified, this command operates on all supported categories.

Свойства параметра

Тип:	List<T>[String]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

OldSetDiagnosticSetting

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Свойства параметра

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	cf

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Свойства параметра

Тип:	IAzureContextContainer
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Enabled

Indicates whether to enable diagnostics. Specify $True to enable diagnostics, or $False to disable diagnostics.

Свойства параметра

Тип:	Boolean
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

OldSetDiagnosticSetting

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-EventHubAuthorizationRuleId

The event hub authorization rule id

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

OldSetDiagnosticSetting

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-EventHubName

The event hub name

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

OldSetDiagnosticSetting

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-ExportToResourceSpecific

Flag indicating that the export to LA must be done to a resource specific table, a.k.a. dedicated or fixed schema table, as opposed to the default dynamic schema table called AzureDiagnostics.

This argument is effective only when the argument -workspaceId is also given.

Свойства параметра

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

OldSetDiagnosticSetting

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-InputObject

The input object (possible from the pipeline.) The name and resourceId will be extracted from this object.

Свойства параметра

Тип:	PSServiceDiagnosticSettings
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

NewSetDiagnosticSetting

Position:	Named
Обязательно:	True
Значение из конвейера:	True
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-MetricCategory

The list of metric categories. If no category is specified, this command operates on all supported categories.

Свойства параметра

Тип:	List<T>[String]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

OldSetDiagnosticSetting

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-Name

The name of the diagnostic setting. The default value is service.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

OldSetDiagnosticSetting

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-ResourceId

Specifies the ID of the resource.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

OldSetDiagnosticSetting

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-RetentionEnabled

Indicates whether retention of diagnostic information is enabled.

Свойства параметра

Тип:	Nullable<T>[Boolean]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

OldSetDiagnosticSetting

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-RetentionInDays

Specifies the retention policy, in days.

Свойства параметра

Тип:	Nullable<T>[Int32]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

OldSetDiagnosticSetting

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-ServiceBusRuleId

The Service Bus Rule id.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

OldSetDiagnosticSetting

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-StorageAccountId

Specifies the ID of the Storage account in which to save the data.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

OldSetDiagnosticSetting

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-Timegrain

Specifies the time grains to enable or disable for metrics, according to the value of Enabled. If you do not specify a time grain, this command operates on all available time grains.

Свойства параметра

Тип:	List<T>[String]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

OldSetDiagnosticSetting

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Свойства параметра

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	wi

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-WorkspaceId

The resource Id of the Log Analytics workspace to send logs/metrics to

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

OldSetDiagnosticSetting

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Поделиться через

Set-AzDiagnosticSetting

Синтаксис

OldSetDiagnosticSetting (по умолчанию)

NewSetDiagnosticSetting

Описание

Примеры

Example 1: Enable all metrics and logs for a resource

Example 2: Disable all metrics and logs

Example 3: Enable/disable multiple metrics categories

Example 4: Enable/disable multiple log categories

Example 4: Enable a time grain and multiple categories

Example 5: Using pipeline

Параметры

-Category

Свойства параметра

Наборы параметров

-Confirm

Свойства параметра

Наборы параметров

-DefaultProfile

Свойства параметра

Наборы параметров

-Enabled

Свойства параметра

Наборы параметров

-EventHubAuthorizationRuleId

Свойства параметра

Наборы параметров

-EventHubName

Свойства параметра

Наборы параметров

-ExportToResourceSpecific

Свойства параметра

Наборы параметров

-InputObject

Свойства параметра

Наборы параметров

-MetricCategory

Свойства параметра

Наборы параметров

-Name

Свойства параметра

Наборы параметров

-ResourceId

Свойства параметра

Наборы параметров

-RetentionEnabled

Свойства параметра

Наборы параметров

-RetentionInDays

Свойства параметра

Наборы параметров

-ServiceBusRuleId

Свойства параметра

Наборы параметров

-StorageAccountId

Свойства параметра

Наборы параметров

-Timegrain

Свойства параметра

Наборы параметров

-WhatIf

Свойства параметра

Наборы параметров

-WorkspaceId

Свойства параметра

Наборы параметров

CommonParameters

Входные данные

PSServiceDiagnosticSettings

String

Boolean

List<T>

Nullable<T>

Nullable<T>

Выходные данные

PSServiceDiagnosticSettings

Связанные ссылки