Microsoft.MobileNetwork simGroups/sims

Article
12/09/2024

Bicep resource definition

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

resource symbolicname 'Microsoft.MobileNetwork/simGroups/sims@2024-04-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    authenticationKey: 'string'
    deviceType: 'string'
    integratedCircuitCardIdentifier: 'string'
    internationalMobileSubscriberIdentity: 'string'
    operatorKeyCode: 'string'
    simPolicy: {
      id: 'string'
    }
    staticIpConfiguration: [
      {
        attachedDataNetwork: {
          id: 'string'
        }
        slice: {
          id: 'string'
        }
        staticIp: {
          ipv4Address: 'string'
        }
      }
    ]
  }
}

Property values

AttachedDataNetworkResourceId

Name	Description	Value
id	Attached data 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]/[pP][aA][cC][kK][eE][tT][cC][oO][rR][eE][cC][oO][nN][tT][rR][oO][lL][pP][lL][aA][nN][eE][sS]/[^/?#]+/[pP][aA][cC][kK][eE][tT][cC][oO][rR][eE][dD][aA][tT][aA][pP][lL][aA][nN][eE][sS]/[^/?#]+/[aA][tT][tT][aA][cC][hH][eE][dD][dD][aA][tT][aA][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+$ (required)

Microsoft.MobileNetwork/simGroups/sims

Name	Description	Value
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: simGroups
properties	SIM Properties.	SimPropertiesFormat (required)

SimPolicyResourceId

Name	Description	Value
id	SIM policy 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]/[^/?#]+/[sS][iI][mM][pP][oO][lL][iI][cC][iI][eE][sS]/[^/?#]+$` (required)

SimPropertiesFormat

Name	Description	Value
authenticationKey	The Ki value for the SIM.	string Constraints: Sensitive value. Pass in as a secure parameter. Pattern = `^[0-9a-fA-F]{32}$`
deviceType	An optional free-form text field that can be used to record the device type this SIM is associated with, for example 'Video camera'. The Azure portal allows SIMs to be grouped and filtered based on this value.	string
integratedCircuitCardIdentifier	The integrated circuit card ID (ICCID) for the SIM.	string Constraints: Pattern = `^[0-9]{10,20}$`
internationalMobileSubscriberIdentity	The international mobile subscriber identity (IMSI) for the SIM.	string Constraints: Pattern = `^[0-9]{5,15}$` (required)
operatorKeyCode	The Opc value for the SIM.	string Constraints: Sensitive value. Pass in as a secure parameter. Pattern = `^[0-9a-fA-F]{32}$`
simPolicy	The SIM policy used by this SIM. The SIM policy must be in the same location as the SIM.	SimPolicyResourceId
staticIpConfiguration	A list of static IP addresses assigned to this SIM. Each address is assigned at a defined network scope, made up of {attached data network, slice}.	SimStaticIpProperties[]

SimStaticIpProperties

Name	Description	Value
attachedDataNetwork	The attached data network on which the static IP address will be used. The combination of attached data network and slice defines the network scope of the IP address. The attached data network must be in the same location as the SIM.	AttachedDataNetworkResourceId
slice	The network slice on which the static IP address will be used. The combination of attached data network and slice defines the network scope of the IP address. The slice must be in the same location as the SIM.	SliceResourceId
staticIp	The static IP configuration for the SIM to use at the defined network scope.	SimStaticIpPropertiesStaticIp

SimStaticIpPropertiesStaticIp

Name	Description	Value
ipv4Address	The IPv4 address assigned to the SIM at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attached data network.	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])$`

SliceResourceId

Name	Description	Value
id	Slice 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]/[^/?#]+/[sS][lL][iI][cC][eE][sS]/[^/?#]+$` (required)

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

{
  "type": "Microsoft.MobileNetwork/simGroups/sims",
  "apiVersion": "2024-04-01",
  "name": "string",
  "properties": {
    "authenticationKey": "string",
    "deviceType": "string",
    "integratedCircuitCardIdentifier": "string",
    "internationalMobileSubscriberIdentity": "string",
    "operatorKeyCode": "string",
    "simPolicy": {
      "id": "string"
    },
    "staticIpConfiguration": [
      {
        "attachedDataNetwork": {
          "id": "string"
        },
        "slice": {
          "id": "string"
        },
        "staticIp": {
          "ipv4Address": "string"
        }
      }
    ]
  }
}

Property values

AttachedDataNetworkResourceId

Name	Description	Value
id	Attached data 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]/[pP][aA][cC][kK][eE][tT][cC][oO][rR][eE][cC][oO][nN][tT][rR][oO][lL][pP][lL][aA][nN][eE][sS]/[^/?#]+/[pP][aA][cC][kK][eE][tT][cC][oO][rR][eE][dD][aA][tT][aA][pP][lL][aA][nN][eE][sS]/[^/?#]+/[aA][tT][tT][aA][cC][hH][eE][dD][dD][aA][tT][aA][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+$ (required)

Microsoft.MobileNetwork/simGroups/sims

Name	Description	Value
apiVersion	The api version	'2024-04-01'
name	The resource name	string Constraints: Max length = Pattern = `^[a-zA-Z0-9][a-zA-Z0-9_-]*$` (required)
properties	SIM Properties.	SimPropertiesFormat (required)
type	The resource type	'Microsoft.MobileNetwork/simGroups/sims'

SimPolicyResourceId

Name	Description	Value
id	SIM policy 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]/[^/?#]+/[sS][iI][mM][pP][oO][lL][iI][cC][iI][eE][sS]/[^/?#]+$` (required)

SimPropertiesFormat

Name	Description	Value
authenticationKey	The Ki value for the SIM.	string Constraints: Sensitive value. Pass in as a secure parameter. Pattern = `^[0-9a-fA-F]{32}$`
deviceType	An optional free-form text field that can be used to record the device type this SIM is associated with, for example 'Video camera'. The Azure portal allows SIMs to be grouped and filtered based on this value.	string
integratedCircuitCardIdentifier	The integrated circuit card ID (ICCID) for the SIM.	string Constraints: Pattern = `^[0-9]{10,20}$`
internationalMobileSubscriberIdentity	The international mobile subscriber identity (IMSI) for the SIM.	string Constraints: Pattern = `^[0-9]{5,15}$` (required)
operatorKeyCode	The Opc value for the SIM.	string Constraints: Sensitive value. Pass in as a secure parameter. Pattern = `^[0-9a-fA-F]{32}$`
simPolicy	The SIM policy used by this SIM. The SIM policy must be in the same location as the SIM.	SimPolicyResourceId
staticIpConfiguration	A list of static IP addresses assigned to this SIM. Each address is assigned at a defined network scope, made up of {attached data network, slice}.	SimStaticIpProperties[]

SimStaticIpProperties

Name	Description	Value
attachedDataNetwork	The attached data network on which the static IP address will be used. The combination of attached data network and slice defines the network scope of the IP address. The attached data network must be in the same location as the SIM.	AttachedDataNetworkResourceId
slice	The network slice on which the static IP address will be used. The combination of attached data network and slice defines the network scope of the IP address. The slice must be in the same location as the SIM.	SliceResourceId
staticIp	The static IP configuration for the SIM to use at the defined network scope.	SimStaticIpPropertiesStaticIp

SimStaticIpPropertiesStaticIp

Name	Description	Value
ipv4Address	The IPv4 address assigned to the SIM at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attached data network.	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])$`

SliceResourceId

Name	Description	Value
id	Slice 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]/[^/?#]+/[sS][lL][iI][cC][eE][sS]/[^/?#]+$` (required)

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.
Provision proxy SIMs	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/sims 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/sims resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MobileNetwork/simGroups/sims@2024-04-01"
  name = "string"
  body = jsonencode({
    properties = {
      authenticationKey = "string"
      deviceType = "string"
      integratedCircuitCardIdentifier = "string"
      internationalMobileSubscriberIdentity = "string"
      operatorKeyCode = "string"
      simPolicy = {
        id = "string"
      }
      staticIpConfiguration = [
        {
          attachedDataNetwork = {
            id = "string"
          }
          slice = {
            id = "string"
          }
          staticIp = {
            ipv4Address = "string"
          }
        }
      ]
    }
  })
}

Property values

AttachedDataNetworkResourceId

Name	Description	Value
id	Attached data 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]/[pP][aA][cC][kK][eE][tT][cC][oO][rR][eE][cC][oO][nN][tT][rR][oO][lL][pP][lL][aA][nN][eE][sS]/[^/?#]+/[pP][aA][cC][kK][eE][tT][cC][oO][rR][eE][dD][aA][tT][aA][pP][lL][aA][nN][eE][sS]/[^/?#]+/[aA][tT][tT][aA][cC][hH][eE][dD][dD][aA][tT][aA][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+$ (required)

Microsoft.MobileNetwork/simGroups/sims

Name	Description	Value
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: simGroups
properties	SIM Properties.	SimPropertiesFormat (required)
type	The resource type	"Microsoft.MobileNetwork/simGroups/sims@2024-04-01"

SimPolicyResourceId

Name	Description	Value
id	SIM policy 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]/[^/?#]+/[sS][iI][mM][pP][oO][lL][iI][cC][iI][eE][sS]/[^/?#]+$` (required)

SimPropertiesFormat

Name	Description	Value
authenticationKey	The Ki value for the SIM.	string Constraints: Sensitive value. Pass in as a secure parameter. Pattern = `^[0-9a-fA-F]{32}$`
deviceType	An optional free-form text field that can be used to record the device type this SIM is associated with, for example 'Video camera'. The Azure portal allows SIMs to be grouped and filtered based on this value.	string
integratedCircuitCardIdentifier	The integrated circuit card ID (ICCID) for the SIM.	string Constraints: Pattern = `^[0-9]{10,20}$`
internationalMobileSubscriberIdentity	The international mobile subscriber identity (IMSI) for the SIM.	string Constraints: Pattern = `^[0-9]{5,15}$` (required)
operatorKeyCode	The Opc value for the SIM.	string Constraints: Sensitive value. Pass in as a secure parameter. Pattern = `^[0-9a-fA-F]{32}$`
simPolicy	The SIM policy used by this SIM. The SIM policy must be in the same location as the SIM.	SimPolicyResourceId
staticIpConfiguration	A list of static IP addresses assigned to this SIM. Each address is assigned at a defined network scope, made up of {attached data network, slice}.	SimStaticIpProperties[]

SimStaticIpProperties

Name	Description	Value
attachedDataNetwork	The attached data network on which the static IP address will be used. The combination of attached data network and slice defines the network scope of the IP address. The attached data network must be in the same location as the SIM.	AttachedDataNetworkResourceId
slice	The network slice on which the static IP address will be used. The combination of attached data network and slice defines the network scope of the IP address. The slice must be in the same location as the SIM.	SliceResourceId
staticIp	The static IP configuration for the SIM to use at the defined network scope.	SimStaticIpPropertiesStaticIp

SimStaticIpPropertiesStaticIp

Name	Description	Value
ipv4Address	The IPv4 address assigned to the SIM at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attached data network.	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])$`

SliceResourceId

Name	Description	Value
id	Slice 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]/[^/?#]+/[sS][lL][iI][cC][eE][sS]/[^/?#]+$` (required)

Share via

Microsoft.MobileNetwork simGroups/sims

Bicep resource definition

Resource format

Property values

AttachedDataNetworkResourceId

Microsoft.MobileNetwork/simGroups/sims

SimPolicyResourceId

SimPropertiesFormat

SimStaticIpProperties

SimStaticIpPropertiesStaticIp

SliceResourceId

Quickstart samples

ARM template resource definition

Resource format

Property values

AttachedDataNetworkResourceId

Microsoft.MobileNetwork/simGroups/sims

SimPolicyResourceId

SimPropertiesFormat

SimStaticIpProperties

SimStaticIpPropertiesStaticIp

SliceResourceId

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

AttachedDataNetworkResourceId

Microsoft.MobileNetwork/simGroups/sims

SimPolicyResourceId

SimPropertiesFormat

SimStaticIpProperties

SimStaticIpPropertiesStaticIp

SliceResourceId

Feedback

Additional resources