cluster_services

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

Overview

Name	cluster_services
Type	Resource
Id	azure_extras.mobile_packet_core.cluster_services

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
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, clusterServiceName		Get a ClusterServiceResource
list_by_resource_group	select	subscriptionId, resourceGroupName		List all Cluster Services by Resource Group.
list_by_subscription	select	subscriptionId		List all Cluster Services by Subscription ID.
create_or_update	insert	subscriptionId, resourceGroupName, clusterServiceName		Create a ClusterServiceResource
delete	delete	subscriptionId, resourceGroupName, clusterServiceName		Delete a ClusterServiceResource
update_tags	exec	subscriptionId, resourceGroupName, clusterServiceName		Update a ClusterServiceResource

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
clusterServiceName	string	The name of the Cluster Service
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

Get a ClusterServiceResource

SELECT
location,
properties,
tags
FROM azure_extras.mobile_packet_core.cluster_services
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterServiceName = '{{ clusterServiceName }}' -- required
;

list_by_resource_group

List all Cluster Services by Resource Group.

SELECT
location,
properties,
tags
FROM azure_extras.mobile_packet_core.cluster_services
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List all Cluster Services by Subscription ID.

SELECT
location,
properties,
tags
FROM azure_extras.mobile_packet_core.cluster_services
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a ClusterServiceResource

INSERT INTO azure_extras.mobile_packet_core.cluster_services (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
clusterServiceName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterServiceName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: cluster_services
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the cluster_services resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the cluster_services resource.
    - name: clusterServiceName
      value: string
      description: Required parameter for the cluster_services resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

DELETE examples

delete

Delete a ClusterServiceResource

DELETE FROM azure_extras.mobile_packet_core.cluster_services
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterServiceName = '{{ clusterServiceName }}' --required
;

Lifecycle Methods

update_tags

Update a ClusterServiceResource

EXEC azure_extras.mobile_packet_core.cluster_services.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterServiceName='{{ clusterServiceName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;