az synapse workspace firewall-rule

Manage a workspace's firewall rules.

Commands

Name	Description	Type	Status
az synapse workspace firewall-rule create	Create a firewall rule.	Core	GA
az synapse workspace firewall-rule delete	Delete a firewall rule.	Core	GA
az synapse workspace firewall-rule list	List all firewall rules.	Core	GA
az synapse workspace firewall-rule show	Get a firewall rule.	Core	GA
az synapse workspace firewall-rule update	Update a firewall rule.	Core	GA
az synapse workspace firewall-rule wait	Place the CLI in a waiting state until a condition of a firewall rule is met.	Core	GA

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]

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The IP firewall rule name.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Default value:	False

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

The workspace name.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az synapse workspace firewall-rule list

List all firewall rules.

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

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.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az synapse workspace firewall-rule show

Get a firewall rule.

az synapse workspace firewall-rule show [--ids]
                                        [--name]
                                        [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The IP firewall rule name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

The workspace name.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az synapse workspace firewall-rule update

Update a firewall rule.

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

Examples

Update a firewall rule.

az synapse workspace firewall-rule update --name allowAll --workspace-name testsynapseworkspace \
--resource-group rg --start-ip-address 172.0.0.0

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--end-ip-address

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

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The IP firewall rule name.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Default value:	False

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--start-ip-address

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

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

The workspace name.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--workspace-name

The workspace name.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False