Edit

Get-AzSubscriptionDiagnosticSetting

  • Reference
Module:
Az.Monitor

Gets the active subscription diagnostic settings for the specified resource.

Syntax

Get-AzSubscriptionDiagnosticSetting
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzSubscriptionDiagnosticSetting
   -Name <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzSubscriptionDiagnosticSetting
   -InputObject <IDiagnosticSettingIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets the active subscription diagnostic settings for the specified resource.

Examples

Example 1: List diagnostic setting for subscription

Get-AzSubscriptionDiagnosticSetting

List diagnostic setting for current subscription

Example 2: Get diagnostic setting for subscription

Get-AzSubscriptionDiagnosticSetting -Name test-setting

Get diagnostic setting by name under current subscription

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IDiagnosticSettingIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of the diagnostic setting.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription.

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IDiagnosticSettingIdentity

Outputs

ISubscriptionDiagnosticSettingsResource