data_networks

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

Overview

Name	data_networks
Type	Resource
Id	azure.mobile_network.data_networks

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting data network resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Data network properties.
tags	object	Resource tags.

list_by_mobile_network

Request successful. The operation returns a list of data network resources.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Data network 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, mobileNetworkName, dataNetworkName		Gets information about the specified data network.
list_by_mobile_network	select	subscriptionId, resourceGroupName, mobileNetworkName		Lists all data networks in the mobile network.
create_or_update	insert	subscriptionId, resourceGroupName, mobileNetworkName, dataNetworkName		Creates or updates a data network. Must be created in the same location as its parent mobile network.
delete	delete	subscriptionId, resourceGroupName, mobileNetworkName, dataNetworkName		Deletes the specified data network.
update_tags	exec	subscriptionId, resourceGroupName, mobileNetworkName, dataNetworkName		Updates data network 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
dataNetworkName	string	The name of the data network.
mobileNetworkName	string	The name of the mobile network.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets information about the specified data network.

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

list_by_mobile_network

Lists all data networks in the mobile network.

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

INSERT examples

create_or_update

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

INSERT INTO azure.mobile_network.data_networks (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
mobileNetworkName,
dataNetworkName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ mobileNetworkName }}',
'{{ dataNetworkName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: data_networks
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the data_networks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_networks resource.
    - name: mobileNetworkName
      value: string
      description: Required parameter for the data_networks resource.
    - name: dataNetworkName
      value: string
      description: Required parameter for the data_networks resource.
    - name: properties
      value: object
      description: |
        Data network 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 data network.

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

Lifecycle Methods

update_tags

Updates data network tags.

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