deployments

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

Overview

Name	deployments
Type	Resource
Id	azure.sphere.deployments

Fields

vw_deployments

Name	Datatype	Description
catalogName	text	field from the properties object
deployed_images	text	field from the properties object
deploymentName	text	field from the properties object
deployment_date_utc	text	field from the properties object
deployment_id	text	field from the properties object
deviceGroupName	text	field from the properties object
productName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object

deployments

Name	Datatype	Description
properties	object	The properties of deployment

Methods

Name	Accessible by	Required Params	Description
get	SELECT	catalogName, deploymentName, deviceGroupName, productName, resourceGroupName, subscriptionId	Get a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
list_by_device_group	SELECT	catalogName, deviceGroupName, productName, resourceGroupName, subscriptionId	List Deployment resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
create_or_update	INSERT	catalogName, deploymentName, deviceGroupName, productName, resourceGroupName, subscriptionId	Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
delete	DELETE	catalogName, deploymentName, deviceGroupName, productName, resourceGroupName, subscriptionId	Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

SELECT examples

List Deployment resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

vw_deployments

SELECT
catalogName,
deployed_images,
deploymentName,
deployment_date_utc,
deployment_id,
deviceGroupName,
productName,
provisioning_state,
resourceGroupName,
subscriptionId
FROM azure.sphere.vw_deployments
WHERE catalogName = '{{ catalogName }}'
AND deviceGroupName = '{{ deviceGroupName }}'
AND productName = '{{ productName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

deployments

SELECT
properties
FROM azure.sphere.deployments
WHERE catalogName = '{{ catalogName }}'
AND deviceGroupName = '{{ deviceGroupName }}'
AND productName = '{{ productName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.sphere.deployments (
catalogName,
deploymentName,
deviceGroupName,
productName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ catalogName }}',
'{{ deploymentName }}',
'{{ deviceGroupName }}',
'{{ productName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: deploymentId
          value: string
        - name: deployedImages
          value:
            - - name: properties
                value:
                  - name: image
                    value: string
                  - name: imageId
                    value: string
                  - name: imageName
                    value: string
                  - name: regionalDataBoundary
                    value: []
                  - name: uri
                    value: string
                  - name: description
                    value: string
                  - name: componentId
                    value: string
                  - name: imageType
                    value: []
                  - name: provisioningState
                    value: []
        - name: deploymentDateUtc
          value: string

DELETE example

Deletes the specified deployments resource.

/*+ delete */
DELETE FROM azure.sphere.deployments
WHERE catalogName = '{{ catalogName }}'
AND deploymentName = '{{ deploymentName }}'
AND deviceGroupName = '{{ deviceGroupName }}'
AND productName = '{{ productName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';