Get-AzSynapseSqlPoolAuditSetting

  • Reference
Module:
Az.Synapse

Gets the auditing settings of an Azure Synapse Analytics SQL pool.

Syntax

Get-AzSynapseSqlPoolAuditSetting
   [[-ResourceGroupName] <String>]
   [-WorkspaceName] <String>
   -SqlPoolName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzSynapseSqlPoolAuditSetting
   -WorkspaceObject <PSSynapseWorkspace>
   -SqlPoolName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzSynapseSqlPoolAuditSetting
   -SqlPoolObject <PSSynapseSqlPool>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzSynapseSqlPoolAuditSetting
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzSynapseSqlPoolAuditSetting cmdlet gets the auditing settings of an Azure Synapse Analytics SQL pool.

Examples

Example 1

Get-AzSynapseSqlPoolAuditSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool

This command gets the auditing settings of a SQL pool called ContosoSqlPool in the workspace ContosoWorkspace.

Example 2

Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool | Get-AzSynapseSqlPoolAuditSetting

This command gets the auditing settings of a SQL pool called ContosoSqlPool in the workspace ContosoWorkspace through pipeline.

Parameters

-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 SQL Pool.

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

-SqlPoolName

Name of Synapse SQL pool.

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

-SqlPoolObject

SQL pool input object, usually passed through the pipeline.

Type:PSSynapseSqlPool
Aliases:InputObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

PSSynapseWorkspace

PSSynapseSqlPool

Outputs

Microsoft.Azure.Commands.Synapse.Models.SqlPoolAuditModel