sim_policies

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

Overview

Name	sim_policies
Type	Resource
Id	azure.mobile_network.sim_policies

Fields

The following fields are returned by SELECT queries:

get

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

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	SIM policy Properties.
tags	object	Resource tags.

list_by_mobile_network

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

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	SIM policy Properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, mobileNetworkName, simPolicyName, subscriptionId		Gets information about the specified SIM policy.
list_by_mobile_network	select	resourceGroupName, mobileNetworkName, subscriptionId		Gets all the SIM policies in a mobile network.
create_or_update	insert	resourceGroupName, mobileNetworkName, simPolicyName, subscriptionId, data__properties		Creates or updates a SIM policy. Must be created in the same location as its parent mobile network.
delete	delete	resourceGroupName, mobileNetworkName, simPolicyName, subscriptionId		Deletes the specified SIM policy.
update_tags	exec	subscriptionId, resourceGroupName, mobileNetworkName, simPolicyName		Updates SIM policy tags.

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
mobileNetworkName	string	The name of the mobile network.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
simPolicyName	string	The name of the SIM policy.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets information about the specified SIM policy.

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

list_by_mobile_network

Gets all the SIM policies in a mobile network.

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

INSERT examples

create_or_update

Creates or updates a SIM policy. Must be created in the same location as its parent mobile network.

INSERT INTO azure.mobile_network.sim_policies (
data__properties,
data__tags,
data__location,
resourceGroupName,
mobileNetworkName,
simPolicyName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ mobileNetworkName }}',
'{{ simPolicyName }}',
'{{ subscriptionId }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: sim_policies
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the sim_policies resource.
    - name: mobileNetworkName
      value: string
      description: Required parameter for the sim_policies resource.
    - name: simPolicyName
      value: string
      description: Required parameter for the sim_policies resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the sim_policies resource.
    - name: properties
      value: object
      description: |
        SIM policy Properties.
    - 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 policy.

DELETE FROM azure.mobile_network.sim_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND mobileNetworkName = '{{ mobileNetworkName }}' --required
AND simPolicyName = '{{ simPolicyName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates SIM policy tags.

EXEC azure.mobile_network.sim_policies.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@mobileNetworkName='{{ mobileNetworkName }}' --required, 
@simPolicyName='{{ simPolicyName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;