Microsoft.MobileNetwork packetCoreControlPlanes/packetCoreDataPlanes 2023-06-01
Bicep resource definition
The packetCoreControlPlanes/packetCoreDataPlanes 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/packetCoreDataPlanes resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes@2023-06-01' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
userPlaneAccessInterface: {
ipv4Address: 'string'
ipv4Gateway: 'string'
ipv4Subnet: 'string'
name: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property values
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 device. | string |
Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Max length = Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: packetCoreControlPlanes |
| properties | Packet core data plane Properties. | PacketCoreDataPlanePropertiesFormat (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
PacketCoreDataPlanePropertiesFormat
| Name | Description | Value |
|---|---|---|
| userPlaneAccessInterface | 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. | InterfaceProperties (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Quickstart samples
The following quickstart samples deploy 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. |
ARM template resource definition
The packetCoreControlPlanes/packetCoreDataPlanes 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/packetCoreDataPlanes resource, add the following JSON to your template.
{
"type": "Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes",
"apiVersion": "2023-06-01",
"name": "string",
"location": "string",
"properties": {
"userPlaneAccessInterface": {
"ipv4Address": "string",
"ipv4Gateway": "string",
"ipv4Subnet": "string",
"name": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property values
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 device. | string |
Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-06-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Max length = Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ (required) |
| properties | Packet core data plane Properties. | PacketCoreDataPlanePropertiesFormat (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes' |
PacketCoreDataPlanePropertiesFormat
| Name | Description | Value |
|---|---|---|
| userPlaneAccessInterface | 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. | InterfaceProperties (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
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. |
Terraform (AzAPI provider) resource definition
The packetCoreControlPlanes/packetCoreDataPlanes 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/packetCoreDataPlanes resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes@2023-06-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
userPlaneAccessInterface = {
ipv4Address = "string"
ipv4Gateway = "string"
ipv4Subnet = "string"
name = "string"
}
}
})
}
Property values
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 device. | string |
Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Max length = Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: packetCoreControlPlanes |
| properties | Packet core data plane Properties. | PacketCoreDataPlanePropertiesFormat (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.MobileNetwork/packetCoreControlPlanes/packetCoreDataPlanes@2023-06-01" |
PacketCoreDataPlanePropertiesFormat
| Name | Description | Value |
|---|---|---|
| userPlaneAccessInterface | 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. | InterfaceProperties (required) |
TrackedResourceTags
| Name | Description | Value |
|---|