apps

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

Overview

Name	apps
Type	Resource
Id	azure.iot_central.apps

Fields

vw_apps

Name	Datatype	Description
application_id	text	field from the properties object
display_name	text	field from the properties object
identity	text	Managed service identity (either system assigned, or none)
location	text	The geo-location where the resource lives
network_rule_sets	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
resourceGroupName	text	field from the properties object
resourceName	text	field from the properties object
sku	text	Information about the SKU of the IoT Central application.
state	text	field from the properties object
subdomain	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
template	text	field from the properties object

apps

Name	Datatype	Description
identity	object	Managed service identity (either system assigned, or none)
location	string	The geo-location where the resource lives
properties	object	The properties of an IoT Central application.
sku	object	Information about the SKU of the IoT Central application.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, resourceName, subscriptionId	Get the metadata of an IoT Central application.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Get all the IoT Central Applications in a resource group.
list_by_subscription	SELECT	subscriptionId	Get all IoT Central Applications in a subscription.
create_or_update	INSERT	resourceGroupName, resourceName, subscriptionId, data__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	resourceGroupName, resourceName, subscriptionId	Delete an IoT Central application.
update	UPDATE	resourceGroupName, resourceName, subscriptionId	Update the metadata of an IoT Central application.
check_name_availability	EXEC	subscriptionId, data__name	Check if an IoT Central application name is available.
check_subdomain_availability	EXEC	subscriptionId, data__name	Check if an IoT Central application subdomain is available.

SELECT examples

Get all IoT Central Applications in a subscription.

vw_apps

SELECT
application_id,
display_name,
identity,
location,
network_rule_sets,
private_endpoint_connections,
provisioning_state,
public_network_access,
resourceGroupName,
resourceName,
sku,
state,
subdomain,
subscriptionId,
tags,
template
FROM azure.iot_central.vw_apps
WHERE subscriptionId = '{{ subscriptionId }}';

apps

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.iot_central.apps
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.iot_central.apps (
resourceGroupName,
resourceName,
subscriptionId,
data__sku,
properties,
sku,
identity,
tags,
location
)
SELECT 
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ data__sku }}',
'{{ properties }}',
'{{ sku }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: provisioningState
          value: []
        - name: applicationId
          value: string
        - name: displayName
          value: string
        - name: subdomain
          value: string
        - name: template
          value: string
        - name: state
          value: []
        - name: publicNetworkAccess
          value: []
        - name: networkRuleSets
          value:
            - name: applyToDevices
              value: boolean
            - name: applyToIoTCentral
              value: boolean
            - name: defaultAction
              value: []
            - name: ipRules
              value:
                - - name: action
                    value: string
                  - name: filterName
                    value: string
                  - name: ipMask
                    value: string
        - name: privateEndpointConnections
          value:
            - - name: properties
                value:
                  - name: groupIds
                    value:
                      - string
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: []
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: []
              - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: systemData
                value:
                  - name: createdBy
                    value: string
                  - name: createdByType
                    value: string
                  - name: createdAt
                    value: string
                  - name: lastModifiedBy
                    value: string
                  - name: lastModifiedByType
                    value: string
                  - name: lastModifiedAt
                    value: string
    - name: sku
      value:
        - name: name
          value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a apps resource.

/*+ update */
UPDATE azure.iot_central.apps
SET 
tags = '{{ tags }}',
sku = '{{ sku }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified apps resource.

/*+ delete */
DELETE FROM azure.iot_central.apps
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';