az webpubsub network-rule

Note

This reference is part of the webpubsub extension for the Azure CLI (version 2.56.0 or higher). The extension will automatically install the first time you run an az webpubsub network-rule command. Learn more about extensions.

Commands to manage Webpubsub network rules.

Commands

Name	Description	Type	Status
az webpubsub network-rule ip-rule	Manage WebPubSub Service IP rules.	Extension	GA
az webpubsub network-rule ip-rule add	Add IP rule to WebPubSub Service.	Extension	GA
az webpubsub network-rule ip-rule remove	Remove IP rule from WebPubSub Service.	Extension	GA
az webpubsub network-rule show	Get the Network access control of WebPubSub Service.	Extension	GA
az webpubsub network-rule update	Update the Network access control of WebPubSub Service.	Extension	GA

az webpubsub network-rule show

Get the Network access control of WebPubSub Service.

az webpubsub network-rule show [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]

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

Name of the webpubsub.

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

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 webpubsub network-rule update

Update the Network access control of WebPubSub Service.

az webpubsub network-rule update [--allow {ClientConnection, RESTAPI, ServerConnection, Trace}]
                                 [--connection-name]
                                 [--deny {ClientConnection, RESTAPI, ServerConnection, Trace}]
                                 [--ids]
                                 [--name]
                                 [--public-network {false, true}]
                                 [--resource-group]
                                 [--subscription]

Examples

Set allowing RESTAPI only for public network.

az webpubsub network-rule update --public-network -n MyWebPubSub -g MyResourceGroup --allow RESTAPI

Set allowing client connection and server connection for a private endpoint connection

az webpubsub network-rule update --connection-name MyPrivateEndpointConnection -n MyWebPubSub -g MyResourceGroup --allow ClientConnection ServerConnection

Set denying client connection for both public network and private endpoint connections

az webpubsub network-rule update --public-network --connection-name MyPrivateEndpointConnection1 MyPrivateEndpointConnection2 -n MyWebPubSub -g MyResourceGroup --deny ClientConnection

Optional Parameters

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

--allow

The allowed virtual network rule. Space-separeted list of scope to assign.

Property	Value
Default value:	[]
Accepted values:	ClientConnection, RESTAPI, ServerConnection, Trace

--connection-name

Space-separeted list of private endpoint connection name.

Property	Value
Parameter group:	Private Endpoint Connection Arguments
Default value:	[]

--deny

The denied virtual network rule. Space-separeted list of scope to assign.

Property	Value
Default value:	[]
Accepted values:	ClientConnection, RESTAPI, ServerConnection, Trace

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

Name of the webpubsub.

Property	Value
Parameter group:	Resource Id Arguments

--public-network

Set rules for public network.

Property	Value
Parameter group:	Public Network Arguments
Accepted values:	false, true

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

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