GeoCatalogs - List By Resource Group

Service:: Planetary Computer

API Version:: 2025-02-11-preview

List GeoCatalog resources by resource group

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/geoCatalogs?api-version=2025-02-11-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	GeoCatalogListResult	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

GeoCatalogs_ListByResourceGroup

Sample request

GET https://management.azure.com/subscriptions/cd9b6cdf-dcf0-4dca-ab19-82be07b74704/resourceGroups/MyResourceGroup/providers/Microsoft.Orbital/geoCatalogs?api-version=2025-02-11-preview


/**
 * Samples for GeoCatalogs ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-02-11-preview/GeoCatalogs_ListByResourceGroup.json
     */
    /**
     * Sample code: GeoCatalogs_ListByResourceGroup.
     * 
     * @param manager Entry point to PlanetaryComputerManager.
     */
    public static void
        geoCatalogsListByResourceGroup(com.azure.resourcemanager.planetarycomputer.PlanetaryComputerManager manager) {
        manager.geoCatalogs().listByResourceGroup("MyResourceGroup", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.planetarycomputer import PlanetaryComputerMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-planetarycomputer
# USAGE
    python geo_catalogs_list_by_resource_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PlanetaryComputerMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.geo_catalogs.list_by_resource_group(
        resource_group_name="MyResourceGroup",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-02-11-preview/GeoCatalogs_ListByResourceGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armplanetarycomputer_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/planetarycomputer/armplanetarycomputer"
)

// Generated from example definition: 2025-02-11-preview/GeoCatalogs_ListByResourceGroup.json
func ExampleGeoCatalogsClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armplanetarycomputer.NewClientFactory("cd9b6cdf-dcf0-4dca-ab19-82be07b74704", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewGeoCatalogsClient().NewListByResourceGroupPager("MyResourceGroup", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armplanetarycomputer.GeoCatalogsClientListByResourceGroupResponse{
		// 	GeoCatalogListResult: armplanetarycomputer.GeoCatalogListResult{
		// 		Value: []*armplanetarycomputer.GeoCatalog{
		// 			{
		// 				Properties: &armplanetarycomputer.GeoCatalogProperties{
		// 					Tier: to.Ptr(armplanetarycomputer.CatalogTierBasic),
		// 					CatalogURI: to.Ptr("https://mycatalog-0123456789abcdef.geocatalog.spatio.azure.com/"),
		// 					ProvisioningState: to.Ptr(armplanetarycomputer.ProvisioningStateSucceeded),
		// 					AutoGeneratedDomainNameLabelScope: to.Ptr(armplanetarycomputer.AutoGeneratedDomainNameLabelScopeNoReuse),
		// 				},
		// 				Identity: &armplanetarycomputer.ManagedServiceIdentity{
		// 					Type: to.Ptr(armplanetarycomputer.ManagedServiceIdentityTypeUserAssigned),
		// 					UserAssignedIdentities: map[string]*armplanetarycomputer.UserAssignedIdentity{
		// 						"/subscriptions/cd9b6cdf-dcf0-4dca-ab19-82be07b74704/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyManagedIdentity": &armplanetarycomputer.UserAssignedIdentity{
		// 							PrincipalID: to.Ptr("1b1424a8-4d17-4a72-b47f-d1d401c1e2fd"),
		// 							ClientID: to.Ptr("c57c7b17-2c5e-4996-8169-c74d026ffc5d"),
		// 						},
		// 					},
		// 				},
		// 				Tags: map[string]*string{
		// 					"MyTag": to.Ptr("MyValue"),
		// 				},
		// 				Location: to.Ptr("eastus"),
		// 				ID: to.Ptr("/subscriptions/cd9b6cdf-dcf0-4dca-ab19-82be07b74704/resourceGroups/MyResourceGroup/providers/Microsoft.Orbital/geoCatalogs/MyCatalog"),
		// 				Name: to.Ptr("MyCatalog"),
		// 				Type: to.Ptr("Microsoft.Orbital/geoCatalogs"),
		// 				SystemData: &armplanetarycomputer.SystemData{
		// 					CreatedBy: to.Ptr("Catalog User"),
		// 					CreatedByType: to.Ptr(armplanetarycomputer.CreatedByTypeUser),
		// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-10-10T18:34:22.271Z"); return t}()),
		// 					LastModifiedBy: to.Ptr("Catalog User"),
		// 					LastModifiedByType: to.Ptr(armplanetarycomputer.CreatedByTypeUser),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-10-10T18:34:22.271Z"); return t}()),
		// 				},
		// 			},
		// 		},
		// 		NextLink: to.Ptr("https://microsoft.com/a"),
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SpatioClient } = require("@azure/arm-planetarycomputer");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to list GeoCatalog resources by resource group
 *
 * @summary list GeoCatalog resources by resource group
 * x-ms-original-file: 2025-02-11-preview/GeoCatalogs_ListByResourceGroup.json
 */
async function geoCatalogsListByResourceGroup() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "cd9b6cdf-dcf0-4dca-ab19-82be07b74704";
  const client = new SpatioClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.geoCatalogs.listByResourceGroup("MyResourceGroup")) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "tier": "Basic",
        "catalogUri": "https://mycatalog-0123456789abcdef.geocatalog.spatio.azure.com/",
        "provisioningState": "Succeeded",
        "autoGeneratedDomainNameLabelScope": "NoReuse"
      },
      "identity": {
        "type": "UserAssigned",
        "userAssignedIdentities": {
          "/subscriptions/cd9b6cdf-dcf0-4dca-ab19-82be07b74704/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyManagedIdentity": {
            "principalId": "1b1424a8-4d17-4a72-b47f-d1d401c1e2fd",
            "clientId": "c57c7b17-2c5e-4996-8169-c74d026ffc5d"
          }
        }
      },
      "tags": {
        "MyTag": "MyValue"
      },
      "location": "eastus",
      "id": "/subscriptions/cd9b6cdf-dcf0-4dca-ab19-82be07b74704/resourceGroups/MyResourceGroup/providers/Microsoft.Orbital/geoCatalogs/MyCatalog",
      "name": "MyCatalog",
      "type": "Microsoft.Orbital/geoCatalogs",
      "systemData": {
        "createdBy": "Catalog User",
        "createdByType": "User",
        "createdAt": "2023-10-10T18:34:22.271Z",
        "lastModifiedBy": "Catalog User",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2023-10-10T18:34:22.271Z"
      }
    }
  ],
  "nextLink": "https://microsoft.com/a"
}

Definitions

Name	Description
AutoGeneratedDomainNameLabelScope	The scope at which the auto-generated domain name label is generated and at which the resource name can be reused.
CatalogTier	The Microsoft Planetary Computer Pro GeoCatalog tier
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
GeoCatalog	A Microsoft Planetary Computer Pro GeoCatalog resource
GeoCatalogListResult	The response of a GeoCatalog list operation.
GeoCatalogProperties	The details of the Microsoft Planetary Computer Pro GeoCatalog.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
ProvisioningState	The status of the current operation.
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	User assigned identity properties

AutoGeneratedDomainNameLabelScope

Enumeration

The scope at which the auto-generated domain name label is generated and at which the resource name can be reused.

Value	Description
NoReuse	The domain name label is randomly generated. The resource name cannot be reused within the same region.
TenantReuse	The domain name label is deterministically generated using the resource name and tenant id. The resource name cannot be reused within the same region and tenant.
SubscriptionReuse	The domain name label is deterministically generated using the resource name, tenant id, and subscription id. The resource name cannot be reused within the same region and subscription.
ResourceGroupReuse	The domain name label is deterministically generated using the resource name, tenant id, subscription id, and resource group name. The resource name cannot be reused within the same resource group.

CatalogTier

Enumeration

The Microsoft Planetary Computer Pro GeoCatalog tier

Value	Description
Basic	The basic tier that utilizes shared resources across catalog instances

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

GeoCatalog

Object

A Microsoft Planetary Computer Pro GeoCatalog resource

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	GeoCatalogProperties	The resource-specific properties for this resource.
systemData	systemData	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"

GeoCatalogListResult

Object

The response of a GeoCatalog list operation.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	GeoCatalog[]	The GeoCatalog items on this page

GeoCatalogProperties

Object

The details of the Microsoft Planetary Computer Pro GeoCatalog.

Name	Type	Default value	Description
autoGeneratedDomainNameLabelScope	AutoGeneratedDomainNameLabelScope	TenantReuse	The scope of the auto-generated domain name label. If not provided, defaults to TenantReuse.
catalogUri	string		The URI of the catalog management UI.
provisioningState	ProvisioningState		The status of the last operation.
tier	CatalogTier	Basic	Tier of the catalog. This cannot be changed after the catalog is created. If not provided, defaults to Basic.

ManagedServiceIdentity

Object

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Enumeration

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

ProvisioningState

Enumeration

The status of the current operation.

Value	Description
Succeeded	Resource has been created.
Failed	Resource creation failed.
Canceled	Resource creation was canceled.
Provisioning	The catalog is being provisioned.
Updating	The catalog is being updated.
Deleting	The catalog is being deleted.
Accepted	The catalog request has been accepted.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.

Share via

GeoCatalogs - List By Resource Group

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

GeoCatalogs_ListByResourceGroup

Sample request

Sample response

Definitions

AutoGeneratedDomainNameLabelScope

CatalogTier

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoCatalog

GeoCatalogListResult

GeoCatalogProperties

ManagedServiceIdentity

ManagedServiceIdentityType

ProvisioningState

systemData

UserAssignedIdentity