Microsoft.MobileNetwork simGroups

Bicep resource definition

The simGroups resource type can be deployed to:

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

Resource format

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

resource symbolicname 'Microsoft.MobileNetwork/simGroups@2022-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    encryptionKey: {
      keyUrl: 'string'
    }
    mobileNetwork: {
      id: 'string'
    }
  }
}

Property values

simGroups

Name Description Value
name The resource name string (required)
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 the encryption key from Azure key vault. ManagedServiceIdentity
properties SIM group Properties. SimGroupPropertiesFormat (required)

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'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. object

SimGroupPropertiesFormat

Name Description Value
encryptionKey A key to encrypt the SIM data that belongs to this SIM group. KeyVaultKey
mobileNetwork Mobile network that this SIM group belongs to. The mobile network must be in the same location as the SIM group. MobileNetworkResourceId

KeyVaultKey

Name Description Value
keyUrl The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey. string

MobileNetworkResourceId

Name Description Value
id Mobile network resource ID. string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a full 5G Core deployment

Deploy to Azure
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.
Provision proxy SIMs

Deploy to Azure
This template adds the SIM group and SIM(s) to an existing mobile network and provisions the SIM(s).

ARM template resource definition

The simGroups resource type can be deployed to:

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

Resource format

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

{
  "type": "Microsoft.MobileNetwork/simGroups",
  "apiVersion": "2022-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "encryptionKey": {
      "keyUrl": "string"
    },
    "mobileNetwork": {
      "id": "string"
    }
  }
}

Property values

simGroups

Name Description Value
type The resource type 'Microsoft.MobileNetwork/simGroups'
apiVersion The resource api version '2022-11-01'
name The resource name string (required)
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 the encryption key from Azure key vault. ManagedServiceIdentity
properties SIM group Properties. SimGroupPropertiesFormat (required)

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'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. object

SimGroupPropertiesFormat

Name Description Value
encryptionKey A key to encrypt the SIM data that belongs to this SIM group. KeyVaultKey
mobileNetwork Mobile network that this SIM group belongs to. The mobile network must be in the same location as the SIM group. MobileNetworkResourceId

KeyVaultKey

Name Description Value
keyUrl The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey. string

MobileNetworkResourceId

Name Description Value
id Mobile network resource ID. string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a full 5G Core deployment

Deploy to Azure
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.
Provision proxy SIMs

Deploy to Azure
This template adds the SIM group and SIM(s) to an existing mobile network and provisions the SIM(s).

Terraform (AzAPI provider) resource definition

The simGroups resource type can be deployed to:

  • Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MobileNetwork/simGroups@2022-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      encryptionKey = {
        keyUrl = "string"
      }
      mobileNetwork = {
        id = "string"
      }
    }
  })
}

Property values

simGroups

Name Description Value
type The resource type "Microsoft.MobileNetwork/simGroups@2022-11-01"
name The resource name string (required)
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 the encryption key from Azure key vault. ManagedServiceIdentity
properties SIM group Properties. SimGroupPropertiesFormat (required)

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). "SystemAssigned"
"SystemAssigned,UserAssigned"
"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.

SimGroupPropertiesFormat

Name Description Value
encryptionKey A key to encrypt the SIM data that belongs to this SIM group. KeyVaultKey
mobileNetwork Mobile network that this SIM group belongs to. The mobile network must be in the same location as the SIM group. MobileNetworkResourceId

KeyVaultKey

Name Description Value
keyUrl The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey. string

MobileNetworkResourceId

Name Description Value
id Mobile network resource ID. string (required)