Share via


az eventhubs namespace network-rule-set

Manage Azure EventHubs networkruleset for namespace.

Commands

Name Description Type Status
az eventhubs namespace network-rule-set create

Create NetworkRuleSet for a Namespace.

Core GA
az eventhubs namespace network-rule-set ip-rule

Manage Azure eventhubs ip-rules in networkruleSet for namespace.

Core GA
az eventhubs namespace network-rule-set ip-rule add

Add a IP-Rule for network rule of namespace.

Core GA
az eventhubs namespace network-rule-set ip-rule remove

Remove Ip-Rule from network rule of namespace.

Core GA
az eventhubs namespace network-rule-set list

List NetworkRuleSet for a Namespace.

Core GA
az eventhubs namespace network-rule-set show

Get NetworkRuleSet for a Namespace.

Core GA
az eventhubs namespace network-rule-set update

Update NetworkRuleSet for a Namespace.

Core GA
az eventhubs namespace network-rule-set virtual-network-rule

Manage Azure eventhubs subnet-rule in networkruleSet for namespace.

Core GA
az eventhubs namespace network-rule-set virtual-network-rule add

Add a Virtual-Network-Rule for network rule of namespace.

Core GA
az eventhubs namespace network-rule-set virtual-network-rule remove

Remove network rule for a namespace.

Core GA

az eventhubs namespace network-rule-set create

Create NetworkRuleSet for a Namespace.

az eventhubs namespace network-rule-set create --name --namespace-name
                                               --resource-group
                                               [--default-action {Allow, Deny}]
                                               [--enable-trusted-service-access {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--ip-rules]
                                               [--public-network-access {Disabled, Enabled, SecuredByPerimeter}]
                                               [--virtual-network-rules]

Required Parameters

--name --namespace-name -n

The Namespace name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

--default-action

Default Action for Network Rule Set.

Property Value
Parameter group: Properties Arguments
Accepted values: Allow, Deny
--enable-trusted-service-access -t

Value that indicates whether Trusted Service Access is Enabled or not.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ip-rules

List of IpRules Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--public-network-access

This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules.

Property Value
Parameter group: Properties Arguments
Default value: Enabled
Accepted values: Disabled, Enabled, SecuredByPerimeter
--virtual-network-rules

List VirtualNetwork Rules Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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.

--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 eventhubs namespace network-rule-set list

List NetworkRuleSet for a Namespace.

az eventhubs namespace network-rule-set list --name --namespace-name
                                             --resource-group
                                             [--max-items]
                                             [--next-token]

Required Parameters

--name --namespace-name -n

The Namespace name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination 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.

--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 eventhubs namespace network-rule-set show

Get NetworkRuleSet for a Namespace.

az eventhubs namespace network-rule-set show [--ids]
                                             [--name --namespace-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 --namespace-name -n

The Namespace 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
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 eventhubs namespace network-rule-set update

Update NetworkRuleSet for a Namespace.

az eventhubs namespace network-rule-set update [--add]
                                               [--default-action {Allow, Deny}]
                                               [--enable-trusted-service-access {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--ids]
                                               [--ip-rules]
                                               [--name --namespace-name]
                                               [--public-network-access {Disabled, Enabled, SecuredByPerimeter}]
                                               [--remove]
                                               [--resource-group]
                                               [--set]
                                               [--subscription]
                                               [--virtual-network-rules]

Optional Parameters

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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--default-action

Default Action for Network Rule Set.

Property Value
Parameter group: Properties Arguments
Accepted values: Allow, Deny
--enable-trusted-service-access -t

Value that indicates whether Trusted Service Access is Enabled or not.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
--ip-rules

List of IpRules Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--name --namespace-name -n

The Namespace name.

Property Value
Parameter group: Resource Id Arguments
--public-network-access

This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules.

Property Value
Parameter group: Properties Arguments
Accepted values: Disabled, Enabled, SecuredByPerimeter
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update 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
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update 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
--virtual-network-rules

List VirtualNetwork Rules Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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