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 associable-resource-type	Manage Network Security Perimeter Associable Resource Types.	Extension	GA
az network perimeter associable-resource-type list	List all network security perimeter associable resource types.	Extension	GA
az network perimeter association	Manage Network Security Perimeter Associations.	Extension	GA
az network perimeter association create	Create a network security perimeter association.	Extension	GA
az network perimeter association delete	Delete a network security perimeter association.	Extension	GA
az network perimeter association list	List all network security perimeter associations.	Extension	GA
az network perimeter association show	Get a network security perimeter association.	Extension	GA
az network perimeter association update	Create or update a network security perimeter 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	Create a network security perimeter.	Extension	GA
az network perimeter delete	Delete a network security perimeter.	Extension	GA
az network perimeter link	Manage Network Security Perimeter Links.	Extension	GA
az network perimeter link-reference	Manage Network Security Perimeter Link References.	Extension	GA
az network perimeter link-reference delete	Delete a network security perimeter link reference.	Extension	GA
az network perimeter link-reference list	List all network security perimeter link references.	Extension	GA
az network perimeter link-reference show	Get a network security perimeter link reference.	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 a network security perimeter link.	Extension	GA
az network perimeter link delete	Delete a network security perimeter link.	Extension	GA
az network perimeter link list	List all network security perimeter links.	Extension	GA
az network perimeter link show	Get a network security perimeter link.	Extension	GA
az network perimeter link update	Create or update a network security perimeter link.	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.	Extension	GA
az network perimeter logging-configuration	Manage Network Security Perimeter Logging Configurations.	Extension	GA
az network perimeter logging-configuration create	Create a network security perimeter logging configuration.	Extension	GA
az network perimeter logging-configuration delete	Delete a network security perimeter logging configuration.	Extension	GA
az network perimeter logging-configuration list	List all network security perimeter logging configurations.	Extension	GA
az network perimeter logging-configuration show	Get a network security perimeter logging configuration.	Extension	GA
az network perimeter logging-configuration update	Cerate or update a network security perimeter logging configuration.	Extension	GA
az network perimeter profile	Manage Network Security Perimeter Profiles.	Extension	GA
az network perimeter profile access-rule	Manage Network Security Perimeter Profile Access Rules.	Extension	GA
az network perimeter profile access-rule create	Create a network security perimeter profile access rule.	Extension	GA
az network perimeter profile access-rule delete	Delete a network security perimeter profile access rule.	Extension	GA
az network perimeter profile access-rule list	List all network security perimeter profile access rules.	Extension	GA
az network perimeter profile access-rule show	Get a network security perimeter profile access rule.	Extension	GA
az network perimeter profile access-rule update	Create or update a network security perimeter profile access rule.	Extension	GA
az network perimeter profile create	Create a network security perimeter profile.	Extension	GA
az network perimeter profile delete	Delete a network security perimeter profile.	Extension	GA
az network perimeter profile list	List all network security perimeter profiles.	Extension	GA
az network perimeter profile show	Get a network security perimeter profile.	Extension	GA
az network perimeter show	Get a network security perimeter.	Extension	GA
az network perimeter wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az network perimeter create

Create a network security perimeter.

az network perimeter create --name --perimeter-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

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

--location -l

The location in which NSP is created. When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Parameters Arguments

--tags

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

Property	Value
Parameter group:	Parameters 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 network perimeter delete

Delete a network security perimeter.

az network perimeter delete [--force-deletion {0, 1, f, false, n, no, t, true, y, yes}]
                            [--ids]
                            [--name --perimeter-name]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--resource-group]
                            [--subscription]
                            [--yes]

Examples

Delete a network security perimeter

az network perimeter delete -g MyResourceGroup -n MyPerimeter

Optional Parameters

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

--force-deletion

Deletes the resource even if it contains any child associations.

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

--name --perimeter-name -n

The name of the network security perimeter.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

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

List all network security perimeters.

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

Examples

List all a network security perimeters

az network perimeter list -g MyResourceGroup

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

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

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

Get a network security perimeter.

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

Examples

Get a network security perimeter

az network perimeter show -g MyResourceGroup -n MyPerimeter

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

The name of the network security perimeter.

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 network perimeter wait

Place the CLI in a waiting state until a condition is met.

az network perimeter wait [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--ids]
                          [--interval]
                          [--name --perimeter-name]
                          [--resource-group]
                          [--subscription]
                          [--timeout]
                          [--updated]

Optional Parameters

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --perimeter-name -n

The name of the network security perimeter.

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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