apps

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

Overview

Name	apps
Type	Resource
Id	azure.iot_central.apps

Fields

The following fields are returned by SELECT queries:

get

The body contains all the non-security properties of the IoT Central application. Security-related properties are set to null.

Name	Datatype	Description
identity	object	The managed identities for the IoT Central application.
location	string	The geo-location where the resource lives
properties	object	The common properties of an IoT Central application.
sku	object	A valid instance SKU.
tags	object	Resource tags.

list_by_resource_group

This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT Central Applications in the resource group.

Name	Datatype	Description
identity	object	The managed identities for the IoT Central application.
location	string	The geo-location where the resource lives
properties	object	The common properties of an IoT Central application.
sku	object	A valid instance SKU.
tags	object	Resource tags.

list_by_subscription

This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT Central Applications in the subscription.

Name	Datatype	Description
identity	object	The managed identities for the IoT Central application.
location	string	The geo-location where the resource lives
properties	object	The common properties of an IoT Central application.
sku	object	A valid instance SKU.
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, resourceName	api-version	Get the metadata of an IoT Central application.
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version	Get all the IoT Central Applications in a resource group.
list_by_subscription	select	subscriptionId	api-version	Get all IoT Central Applications in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName, data__sku	api-version	Create or update the metadata of an IoT Central application. The usual pattern to modify a property is to retrieve the IoT Central application metadata and security metadata, and then combine them with the modified values in a new body to update the IoT Central application.
update	update	subscriptionId, resourceGroupName, resourceName	api-version	Update the metadata of an IoT Central application.
delete	delete	subscriptionId, resourceGroupName, resourceName	api-version	Delete an IoT Central application.
check_name_availability	exec	subscriptionId, name	api-version	Check if an IoT Central application name is available.
check_subdomain_availability	exec	subscriptionId, name	api-version	Check if an IoT Central application subdomain is available.

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 that contains the IoT Central application.
resourceName	string	The ARM resource name of the IoT Central application.
subscriptionId	string	The subscription identifier.
api-version	string	The version of the API.

SELECT examples

get

Get the metadata of an IoT Central application.

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.iot_central.apps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

Get all the IoT Central Applications in a resource group.

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.iot_central.apps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_subscription

Get all IoT Central Applications in a subscription.

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.iot_central.apps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Create or update the metadata of an IoT Central application. The usual pattern to modify a property is to retrieve the IoT Central application metadata and security metadata, and then combine them with the modified values in a new body to update the IoT Central application.

INSERT INTO azure.iot_central.apps (
data__properties,
data__sku,
data__identity,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
resourceName,
api-version
)
SELECT 
'{{ properties }}',
'{{ sku }}' /* required */,
'{{ identity }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ api-version }}'
RETURNING
identity,
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: apps
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the apps resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the apps resource.
    - name: resourceName
      value: string
      description: Required parameter for the apps resource.
    - name: properties
      value: object
      description: |
        The common properties of an IoT Central application.
    - name: sku
      value: object
      description: |
        A valid instance SKU.
    - name: identity
      value: object
      description: |
        The managed identities for the IoT Central application.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: api-version
      value: string
      description: The version of the API.

UPDATE examples

update

Update the metadata of an IoT Central application.

UPDATE azure.iot_central.apps
SET 
data__tags = '{{ tags }}',
data__sku = '{{ sku }}',
data__properties = '{{ properties }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND api-version = '{{ api-version}}';

DELETE examples

delete

Delete an IoT Central application.

DELETE FROM azure.iot_central.apps
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

check_name_availability

Check if an IoT Central application name is available.

EXEC azure.iot_central.apps.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;

check_subdomain_availability

Check if an IoT Central application subdomain is available.

EXEC azure.iot_central.apps.check_subdomain_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;