Attached Data Networks - List By Packet Core Data Plane

Service:: Mobile Network

API Version:: 2024-04-01

Gets all the attached data networks associated with a packet core data plane.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes/{packetCoreDataPlaneName}/attachedDataNetworks?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
packetCoreControlPlaneName	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	The name of the packet core control plane.
packetCoreDataPlaneName	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	The name of the packet core data plane.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	AttachedDataNetworkListResult	Request successful. The operation returns a list of attached data network resources.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List attached data networks in a data plane

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks?api-version=2024-04-01


/**
 * Samples for AttachedDataNetworks ListByPacketCoreDataPlane.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/stable/2024-04-01/examples/
     * AttachedDataNetworkListByPacketCoreDataPlane.json
     */
    /**
     * Sample code: List attached data networks in a data plane.
     * 
     * @param manager Entry point to MobileNetworkManager.
     */
    public static void
        listAttachedDataNetworksInADataPlane(com.azure.resourcemanager.mobilenetwork.MobileNetworkManager manager) {
        manager.attachedDataNetworks().listByPacketCoreDataPlane("rg1", "TestPacketCoreCP", "TestPacketCoreDP",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.mobilenetwork import MobileNetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mobilenetwork
# USAGE
    python attached_data_network_list_by_packet_core_data_plane.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MobileNetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.attached_data_networks.list_by_packet_core_data_plane(
        resource_group_name="rg1",
        packet_core_control_plane_name="TestPacketCoreCP",
        packet_core_data_plane_name="TestPacketCoreDP",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/stable/2024-04-01/examples/AttachedDataNetworkListByPacketCoreDataPlane.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armmobilenetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d88c94b22a8efdd47c0cadfe6d8d489107db2b23/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/stable/2024-04-01/examples/AttachedDataNetworkListByPacketCoreDataPlane.json
func ExampleAttachedDataNetworksClient_NewListByPacketCoreDataPlanePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmobilenetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAttachedDataNetworksClient().NewListByPacketCoreDataPlanePager("rg1", "TestPacketCoreCP", "TestPacketCoreDP", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AttachedDataNetworkListResult = armmobilenetwork.AttachedDataNetworkListResult{
		// 	Value: []*armmobilenetwork.AttachedDataNetwork{
		// 		{
		// 			Name: to.Ptr("TestAttachedDataNetwork"),
		// 			Type: to.Ptr("Microsoft.MobileNetwork/attachedDataNetworks"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork"),
		// 			SystemData: &armmobilenetwork.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
		// 				CreatedBy: to.Ptr("user1"),
		// 				CreatedByType: to.Ptr(armmobilenetwork.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("user2"),
		// 				LastModifiedByType: to.Ptr(armmobilenetwork.CreatedByTypeUser),
		// 			},
		// 			Location: to.Ptr("eastus"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armmobilenetwork.AttachedDataNetworkPropertiesFormat{
		// 				DNSAddresses: []*string{
		// 					to.Ptr("1.1.1.1")},
		// 					NaptConfiguration: &armmobilenetwork.NaptConfiguration{
		// 						Enabled: to.Ptr(armmobilenetwork.NaptEnabledEnabled),
		// 						PinholeLimits: to.Ptr[int32](65536),
		// 						PinholeTimeouts: &armmobilenetwork.PinholeTimeouts{
		// 							Icmp: to.Ptr[int32](30),
		// 							TCP: to.Ptr[int32](180),
		// 							UDP: to.Ptr[int32](30),
		// 						},
		// 						PortRange: &armmobilenetwork.PortRange{
		// 							MaxPort: to.Ptr[int32](49999),
		// 							MinPort: to.Ptr[int32](1024),
		// 						},
		// 						PortReuseHoldTime: &armmobilenetwork.PortReuseHoldTimes{
		// 							TCP: to.Ptr[int32](120),
		// 							UDP: to.Ptr[int32](60),
		// 						},
		// 					},
		// 					ProvisioningState: to.Ptr(armmobilenetwork.ProvisioningStateSucceeded),
		// 					UserEquipmentAddressPoolPrefix: []*string{
		// 						to.Ptr("2.2.0.0/16")},
		// 						UserEquipmentStaticAddressPoolPrefix: []*string{
		// 							to.Ptr("2.4.0.0/16")},
		// 							UserPlaneDataInterface: &armmobilenetwork.InterfaceProperties{
		// 								Name: to.Ptr("N6"),
		// 							},
		// 						},
		// 				}},
		// 			}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { MobileNetworkManagementClient } = require("@azure/arm-mobilenetwork");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets all the attached data networks associated with a packet core data plane.
 *
 * @summary Gets all the attached data networks associated with a packet core data plane.
 * x-ms-original-file: specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/stable/2024-04-01/examples/AttachedDataNetworkListByPacketCoreDataPlane.json
 */
async function listAttachedDataNetworksInADataPlane() {
  const subscriptionId =
    process.env["MOBILENETWORK_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["MOBILENETWORK_RESOURCE_GROUP"] || "rg1";
  const packetCoreControlPlaneName = "TestPacketCoreCP";
  const packetCoreDataPlaneName = "TestPacketCoreDP";
  const credential = new DefaultAzureCredential();
  const client = new MobileNetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.attachedDataNetworks.listByPacketCoreDataPlane(
    resourceGroupName,
    packetCoreControlPlaneName,
    packetCoreDataPlaneName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "name": "TestAttachedDataNetwork",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork",
      "type": "Microsoft.MobileNetwork/attachedDataNetworks",
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "location": "eastus",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "userPlaneDataInterface": {
          "name": "N6"
        },
        "dnsAddresses": [
          "1.1.1.1"
        ],
        "naptConfiguration": {
          "enabled": "Enabled",
          "portRange": {
            "minPort": 1024,
            "maxPort": 49999
          },
          "portReuseHoldTime": {
            "tcp": 120,
            "udp": 60
          },
          "pinholeLimits": 65536,
          "pinholeTimeouts": {
            "tcp": 180,
            "udp": 30,
            "icmp": 30
          }
        },
        "userEquipmentAddressPoolPrefix": [
          "2.2.0.0/16"
        ],
        "userEquipmentStaticAddressPoolPrefix": [
          "2.4.0.0/16"
        ]
      }
    }
  ]
}

Definitions

Name	Description
AttachedDataNetwork	Attached data network resource. Must be created in the same location as its parent packet core data plane.
AttachedDataNetworkListResult	Response for attached data network API service call.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
InterfaceProperties	Interface properties
NaptConfiguration	The network address and port translation settings to use for the attached data network.
NaptEnabled	Whether network address and port translation is enabled.
PinholeTimeouts	Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second.
PortRange	Range of port numbers to use as translated ports on each translated address. If not specified and NAPT is enabled, this range defaults to 1,024 - 49,999. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA. Ports 50,000 and above are reserved for non-NAPT use.)
PortReuseHoldTimes	The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second.
ProvisioningState	The current provisioning state.
systemData	Metadata pertaining to creation and last modification of the resource.

AttachedDataNetwork

Object

Attached data network resource. Must be created in the same location as its parent packet core data plane.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.dnsAddresses	string[] pattern: ^(([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])\.){3}([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])$	The DNS servers to signal to UEs to use for this attached data network. This configuration is mandatory - if you don't want DNS servers, you must provide an empty array.
properties.naptConfiguration	NaptConfiguration	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.
properties.provisioningState	ProvisioningState	The provisioning state of the attached data network resource.
properties.userEquipmentAddressPoolPrefix	string[] pattern: ^(([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])\.){3}([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])(\/([0-9]\|[1-2][0-9]\|3[0-2]))$	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.
properties.userEquipmentStaticAddressPoolPrefix	string[] pattern: ^(([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])\.){3}([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])(\/([0-9]\|[1-2][0-9]\|3[0-2]))$	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.
properties.userPlaneDataInterface	InterfaceProperties	The user plane interface on the data network. For 5G networks, this is the N6 interface. For 4G networks, this is the SGi interface.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

AttachedDataNetworkListResult

Object

Response for attached data network API service call.

Name	Type	Description
nextLink	string	The URL to get the next set of results.
value	AttachedDataNetwork[]	A list of data networks in a resource group.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

InterfaceProperties

Object

Interface properties

Name	Type	Description
bfdIpv4Endpoints	string[] pattern: ^(([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])\.){3}([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])$	The IPv4 addresses of the endpoints to send BFD probes to.
ipv4Address	string pattern: ^(([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])\.){3}([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])$	The IPv4 address.
ipv4AddressList	string[] pattern: ^(([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])\.){3}([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])$	The list of IPv4 addresses, for a multi-node system.
ipv4Gateway	string pattern: ^(([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])\.){3}([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])$	The default IPv4 gateway (router).
ipv4Subnet	string pattern: ^(([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])\.){3}([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])(\/([0-9]\|[1-2][0-9]\|3[0-2]))$	The IPv4 subnet.
name	string	The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge device.
vlanId	integer (int32) minimum: 1 maximum: 4094	VLAN identifier of the network interface. Example: 501.

NaptConfiguration

Object

The network address and port translation settings to use for the attached data network.

Name	Type	Default value	Description
enabled	NaptEnabled	Enabled	Whether NAPT is enabled for connections to this attached data network.
pinholeLimits	integer (int32) minimum: 1 maximum: 65536	65536	Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. For 5G networks, this is the N6 interface. For 4G networks, this is the SGi interface.
pinholeTimeouts	PinholeTimeouts		Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second.
portRange	PortRange		Range of port numbers to use as translated ports on each translated address. If not specified and NAPT is enabled, this range defaults to 1,024 - 49,999. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA. Ports 50,000 and above are reserved for non-NAPT use.)
portReuseHoldTime	PortReuseHoldTimes		The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be at least 1 second.

NaptEnabled

Enumeration

Whether network address and port translation is enabled.

Value	Description
Enabled	NAPT is enabled
Disabled	NAPT is disabled

PinholeTimeouts

Object

Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second.

Name	Type	Default value	Description
icmp	integer (int32) minimum: 1	30	Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 30 seconds.
tcp	integer (int32) minimum: 1	180	Pinhole timeout for TCP pinholes in seconds. Default for TCP is 3 minutes.
udp	integer (int32) minimum: 1	30	Pinhole timeout for UDP pinholes in seconds. Default for UDP is 30 seconds.

PortRange

Object

Range of port numbers to use as translated ports on each translated address. If not specified and NAPT is enabled, this range defaults to 1,024 - 49,999. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA. Ports 50,000 and above are reserved for non-NAPT use.)

Name	Type	Default value	Description
maxPort	integer (int32) minimum: 1024 maximum: 65535	49999	The maximum port number
minPort	integer (int32) minimum: 1024 maximum: 65535	1024	The minimum port number

PortReuseHoldTimes

Object

The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second.

Name	Type	Default value	Description
tcp	integer (int32) minimum: 1	120	Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. Default for TCP is 2 minutes.
udp	integer (int32) minimum: 1	60	Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. Default for UDP is 1 minute.

ProvisioningState

Enumeration

The current provisioning state.

Value	Description
Unknown
Succeeded
Accepted
Deleting
Failed
Canceled
Deleted

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Attached Data Networks - List By Packet Core Data Plane

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List attached data networks in a data plane

Sample request

Sample response

Definitions

AttachedDataNetwork

AttachedDataNetworkListResult

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InterfaceProperties

NaptConfiguration

NaptEnabled

PinholeTimeouts

PortRange

PortReuseHoldTimes

ProvisioningState

systemData