services

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

Overview

Name	services
Type	Resource
Id	azure_extras.windows_iot.services

Fields

vw_services

Name	Datatype	Description
admin_domain_name	text	field from the properties object
billing_domain_name	text	field from the properties object
deviceName	text	field from the properties object
etag	text	The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
location	text	The Azure Region where the resource lives
notes	text	field from the properties object
quantity	text	field from the properties object
resourceGroupName	text	field from the properties object
start_date	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

services

Name	Datatype	Description
etag	string	The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
location	string	The Azure Region where the resource lives
properties	object	The properties of a Windows IoT Device Service.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	deviceName, resourceGroupName, subscriptionId	Get the non-security related metadata of a Windows IoT Device Service.
list	SELECT	subscriptionId	Get all the IoT hubs in a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Get all the IoT hubs in a resource group.
create_or_update	INSERT	deviceName, resourceGroupName, subscriptionId	Create or update the metadata of a Windows IoT Device Service. The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service.
delete	DELETE	deviceName, resourceGroupName, subscriptionId	Delete a Windows IoT Device Service.
update	UPDATE	deviceName, resourceGroupName, subscriptionId	Updates the metadata of a Windows IoT Device Service. The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service.
check_device_service_name_availability	EXEC	subscriptionId, data__name	Check if a Windows IoT Device Service name is available.

SELECT examples

Get all the IoT hubs in a subscription.

vw_services

SELECT
admin_domain_name,
billing_domain_name,
deviceName,
etag,
location,
notes,
quantity,
resourceGroupName,
start_date,
subscriptionId,
tags
FROM azure_extras.windows_iot.vw_services
WHERE subscriptionId = '{{ subscriptionId }}';

services

SELECT
etag,
location,
properties,
tags
FROM azure_extras.windows_iot.services
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new services resource.

All Properties

/*+ create */
INSERT INTO azure_extras.windows_iot.services (
deviceName,
resourceGroupName,
subscriptionId,
etag,
properties,
tags,
location
)
SELECT 
'{{ deviceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ etag }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: etag
      value: string
    - name: properties
      value:
        - name: notes
          value: string
        - name: startDate
          value: string
        - name: quantity
          value: integer
        - name: billingDomainName
          value: string
        - name: adminDomainName
          value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a services resource.

/*+ update */
UPDATE azure_extras.windows_iot.services
SET 
etag = '{{ etag }}',
properties = '{{ properties }}',
tags = '{{ tags }}',
location = '{{ location }}'
WHERE 
deviceName = '{{ deviceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified services resource.

/*+ delete */
DELETE FROM azure_extras.windows_iot.services
WHERE deviceName = '{{ deviceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';