sims

Creates, updates, deletes, gets or lists a sims resource.

Overview

Name	sims
Type	Resource
Id	azure.mobile_network.sims

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting SIM resource.

Name	Datatype	Description
properties	object	SIM Properties.

list_by_group

Request successful. The operation returns a list of SIM resources.

Name	Datatype	Description
properties	object	SIM Properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, simGroupName, simName		Gets information about the specified SIM.
list_by_group	select	resourceGroupName, subscriptionId, simGroupName		Gets all the SIMs in a SIM group.
create_or_update	insert	subscriptionId, resourceGroupName, simGroupName, simName, data__properties		Creates or updates a SIM.
delete	delete	subscriptionId, resourceGroupName, simGroupName, simName		Deletes the specified SIM.
bulk_upload	exec	resourceGroupName, subscriptionId, simGroupName, sims		Bulk upload SIMs to a SIM group.
bulk_delete	exec	resourceGroupName, subscriptionId, simGroupName, sims		Bulk delete SIMs from a SIM group.
bulk_upload_encrypted	exec	resourceGroupName, subscriptionId, simGroupName, version, azureKeyIdentifier, vendorKeyFingerprint, encryptedTransportKey, signedTransportKey, sims		Bulk upload SIMs in encrypted form to a SIM group. The SIM credentials must be encrypted.
move	exec	resourceGroupName, subscriptionId, simGroupName		Move SIMs to another SIM Group
clone	exec	resourceGroupName, subscriptionId, simGroupName		Clone SIMs to another SIM Group

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resourceGroupName	string	The name of the resource group. The name is case insensitive.
simGroupName	string	The name of the SIM Group.
simName	string	The name of the SIM.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets information about the specified SIM.

SELECT
properties
FROM azure.mobile_network.sims
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND simGroupName = '{{ simGroupName }}' -- required
AND simName = '{{ simName }}' -- required
;

list_by_group

Gets all the SIMs in a SIM group.

SELECT
properties
FROM azure.mobile_network.sims
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND simGroupName = '{{ simGroupName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a SIM.

INSERT INTO azure.mobile_network.sims (
data__properties,
subscriptionId,
resourceGroupName,
simGroupName,
simName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ simGroupName }}',
'{{ simName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: sims
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the sims resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sims resource.
    - name: simGroupName
      value: string
      description: Required parameter for the sims resource.
    - name: simName
      value: string
      description: Required parameter for the sims resource.
    - name: properties
      value: object
      description: |
        SIM Properties.

DELETE examples

delete

Deletes the specified SIM.

DELETE FROM azure.mobile_network.sims
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND simGroupName = '{{ simGroupName }}' --required
AND simName = '{{ simName }}' --required
;

Lifecycle Methods

bulk_upload

Bulk upload SIMs to a SIM group.

EXEC azure.mobile_network.sims.bulk_upload 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@simGroupName='{{ simGroupName }}' --required 
@@json=
'{
"sims": "{{ sims }}"
}'
;

bulk_delete

Bulk delete SIMs from a SIM group.

EXEC azure.mobile_network.sims.bulk_delete 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@simGroupName='{{ simGroupName }}' --required 
@@json=
'{
"sims": "{{ sims }}"
}'
;

bulk_upload_encrypted

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

EXEC azure.mobile_network.sims.bulk_upload_encrypted 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@simGroupName='{{ simGroupName }}' --required 
@@json=
'{
"version": {{ version }}, 
"azureKeyIdentifier": {{ azureKeyIdentifier }}, 
"vendorKeyFingerprint": "{{ vendorKeyFingerprint }}", 
"encryptedTransportKey": "{{ encryptedTransportKey }}", 
"signedTransportKey": "{{ signedTransportKey }}", 
"sims": "{{ sims }}"
}'
;

move

Move SIMs to another SIM Group

EXEC azure.mobile_network.sims.move 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@simGroupName='{{ simGroupName }}' --required 
@@json=
'{
"targetSimGroupId": "{{ targetSimGroupId }}", 
"sims": "{{ sims }}"
}'
;

clone

Clone SIMs to another SIM Group

EXEC azure.mobile_network.sims.clone 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@simGroupName='{{ simGroupName }}' --required 
@@json=
'{
"targetSimGroupId": "{{ targetSimGroupId }}", 
"sims": "{{ sims }}"
}'
;