az mobile-network pcdp

  • Reference

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

Manage packet core data plane.

Commands

Name Description Type Status
az mobile-network pcdp create

Create a packet core data plane.

 Extension GA
az mobile-network pcdp delete

Delete the specified packet core data plane.

 Extension GA
az mobile-network pcdp list

List all the packet core data planes associated with a packet core control plane.

 Extension GA
az mobile-network pcdp show

Get information about the specified packet core data plane.

 Extension GA
az mobile-network pcdp update

Update packet core data planes tags.

 Extension GA
az mobile-network pcdp wait

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

 Extension GA

az mobile-network pcdp create

Create a packet core data plane.

az mobile-network pcdp create --access-interface
                              --name
                              --pccp-name
                              --resource-group
                              [--location]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--tags]

Examples

Create Packet Core Data Plane

az mobile-network pcdp create -n pcdp-name -g rg --pccp-name pccp-name --access-interface "{name:N2,ipv4Address:10.28.128.2,ipv4Subnet:10.28.128.0/24,ipv4Gateway:10.28.128.1}"

Required Parameters

--access-interface

The user plane interface on the access network. For 5G networks, this is the N3 interface. For 4G networks, this is the S1-U interface. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name --pcdp-name -n

The name of the packet core data plane.

--pccp-name

The name of the packet core control plane.

--resource-group -g

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

Optional Parameters

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 mobile-network pcdp delete

Delete the specified packet core data plane.

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

Examples

Delete Packet Core Data Plane

az mobile-network pcdp delete -g rg -n pcdp-name --pccp-name pccp-name -y

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

The name of the packet core data plane.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pccp-name

The name of the packet core control plane.

--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 mobile-network pcdp list

List all the packet core data planes associated with a packet core control plane.

az mobile-network pcdp list --pccp-name
                            --resource-group
                            [--max-items]
                            [--next-token]

Examples

List Packet Core Data Plane by resource group

az mobile-network pcdp list -g rg --pccp-name pccp_name

Required Parameters

--pccp-name

The name of the packet core control plane.

--resource-group -g

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

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.

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 mobile-network pcdp show

Get information about the specified packet core data plane.

az mobile-network pcdp show [--ids]
                            [--name]
                            [--pccp-name]
                            [--resource-group]
                            [--subscription]

Examples

Show Packet Core Data Plane

az mobile-network pcdp show -g rg -n pcdp-name --pccp-name pccp-name

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

The name of the packet core data plane.

--pccp-name

The name of the packet core control plane.

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

az mobile-network pcdp update

Update packet core data planes tags.

az mobile-network pcdp update [--ids]
                              [--name]
                              [--pccp-name]
                              [--resource-group]
                              [--subscription]
                              [--tags]

Examples

Update Packet Core Data Plane

az mobile-network pcdp update -n pcdp_name -g rg --pccp-name pccp-name --tags "{tag:test,tag2:test2}"

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

The name of the packet core data plane.

--pccp-name

The name of the packet core control plane.

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

--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 mobile-network pcdp wait

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

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

Optional Parameters

--created

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

default value: False
--custom

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

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

default value: 30
--name --pcdp-name -n

The name of the packet core data plane.

--pccp-name

The name of the packet core control plane.

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.