Microsoft.MobileNetwork packetCoreControlPlanes 2022-03-01-preview

Article
03/15/2024

Bicep resource definition

The packetCoreControlPlanes resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MobileNetwork/packetCoreControlPlanes resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.MobileNetwork/packetCoreControlPlanes@2022-03-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    controlPlaneAccessInterface: {
      ipv4Address: 'string'
      ipv4Gateway: 'string'
      ipv4Subnet: 'string'
      name: 'string'
    }
    coreNetworkTechnology: 'string'
    customLocation: {
      id: 'string'
    }
    mobileNetwork: {
      id: 'string'
    }
    version: 'string'
  }
}

Property values

packetCoreControlPlanes

Name	Description	Value
name	The resource name	string (required) Character limit: 1-64 Valid characters: Alphanumeric, underscores and hyphens. Start with alphanumeric.
location	The geo-location where the resource lives	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
properties	Packet core control plane Properties.	PacketCoreControlPlanePropertiesFormat (required)

PacketCoreControlPlanePropertiesFormat

Name	Description	Value
controlPlaneAccessInterface	The control plane interface on the access network. In 5G networks this is called as N2 interface whereas in 4G networks this is called as S1-MME interface.	InterfaceProperties (required)
coreNetworkTechnology	The core network technology generation.	'5GC' 'EPC'
customLocation	Azure ARC custom location where the packet core is deployed.	CustomLocationResourceId
mobileNetwork	Mobile network that this packet core control plane belongs to	MobileNetworkResourceId (required)
version	The version of the packet core software that is deployed.	string

InterfaceProperties

Name	Description	Value
ipv4Address	The IPv4 address.	string Constraints: 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])$`
ipv4Gateway	The default IPv4 gateway (router).	string Constraints: 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])$`
ipv4Subnet	The IPv4 subnet.	string Constraints: 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]))$`
name	The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine.	string (required)

CustomLocationResourceId

Name	Description	Value
id	Azure ARC custom location resource ID.	string (required) Constraints: Pattern = `^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\.[eE][xX][tT][eE][nN][dD][eE][dD][lL][oO][cC][aA][tT][iI][oO][nN]/[cC][uU][sS][tT][oO][mM][lL][oO][cC][aA][tT][iI][oO][nN][sS]/[^/?#]+$`

MobileNetworkResourceId

Name	Description	Value
id	Mobile Network resource ID.	string (required) Constraints: Pattern = `^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\.[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK]/[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+$`

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a full 5G Core deployment	This template creates all resources required to deploy a Private 5G Core, including provisioning sims and creating sample QoS policy. It can optionally be deployed to a Kubernetes cluster running on an Azure Stack Edge device.
Create a new mobile network site	This template creates a new site with associated 5G packet core resources. It can optionally be deployed to a Kubernetes cluster running on an Azure Stack Edge device.
Update a packet core control plane	This template allows you to update the version of an existing packet core.

ARM template resource definition

The packetCoreControlPlanes resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MobileNetwork/packetCoreControlPlanes resource, add the following JSON to your template.

{
  "type": "Microsoft.MobileNetwork/packetCoreControlPlanes",
  "apiVersion": "2022-03-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "controlPlaneAccessInterface": {
      "ipv4Address": "string",
      "ipv4Gateway": "string",
      "ipv4Subnet": "string",
      "name": "string"
    },
    "coreNetworkTechnology": "string",
    "customLocation": {
      "id": "string"
    },
    "mobileNetwork": {
      "id": "string"
    },
    "version": "string"
  }
}

Property values

packetCoreControlPlanes

Name	Description	Value
type	The resource type	'Microsoft.MobileNetwork/packetCoreControlPlanes'
apiVersion	The resource api version	'2022-03-01-preview'
name	The resource name	string (required) Character limit: 1-64 Valid characters: Alphanumeric, underscores and hyphens. Start with alphanumeric.
location	The geo-location where the resource lives	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
properties	Packet core control plane Properties.	PacketCoreControlPlanePropertiesFormat (required)

PacketCoreControlPlanePropertiesFormat

Name	Description	Value
controlPlaneAccessInterface	The control plane interface on the access network. In 5G networks this is called as N2 interface whereas in 4G networks this is called as S1-MME interface.	InterfaceProperties (required)
coreNetworkTechnology	The core network technology generation.	'5GC' 'EPC'
customLocation	Azure ARC custom location where the packet core is deployed.	CustomLocationResourceId
mobileNetwork	Mobile network that this packet core control plane belongs to	MobileNetworkResourceId (required)
version	The version of the packet core software that is deployed.	string

InterfaceProperties

Name	Description	Value
ipv4Address	The IPv4 address.	string Constraints: 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])$`
ipv4Gateway	The default IPv4 gateway (router).	string Constraints: 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])$`
ipv4Subnet	The IPv4 subnet.	string Constraints: 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]))$`
name	The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine.	string (required)

CustomLocationResourceId

Name	Description	Value
id	Azure ARC custom location resource ID.	string (required) Constraints: Pattern = `^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\.[eE][xX][tT][eE][nN][dD][eE][dD][lL][oO][cC][aA][tT][iI][oO][nN]/[cC][uU][sS][tT][oO][mM][lL][oO][cC][aA][tT][iI][oO][nN][sS]/[^/?#]+$`

MobileNetworkResourceId

Name	Description	Value
id	Mobile Network resource ID.	string (required) Constraints: Pattern = `^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\.[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK]/[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+$`

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a full 5G Core deployment	This template creates all resources required to deploy a Private 5G Core, including provisioning sims and creating sample QoS policy. It can optionally be deployed to a Kubernetes cluster running on an Azure Stack Edge device.
Create a new mobile network site	This template creates a new site with associated 5G packet core resources. It can optionally be deployed to a Kubernetes cluster running on an Azure Stack Edge device.
Update a packet core control plane	This template allows you to update the version of an existing packet core.

Terraform (AzAPI provider) resource definition

The packetCoreControlPlanes resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MobileNetwork/packetCoreControlPlanes resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MobileNetwork/packetCoreControlPlanes@2022-03-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      controlPlaneAccessInterface = {
        ipv4Address = "string"
        ipv4Gateway = "string"
        ipv4Subnet = "string"
        name = "string"
      }
      coreNetworkTechnology = "string"
      customLocation = {
        id = "string"
      }
      mobileNetwork = {
        id = "string"
      }
      version = "string"
    }
  })
}

Property values

packetCoreControlPlanes

Name	Description	Value
type	The resource type	"Microsoft.MobileNetwork/packetCoreControlPlanes@2022-03-01-preview"
name	The resource name	string (required) Character limit: 1-64 Valid characters: Alphanumeric, underscores and hyphens. Start with alphanumeric.
location	The geo-location where the resource lives	string (required)
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags.	Dictionary of tag names and values.
properties	Packet core control plane Properties.	PacketCoreControlPlanePropertiesFormat (required)

PacketCoreControlPlanePropertiesFormat

Name	Description	Value
controlPlaneAccessInterface	The control plane interface on the access network. In 5G networks this is called as N2 interface whereas in 4G networks this is called as S1-MME interface.	InterfaceProperties (required)
coreNetworkTechnology	The core network technology generation.	"5GC" "EPC"
customLocation	Azure ARC custom location where the packet core is deployed.	CustomLocationResourceId
mobileNetwork	Mobile network that this packet core control plane belongs to	MobileNetworkResourceId (required)
version	The version of the packet core software that is deployed.	string

InterfaceProperties

Name	Description	Value
ipv4Address	The IPv4 address.	string Constraints: 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])$`
ipv4Gateway	The default IPv4 gateway (router).	string Constraints: 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])$`
ipv4Subnet	The IPv4 subnet.	string Constraints: 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]))$`
name	The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine.	string (required)

CustomLocationResourceId

Name	Description	Value
id	Azure ARC custom location resource ID.	string (required) Constraints: Pattern = `^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\.[eE][xX][tT][eE][nN][dD][eE][dD][lL][oO][cC][aA][tT][iI][oO][nN]/[cC][uU][sS][tT][oO][mM][lL][oO][cC][aA][tT][iI][oO][nN][sS]/[^/?#]+$`

MobileNetworkResourceId

Name	Description	Value
id	Mobile Network resource ID.	string (required) Constraints: Pattern = `^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\.[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK]/[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+$`

Share via

Microsoft.MobileNetwork packetCoreControlPlanes 2022-03-01-preview

Bicep resource definition

Resource format

Property values

packetCoreControlPlanes

PacketCoreControlPlanePropertiesFormat

InterfaceProperties

CustomLocationResourceId

MobileNetworkResourceId

Quickstart templates

ARM template resource definition

Resource format

Property values

packetCoreControlPlanes

PacketCoreControlPlanePropertiesFormat

InterfaceProperties

CustomLocationResourceId

MobileNetworkResourceId

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

packetCoreControlPlanes

PacketCoreControlPlanePropertiesFormat

InterfaceProperties

CustomLocationResourceId

MobileNetworkResourceId

Feedback

Additional resources