Share via

Microsoft.MobileNetwork simGroups

  • Article

Bicep resource definition

The simGroups resource type can be deployed with operations that target:

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@2024-04-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    encryptionKey: {
      keyUrl: 'string'
    }
    mobileNetwork: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

KeyVaultKey

Name Description Value
keyUrl The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey. 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/simGroups

Name Description Value
identity The identity used to retrieve the encryption key 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 SIM group Properties. SimGroupPropertiesFormat (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

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)

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

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.
Provision proxy SIMs 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 with operations that target:

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": "2024-04-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "encryptionKey": {
      "keyUrl": "string"
    },
    "mobileNetwork": {
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

KeyVaultKey

Name Description Value
keyUrl The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey. 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/simGroups

Name Description Value
apiVersion The api version '2024-04-01'
identity The identity used to retrieve the encryption key 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 SIM group Properties. SimGroupPropertiesFormat (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.MobileNetwork/simGroups'

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)

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

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

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 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/simGroups resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MobileNetwork/simGroups@2024-04-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      encryptionKey = {
        keyUrl = "string"
      }
      mobileNetwork = {
        id = "string"
      }
    }
  })
}

Property values

KeyVaultKey

Name Description Value
keyUrl The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey. 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/simGroups

Name Description Value
identity The identity used to retrieve the encryption key 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 SIM group Properties. SimGroupPropertiesFormat (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.MobileNetwork/simGroups@2024-04-01"

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)

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

TrackedResourceTags

Name Description Value

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value