az mobile-network attached-data-network
Note
This reference is part of the mobile-network extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az mobile-network attached-data-network command. Learn more about extensions.
Manage attached data net work.
Commands
Name | Description | Type | Status |
---|---|---|---|
az mobile-network attached-data-network create |
Create an attached data network. |
Extension | GA |
az mobile-network attached-data-network delete |
Delete the specified attached data network. |
Extension | GA |
az mobile-network attached-data-network list |
List all the attached data networks associated with a packet core data plane. |
Extension | GA |
az mobile-network attached-data-network show |
Get information about the specified attached data network. |
Extension | GA |
az mobile-network attached-data-network update |
Update an attached data network. |
Extension | GA |
az mobile-network attached-data-network wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az mobile-network attached-data-network create
Create an attached data network.
az mobile-network attached-data-network create --adn-name
--data-interface
--dns-addresses
--pccp-name
--pcdp-name
--resource-group
[--address-pool]
[--location]
[--napt-configuration]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--static-address-pool]
[--tags]
Examples
Create attached-data-network
az mobile-network attached-data-network create -n data-network-name -g rg --pccp-name pccp-name --pcdp-name pcdp-name --dns-addresses "[1.1.1.1]" --data-interface " {name:N2,ipv4Address:10.28.128.2,ipv4Subnet:10.28.128.0/24,ipv4Gateway:10.28.128.1}" --address-pool "[2.2.0.0/16]"
Required Parameters
The name of the attached data network.
The user plane interface on the data network. For 5G networks, this is the N6 interface. For 4G networks, this is the SGi interface. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The DNS servers to signal to UEs to use for this attached data network. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the packet core control plane.
The name of the packet core data plane.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will dynamically assign IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. You must define at least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix. If you define both, they must be of the same size. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
The network address and port translation (NAPT) configuration. If this is not specified, the attached data network will use a default NAPT configuration with NAPT enabled. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will assign static IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. The static IP address for a specific UE is set in StaticIPConfiguration on the corresponding SIM resource. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined, they must be of the same size. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Resource tags. 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 mobile-network attached-data-network delete
Delete the specified attached data network.
az mobile-network attached-data-network delete [--adn-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pccp-name]
[--pcdp-name]
[--resource-group]
[--subscription]
[--yes]
Examples
Delete attached-data-network
az mobile-network attached-data-network delete -n data-network-name --pccp-name pccp-name --pcdp-name pcdp-name -g rg -y
Optional Parameters
The name of the attached data network.
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.
Do not wait for the long-running operation to finish.
The name of the packet core control plane.
The name of the packet core data plane.
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 mobile-network attached-data-network list
List all the attached data networks associated with a packet core data plane.
az mobile-network attached-data-network list --pccp-name
--pcdp-name
--resource-group
[--max-items]
[--next-token]
Examples
List attached-data-network by resource group
az mobile-network attached-data-network list -g rg --pccp-name pccp-name --pcdp-name pcdp-name
Required Parameters
The name of the packet core control plane.
The name of the packet core data plane.
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.
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 mobile-network attached-data-network show
Get information about the specified attached data network.
az mobile-network attached-data-network show [--adn-name]
[--ids]
[--pccp-name]
[--pcdp-name]
[--resource-group]
[--subscription]
Examples
Show attached-data-network
az mobile-network attached-data-network show -n data-network-name --pccp-name pccp-name --pcdp-name pcdp-name -g rg
Optional Parameters
The name of the attached data network.
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 packet core control plane.
The name of the packet core data plane.
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 mobile-network attached-data-network update
Update an attached data network.
az mobile-network attached-data-network update [--add]
[--address-pool]
[--adn-name]
[--data-interface]
[--dns-addresses]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--napt-configuration]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pccp-name]
[--pcdp-name]
[--remove]
[--resource-group]
[--set]
[--static-address-pool]
[--subscription]
[--tags]
Examples
Update attached-data-network tags
az mobile-network attached-data-network update -n data_network-name -g rg --pccp-name pccp-name --pcdp-name pcdp-name --tags "{tag:test,tag2:test2}"
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>
.
The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will dynamically assign IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. You must define at least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix. If you define both, they must be of the same size. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the attached data network.
The user plane interface on the data network. For 5G networks, this is the N6 interface. For 4G networks, this is the SGi interface. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The DNS servers to signal to UEs to use for this attached data network. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 network address and port translation (NAPT) configuration. If this is not specified, the attached data network will use a default NAPT configuration with NAPT enabled. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
The name of the packet core control plane.
The name of the packet core data plane.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
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=<value>
.
The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will assign static IP addresses to UEs. The packet core instance assigns an IP address to a UE when the UE sets up a PDU session. The static IP address for a specific UE is set in StaticIPConfiguration on the corresponding SIM resource. At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined, they must be of the same size. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags. 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 mobile-network attached-data-network wait
Place the CLI in a waiting state until a condition is met.
az mobile-network attached-data-network wait [--adn-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--pccp-name]
[--pcdp-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
The name of the attached data network.
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 packet core control plane.
The name of the packet core data plane.
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.