az network perimeter profile

Reference

Note

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

Manage Network Profiles under an NSP.

Commands

Name	Description	Type	Status
az network perimeter profile access-rule	Manage Access Rules of a Profile inside an NSP.	Extension	GA
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	Updates a network access rule.	Extension	GA
az network perimeter profile create	Creates or updates a network profile.	Extension	GA
az network perimeter profile delete	Deletes an NSP profile.	Extension	GA
az network perimeter profile list	Lists the NSP profiles in the specified network security perimeter.	Extension	GA
az network perimeter profile show	Gets the specified NSP profile.	Extension	GA

az network perimeter profile create

Creates or updates a network profile.

az network perimeter profile create --name
                                    --perimeter-name
                                    --resource-group
                                    [--location]
                                    [--tags]

Examples

Create NSP Profile

az network perimeter profile create -n MyProfile --perimeter-name MyPerimeter -g MyResourceGroup

Required Parameters

--name --profile-name -n

The name of the NSP profile.

--perimeter-name

The name of the network security perimeter.

--resource-group -g

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

Optional Parameters

--location -l

Resource location.

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

Deletes an NSP profile.

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

Examples

Delete NSP Profile

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

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 --profile-name -n

The name of the NSP profile.

--perimeter-name

The name of the network security perimeter.

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

Lists the NSP profiles in the specified network security perimeter.

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

Examples

List NSP Profiles inside a Perimeter

az network perimeter profile list --perimeter-name MyPerimeter -g MyResourceGroup

Required Parameters

--perimeter-name

The name of the network security perimeter.

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

Gets the specified NSP profile.

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

Examples

Get NSP Profile

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

Optional Parameters

--ids

--name --profile-name -n

The name of the NSP profile.

--perimeter-name

The name of the network security perimeter.

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

Commands

az network perimeter profile create

Examples

Required Parameters

Optional Parameters

az network perimeter profile delete

Examples

Optional Parameters

az network perimeter profile list

Examples

Required Parameters

Optional Parameters

az network perimeter profile show

Examples

Optional Parameters

Feedback

Additional resources