packet_core_data_planes

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

Overview

Name	packet_core_data_planes
Type	Resource
Id	azure.mobile_network.packet_core_data_planes

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting packet core data plane resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Packet core data plane Properties.
tags	object	Resource tags.

list_by_packet_core_control_plane

Request successful. The operation returns a list of packet core data plane resources.

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

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

list_by_packet_core_control_plane

Lists all the packet core data planes associated with a packet core control plane.

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

INSERT examples

create_or_update

Creates or updates a packet core data plane. Must be created in the same location as its parent packet core control plane.

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

Manifest

# Description fields are for documentation purposes
- name: packet_core_data_planes
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the packet_core_data_planes resource.
    - name: packetCoreControlPlaneName
      value: string
      description: Required parameter for the packet_core_data_planes resource.
    - name: packetCoreDataPlaneName
      value: string
      description: Required parameter for the packet_core_data_planes resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the packet_core_data_planes resource.
    - name: properties
      value: object
      description: |
        Packet core data plane 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 packet core data plane.

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

Lifecycle Methods

update_tags

Updates packet core data planes tags.

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