az network perimeter link
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 link command. Learn more about extensions.
Manage network security perimeter link.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| 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 link create
Create NSP link resource.
az network perimeter link create --link-name
--perimeter-name
--resource-group
[--auto-remote-nsp-id]
[--description]
[--local-inbound-profile]
[--remote-inbound-profile]Examples
Create NSP Link
az network perimeter link create --name link1 --perimeter-name nsp1 --resource-group rg1 --auto-remote-nsp-id <NspId> --local-inbound-profile "['*']" --remote-inbound-profile "['*']" 'Required Parameters
The name of the NSP link.
The name of the network security perimeter.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Perimeter ARM Id for the remote NSP with which the link gets created in Auto-approval mode. It should be used when the NSP admin have Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action permission on the remote NSP resource.
A message passed to the owner of the remote NSP link resource with this connection request. In case of Auto-approved flow, it is default to 'Auto Approved'. Restricted to 140 chars.
List of local Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. It's default value is ['']. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of remote Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. This property can only be updated in auto-approval mode. It's default value is ['']. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network perimeter link delete
Delete an NSP Link resource.
az network perimeter link delete [--ids]
[--link-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--perimeter-name]
[--resource-group]
[--subscription]
[--yes]Examples
Delete NSP link
az network perimeter link delete --name link1 --perimeter-name nsp1 --resource-group rg1Optional Parameters
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.
The name of the NSP link.
Do not wait for the long-running operation to finish.
The name of the network security perimeter.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network perimeter link list
List the NSP Link resources in the specified network security perimeter.
az network perimeter link list --perimeter-name
--resource-group
[--max-items]
[--next-token]
[--skip-token]
[--top]Examples
Lists NSP links in a parameter
az network perimeter link list --perimeter-name nsp1 --resource-group rg1Required Parameters
The name of the network security perimeter.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
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.
An optional query parameter which specifies the maximum number of records to be returned by the server.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network perimeter link show
Get the specified NSP link resource.
az network perimeter link show [--ids]
[--link-name]
[--perimeter-name]
[--resource-group]
[--subscription]Examples
Get NSP link
az network perimeter link list --perimeter-name nsp1 --resource-group rg1Optional Parameters
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.
The name of the NSP link.
The name of the network security perimeter.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network perimeter link update
Update NSP link resource.
az network perimeter link update [--add]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--link-name]
[--local-inbound-profile]
[--perimeter-name]
[--remote-inbound-profile]
[--remove]
[--resource-group]
[--set]
[--subscription]Examples
Update NSP Link
az network perimeter link update --name link1 --perimeter-name nsp1 --resource-group rg1 --local-inbound-profile "['*']"Optional Parameters
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>.
A message passed to the owner of the remote NSP link resource with this connection request. In case of Auto-approved flow, it is default to 'Auto Approved'. Restricted to 140 chars.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
The name of the NSP link.
List of local Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. It's default value is ['']. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the network security perimeter.
List of remote Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. This property can only be updated in auto-approval mode. It's default value is ['']. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network perimeter link wait
Place the CLI in a waiting state until a condition is met.
az network perimeter link wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--link-name]
[--perimeter-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
The name of the NSP link.
The name of the network security perimeter.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for