packet_core_control_planes

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

Overview

Name	packet_core_control_planes
Type	Resource
Id	azure.mobile_network.packet_core_control_planes

Fields

The following fields are returned by SELECT queries:

get

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

Name	Datatype	Description
identity	object	The identity used to retrieve the ingress certificate from Azure key vault.
location	string	The geo-location where the resource lives
properties	object	Packet core control plane Properties.
tags	object	Resource tags.

list_by_resource_group

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

Name	Datatype	Description
identity	object	The identity used to retrieve the ingress certificate from Azure key vault.
location	string	The geo-location where the resource lives
properties	object	Packet core control plane Properties.
tags	object	Resource tags.

list_by_subscription

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

Name	Datatype	Description
identity	object	The identity used to retrieve the ingress certificate from Azure key vault.
location	string	The geo-location where the resource lives
properties	object	Packet core control 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, subscriptionId		Gets information about the specified packet core control plane.
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists all the packet core control planes in a resource group.
list_by_subscription	select	subscriptionId		Lists all the packet core control planes in a subscription.
create_or_update	insert	resourceGroupName, packetCoreControlPlaneName, subscriptionId, data__properties		Creates or updates a packet core control plane.
delete	delete	resourceGroupName, packetCoreControlPlaneName, subscriptionId		Deletes the specified packet core control plane.
update_tags	exec	resourceGroupName, packetCoreControlPlaneName, subscriptionId		Patch packet core control plane resource.
rollback	exec	resourceGroupName, packetCoreControlPlaneName, subscriptionId		Roll back the specified packet core control plane to the previous version, "rollbackVersion". Multiple consecutive rollbacks are not possible. This action may cause a service outage.
reinstall	exec	resourceGroupName, packetCoreControlPlaneName, subscriptionId		Reinstall the specified packet core control plane. This action will try to restore the packet core to the installed state that was disrupted by a transient failure. This action will cause a service outage.
collect_diagnostics_package	exec	resourceGroupName, packetCoreControlPlaneName, subscriptionId, storageAccountBlobUrl		Collect a diagnostics package for the specified packet core control plane. This action will upload the diagnostics to a storage account.

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.
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 control plane.

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

list_by_resource_group

Lists all the packet core control planes in a resource group.

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

list_by_subscription

Lists all the packet core control planes in a subscription.

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

INSERT examples

create_or_update

Creates or updates a packet core control plane.

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

Manifest

# Description fields are for documentation purposes
- name: packet_core_control_planes
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the packet_core_control_planes resource.
    - name: packetCoreControlPlaneName
      value: string
      description: Required parameter for the packet_core_control_planes resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the packet_core_control_planes resource.
    - name: properties
      value: object
      description: |
        Packet core control plane Properties.
    - name: identity
      value: object
      description: |
        The identity used to retrieve the ingress certificate 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 packet core control plane.

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

Lifecycle Methods

update_tags

Patch packet core control plane resource.

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

rollback

Roll back the specified packet core control plane to the previous version, "rollbackVersion". Multiple consecutive rollbacks are not possible. This action may cause a service outage.

EXEC azure.mobile_network.packet_core_control_planes.rollback 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@packetCoreControlPlaneName='{{ packetCoreControlPlaneName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

reinstall

Reinstall the specified packet core control plane. This action will try to restore the packet core to the installed state that was disrupted by a transient failure. This action will cause a service outage.

EXEC azure.mobile_network.packet_core_control_planes.reinstall 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@packetCoreControlPlaneName='{{ packetCoreControlPlaneName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

collect_diagnostics_package

Collect a diagnostics package for the specified packet core control plane. This action will upload the diagnostics to a storage account.

EXEC azure.mobile_network.packet_core_control_planes.collect_diagnostics_package 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@packetCoreControlPlaneName='{{ packetCoreControlPlaneName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"storageAccountBlobUrl": "{{ storageAccountBlobUrl }}"
}'
;