Microsoft.MobileNetwork mobileNetworks 2024-02-01
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' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
publicLandMobileNetworkIdentifier: {
mcc: 'string'
mnc: 'string'
}
publicLandMobileNetworks: [
{
homeNetworkPublicKeys: {
profileA: [
{
id: int
url: 'string'
}
]
profileB: [
{
id: int
url: 'string'
}
]
}
mcc: 'string'
mnc: 'string'
}
]
}
}
Property values
mobileNetworks
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 1-64 Valid characters: Alphanumerics 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 |
| identity | The identity used to retrieve any private keys used for SUPI concealment from Azure key vault. | ManagedServiceIdentity |
| properties | Mobile network properties. | MobileNetworkPropertiesFormat (required) |
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 |
UserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | UserAssignedIdentity |
UserAssignedIdentity
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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[] Constraints: Min length = 1 |
PlmnId
| Name | Description | Value |
|---|---|---|
| mcc | Mobile country code (MCC). | string (required) Constraints: Pattern = ^\d{3}$ |
| mnc | Mobile network code (MNC). | string (required) Constraints: Pattern = ^\d{2,3}$ |
PublicLandMobileNetwork
| Name | Description | Value |
|---|---|---|
| homeNetworkPublicKeys | Configuration relating to SUPI concealment. | PublicLandMobileNetworkHomeNetworkPublicKeys |
| mcc | Mobile country code (MCC). | string (required) Constraints: Pattern = ^\d{3}$ |
| mnc | Mobile network code (MNC). | string (required) Constraints: Pattern = ^\d{2,3}$ |
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[] |
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 (required) Constraints: Min value = 1 Max value = 255 |
| 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 |
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. |
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",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"publicLandMobileNetworkIdentifier": {
"mcc": "string",
"mnc": "string"
},
"publicLandMobileNetworks": [
{
"homeNetworkPublicKeys": {
"profileA": [
{
"id": "int",
"url": "string"
}
],
"profileB": [
{
"id": "int",
"url": "string"
}
]
},
"mcc": "string",
"mnc": "string"
}
]
}
}
Property values
mobileNetworks
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.MobileNetwork/mobileNetworks' |
| apiVersion | The resource api version | '2024-02-01' |
| name | The resource name | string (required) Character limit: 1-64 Valid characters: Alphanumerics 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 |
| identity | The identity used to retrieve any private keys used for SUPI concealment from Azure key vault. | ManagedServiceIdentity |
| properties | Mobile network properties. | MobileNetworkPropertiesFormat (required) |
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 |
UserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | UserAssignedIdentity |
UserAssignedIdentity
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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[] Constraints: Min length = 1 |
PlmnId
| Name | Description | Value |
|---|---|---|
| mcc | Mobile country code (MCC). | string (required) Constraints: Pattern = ^\d{3}$ |
| mnc | Mobile network code (MNC). | string (required) Constraints: Pattern = ^\d{2,3}$ |
PublicLandMobileNetwork
| Name | Description | Value |
|---|---|---|
| homeNetworkPublicKeys | Configuration relating to SUPI concealment. | PublicLandMobileNetworkHomeNetworkPublicKeys |
| mcc | Mobile country code (MCC). | string (required) Constraints: Pattern = ^\d{3}$ |
| mnc | Mobile network code (MNC). | string (required) Constraints: Pattern = ^\d{2,3}$ |
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[] |
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 (required) Constraints: Min value = 1 Max value = 255 |
| 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 |
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"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "UserAssigned"
identity_ids = []
}
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
mobileNetworks
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.MobileNetwork/mobileNetworks@2024-02-01" |
| name | The resource name | string (required) Character limit: 1-64 Valid characters: Alphanumerics 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. |
| identity | The identity used to retrieve any private keys used for SUPI concealment from Azure key vault. | ManagedServiceIdentity |
| properties | Mobile network properties. | MobileNetworkPropertiesFormat (required) |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (currently only UserAssigned allowed). | "UserAssigned" (required) |
| identity_ids | 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. | Array of user identity IDs. |
UserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | UserAssignedIdentity |
UserAssignedIdentity
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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[] Constraints: Min length = 1 |
PlmnId
| Name | Description | Value |
|---|---|---|
| mcc | Mobile country code (MCC). | string (required) Constraints: Pattern = ^\d{3}$ |
| mnc | Mobile network code (MNC). | string (required) Constraints: Pattern = ^\d{2,3}$ |
PublicLandMobileNetwork
| Name | Description | Value |
|---|---|---|
| homeNetworkPublicKeys | Configuration relating to SUPI concealment. | PublicLandMobileNetworkHomeNetworkPublicKeys |
| mcc | Mobile country code (MCC). | string (required) Constraints: Pattern = ^\d{3}$ |
| mnc | Mobile network code (MNC). | string (required) Constraints: Pattern = ^\d{2,3}$ |
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[] |
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 (required) Constraints: Min value = 1 Max value = 255 |
| 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 |