catalogs

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

Overview

Name	catalogs
Type	Resource
Id	azure.sphere.catalogs

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, catalogName		Get a Catalog
list_by_resource_group	select	subscriptionId, resourceGroupName		List Catalog resources by resource group
list_by_subscription	select	subscriptionId		List Catalog resources by subscription ID
create_or_update	insert	subscriptionId, resourceGroupName, catalogName		Create a Catalog
update	update	subscriptionId, resourceGroupName, catalogName		Update a Catalog
delete	delete	subscriptionId, resourceGroupName, catalogName		Delete a Catalog
count_devices	exec	subscriptionId, resourceGroupName, catalogName		Counts devices in catalog.
upload_image	exec	subscriptionId, resourceGroupName, catalogName		Creates an image. Use this action when the image ID is unknown.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get a Catalog

SELECT
location,
properties,
tags
FROM azure.sphere.catalogs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND catalogName = '{{ catalogName }}' -- required
;

list_by_resource_group

List Catalog resources by resource group

SELECT
location,
properties,
tags
FROM azure.sphere.catalogs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List Catalog resources by subscription ID

SELECT
location,
properties,
tags
FROM azure.sphere.catalogs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a Catalog

INSERT INTO azure.sphere.catalogs (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
catalogName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ catalogName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: catalogs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the catalogs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the catalogs resource.
    - name: catalogName
      value: string
      description: Required parameter for the catalogs resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a Catalog

UPDATE azure.sphere.catalogs
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND catalogName = '{{ catalogName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete a Catalog

DELETE FROM azure.sphere.catalogs
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND catalogName = '{{ catalogName }}' --required
;

Lifecycle Methods

count_devices

Counts devices in catalog.

EXEC azure.sphere.catalogs.count_devices 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@catalogName='{{ catalogName }}' --required
;

upload_image

Creates an image. Use this action when the image ID is unknown.

EXEC azure.sphere.catalogs.upload_image 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@catalogName='{{ catalogName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;