catalogs

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

Overview

Name	catalogs
Type	Resource
Id	azure.developer_devcenter.catalogs

Fields

The following fields are returned by SELECT queries:

get_catalog

Name	Datatype	Description
name	string	Name of the catalog. Required.

list_catalogs

Name	Datatype	Description
name	string	Name of the catalog. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_catalog	select	project_name, catalog_name, endpoint		Gets the specified catalog within the project.
list_catalogs	select	project_name, endpoint		Lists all of the catalogs available for a project.

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 the catalog. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
project_name	string	Name of the project. Required.

SELECT examples

get_catalog

Gets the specified catalog within the project.

SELECT
name
FROM azure.developer_devcenter.catalogs
WHERE project_name = '{{ project_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_catalogs

Lists all of the catalogs available for a project.

SELECT
name
FROM azure.developer_devcenter.catalogs
WHERE project_name = '{{ project_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;