az network perimeter

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 command. Learn more about extensions.

Manage Network Security Perimeters.

Commands

Name	Description	Type	Status
az network perimeter association	Manage NSP Associations.	Extension	GA
az network perimeter association create	Creates or updates a NSP resource association.	Extension	GA
az network perimeter association delete	Deletes an NSP association resource.	Extension	GA
az network perimeter association list	Lists the NSP resource associations.	Extension	GA
az network perimeter association show	Gets the specified NSP association by name.	Extension	GA
az network perimeter association update	Updates a NSP resource association.	Extension	GA
az network perimeter association wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az network perimeter create	Creates a Network Security Perimeter.	Extension	GA
az network perimeter delete	Deletes a network security perimeter.	Extension	GA
az network perimeter link	Manage network security perimeter link.	Extension	GA
az network perimeter link-reference	Manage network security perimeter link reference.	Extension	GA
az network perimeter link-reference delete	Delete an NSP LinkReference resource.	Extension	GA
az network perimeter link-reference list	List the NSP LinkReference resources in the specified network security perimeter.	Extension	GA
az network perimeter link-reference show	Get the specified NSP linkReference resource.	Extension	GA
az network perimeter link-reference wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az network perimeter link create	Create NSP link resource.	Extension	GA
az network perimeter link delete	Delete an NSP Link resource.	Extension	GA
az network perimeter link list	List the NSP Link resources in the specified network security perimeter.	Extension	GA
az network perimeter link show	Get the specified NSP link resource.	Extension	GA
az network perimeter link update	Update NSP link resource.	Extension	GA
az network perimeter link wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az network perimeter list	List all network security perimeters in a subscription.	Extension	GA
az network perimeter onboarded-resources	Manage resources onboarded to NSP.	Extension	GA
az network perimeter onboarded-resources list	Gets the list of resources that are onboarded with NSP. These resources can be associated with a network security perimeter.	Extension	GA
az network perimeter profile	Manage Network Profiles under an NSP.	Extension	GA
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	Creates or 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 show	Gets the specified network security perimeter by the name.	Extension	GA

az network perimeter create

Creates a Network Security Perimeter.

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

Examples

Create a Network Security Perimeter

az network perimeter create -n MyPerimeter -g MyResourceGroup -l northcentralus

Required Parameters

--name --perimeter-name -n

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

The location in which NSP is created.

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

Deletes a network security perimeter.

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

Examples

Delete a Network Security Perimeter

az network perimeter delete -g MyResourceGroup -n MyPerimeter

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

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 list

List all network security perimeters in a subscription.

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

Examples

List Network Security Perimeters

az network perimeter list -g MyResourceGroup

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.

--resource-group -g

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

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

Gets the specified network security perimeter by the name.

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

Examples

Get the Network Security Perimeter

az network perimeter show -g MyResourceGroup -n MyPerimeter

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

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.