project_catalogs

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

Overview

Name	project_catalogs
Type	Resource
Id	azure.dev_center.project_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

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, projectName, catalogName		Gets an associated project catalog.
list	select	subscriptionId, resourceGroupName, projectName	$top	Lists the catalogs associated with a project.
create_or_update	insert	subscriptionId, resourceGroupName, projectName, catalogName		Creates or updates a project catalog.
patch	update	subscriptionId, resourceGroupName, projectName, catalogName		Partially updates a project catalog.
delete	delete	subscriptionId, resourceGroupName, projectName, catalogName		Deletes a project catalog resource.
sync	exec	subscriptionId, resourceGroupName, projectName, catalogName		Syncs templates for a template source.
connect	exec	subscriptionId, resourceGroupName, projectName, catalogName		Connects a project 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.
projectName	string	The name of the project.
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 an associated project catalog.

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

list

Lists the catalogs associated with a project.

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

INSERT examples

create_or_update

Creates or updates a project catalog.

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

Manifest

# Description fields are for documentation purposes
- name: project_catalogs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the project_catalogs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the project_catalogs resource.
    - name: projectName
      value: string
      description: Required parameter for the project_catalogs resource.
    - name: catalogName
      value: string
      description: Required parameter for the project_catalogs resource.
    - name: properties
      value: object
      description: |
        Catalog properties.

UPDATE examples

patch

Partially updates a project catalog.

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

DELETE examples

delete

Deletes a project catalog resource.

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

Lifecycle Methods

sync

Syncs templates for a template source.

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

connect

Connects a project catalog to enable syncing.

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