deployments

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

Overview

Name	deployments
Type	Resource
Id	azure.sphere.deployments

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list_by_device_group

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName, deploymentName		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	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName	$filter, $top, $skip, $maxpagesize	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	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName, deploymentName		Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
delete	delete	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName, deploymentName		Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

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
catalogName	string	Name of catalog
deploymentName	string	Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.
deviceGroupName	string	Name of device group.
productName	string	Name of product.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$filter	string	Filter the result list using the given expression
$maxpagesize	integer (int32)	The maximum number of result items per page.
$skip	integer (int32)	The number of result items to skip.
$top	integer (int32)	The number of result items to return.

SELECT examples

get

Get a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

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

list_by_device_group

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

SELECT
properties
FROM azure.sphere.deployments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND catalogName = '{{ catalogName }}' -- required
AND productName = '{{ productName }}' -- required
AND deviceGroupName = '{{ deviceGroupName }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND $maxpagesize = '{{ $maxpagesize }}'
;

INSERT examples

create_or_update

Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

INSERT INTO azure.sphere.deployments (
data__properties,
subscriptionId,
resourceGroupName,
catalogName,
productName,
deviceGroupName,
deploymentName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ catalogName }}',
'{{ productName }}',
'{{ deviceGroupName }}',
'{{ deploymentName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: deployments
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the deployments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the deployments resource.
    - name: catalogName
      value: string
      description: Required parameter for the deployments resource.
    - name: productName
      value: string
      description: Required parameter for the deployments resource.
    - name: deviceGroupName
      value: string
      description: Required parameter for the deployments resource.
    - name: deploymentName
      value: string
      description: Required parameter for the deployments resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

DELETE examples

delete

Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

DELETE FROM azure.sphere.deployments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND catalogName = '{{ catalogName }}' --required
AND productName = '{{ productName }}' --required
AND deviceGroupName = '{{ deviceGroupName }}' --required
AND deploymentName = '{{ deploymentName }}' --required
;