catalogs

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

Overview

Name	catalogs
Type	Resource
Id	azure.dev_center.catalogs

Fields

vw_catalogs

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	text	The name of the resource
ado_git	text	field from the properties object
catalogName	text	field from the properties object
connection_state	text	field from the properties object
devCenterName	text	field from the properties object
git_hub	text	field from the properties object
last_connection_time	text	field from the properties object
last_sync_stats	text	field from the properties object
last_sync_time	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
sync_state	text	field from the properties object
sync_type	text	field from the properties object
system_data	text	field from the properties object
tags	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

catalogs

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Properties of a catalog.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	catalogName, devCenterName, resourceGroupName, subscriptionId	Gets a catalog
list_by_dev_center	SELECT	devCenterName, resourceGroupName, subscriptionId	Lists catalogs for a devcenter.
create_or_update	INSERT	catalogName, devCenterName, resourceGroupName, subscriptionId	Creates or updates a catalog.
delete	DELETE	catalogName, devCenterName, resourceGroupName, subscriptionId	Deletes a catalog resource.
update	UPDATE	catalogName, devCenterName, resourceGroupName, subscriptionId	Partially updates a catalog.
connect	EXEC	catalogName, devCenterName, resourceGroupName, subscriptionId	Connects a catalog to enable syncing.
sync	EXEC	catalogName, devCenterName, resourceGroupName, subscriptionId	Syncs templates for a template source.

SELECT examples

Lists catalogs for a devcenter.

vw_catalogs

SELECT
id,
name,
ado_git,
catalogName,
connection_state,
devCenterName,
git_hub,
last_connection_time,
last_sync_stats,
last_sync_time,
provisioning_state,
resourceGroupName,
subscriptionId,
sync_state,
sync_type,
system_data,
tags,
type
FROM azure.dev_center.vw_catalogs
WHERE devCenterName = '{{ devCenterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

catalogs

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

INSERT example

Use the following StackQL query and manifest file to create a new catalogs resource.

All Properties

/*+ create */
INSERT INTO azure.dev_center.catalogs (
catalogName,
devCenterName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ catalogName }}',
'{{ devCenterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: properties
      value:
        - name: gitHub
          value:
            - name: uri
              value: string
            - name: branch
              value: string
            - name: secretIdentifier
              value: string
            - name: path
              value: string
        - name: syncType
          value: string
        - name: tags
          value: object
        - name: provisioningState
          value: []
        - name: syncState
          value: string
        - name: lastSyncStats
          value:
            - name: added
              value: integer
            - name: updated
              value: integer
            - name: unchanged
              value: integer
            - name: removed
              value: integer
            - name: validationErrors
              value: integer
            - name: synchronizationErrors
              value: integer
            - name: syncedCatalogItemTypes
              value:
                - []
        - name: connectionState
          value: string
        - name: lastConnectionTime
          value: string
        - name: lastSyncTime
          value: string

UPDATE example

Updates a catalogs resource.

/*+ update */
UPDATE azure.dev_center.catalogs
SET 
properties = '{{ properties }}'
WHERE 
catalogName = '{{ catalogName }}'
AND devCenterName = '{{ devCenterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified catalogs resource.

/*+ delete */
DELETE FROM azure.dev_center.catalogs
WHERE catalogName = '{{ catalogName }}'
AND devCenterName = '{{ devCenterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';