Microsoft.MobileNetwork mobileNetworks 2024-02-01

Article
12/09/2024

Bicep resource definition

The mobileNetworks 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/mobileNetworks resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.MobileNetwork/mobileNetworks@2024-02-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    publicLandMobileNetworkIdentifier: {
      mcc: 'string'
      mnc: 'string'
    }
    publicLandMobileNetworks: [
      {
        homeNetworkPublicKeys: {
          profileA: [
            {
              id: int
              url: 'string'
            }
          ]
          profileB: [
            {
              id: int
              url: 'string'
            }
          ]
        }
        mcc: 'string'
        mnc: 'string'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

HomeNetworkPublicKey

Name	Description	Value
id	The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5.	int Constraints: Min value = 1 Max value = 255 (required)
url	The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78.	string

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (currently only UserAssigned allowed).	'None' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

Microsoft.MobileNetwork/mobileNetworks

Name	Description	Value
identity	The identity used to retrieve any private keys used for SUPI concealment from Azure key vault.	ManagedServiceIdentity
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	Mobile network properties.	MobileNetworkPropertiesFormat (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

MobileNetworkPropertiesFormat

Name	Description	Value
publicLandMobileNetworkIdentifier	The unique public land mobile network identifier for the network. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence.	PlmnId (required)
publicLandMobileNetworks	A list of public land mobile networks including their identifiers. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence.	PublicLandMobileNetwork[]

PlmnId

Name	Description	Value
mcc	Mobile country code (MCC).	string Constraints: Pattern = `^\d{3}$` (required)
mnc	Mobile network code (MNC).	string Constraints: Pattern = `^\d{2,3}$` (required)

PublicLandMobileNetwork

Name	Description	Value
homeNetworkPublicKeys	Configuration relating to SUPI concealment.	PublicLandMobileNetworkHomeNetworkPublicKeys
mcc	Mobile country code (MCC).	string Constraints: Pattern = `^\d{3}$` (required)
mnc	Mobile network code (MNC).	string Constraints: Pattern = `^\d{2,3}$` (required)

PublicLandMobileNetworkHomeNetworkPublicKeys

Name	Description	Value
profileA	This provides a mapping to identify which public key has been used for SUPI concealment using the Profile A Protection Scheme.	HomeNetworkPublicKey[]
profileB	This provides a mapping to identify which public key has been used for SUPI concealment using the Profile B Protection Scheme.	HomeNetworkPublicKey[]

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

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 private mobile network	This template creates a mobile network resource with an associated slice and data network. You can then use other templates in this repository to create sites for running the Private 5G Core software and provision sims and sim policies..
Update a packet core control plane	This template allows you to update the version of an existing packet core.

ARM template resource definition

The mobileNetworks 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/mobileNetworks resource, add the following JSON to your template.

{
  "type": "Microsoft.MobileNetwork/mobileNetworks",
  "apiVersion": "2024-02-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "publicLandMobileNetworkIdentifier": {
      "mcc": "string",
      "mnc": "string"
    },
    "publicLandMobileNetworks": [
      {
        "homeNetworkPublicKeys": {
          "profileA": [
            {
              "id": "int",
              "url": "string"
            }
          ],
          "profileB": [
            {
              "id": "int",
              "url": "string"
            }
          ]
        },
        "mcc": "string",
        "mnc": "string"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

HomeNetworkPublicKey

Name	Description	Value
id	The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5.	int Constraints: Min value = 1 Max value = 255 (required)
url	The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78.	string

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (currently only UserAssigned allowed).	'None' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

Microsoft.MobileNetwork/mobileNetworks

Name	Description	Value
apiVersion	The api version	'2024-02-01'
identity	The identity used to retrieve any private keys used for SUPI concealment from Azure key vault.	ManagedServiceIdentity
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	Mobile network properties.	MobileNetworkPropertiesFormat (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.MobileNetwork/mobileNetworks'

MobileNetworkPropertiesFormat

Name	Description	Value
publicLandMobileNetworkIdentifier	The unique public land mobile network identifier for the network. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence.	PlmnId (required)
publicLandMobileNetworks	A list of public land mobile networks including their identifiers. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence.	PublicLandMobileNetwork[]

PlmnId

Name	Description	Value
mcc	Mobile country code (MCC).	string Constraints: Pattern = `^\d{3}$` (required)
mnc	Mobile network code (MNC).	string Constraints: Pattern = `^\d{2,3}$` (required)

PublicLandMobileNetwork

Name	Description	Value
homeNetworkPublicKeys	Configuration relating to SUPI concealment.	PublicLandMobileNetworkHomeNetworkPublicKeys
mcc	Mobile country code (MCC).	string Constraints: Pattern = `^\d{3}$` (required)
mnc	Mobile network code (MNC).	string Constraints: Pattern = `^\d{2,3}$` (required)

PublicLandMobileNetworkHomeNetworkPublicKeys

Name	Description	Value
profileA	This provides a mapping to identify which public key has been used for SUPI concealment using the Profile A Protection Scheme.	HomeNetworkPublicKey[]
profileB	This provides a mapping to identify which public key has been used for SUPI concealment using the Profile B Protection Scheme.	HomeNetworkPublicKey[]

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

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 private mobile network	This template creates a mobile network resource with an associated slice and data network. You can then use other templates in this repository to create sites for running the Private 5G Core software and provision sims and sim policies..
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 mobileNetworks 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/mobileNetworks resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MobileNetwork/mobileNetworks@2024-02-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      publicLandMobileNetworkIdentifier = {
        mcc = "string"
        mnc = "string"
      }
      publicLandMobileNetworks = [
        {
          homeNetworkPublicKeys = {
            profileA = [
              {
                id = int
                url = "string"
              }
            ]
            profileB = [
              {
                id = int
                url = "string"
              }
            ]
          }
          mcc = "string"
          mnc = "string"
        }
      ]
    }
  })
}

Property values

HomeNetworkPublicKey

Name	Description	Value
id	The Home Network Public Key Identifier determines which public key was used to generate the SUCI sent to the AMF. See TS 23.003 Section 2.2B Section 5.	int Constraints: Min value = 1 Max value = 255 (required)
url	The URL of Azure Key Vault secret containing the private key, versioned or unversioned. For example: https://contosovault.vault.azure.net/secrets/mySuciPrivateKey/562a4bb76b524a1493a6afe8e536ee78.	string

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (currently only UserAssigned allowed).	'None' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

Microsoft.MobileNetwork/mobileNetworks

Name	Description	Value
identity	The identity used to retrieve any private keys used for SUPI concealment from Azure key vault.	ManagedServiceIdentity
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	Mobile network properties.	MobileNetworkPropertiesFormat (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.MobileNetwork/mobileNetworks@2024-02-01"

MobileNetworkPropertiesFormat

Name	Description	Value
publicLandMobileNetworkIdentifier	The unique public land mobile network identifier for the network. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence.	PlmnId (required)
publicLandMobileNetworks	A list of public land mobile networks including their identifiers. If both 'publicLandMobileNetworks' and 'publicLandMobileNetworkIdentifier' are specified, then the 'publicLandMobileNetworks' will take precedence.	PublicLandMobileNetwork[]

PlmnId

Name	Description	Value
mcc	Mobile country code (MCC).	string Constraints: Pattern = `^\d{3}$` (required)
mnc	Mobile network code (MNC).	string Constraints: Pattern = `^\d{2,3}$` (required)

PublicLandMobileNetwork

Name	Description	Value
homeNetworkPublicKeys	Configuration relating to SUPI concealment.	PublicLandMobileNetworkHomeNetworkPublicKeys
mcc	Mobile country code (MCC).	string Constraints: Pattern = `^\d{3}$` (required)
mnc	Mobile network code (MNC).	string Constraints: Pattern = `^\d{2,3}$` (required)

PublicLandMobileNetworkHomeNetworkPublicKeys

Name	Description	Value
profileA	This provides a mapping to identify which public key has been used for SUPI concealment using the Profile A Protection Scheme.	HomeNetworkPublicKey[]
profileB	This provides a mapping to identify which public key has been used for SUPI concealment using the Profile B Protection Scheme.	HomeNetworkPublicKey[]

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

Share via

Microsoft.MobileNetwork mobileNetworks 2024-02-01

Bicep resource definition

Resource format

Property values

HomeNetworkPublicKey

ManagedServiceIdentity

Microsoft.MobileNetwork/mobileNetworks

MobileNetworkPropertiesFormat

PlmnId

PublicLandMobileNetwork

PublicLandMobileNetworkHomeNetworkPublicKeys

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Quickstart samples

ARM template resource definition

Resource format

Property values

HomeNetworkPublicKey

ManagedServiceIdentity

Microsoft.MobileNetwork/mobileNetworks

MobileNetworkPropertiesFormat

PlmnId

PublicLandMobileNetwork

PublicLandMobileNetworkHomeNetworkPublicKeys

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

HomeNetworkPublicKey

ManagedServiceIdentity

Microsoft.MobileNetwork/mobileNetworks

MobileNetworkPropertiesFormat

PlmnId

PublicLandMobileNetwork

PublicLandMobileNetworkHomeNetworkPublicKeys

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Feedback

Additional resources