az network perimeter association

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

Manage Network Security Perimeter Associations.

Commands

Name	Description	Type	Status
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 association create

Create a network security perimeter association.

az network perimeter association create --association-name --name
                                        --perimeter-name
                                        --resource-group
                                        [--access-mode {Audit, Enforced, Learning}]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--private-link-resource]
                                        [--profile]

Examples

Create a network security perimeter association

az network perimeter association create -n MyAssociation --perimeter-name MyPerimeter -g MyResourceGroup --access-mode Learning --private-link-resource "{id:<PaaSArmID>}" --profile "{id:<ProfileArmID>}"

Required Parameters

--association-name --name -n

The name of the NSP association.

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

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

--access-mode

Access mode on the association.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Audit, Enforced, Learning

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

--private-link-resource

The PaaS resource to be associated. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--profile

Profile id to which the PaaS resource is associated. 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 network perimeter association delete

Delete a network security perimeter association.

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

Examples

Delete a network security perimeter association

az network perimeter association delete -n MyAssociation --perimeter-name MyPerimeter -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.

--association-name --name -n

The name of the NSP association.

Property	Value
Parameter group:	Resource Id Arguments

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

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

--perimeter-name

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

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

List all network security perimeter associations.

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

Examples

List all network security perimeter associations

az network perimeter association 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

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

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

Get a network security perimeter association.

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

Examples

Get a network security perimeter association

az network perimeter association show -n MyAssociation --perimeter-name MyPerimeter -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.

--association-name --name -n

The name of the NSP association.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--perimeter-name

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

Create or update a network security perimeter association.

az network perimeter association update [--access-mode {Audit, Enforced, Learning}]
                                        [--add]
                                        [--association-name --name]
                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--ids]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--perimeter-name]
                                        [--private-link-resource]
                                        [--profile]
                                        [--remove]
                                        [--resource-group]
                                        [--set]
                                        [--subscription]

Examples

Update a network security perimeter association

az network perimeter association update --name MyAssociation --perimeter-name MyPerimeter --resource-group MyResourceGroup --access-mode Enforced --private-link-resource id="<PaaSArmID> --profile id="ProfileArmID"

Optional Parameters

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

--access-mode

Access mode on the association.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Audit, Enforced, Learning

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

--association-name --name -n

The name of the NSP association.

Property	Value
Parameter group:	Resource Id Arguments

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

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

--perimeter-name

The name of the network security perimeter.

Property	Value
Parameter group:	Resource Id Arguments

--private-link-resource

The PaaS resource to be associated. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--profile

Profile id to which the PaaS resource is associated. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

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

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

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

az network perimeter association wait [--association-name --name]
                                      [--created]
                                      [--custom]
                                      [--deleted]
                                      [--exists]
                                      [--ids]
                                      [--interval]
                                      [--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.

--association-name --name -n

The name of the NSP association.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

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

--perimeter-name

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

Jaa

az network perimeter association

Commands

az network perimeter association create

Examples

Required Parameters

Optional Parameters

az network perimeter association delete

Examples

Optional Parameters

az network perimeter association list

Examples

Required Parameters

Optional Parameters

az network perimeter association show

Examples

Optional Parameters

az network perimeter association update

Examples

Optional Parameters

az network perimeter association wait

Optional Parameters

Palaute