apps

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

Overview

Name	apps
Type	Resource
Id	azure_extras.iot_central.apps

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The ARM resource identifier.
name	string	The ARM resource name.
applicationId	string	The ID of the application.
displayName	string	The display name of the application.
identity	object	The managed identities for the IoT Central application.
location	string	The resource location. Required.
sku	object	A valid instance SKU. Required.
state	string	The current state of the application. Known values are: "created" and "suspended".
subdomain	string	The subdomain of the application.
tags	object	The resource tags.
template	string	The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.
type	string	The resource type.

list_by_resource_group

Name	Datatype	Description
id	string	The ARM resource identifier.
name	string	The ARM resource name.
applicationId	string	The ID of the application.
displayName	string	The display name of the application.
identity	object	The managed identities for the IoT Central application.
location	string	The resource location. Required.
sku	object	A valid instance SKU. Required.
state	string	The current state of the application. Known values are: "created" and "suspended".
subdomain	string	The subdomain of the application.
tags	object	The resource tags.
template	string	The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.
type	string	The resource type.

check_name_availability

Name	Datatype	Description
message	string	The detailed reason message.
nameAvailable	boolean	The value which indicates whether the provided name is available.
reason	string	The reason for unavailability.

list_by_subscription

Name	Datatype	Description
id	string	The ARM resource identifier.
name	string	The ARM resource name.
applicationId	string	The ID of the application.
displayName	string	The display name of the application.
identity	object	The managed identities for the IoT Central application.
location	string	The resource location. Required.
sku	object	A valid instance SKU. Required.
state	string	The current state of the application. Known values are: "created" and "suspended".
subdomain	string	The subdomain of the application.
tags	object	The resource tags.
template	string	The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, subscription_id		Get the metadata of an IoT Central application.
list_by_resource_group	select	resource_group_name, subscription_id		Get all the IoT Central Applications in a resource group.
check_name_availability	select	subscription_id		Check if an IoT Central application name is available.
list_by_subscription	select	subscription_id		Get all IoT Central Applications in a subscription.
create_or_update	insert	resource_group_name, resource_name, subscription_id, location, sku		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	resource_group_name, resource_name, subscription_id		Update the metadata of an IoT Central application.
create_or_update	replace	resource_group_name, resource_name, subscription_id, location, sku		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.
delete	delete	resource_group_name, resource_name, subscription_id		Delete an IoT Central application.
list_templates	exec	subscription_id		Get all available application templates.
check_subdomain_availability	exec	subscription_id, name		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
resource_group_name	string	The name of the resource group that contains the IoT Central application. Required.
resource_name	string	The ARM resource name of the IoT Central application. Required.
subscription_id	string

SELECT examples

get

Get the metadata of an IoT Central application.

SELECT
id,
name,
applicationId,
displayName,
identity,
location,
sku,
state,
subdomain,
tags,
template,
type
FROM azure_extras.iot_central.apps
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get all the IoT Central Applications in a resource group.

SELECT
id,
name,
applicationId,
displayName,
identity,
location,
sku,
state,
subdomain,
tags,
template,
type
FROM azure_extras.iot_central.apps
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

check_name_availability

Check if an IoT Central application name is available.

SELECT
message,
nameAvailable,
reason
FROM azure_extras.iot_central.apps
WHERE subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Get all IoT Central Applications in a subscription.

SELECT
id,
name,
applicationId,
displayName,
identity,
location,
sku,
state,
subdomain,
tags,
template,
type
FROM azure_extras.iot_central.apps
WHERE subscription_id = '{{ subscription_id }}' -- required
;

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_extras.iot_central.apps (
location,
tags,
sku,
identity,
properties,
resource_group_name,
resource_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ sku }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: apps
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the apps resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the apps resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the apps resource.
  - name: location
    value: "{{ location }}"
    description: |
      The resource location. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      The resource tags.
  - name: sku
    description: |
      A valid instance SKU. Required.
    value:
      name: "{{ name }}"
  - name: identity
    description: |
      The managed identities for the IoT Central application.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
  - name: properties
    value:
      displayName: "{{ displayName }}"
      subdomain: "{{ subdomain }}"
      template: "{{ template }}"

UPDATE examples

update

Update the metadata of an IoT Central application.

UPDATE azure_extras.iot_central.apps
SET 
tags = '{{ tags }}',
sku = '{{ sku }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
tags,
type;

REPLACE 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.

REPLACE azure_extras.iot_central.apps
SET 
location = '{{ location }}',
tags = '{{ tags }}',
sku = '{{ sku }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND sku = '{{ sku }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Delete an IoT Central application.

DELETE FROM azure_extras.iot_central.apps
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_templates

Get all available application templates.

EXEC azure_extras.iot_central.apps.list_templates 
@subscription_id='{{ subscription_id }}' --required
;

check_subdomain_availability

Check if an IoT Central application subdomain is available.

EXEC azure_extras.iot_central.apps.check_subdomain_availability 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;