Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzSynapseFirewallRule

Gets a Synapse Analytics Firewall Rule.

Syntax

GetByNameParameterSet (Default) 

Get-AzSynapseFirewallRule
 -WorkspaceName <String>
 [-ResourceGroupName <String>]
 [-Name <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

GetByParentObjectParameterSet 

Get-AzSynapseFirewallRule
 -WorkspaceObject <PSSynapseWorkspace>
 [-Name <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

Description

The Get-AzSynapseFirewallRule cmdlet gets a Azure Synapse Analytics Firewall Rule. If you do not specify a rule name, this cmdlet gets all rules.

Examples

Example 1

Get-AzSynapseFirewallRule -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace

This command gets all firewall rules under a workspace.

Example 2

Get-AzSynapseFirewallRule -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoFirewallRule

This command gets the firewall rule under workspace ContosoWorkspace with name ContosoFirewallRule.

Example 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseFirewallRule

This command gets all firewall rules under a workspace 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

-Name

The firewall rule name for the workspace.

Parameter properties

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

Parameter sets

-ResourceGroupName

Resource group name.

Parameter properties

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

Parameter sets

-WorkspaceName

Name of Synapse workspace.

Parameter properties

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

Parameter sets

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Parameter properties

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

Parameter sets

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

Outputs

Microsoft.Azure.Commands.Synapse.Models.PSSynapseIpFirewallRule

Feedback

Was this page helpful?