deployments

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

Overview

Name	deployments
Type	Resource
Id	azure_extras.sphere.deployments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
deployedImages	array	Images deployed.
deploymentDateUtc	string (date-time)	Deployment date UTC.
deploymentId	string	Deployment ID.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_device_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
deployedImages	array	Images deployed.
deploymentDateUtc	string (date-time)	Deployment date UTC.
deploymentId	string	Deployment ID.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, catalog_name, product_name, device_group_name, deployment_name, subscription_id		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	resource_group_name, catalog_name, product_name, device_group_name, subscription_id	$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	resource_group_name, catalog_name, product_name, device_group_name, deployment_name, subscription_id		Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
create_or_update	replace	resource_group_name, catalog_name, product_name, device_group_name, deployment_name, subscription_id		Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
delete	delete	resource_group_name, catalog_name, product_name, device_group_name, deployment_name, subscription_id		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
catalog_name	string	Name of catalog. Required.
deployment_name	string	Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group. Required.
device_group_name	string	Name of device group. Required.
product_name	string	Name of product. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	Filter the result list using the given expression. Default value is None.
$maxpagesize	integer	The maximum number of result items per page. Default value is None.
$skip	integer	The number of result items to skip. Default value is None.
$top	integer	The number of result items to return. Default value is None.

SELECT examples

get

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

SELECT
id,
name,
deployedImages,
deploymentDateUtc,
deploymentId,
provisioningState,
systemData,
type
FROM azure_extras.sphere.deployments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND product_name = '{{ product_name }}' -- required
AND device_group_name = '{{ device_group_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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
id,
name,
deployedImages,
deploymentDateUtc,
deploymentId,
provisioningState,
systemData,
type
FROM azure_extras.sphere.deployments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND product_name = '{{ product_name }}' -- required
AND device_group_name = '{{ device_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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_extras.sphere.deployments (
properties,
resource_group_name,
catalog_name,
product_name,
device_group_name,
deployment_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ catalog_name }}',
'{{ product_name }}',
'{{ device_group_name }}',
'{{ deployment_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: deployments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the deployments resource.
  - name: catalog_name
    value: "{{ catalog_name }}"
    description: Required parameter for the deployments resource.
  - name: product_name
    value: "{{ product_name }}"
    description: Required parameter for the deployments resource.
  - name: device_group_name
    value: "{{ device_group_name }}"
    description: Required parameter for the deployments resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the deployments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the deployments resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      deploymentId: "{{ deploymentId }}"
      deployedImages:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            image: "{{ image }}"
            imageId: "{{ imageId }}"
            imageName: "{{ imageName }}"
            regionalDataBoundary: "{{ regionalDataBoundary }}"
            uri: "{{ uri }}"
            description: "{{ description }}"
            componentId: "{{ componentId }}"
            imageType: "{{ imageType }}"
            provisioningState: "{{ provisioningState }}"
      deploymentDateUtc: "{{ deploymentDateUtc }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

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

REPLACE azure_extras.sphere.deployments
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND product_name = '{{ product_name }}' --required
AND device_group_name = '{{ device_group_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

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_extras.sphere.deployments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND product_name = '{{ product_name }}' --required
AND device_group_name = '{{ device_group_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;