Sims - Bulk Upload Encrypted

Bulk upload SIMs in encrypted form to a SIM group. The SIM credentials must be encrypted.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/simGroups/{simGroupName}/uploadEncryptedSims?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_-]*$

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
azureKeyIdentifier True

integer

An identifier for the Azure SIM onboarding public key used for encrypted upload.

encryptedTransportKey True

string

The transport key used for encrypting SIM credentials, encrypted using the SIM onboarding public key.

signedTransportKey True

string

The encrypted transport key, signed using the SIM vendor private key.

sims True

SimNameAndEncryptedProperties[]

A list of SIMs to upload, with encrypted properties.

vendorKeyFingerprint True

string

The fingerprint of the SIM vendor public key. The private counterpart is used for signing the encrypted transport key.

version True

integer

The upload file format version.

Responses

Name Type Description
200 OK

AsyncOperationStatus

Async operation completed.

202 Accepted

Accepted. Returns an operation URI that can be queried to find the current state of the operation.

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

Bulk upload encrypted SIMs to a SIM group

Sample request

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

{
  "version": 1,
  "azureKeyIdentifier": 1,
  "vendorKeyFingerprint": "ABC123",
  "encryptedTransportKey": "ABC123",
  "signedTransportKey": "ABC123",
  "sims": [
    {
      "name": "testSim",
      "properties": {
        "integratedCircuitCardIdentifier": "8900000000000000000",
        "internationalMobileSubscriberIdentity": "00000",
        "encryptedCredentials": "ABC123",
        "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"
            }
          }
        ]
      }
    },
    {
      "name": "testSim2",
      "properties": {
        "integratedCircuitCardIdentifier": "8900000000000000001",
        "internationalMobileSubscriberIdentity": "00000",
        "encryptedCredentials": "ABC123",
        "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.2"
            }
          }
        ]
      }
    }
  ]
}

Sample response

{
  "id": "/providers/Microsoft.MobileNetwork/locations/testLocation/operationStatuses/testOperation",
  "name": "testOperation",
  "status": "Succeeded",
  "startTime": "2021-08-19T03:36:07.000Z",
  "endTime": "2021-08-19T03:38:07.000Z"
}
Azure-AsyncOperation: https://management.azure.com/providers/Microsoft.MobileNetwork/locations/testLocation/operationStatuses/testOperation?api-version=2024-04-01

Definitions

Name Description
AsyncOperationStatus

The current status of an async operation.

AttachedDataNetworkResourceId

Reference to an attached data network resource.

EncryptedSimUploadList

The SIMs to upload. The SIM credentials must be encrypted.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

ProvisioningState

The current provisioning state.

SimNameAndEncryptedProperties

SIM name and encrypted properties.

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.

AsyncOperationStatus

The current status of an async operation.

Name Type Description
endTime

string

The end time of the operation.

error

ErrorDetail

If present, details of the operation error.

id

string

Fully qualified ID for the async operation.

name

string

Name of the async operation.

percentComplete

number

Percentage of the operation that is complete.

properties

object

Properties returned by the resource provider on a successful operation

resourceId

string

Fully qualified ID for the resource that this async operation status relates to.

startTime

string

The start time of the operation.

status

string

The operation status.

AttachedDataNetworkResourceId

Reference to an attached data network resource.

Name Type Description
id

string

Attached data network resource ID.

EncryptedSimUploadList

The SIMs to upload. The SIM credentials must be encrypted.

Name Type Description
azureKeyIdentifier

integer

An identifier for the Azure SIM onboarding public key used for encrypted upload.

encryptedTransportKey

string

The transport key used for encrypting SIM credentials, encrypted using the SIM onboarding public key.

signedTransportKey

string

The encrypted transport key, signed using the SIM vendor private key.

sims

SimNameAndEncryptedProperties[]

A list of SIMs to upload, with encrypted properties.

vendorKeyFingerprint

string

The fingerprint of the SIM vendor public key. The private counterpart is used for signing the encrypted transport key.

version

integer

The upload file format version.

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

SimNameAndEncryptedProperties

SIM name and encrypted properties.

Name Type Description
name

string

The name of 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.encryptedCredentials

string

The encrypted SIM credentials.

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.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.

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.