energy_services

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

Overview

Name	energy_services
Type	Resource
Id	azure_extras.open_energy_platform.energy_services

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
location	string	Geo-location where the resource lives.
properties	object
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
location	string	Geo-location where the resource lives.
properties	object
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_subscription

Returned when the operation is successful.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
location	string	Geo-location where the resource lives.
properties	object
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName		Returns oep resource for a given name.
list_by_resource_group	select	subscriptionId, resourceGroupName		Returns list of oep resources..
list_by_subscription	select	subscriptionId		Lists a collection of oep resources under the given Azure Subscription ID.
create	insert	subscriptionId, resourceGroupName, resourceName, data__location		Method that gets called if subscribed for ResourceCreationBegin trigger.
update	update	subscriptionId, resourceGroupName, resourceName
delete	delete	subscriptionId, resourceGroupName, resourceName		Deletes oep resource
add_partition	exec	subscriptionId, resourceGroupName, resourceName		Method that gets called if new partition is to be added in a resource.
remove_partition	exec	subscriptionId, resourceGroupName, resourceName		Method that gets called if new partition is to be removed from a resource.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The resource name.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Returns oep resource for a given name.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure_extras.open_energy_platform.energy_services
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list_by_resource_group

Returns list of oep resources..

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure_extras.open_energy_platform.energy_services
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Lists a collection of oep resources under the given Azure Subscription ID.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure_extras.open_energy_platform.energy_services
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Method that gets called if subscribed for ResourceCreationBegin trigger.

INSERT INTO azure_extras.open_energy_platform.energy_services (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
resourceName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: energy_services
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the energy_services resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the energy_services resource.
    - name: resourceName
      value: string
      description: Required parameter for the energy_services resource.
    - name: properties
      value: object
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        Geo-location where the resource lives.

UPDATE examples

update

No description available.

UPDATE azure_extras.open_energy_platform.energy_services
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes oep resource

DELETE FROM azure_extras.open_energy_platform.energy_services
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
;

Lifecycle Methods

add_partition

Method that gets called if new partition is to be added in a resource.

EXEC azure_extras.open_energy_platform.energy_services.add_partition 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;

remove_partition

Method that gets called if new partition is to be removed from a resource.

EXEC azure_extras.open_energy_platform.energy_services.remove_partition 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;