Share via

az network perimeter profile access-rule

  • Reference

Note

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

Manage Access Rules of a Profile inside an NSP.

Commands

Name Description Type Status
az network perimeter profile access-rule create

Creates or updates a network access rule.

 Extension GA
az network perimeter profile access-rule delete

Deletes an NSP access rule.

 Extension GA
az network perimeter profile access-rule list

Lists the NSP access rules in the specified NSP profile.

 Extension GA
az network perimeter profile access-rule show

Gets the specified NSP access rule by name.

 Extension GA
az network perimeter profile access-rule update

Creates or updates a network access rule.

 Extension GA

az network perimeter profile access-rule create

Creates or updates a network access rule.

az network perimeter profile access-rule create --access-rule-name
                                                --perimeter-name
                                                --profile-name
                                                --resource-group
                                                [--address-prefixes]
                                                [--direction {Inbound, Outbound}]
                                                [--email-addresses]
                                                [--fqdn]
                                                [--location]
                                                [--phone-numbers]
                                                [--service-tags]
                                                [--subscriptions]
                                                [--tags]

Examples

Create IP based access rule

az network perimeter profile access-rule create -n MyAccessRule --profile-name MyProfile --perimeter-name MyPerimeter -g MyResourceGroup --address-prefixes "[10.10.0.0/16]"

Create NSP based access rule

az network perimeter profile access-rule create -n MyAccessRule --profile-name MyProfile --perimeter-name MyPerimeter -g MyResourceGroup --nsp "[{id:<NSP_ARM_ID>}]"

Create FQDN based access rule

az network perimeter profile access-rule create -n MyAccessRule --profile-name MyProfile --perimeter-name MyPerimeter -g MyResourceGroup --fqdn "['www.abc.com', 'www.google.com']" --direction "Outbound"

Create Subscription based access rule

az network perimeter profile access-rule create -n MyAccessRule --profile-name MyProfile --perimeter-name MyPerimeter -g MyResourceGroup --subscriptions [0].id="<SubscriptionID1>" [1].id="<SubscriptionID2>"

Create ServiceTags based access rule

az network perimeter profile access-rule create -n MyAccessRule --profile-name MyProfile --perimeter-name MyPerimeter -g MyResourceGroup --service-tags  [st1,st2]

Required Parameters

--access-rule-name --name -n

The name of the NSP access rule.

--perimeter-name

The name of the network security perimeter.

--profile-name

The name of the NSP profile.

--resource-group -g

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

Optional Parameters

--address-prefixes

Inbound address prefixes (IPv4/IPv6) Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--direction

Direction that specifies whether the access rules is inbound/outbound.

Accepted values: Inbound, Outbound
--email-addresses

Outbound rules email address format. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--fqdn

Outbound rules fully qualified domain name format. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

Resource location.

--phone-numbers

Outbound rules phone number format. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--service-tags

Inbound rules service tag names. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--subscriptions

Subscription id in the ARM id format. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network perimeter profile access-rule delete

Deletes an NSP access rule.

az network perimeter profile access-rule delete [--access-rule-name]
                                                [--ids]
                                                [--perimeter-name]
                                                [--profile-name]
                                                [--resource-group]
                                                [--subscription]
                                                [--yes]

Examples

Delete NSP access rule

az network perimeter profile access-rule delete -n MyAccessRule --profile-name MyProfile --perimeter-name MyPerimeter -g MyResourceGroup

Optional Parameters

--access-rule-name --name -n

The name of the NSP access rule.

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

--perimeter-name

The name of the network security perimeter.

--profile-name

The name of the NSP profile.

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

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network perimeter profile access-rule list

Lists the NSP access rules in the specified NSP profile.

az network perimeter profile access-rule list --perimeter-name
                                              --profile-name
                                              --resource-group
                                              [--max-items]
                                              [--next-token]
                                              [--skip-token]
                                              [--top]

Examples

List access rules inside a Profile

az network perimeter profile access-rule list --profile-name MyProfile --perimeter-name MyPerimeter -g MyResourceGroup

Required Parameters

--perimeter-name

The name of the network security perimeter.

--profile-name

The name of the NSP profile.

--resource-group -g

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

Optional Parameters

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

--next-token

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

--skip-token

SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

--top

An optional query parameter which specifies the maximum number of records to be returned by the server.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network perimeter profile access-rule show

Gets the specified NSP access rule by name.

az network perimeter profile access-rule show [--access-rule-name]
                                              [--ids]
                                              [--perimeter-name]
                                              [--profile-name]
                                              [--resource-group]
                                              [--subscription]

Examples

Get NSP access rule

az network perimeter profile access-rule show -n MyAccessRule --profile-name MyProfile --perimeter-name MyPerimeter -g MyResourceGroup

Optional Parameters

--access-rule-name --name -n

The name of the NSP access rule.

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

--perimeter-name

The name of the network security perimeter.

--profile-name

The name of the NSP profile.

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network perimeter profile access-rule update

Creates or updates a network access rule.

az network perimeter profile access-rule update [--access-rule-name]
                                                [--add]
                                                [--address-prefixes]
                                                [--direction {Inbound, Outbound}]
                                                [--email-addresses]
                                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--fqdn]
                                                [--ids]
                                                [--location]
                                                [--perimeter-name]
                                                [--phone-numbers]
                                                [--profile-name]
                                                [--remove]
                                                [--resource-group]
                                                [--service-tags]
                                                [--set]
                                                [--subscription]
                                                [--subscriptions]
                                                [--tags]

Examples

Update access rule

az network perimeter profile access-rule update -n MyAccessRule --profile-name MyProfile --perimeter-name MyPerimeter -g MyResourceGroup --address-prefixes "[10.10.0.0/16]"

Optional Parameters

--access-rule-name --name -n

The name of the NSP access rule.

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

--address-prefixes

Inbound address prefixes (IPv4/IPv6) Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--direction

Direction that specifies whether the access rules is inbound/outbound.

Accepted values: Inbound, Outbound
--email-addresses

Outbound rules email address format. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--fqdn

Outbound rules fully qualified domain name format. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--location -l

Resource location.

--perimeter-name

The name of the network security perimeter.

--phone-numbers

Outbound rules phone number format. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--profile-name

The name of the NSP profile.

--remove

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

--resource-group -g

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

--service-tags

Inbound rules service tag names. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--set

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

--subscription

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

--subscriptions

Subscription id in the ARM id format. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.