catalogs

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

Overview

Name	catalogs
Type	Resource
Id	azure_extras.sphere.catalogs

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.
location	string	The geo-location where the resource lives. Required.
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.
tags	object	Resource tags.
tenantId	string	The Azure Sphere tenant ID associated with the catalog.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_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.
location	string	The geo-location where the resource lives. Required.
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.
tags	object	Resource tags.
tenantId	string	The Azure Sphere tenant ID associated with the catalog.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
location	string	The geo-location where the resource lives. Required.
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.
tags	object	Resource tags.
tenantId	string	The Azure Sphere tenant ID associated with the catalog.
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, subscription_id		Get a Catalog.
list_by_resource_group	select	resource_group_name, subscription_id		List Catalog resources by resource group.
list_by_subscription	select	subscription_id		List Catalog resources by subscription ID.
create_or_update	insert	resource_group_name, catalog_name, subscription_id, location		Create a Catalog.
update	update	resource_group_name, catalog_name, subscription_id		Update a Catalog.
create_or_update	replace	resource_group_name, catalog_name, subscription_id, location		Create a Catalog.
delete	delete	resource_group_name, catalog_name, subscription_id		Delete a Catalog.
list_deployments	exec	resource_group_name, catalog_name, subscription_id	$filter, $top, $skip, $maxpagesize	Lists deployments for catalog.
list_device_groups	exec	resource_group_name, catalog_name, subscription_id	$filter, $top, $skip, $maxpagesize	List the device groups for the catalog.
list_device_insights	exec	resource_group_name, catalog_name, subscription_id	$filter, $top, $skip, $maxpagesize	Lists device insights for catalog.
list_devices	exec	resource_group_name, catalog_name, subscription_id	$filter, $top, $skip, $maxpagesize	Lists devices for catalog.
count_devices	exec	resource_group_name, catalog_name, subscription_id		Counts devices in catalog.
upload_image	exec	resource_group_name, catalog_name, subscription_id		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
catalog_name	string	Name of catalog. 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 Catalog.

SELECT
id,
name,
location,
provisioningState,
systemData,
tags,
tenantId,
type
FROM azure_extras.sphere.catalogs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List Catalog resources by resource group.

SELECT
id,
name,
location,
provisioningState,
systemData,
tags,
tenantId,
type
FROM azure_extras.sphere.catalogs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List Catalog resources by subscription ID.

SELECT
id,
name,
location,
provisioningState,
systemData,
tags,
tenantId,
type
FROM azure_extras.sphere.catalogs
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a Catalog.

INSERT INTO azure_extras.sphere.catalogs (
tags,
location,
properties,
resource_group_name,
catalog_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ catalog_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: catalogs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the catalogs resource.
  - name: catalog_name
    value: "{{ catalog_name }}"
    description: Required parameter for the catalogs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the catalogs resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      tenantId: "{{ tenantId }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a Catalog.

UPDATE azure_extras.sphere.catalogs
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a Catalog.

REPLACE azure_extras.sphere.catalogs
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Catalog.

DELETE FROM azure_extras.sphere.catalogs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_deployments

Lists deployments for catalog.

EXEC azure_extras.sphere.catalogs.list_deployments 
@resource_group_name='{{ resource_group_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$filter='{{ $filter }}', 
@$top='{{ $top }}', 
@$skip='{{ $skip }}', 
@$maxpagesize='{{ $maxpagesize }}'
;

list_device_groups

List the device groups for the catalog.

EXEC azure_extras.sphere.catalogs.list_device_groups 
@resource_group_name='{{ resource_group_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$filter='{{ $filter }}', 
@$top='{{ $top }}', 
@$skip='{{ $skip }}', 
@$maxpagesize='{{ $maxpagesize }}' 
@@json=
'{
"deviceGroupName": "{{ deviceGroupName }}"
}'
;

list_device_insights

Lists device insights for catalog.

EXEC azure_extras.sphere.catalogs.list_device_insights 
@resource_group_name='{{ resource_group_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$filter='{{ $filter }}', 
@$top='{{ $top }}', 
@$skip='{{ $skip }}', 
@$maxpagesize='{{ $maxpagesize }}'
;

list_devices

Lists devices for catalog.

EXEC azure_extras.sphere.catalogs.list_devices 
@resource_group_name='{{ resource_group_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$filter='{{ $filter }}', 
@$top='{{ $top }}', 
@$skip='{{ $skip }}', 
@$maxpagesize='{{ $maxpagesize }}'
;

count_devices

Counts devices in catalog.

EXEC azure_extras.sphere.catalogs.count_devices 
@resource_group_name='{{ resource_group_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

upload_image

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

EXEC azure_extras.sphere.catalogs.upload_image 
@resource_group_name='{{ resource_group_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;