catalogs

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

Overview

Name	catalogs
Type	Resource
Id	azure.devcenter.catalogs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
adoGit	object	Properties for an Azure DevOps catalog type.
connectionState	string	The connection state of the catalog. Known values are: "Connected" and "Disconnected".
gitHub	object	Properties for a GitHub catalog type.
lastConnectionTime	string (date-time)	When the catalog was last connected.
lastSyncStats	object	Stats of the latest synchronization.
lastSyncTime	string (date-time)	When the catalog was last synced.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
syncState	string	The synchronization state of the catalog. Known values are: "Succeeded", "InProgress", "Failed", and "Canceled".
syncType	string	Indicates the type of sync that is configured for the catalog. Known values are: "Manual" and "Scheduled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_dev_center

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
adoGit	object	Properties for an Azure DevOps catalog type.
connectionState	string	The connection state of the catalog. Known values are: "Connected" and "Disconnected".
gitHub	object	Properties for a GitHub catalog type.
lastConnectionTime	string (date-time)	When the catalog was last connected.
lastSyncStats	object	Stats of the latest synchronization.
lastSyncTime	string (date-time)	When the catalog was last synced.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
syncState	string	The synchronization state of the catalog. Known values are: "Succeeded", "InProgress", "Failed", and "Canceled".
syncType	string	Indicates the type of sync that is configured for the catalog. Known values are: "Manual" and "Scheduled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, dev_center_name, catalog_name, subscription_id		Gets a catalog.
list_by_dev_center	select	resource_group_name, dev_center_name, subscription_id	$top	Lists catalogs for a devcenter.
create_or_update	insert	resource_group_name, dev_center_name, catalog_name, subscription_id		Creates or updates a catalog.
update	update	resource_group_name, dev_center_name, catalog_name, subscription_id		Partially updates a catalog.
create_or_update	replace	resource_group_name, dev_center_name, catalog_name, subscription_id		Creates or updates a catalog.
delete	delete	resource_group_name, dev_center_name, catalog_name, subscription_id		Deletes a catalog resource.
get_sync_error_details	exec	resource_group_name, dev_center_name, catalog_name, subscription_id		Gets catalog synchronization error details.
sync	exec	resource_group_name, dev_center_name, catalog_name, subscription_id		Syncs templates for a template source.
connect	exec	resource_group_name, dev_center_name, catalog_name, subscription_id		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
catalog_name	string	The name of the Catalog. Required.
dev_center_name	string	The name of the devcenter. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Gets a catalog.

SELECT
id,
name,
adoGit,
connectionState,
gitHub,
lastConnectionTime,
lastSyncStats,
lastSyncTime,
provisioningState,
syncState,
syncType,
systemData,
tags,
type
FROM azure.devcenter.catalogs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dev_center_name = '{{ dev_center_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_dev_center

Lists catalogs for a devcenter.

SELECT
id,
name,
adoGit,
connectionState,
gitHub,
lastConnectionTime,
lastSyncStats,
lastSyncTime,
provisioningState,
syncState,
syncType,
systemData,
tags,
type
FROM azure.devcenter.catalogs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dev_center_name = '{{ dev_center_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a catalog.

INSERT INTO azure.devcenter.catalogs (
properties,
resource_group_name,
dev_center_name,
catalog_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ dev_center_name }}',
'{{ catalog_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
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: dev_center_name
    value: "{{ dev_center_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: properties
    value:
      gitHub:
        uri: "{{ uri }}"
        branch: "{{ branch }}"
        secretIdentifier: "{{ secretIdentifier }}"
        path: "{{ path }}"
      adoGit:
        uri: "{{ uri }}"
        branch: "{{ branch }}"
        secretIdentifier: "{{ secretIdentifier }}"
        path: "{{ path }}"
      syncType: "{{ syncType }}"
      tags: "{{ tags }}"

UPDATE examples

update

Partially updates a catalog.

UPDATE azure.devcenter.catalogs
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dev_center_name = '{{ dev_center_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates a catalog.

REPLACE azure.devcenter.catalogs
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dev_center_name = '{{ dev_center_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a catalog resource.

DELETE FROM azure.devcenter.catalogs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dev_center_name = '{{ dev_center_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_sync_error_details

Gets catalog synchronization error details.

EXEC azure.devcenter.catalogs.get_sync_error_details 
@resource_group_name='{{ resource_group_name }}' --required, 
@dev_center_name='{{ dev_center_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

sync

Syncs templates for a template source.

EXEC azure.devcenter.catalogs.sync 
@resource_group_name='{{ resource_group_name }}' --required, 
@dev_center_name='{{ dev_center_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

connect

Connects a catalog to enable syncing.

EXEC azure.devcenter.catalogs.connect 
@resource_group_name='{{ resource_group_name }}' --required, 
@dev_center_name='{{ dev_center_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;