Get-AzDiagnosticSetting

Module:

Az.Monitor

Gets the active diagnostic settings for the specified resource.

Syntax

Get-AzDiagnosticSetting
   -ResourceId <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzDiagnosticSetting
   -Name <String>
   -ResourceId <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzDiagnosticSetting
   -InputObject <IDiagnosticSettingIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets the active diagnostic settings for the specified resource.

Examples

Example 1: List diagnostic settings

$subscriptionId = (Get-AzContext).Subscription.Id
Get-AzDiagnosticSetting -ResourceId /subscriptions/$subscriptionId/resourceGroups/test-rg-name/providers/Microsoft.AppPlatform/Spring/springcloud-001

List diagnostic settings for resource

Example 2: Get diagnostic setting by name

$subscriptionId = (Get-AzContext).Subscription.Id
Get-AzDiagnosticSetting -ResourceId /subscriptions/$subscriptionId/resourceGroups/test-rg-name/providers/Microsoft.AppPlatform/Spring/springcloud-001 -Name test-setting

Get diagnostic settings under resource by name

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

-ResourceId

The identifier of the resource.

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

Inputs

IDiagnosticSettingIdentity

Outputs

IDiagnosticSettingsResource