Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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' = {
location: 'string'
name: 'string'
properties: {
controlPlaneAccessInterface: {
ipv4Address: 'string'
ipv4Gateway: 'string'
ipv4Subnet: 'string'
name: 'string'
}
coreNetworkTechnology: 'string'
customLocation: {
id: 'string'
}
mobileNetwork: {
id: 'string'
}
version: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.MobileNetwork/packetCoreControlPlanes
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Max length = 64 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ (required) |
| properties | Packet core control plane Properties. | PacketCoreControlPlanePropertiesFormat (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
CustomLocationResourceId
| Name | Description | Value |
|---|---|---|
| id | Azure ARC custom location resource ID. | string 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]/[^/?#]+$ (required) |
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) |
MobileNetworkResourceId
| Name | Description | Value |
|---|---|---|
| id | Mobile Network resource ID. | string 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]/[^/?#]+$ (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 |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | 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",
"properties": {
"controlPlaneAccessInterface": {
"ipv4Address": "string",
"ipv4Gateway": "string",
"ipv4Subnet": "string",
"name": "string"
},
"coreNetworkTechnology": "string",
"customLocation": {
"id": "string"
},
"mobileNetwork": {
"id": "string"
},
"version": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.MobileNetwork/packetCoreControlPlanes
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-03-01-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Max length = 64 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ (required) |
| properties | Packet core control plane Properties. | PacketCoreControlPlanePropertiesFormat (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.MobileNetwork/packetCoreControlPlanes' |
CustomLocationResourceId
| Name | Description | Value |
|---|---|---|
| id | Azure ARC custom location resource ID. | string 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]/[^/?#]+$ (required) |
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) |
MobileNetworkResourceId
| Name | Description | Value |
|---|---|---|
| id | Mobile Network resource ID. | string 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]/[^/?#]+$ (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 |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure 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"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
controlPlaneAccessInterface = {
ipv4Address = "string"
ipv4Gateway = "string"
ipv4Subnet = "string"
name = "string"
}
coreNetworkTechnology = "string"
customLocation = {
id = "string"
}
mobileNetwork = {
id = "string"
}
version = "string"
}
}
}
Property Values
Microsoft.MobileNetwork/packetCoreControlPlanes
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Max length = 64 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ (required) |
| properties | Packet core control plane Properties. | PacketCoreControlPlanePropertiesFormat (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.MobileNetwork/packetCoreControlPlanes@2022-03-01-preview" |
CustomLocationResourceId
| Name | Description | Value |
|---|---|---|
| id | Azure ARC custom location resource ID. | string 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]/[^/?#]+$ (required) |
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) |
MobileNetworkResourceId
| Name | Description | Value |
|---|---|---|
| id | Mobile Network resource ID. | string 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]/[^/?#]+$ (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 |
TrackedResourceTags
| Name | Description | Value |
|---|