attached_data_networks

Creates, updates, deletes, gets or lists an attached_data_networks resource.

Overview

Name	attached_data_networks
Type	Resource
Id	azure.mobile_network.attached_data_networks

Fields

The following fields are returned by SELECT queries:

get

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

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

list_by_packet_core_data_plane

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

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Attached 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, packetCoreControlPlaneName, packetCoreDataPlaneName, attachedDataNetworkName		Gets information about the specified attached data network.
list_by_packet_core_data_plane	select	subscriptionId, resourceGroupName, packetCoreControlPlaneName, packetCoreDataPlaneName		Gets all the attached data networks associated with a packet core data plane.
create_or_update	insert	subscriptionId, resourceGroupName, packetCoreControlPlaneName, packetCoreDataPlaneName, attachedDataNetworkName, data__properties		Creates or updates an attached data network. Must be created in the same location as its parent packet core data plane.
delete	delete	subscriptionId, resourceGroupName, packetCoreControlPlaneName, packetCoreDataPlaneName, attachedDataNetworkName		Deletes the specified attached data network.
update_tags	exec	subscriptionId, resourceGroupName, packetCoreControlPlaneName, packetCoreDataPlaneName, attachedDataNetworkName		Updates an attached 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
attachedDataNetworkName	string	The name of the attached data network.
packetCoreControlPlaneName	string	The name of the packet core control plane.
packetCoreDataPlaneName	string	The name of the packet core data plane.
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 attached data network.

SELECT
location,
properties,
tags
FROM azure.mobile_network.attached_data_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND packetCoreControlPlaneName = '{{ packetCoreControlPlaneName }}' -- required
AND packetCoreDataPlaneName = '{{ packetCoreDataPlaneName }}' -- required
AND attachedDataNetworkName = '{{ attachedDataNetworkName }}' -- required
;

list_by_packet_core_data_plane

Gets all the attached data networks associated with a packet core data plane.

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

INSERT examples

create_or_update

Creates or updates an attached data network. Must be created in the same location as its parent packet core data plane.

INSERT INTO azure.mobile_network.attached_data_networks (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
packetCoreControlPlaneName,
packetCoreDataPlaneName,
attachedDataNetworkName
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ packetCoreControlPlaneName }}',
'{{ packetCoreDataPlaneName }}',
'{{ attachedDataNetworkName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: attached_data_networks
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the attached_data_networks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the attached_data_networks resource.
    - name: packetCoreControlPlaneName
      value: string
      description: Required parameter for the attached_data_networks resource.
    - name: packetCoreDataPlaneName
      value: string
      description: Required parameter for the attached_data_networks resource.
    - name: attachedDataNetworkName
      value: string
      description: Required parameter for the attached_data_networks resource.
    - name: properties
      value: object
      description: |
        Attached 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 attached data network.

DELETE FROM azure.mobile_network.attached_data_networks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND packetCoreControlPlaneName = '{{ packetCoreControlPlaneName }}' --required
AND packetCoreDataPlaneName = '{{ packetCoreDataPlaneName }}' --required
AND attachedDataNetworkName = '{{ attachedDataNetworkName }}' --required
;

Lifecycle Methods

update_tags

Updates an attached data network tags.

EXEC azure.mobile_network.attached_data_networks.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@packetCoreControlPlaneName='{{ packetCoreControlPlaneName }}' --required, 
@packetCoreDataPlaneName='{{ packetCoreDataPlaneName }}' --required, 
@attachedDataNetworkName='{{ attachedDataNetworkName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;