az synapse workspace firewall-rule

Manage a workspace's firewall rules.

Commands

az synapse workspace firewall-rule create

Create a firewall rule.

az synapse workspace firewall-rule delete

Delete a firewall rule.

az synapse workspace firewall-rule list

List all firewall rules.

az synapse workspace firewall-rule show

Get a firewall rule.

az synapse workspace firewall-rule wait

Place the CLI in a waiting state until a condition of a firewall rule is met.

az synapse workspace firewall-rule create

Create a firewall rule.

az synapse workspace firewall-rule create --end-ip-address
                                          --name
                                          --resource-group
                                          --start-ip-address
                                          --workspace-name
                                          [--no-wait]
                                          [--subscription]

Examples

Create a firewall rule.

az synapse workspace firewall-rule create --name allowAll --workspace-name testsynapseworkspace \
--resource-group rg --start-ip-address 0.0.0.0 --end-ip-address 255.255.255.255

Required Parameters

--end-ip-address

The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress.

--name -n

The IP firewall rule name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--start-ip-address

The start IP address of the firewall rule. Must be IPv4 format.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az synapse workspace firewall-rule delete

Delete a firewall rule.

az synapse workspace firewall-rule delete [--ids]
                                          [--name]
                                          [--no-wait]
                                          [--resource-group]
                                          [--subscription]
                                          [--workspace-name]
                                          [--yes]

Examples

Delete a firewall rule.

az synapse workspace firewall-rule delete --name rule1 --workspace-name testsynapseworkspace --resource-group rg

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The IP firewall rule name.

--no-wait

Do not wait for the long-running operation to finish.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The workspace name.

--yes -y

Do not prompt for confirmation.

az synapse workspace firewall-rule list

List all firewall rules.

az synapse workspace firewall-rule list --resource-group
                                        --workspace-name
                                        [--query-examples]
                                        [--subscription]

Examples

List all firewall rules.

az synapse workspace firewall-rule list --workspace-name testsynapseworkspace --resource-group rg

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The workspace name.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az synapse workspace firewall-rule show

Get a firewall rule.

az synapse workspace firewall-rule show [--ids]
                                        [--name]
                                        [--query-examples]
                                        [--resource-group]
                                        [--subscription]
                                        [--workspace-name]

Examples

Get a firewall rule.

az synapse workspace firewall-rule show --name rule1 --workspace-name testsynapseworkspace --resource-group rg

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The IP firewall rule name.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The workspace name.

az synapse workspace firewall-rule wait

Place the CLI in a waiting state until a condition of a firewall rule is met.

az synapse workspace firewall-rule wait --rule-name
                                        [--created]
                                        [--custom]
                                        [--deleted]
                                        [--exists]
                                        [--ids]
                                        [--interval]
                                        [--resource-group]
                                        [--subscription]
                                        [--timeout]
                                        [--updated]
                                        [--workspace-name]

Required Parameters

--rule-name

The IP firewall rule name.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

--workspace-name

The workspace name.