Get-AzSynapseSqlPoolAuditSetting

Module:

Az.Synapse Module

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

Syntax

SqlPoolParameterSet (Default)

Get-AzSynapseSqlPoolAuditSetting
    [[-ResourceGroupName] <String>]
    [-WorkspaceName] <String>
    -SqlPoolName <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

SqlPoolParentObjectParameterSet

Get-AzSynapseSqlPoolAuditSetting
    -WorkspaceObject <PSSynapseWorkspace>
    -SqlPoolName <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

SqlPoolObjectParameterSet

Get-AzSynapseSqlPoolAuditSetting
    -SqlPoolObject <PSSynapseSqlPool>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

SqlPoolResourceIdParameterSet

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.

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

Resource group name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SqlPoolParameterSet

Position:	0
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceId

Resource identifier of Synapse SQL Pool.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SqlPoolResourceIdParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SqlPoolName

Name of Synapse SQL pool.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Name

Parameter sets

SqlPoolParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

SqlPoolParentObjectParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SqlPoolObject

SQL pool input object, usually passed through the pipeline.

Parameter properties

Type:	PSSynapseSqlPool
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	InputObject

Parameter sets

SqlPoolObjectParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WorkspaceName

Name of Synapse workspace.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SqlPoolParameterSet

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Parameter properties

Type:	PSSynapseWorkspace
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SqlPoolParentObjectParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSSynapseWorkspace

PSSynapseSqlPool

Outputs

Microsoft.Azure.Commands.Synapse.Models.SqlPoolAuditModel