Get-AzSynapseSqlAuditSetting

Reference

Module:: Az.Synapse

Gets the auditing settings of an Azure Synapse Analytics Workspace.

Syntax

Get-AzSynapseSqlAuditSetting
   [[-ResourceGroupName] <String>]
   [-WorkspaceName] <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseSqlAuditSetting
   -WorkspaceObject <PSSynapseWorkspace>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseSqlAuditSetting
   -ResourceId <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzSynapseSqlAuditSetting cmdlet gets the auditing settings of an Azure Synapse Analytics Workspace.

Examples

Example 1

Get-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace

Gets the auditing settings of a workspace named ContosoWorkspace.

Example 2

Get-AzSynapseWorkspace -Name ContosoWorkspace | Get-AzSynapseSqlAuditSetting

Gets the auditing settings of a workspace named ContosoWorkspace through pipeline.

Parameters

-AsJob

Run cmdlet in the background

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Resource group name.

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

-ResourceId

Resource identifier of Synapse workspace.

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

-WorkspaceName

Name of Synapse workspace.

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

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Type:	PSSynapseWorkspace
Aliases:	InputObject
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

PSSynapseWorkspace

Outputs

Microsoft.Azure.Commands.Synapse.Models.WorkspaceAuditModel