Sims - Create Or Update

Reference

Service:: Mobile Network

API Version:: 2024-04-01

Creates or updates a SIM.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/simGroups/{simGroupName}/sims/{simName}?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
simGroupName	path	True	string	The name of the SIM Group. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$`
simName	path	True	string	The name of the SIM. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
properties.internationalMobileSubscriberIdentity	True	string	The international mobile subscriber identity (IMSI) for the SIM.
properties.authenticationKey		string	The Ki value for the SIM.
properties.deviceType		string	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.
properties.integratedCircuitCardIdentifier		string	The integrated circuit card ID (ICCID) for the SIM.
properties.operatorKeyCode		string	The Opc value for the SIM.
properties.simPolicy		SimPolicyResourceId	The SIM policy used by this SIM. The SIM policy must be in the same location as the SIM.
properties.staticIpConfiguration		SimStaticIpProperties[]	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}.

Responses

Name	Type	Description
200 OK	Sim	Update successful. The operation returns the resulting SIM resource.
201 Created	Sim	Create successful. The operation returns the resulting SIM resource.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create SIM

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/simGroups/testSimGroup/sims/testSim?api-version=2024-04-01

{
  "properties": {
    "integratedCircuitCardIdentifier": "8900000000000000000",
    "internationalMobileSubscriberIdentity": "00000",
    "authenticationKey": "00000000000000000000000000000000",
    "operatorKeyCode": "00000000000000000000000000000000",
    "deviceType": "Video camera",
    "simPolicy": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/MySimPolicy"
    },
    "staticIpConfiguration": [
      {
        "attachedDataNetwork": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork"
        },
        "slice": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"
        },
        "staticIp": {
          "ipv4Address": "2.4.0.1"
        }
      }
    ]
  }
}

Sample response

Status code:: 200

{
  "name": "testSim",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/simGroups/testSimGroup/sims/testSim",
  "type": "Microsoft.MobileNetwork/simGroups/sims",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "simState": "Enabled",
    "siteProvisioningState": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite": "Provisioned",
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite2": "Provisioned"
    },
    "integratedCircuitCardIdentifier": "8900000000000000000",
    "internationalMobileSubscriberIdentity": "00000",
    "deviceType": "Video camera",
    "simPolicy": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/MySimPolicy"
    },
    "staticIpConfiguration": [
      {
        "attachedDataNetwork": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork"
        },
        "slice": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"
        },
        "staticIp": {
          "ipv4Address": "2.4.0.1"
        }
      }
    ]
  }
}

Status code:: 201

Azure-AsyncOperation: https://management.azure.com/providers/Microsoft.MobileNetwork/locations/testLocation/operationStatuses/testOperation?api-version=2024-04-01

{
  "name": "testSim",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/simGroups/testSimGroup/sims/testSim",
  "type": "Microsoft.MobileNetwork/simGroups/sims",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Created",
    "simState": "Enabled",
    "siteProvisioningState": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite": "Adding",
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite2": "Adding"
    },
    "integratedCircuitCardIdentifier": "8900000000000000000",
    "internationalMobileSubscriberIdentity": "00000",
    "deviceType": "Video camera",
    "simPolicy": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/MySimPolicy"
    },
    "staticIpConfiguration": [
      {
        "attachedDataNetwork": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork"
        },
        "slice": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"
        },
        "staticIp": {
          "ipv4Address": "2.4.0.1"
        }
      }
    ]
  }
}

Definitions

Name	Description
AttachedDataNetworkResourceId	Reference to an attached data network resource.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ProvisioningState	The current provisioning state.
Sim	SIM resource.
SimPolicyResourceId	Reference to a SIM policy resource.
SimState	The state of the SIM resource.
SimStaticIpProperties	Static IP configuration for a SIM, scoped to a particular attached data network and slice.
SliceResourceId	Reference to a slice resource.
StaticIp	The static IP configuration for the SIM to use at the defined network scope.
systemData	Metadata pertaining to creation and last modification of the resource.

AttachedDataNetworkResourceId

Reference to an attached data network resource.

Name	Type	Description
id	string	Attached data network resource ID.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ProvisioningState

The current provisioning state.

Name	Type	Description
Accepted	string
Canceled	string
Deleted	string
Deleting	string
Failed	string
Succeeded	string
Unknown	string

Sim

SIM resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.authenticationKey	string	The Ki value for the SIM.
properties.deviceType	string	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.
properties.integratedCircuitCardIdentifier	string	The integrated circuit card ID (ICCID) for the SIM.
properties.internationalMobileSubscriberIdentity	string	The international mobile subscriber identity (IMSI) for the SIM.
properties.operatorKeyCode	string	The Opc value for the SIM.
properties.provisioningState	ProvisioningState	The provisioning state of the SIM resource.
properties.simPolicy	SimPolicyResourceId	The SIM policy used by this SIM. The SIM policy must be in the same location as the SIM.
properties.simState	SimState	The state of the SIM resource.
properties.siteProvisioningState	object	A dictionary of sites to the provisioning state of this SIM on that site.
properties.staticIpConfiguration	SimStaticIpProperties[]	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}.
properties.vendorKeyFingerprint	string	The public key fingerprint of the SIM vendor who provided this SIM, if any.
properties.vendorName	string	The name of the SIM vendor who provided this SIM, if any.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SimPolicyResourceId

Reference to a SIM policy resource.

Name	Type	Description
id	string	SIM policy resource ID.

SimState

The state of the SIM resource.

Name	Type	Description
Disabled	string	The SIM is disabled because not all configuration required for enabling is present.
Enabled	string	The SIM is enabled.
Invalid	string	The SIM cannot be enabled because some of the associated configuration is invalid.

SimStaticIpProperties

Static IP configuration for a SIM, scoped to a particular attached data network and slice.

Name	Type	Description
attachedDataNetwork	AttachedDataNetworkResourceId	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.
slice	SliceResourceId	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.
staticIp	StaticIp	The static IP configuration for the SIM to use at the defined network scope.

SliceResourceId

Reference to a slice resource.

Name	Type	Description
id	string	Slice resource ID.

StaticIp

The static IP configuration for the SIM to use at the defined network scope.

Name	Type	Description
ipv4Address	string	The IPv4 address assigned to the SIM at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attached data network.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via