catalogs

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

Overview

Name	catalogs
Type	Resource
Id	azure.dev_center.catalogs

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	Catalog properties.
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_dev_center

OK. The request has succeeded.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	Catalog properties.
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	subscriptionId, resourceGroupName, devCenterName, catalogName		Gets a catalog
list_by_dev_center	select	subscriptionId, resourceGroupName, devCenterName	$top	Lists catalogs for a devcenter.
create_or_update	insert	subscriptionId, resourceGroupName, devCenterName, catalogName		Creates or updates a catalog.
update	update	subscriptionId, resourceGroupName, devCenterName, catalogName		Partially updates a catalog.
delete	delete	subscriptionId, resourceGroupName, devCenterName, catalogName		Deletes a catalog resource.
sync	exec	subscriptionId, resourceGroupName, devCenterName, catalogName		Syncs templates for a template source.
connect	exec	subscriptionId, resourceGroupName, devCenterName, catalogName		Connects a catalog to enable syncing.

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	The name of the Catalog.
devCenterName	string	The name of the devcenter.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$top	integer (int32)	The maximum number of resources to return from the operation. Example: '$top=10'.

SELECT examples

get

Gets a catalog

SELECT
id,
name,
properties,
systemData,
type
FROM azure.dev_center.catalogs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND devCenterName = '{{ devCenterName }}' -- required
AND catalogName = '{{ catalogName }}' -- required
;

list_by_dev_center

Lists catalogs for a devcenter.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.dev_center.catalogs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND devCenterName = '{{ devCenterName }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a catalog.

INSERT INTO azure.dev_center.catalogs (
data__properties,
subscriptionId,
resourceGroupName,
devCenterName,
catalogName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ devCenterName }}',
'{{ catalogName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

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: devCenterName
      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: |
        Catalog properties.

UPDATE examples

update

Partially updates a catalog.

UPDATE azure.dev_center.catalogs
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND devCenterName = '{{ devCenterName }}' --required
AND catalogName = '{{ catalogName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a catalog resource.

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

Lifecycle Methods

sync

Syncs templates for a template source.

EXEC azure.dev_center.catalogs.sync 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@devCenterName='{{ devCenterName }}' --required, 
@catalogName='{{ catalogName }}' --required
;

connect

Connects a catalog to enable syncing.

EXEC azure.dev_center.catalogs.connect 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@devCenterName='{{ devCenterName }}' --required, 
@catalogName='{{ catalogName }}' --required
;