Get-AzDiagnosticSetting

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 credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
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
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of the diagnostic setting.

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

-ResourceId

The identifier of the resource.

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

Inputs

IDiagnosticSettingIdentity

Outputs

IDiagnosticSettingsResource

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IDiagnosticSettingIdentity>: Identity Parameter

  • [Id <String>]: Resource identity path
  • [Name <String>]: The name of the diagnostic setting.
  • [ResourceUri <String>]: The identifier of the resource.
  • [SubscriptionId <String>]: The ID of the target subscription.