GeoCatalogs - Create

Služba:

Planetary Computer

Verze rozhraní API:

2026-04-15

Vytvořte GeoKatalog

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/geoCatalogs/{catalogName}?api-version=2026-04-15

Parametry identifikátoru URI

Název	V	Vyžadováno	Typ	Description
catalogName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Název katalogu
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Název	Vyžadováno	Typ	Description
location	True	string	Geografické umístění, ve kterém se nachází zdroj
identity		ManagedServiceIdentity	Identity spravované služby přiřazené k tomuto prostředku.
properties		GeoCatalogProperties	Vlastnosti specifické pro prostředek pro tento prostředek.
tags		object	Značky prostředků

Odpovědi

Název	Typ	Description
200 OK	GeoCatalog	Aktualizace zdroje 'GeoCatalog' byla úspěšná
201 Created	GeoCatalog	Operace vytvoření zdroje 'GeoCatalog' byla úspěšná Hlavičky Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Název	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

GeoCatalogs_Create

Ukázkový požadavek

HTTP

PUT https://management.azure.com/subscriptions/cd9b6cdf-dcf0-4dca-ab19-82be07b74704/resourceGroups/MyResourceGroup/providers/Microsoft.Orbital/geoCatalogs/MyCatalog?api-version=2026-04-15

{
  "properties": {
    "tier": "Basic",
    "autoGeneratedDomainNameLabelScope": "NoReuse"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/cd9b6cdf-dcf0-4dca-ab19-82be07b74704/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyManagedIdentity": {}
    }
  },
  "tags": {
    "MyTag": "MyValue"
  },
  "location": "eastus"
}

Python

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_create.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.begin_create(
        resource_group_name="MyResourceGroup",
        catalog_name="MyCatalog",
        resource={
            "identity": {
                "type": "UserAssigned",
                "userAssignedIdentities": {
                    "/subscriptions/cd9b6cdf-dcf0-4dca-ab19-82be07b74704/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyManagedIdentity": {}
                },
            },
            "location": "eastus",
            "properties": {"autoGeneratedDomainNameLabelScope": "NoReuse", "tier": "Basic"},
            "tags": {"MyTag": "MyValue"},
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-04-15/GeoCatalogs_Create.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

Go

package armplanetarycomputer_test

import (
	"context"
	"log"

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

// Generated from example definition: 2026-04-15/GeoCatalogs_Create.json
func ExampleGeoCatalogsClient_BeginCreate() {
	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)
	}
	poller, err := clientFactory.NewGeoCatalogsClient().BeginCreate(ctx, "MyResourceGroup", "MyCatalog", armplanetarycomputer.GeoCatalog{
		Properties: &armplanetarycomputer.GeoCatalogProperties{
			Tier:                              to.Ptr(armplanetarycomputer.CatalogTierBasic),
			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": {},
			},
		},
		Tags: map[string]*string{
			"MyTag": to.Ptr("MyValue"),
		},
		Location: to.Ptr("eastus"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armplanetarycomputer.GeoCatalogsClientCreateResponse{
	// 	GeoCatalog: &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}()),
	// 		},
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to create a GeoCatalog
 *
 * @summary create a GeoCatalog
 * x-ms-original-file: 2026-04-15/GeoCatalogs_Create.json
 */
async function geoCatalogsCreate() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "cd9b6cdf-dcf0-4dca-ab19-82be07b74704";
  const client = new SpatioClient(credential, subscriptionId);
  const result = await client.geoCatalogs.create("MyResourceGroup", "MyCatalog", {
    properties: { tier: "Basic", autoGeneratedDomainNameLabelScope: "NoReuse" },
    identity: {
      type: "UserAssigned",
      userAssignedIdentities: {
        "/subscriptions/cd9b6cdf-dcf0-4dca-ab19-82be07b74704/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyManagedIdentity":
          {},
      },
    },
    tags: { MyTag: "MyValue" },
    location: "eastus",
  });
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.PlanetaryComputer.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.PlanetaryComputer;

// Generated from example definition: 2026-04-15/GeoCatalogs_Create.json
// this example is just showing the usage of "GeoCatalog_Create" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "cd9b6cdf-dcf0-4dca-ab19-82be07b74704";
string resourceGroupName = "MyResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this PlanetaryComputerGeoCatalogResource
PlanetaryComputerGeoCatalogCollection collection = resourceGroupResource.GetPlanetaryComputerGeoCatalogs();

// invoke the operation
string catalogName = "MyCatalog";
PlanetaryComputerGeoCatalogData data = new PlanetaryComputerGeoCatalogData(new AzureLocation("eastus"))
{
    Properties = new PlanetaryComputerGeoCatalogProperties
    {
        Tier = PlanetaryComputerGeoCatalogTier.Basic,
        AutoGeneratedDomainNameLabelScope = AutoGeneratedDomainNameLabelScope.NoReuse,
    },
    Identity = new ManagedServiceIdentity("UserAssigned")
    {
        UserAssignedIdentities =
        {
        [new ResourceIdentifier("/subscriptions/cd9b6cdf-dcf0-4dca-ab19-82be07b74704/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyManagedIdentity")] = new UserAssignedIdentity()
        },
    },
    Tags =
    {
    ["MyTag"] = "MyValue"
    },
};
ArmOperation<PlanetaryComputerGeoCatalogResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, catalogName, data);
PlanetaryComputerGeoCatalogResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
PlanetaryComputerGeoCatalogData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Ukázková odpověď

Stavový kód:

200

{
  "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"
  }
}

Stavový kód:

201

Azure-AsyncOperation: https://contoso.com/operationstatus

{
  "properties": {
    "tier": "Basic",
    "catalogUri": "https://mycatalog-0123456789abcdef.geocatalog.spatio.azure.com/",
    "provisioningState": "Accepted",
    "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"
  }
}

Definice

Název	Description
AutoGeneratedDomainNameLabelScope	Rozsah, ve kterém je automaticky generovaný štítek doménového jména generován a ve kterém lze název zdroje znovu použít.
CatalogTier	Úroveň Microsoft Planetary Computer Pro GeoCatalog
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
GeoCatalog	Zdroj pro Microsoft Planetary Computer Pro GeoCatalog
GeoCatalogProperties	Podrobnosti o Microsoft Planetary Computer Pro GeoCatalog.
ManagedServiceIdentity	Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)
ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
ProvisioningState	Stav aktuální operace.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UserAssignedIdentity	Vlastnosti identity přiřazené uživatelem

AutoGeneratedDomainNameLabelScope

Výčet

Rozsah, ve kterém je automaticky generovaný štítek doménového jména generován a ve kterém lze název zdroje znovu použít.

Hodnota	Description
NoReuse	Štítek doménového jména je generován náhodně. Název zdroje nelze znovu použít v rámci stejné oblasti.
TenantReuse	Štítek doménového jména je deterministicky generován pomocí názvu zdroje a ID nájemce. Název zdroje nelze znovu použít ve stejném regionu a tenantu.
SubscriptionReuse	Štítek doménového jména je deterministicky generován pomocí názvu zdroje, tenant id a subscription id. Název zdroje nelze znovu použít ve stejném regionu a rámci předplatného.
ResourceGroupReuse	Štítek doménového jména je deterministicky generován pomocí názvu zdroje, ID nájemce, ID předplatného a názvu skupiny zdrojů. Název zdroje nelze znovu použít ve stejné skupině zdrojů.

CatalogTier

Výčet

Úroveň Microsoft Planetary Computer Pro GeoCatalog

Hodnota	Description
Basic	Základní vrstva, která využívá sdílené zdroje napříč katalogovými instancemi

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Název	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Název	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Název	Typ	Description
error	ErrorDetail	Objekt chyby.

GeoCatalog

Objekt

Zdroj pro Microsoft Planetary Computer Pro GeoCatalog

Název	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	Identity spravované služby přiřazené k tomuto prostředku.
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties	GeoCatalogProperties	Vlastnosti specifické pro prostředek pro tento prostředek.
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags	object	Značky prostředků
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

GeoCatalogProperties

Objekt

Podrobnosti o Microsoft Planetary Computer Pro GeoCatalog.

Název	Typ	Default value	Description
autoGeneratedDomainNameLabelScope	AutoGeneratedDomainNameLabelScope	TenantReuse	Rozsah automaticky generovaného štítku názvu domény. Pokud není zadaný, výchozí hodnota je TenantReuse.
catalogUri	string		URI rozhraní pro správu katalogu.
provisioningState	ProvisioningState		Stav poslední operace.
tier	CatalogTier	Basic	Úroveň katalogu. Po vytvoření katalogu to nelze změnit. Pokud není zadána, použije se výchozí hodnota Základní.

ManagedServiceIdentity

Objekt

Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)

Název	Typ	Description
principalId	string (uuid)	ID instančního objektu identity přiřazené systémem. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
tenantId	string (uuid)	ID tenanta přiřazené identity systému. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
type	ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
userAssignedIdentities	<string,  UserAssignedIdentity>	identity User-Assigned Sada identit přiřazených uživatelem přidružená k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích.

ManagedServiceIdentityType

Výčet

Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).

Hodnota	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

ProvisioningState

Výčet

Stav aktuální operace.

Hodnota	Description
Succeeded	Zdroj byl vytvořen.
Failed	Vytvoření zdroje se nezdařilo.
Canceled	Vytváření zdrojů bylo zrušeno.
Provisioning	Katalog je právě provisionován.
Updating	Katalog je aktualizován.
Deleting	Katalog je mazán.
Accepted	Žádost o katalog byla přijata.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Název	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UserAssignedIdentity

Objekt

Vlastnosti identity přiřazené uživatelem

Název	Typ	Description
clientId	string (uuid)	ID klienta přiřazené identity.
principalId	string (uuid)	ID objektu zabezpečení přiřazené identity.