geo_catalogs

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

Overview

Name	geo_catalogs
Type	Resource
Id	azure.planetary_computer.geo_catalogs

Fields

The following fields are returned by SELECT queries:

get

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.
autoGeneratedDomainNameLabelScope	string	The scope of the auto-generated domain name label. If not provided, defaults to TenantReuse. Known values are: "NoReuse", "TenantReuse", "SubscriptionReuse", and "ResourceGroupReuse". (NoReuse, TenantReuse, SubscriptionReuse, ResourceGroupReuse)
catalogUri	string	The URI of the catalog management UI.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tier	string	Tier of the catalog. This cannot be changed after the catalog is created. If not provided, defaults to Basic. "Basic" (Basic)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
autoGeneratedDomainNameLabelScope	string	The scope of the auto-generated domain name label. If not provided, defaults to TenantReuse. Known values are: "NoReuse", "TenantReuse", "SubscriptionReuse", and "ResourceGroupReuse". (NoReuse, TenantReuse, SubscriptionReuse, ResourceGroupReuse)
catalogUri	string	The URI of the catalog management UI.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tier	string	Tier of the catalog. This cannot be changed after the catalog is created. If not provided, defaults to Basic. "Basic" (Basic)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
autoGeneratedDomainNameLabelScope	string	The scope of the auto-generated domain name label. If not provided, defaults to TenantReuse. Known values are: "NoReuse", "TenantReuse", "SubscriptionReuse", and "ResourceGroupReuse". (NoReuse, TenantReuse, SubscriptionReuse, ResourceGroupReuse)
catalogUri	string	The URI of the catalog management UI.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tier	string	Tier of the catalog. This cannot be changed after the catalog is created. If not provided, defaults to Basic. "Basic" (Basic)
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, catalog_name, subscription_id		Get a GeoCatalog.
list_by_resource_group	select	resource_group_name, subscription_id		List GeoCatalog resources by resource group.
list_by_subscription	select	subscription_id		List GeoCatalog resources by subscription ID.
create	insert	resource_group_name, catalog_name, subscription_id, location		Create a GeoCatalog.
update	update	resource_group_name, catalog_name, subscription_id		Update a GeoCatalog.
delete	delete	resource_group_name, catalog_name, subscription_id		Delete a GeoCatalog.

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.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a GeoCatalog.

SELECT
id,
name,
autoGeneratedDomainNameLabelScope,
catalogUri,
identity,
location,
provisioningState,
systemData,
tags,
tier,
type
FROM azure.planetary_computer.geo_catalogs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List GeoCatalog resources by resource group.

SELECT
id,
name,
autoGeneratedDomainNameLabelScope,
catalogUri,
identity,
location,
provisioningState,
systemData,
tags,
tier,
type
FROM azure.planetary_computer.geo_catalogs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List GeoCatalog resources by subscription ID.

SELECT
id,
name,
autoGeneratedDomainNameLabelScope,
catalogUri,
identity,
location,
provisioningState,
systemData,
tags,
tier,
type
FROM azure.planetary_computer.geo_catalogs
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a GeoCatalog.

INSERT INTO azure.planetary_computer.geo_catalogs (
tags,
location,
properties,
identity,
resource_group_name,
catalog_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ catalog_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: geo_catalogs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the geo_catalogs resource.
  - name: catalog_name
    value: "{{ catalog_name }}"
    description: Required parameter for the geo_catalogs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the geo_catalogs resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      tier: "{{ tier }}"
      catalogUri: "{{ catalogUri }}"
      provisioningState: "{{ provisioningState }}"
      autoGeneratedDomainNameLabelScope: "{{ autoGeneratedDomainNameLabelScope }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a GeoCatalog.

UPDATE azure.planetary_computer.geo_catalogs
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a GeoCatalog.

DELETE FROM azure.planetary_computer.geo_catalogs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;