New-AzSynapseFirewallRule
Creates a Synapse Analytics Firewall Rule.
Syntax
New-AzSynapseFirewallRule
[-ResourceGroupName <String>]
-WorkspaceName <String>
-Name <String>
-StartIpAddress <String>
-EndIpAddress <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzSynapseFirewallRule
[-ResourceGroupName <String>]
-WorkspaceName <String>
[-AllowAllAzureIp]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzSynapseFirewallRule
[-ResourceGroupName <String>]
-WorkspaceName <String>
[-AllowAllIp]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzSynapseFirewallRule
-WorkspaceObject <PSSynapseWorkspace>
-Name <String>
-StartIpAddress <String>
-EndIpAddress <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzSynapseFirewallRule
-WorkspaceObject <PSSynapseWorkspace>
[-AllowAllAzureIp]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzSynapseFirewallRule
-WorkspaceObject <PSSynapseWorkspace>
[-AllowAllIp]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The New-AzSynapseFirewallRule cmdlet creates an Azure Synapse Analytics Firewall Rule.
Examples
Example 1
New-AzSynapseFirewallRule -WorkspaceName ContosoWorkspace -Name ContosoFirewallRule -StartIpAddress "0.0.0.0" -EndIpAddress "255.255.255.255"This command creates firewall rule named ContosoFirewallRule under workspace ContosoWorkspace with name ContosoFirewallRule.
Example 2
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | New-AzSynapseFirewallRule -Name ContosoFirewallRule -StartIpAddress "0.0.0.0" -EndIpAddress "255.255.255.255"This command creates firewall rule named ContosoFirewallRule under a workspace through pipeline.
Example 3
New-AzSynapseFirewallRule -WorkspaceName ContosoWorkspace -AllowAllAzureIPThis command creates firewall rule that allow all azure ips under a workspace.
Parameters
-AllowAllAzureIp
Creates a special firewall rule that permits all Azure IPs to have access.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllowAllIp
Creates a special firewall rule that allows connections from all IP addresses. The Start IP is 0.0.0.0. The End IP is 255.255.255.255.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AsJob
Run cmdlet in the background
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| 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 |
-EndIpAddress
The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The firerwall rule name for the workspace.
| Type: | String |
| Aliases: | FirewallRuleName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Resource group name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartIpAddress
The start IP address of the firewall rule. Must be IPv4 format.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WorkspaceName
Name of Synapse workspace.
| Type: | String |
| Position: | Named |
| 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
Outputs
Microsoft.Azure.Commands.Synapse.Models.PSSynapseIpFirewallRule
Azure PowerShell