sim_groups

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

Overview

Name	sim_groups
Type	Resource
Id	azure.mobile_network.sim_groups

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting SIM group resource.

Name	Datatype	Description
identity	object	The identity used to retrieve the encryption key from Azure key vault.
location	string	The geo-location where the resource lives
properties	object	SIM group Properties.
tags	object	Resource tags.

list_by_resource_group

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

Name	Datatype	Description
identity	object	The identity used to retrieve the encryption key from Azure key vault.
location	string	The geo-location where the resource lives
properties	object	SIM group Properties.
tags	object	Resource tags.

list_by_subscription

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

Name	Datatype	Description
identity	object	The identity used to retrieve the encryption key from Azure key vault.
location	string	The geo-location where the resource lives
properties	object	SIM group Properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, simGroupName		Gets information about the specified SIM group.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all the SIM groups in a resource group.
list_by_subscription	select	subscriptionId		Gets all the SIM groups in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, simGroupName, data__properties		Creates or updates a SIM group.
delete	delete	subscriptionId, resourceGroupName, simGroupName		Deletes the specified SIM group.
update_tags	exec	subscriptionId, resourceGroupName, simGroupName		Patch SIM group resource.

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.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets information about the specified SIM group.

SELECT
identity,
location,
properties,
tags
FROM azure.mobile_network.sim_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND simGroupName = '{{ simGroupName }}' -- required
;

list_by_resource_group

Gets all the SIM groups in a resource group.

SELECT
identity,
location,
properties,
tags
FROM azure.mobile_network.sim_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Gets all the SIM groups in a subscription.

SELECT
identity,
location,
properties,
tags
FROM azure.mobile_network.sim_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a SIM group.

INSERT INTO azure.mobile_network.sim_groups (
data__properties,
data__identity,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
simGroupName
)
SELECT 
'{{ properties }}' /* required */,
'{{ identity }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ simGroupName }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: sim_groups
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the sim_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sim_groups resource.
    - name: simGroupName
      value: string
      description: Required parameter for the sim_groups resource.
    - name: properties
      value: object
      description: |
        SIM group Properties.
    - name: identity
      value: object
      description: |
        The identity used to retrieve the encryption key from Azure key vault.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

DELETE examples

delete

Deletes the specified SIM group.

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

Lifecycle Methods

update_tags

Patch SIM group resource.

EXEC azure.mobile_network.sim_groups.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@simGroupName='{{ simGroupName }}' --required 
@@json=
'{
"identity": "{{ identity }}", 
"tags": "{{ tags }}"
}'
;