GeoCatalogs - Create

Tjänst:

Planetary Computer

API-version:

2026-04-15

Skapa en GeoCatalog

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
catalogName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Namnet på katalogen
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
location	True	string	Den geo-plats där resursen finns
identity		ManagedServiceIdentity	De hanterade tjänstidentiteter som tilldelats den här resursen.
properties		GeoCatalogProperties	Resursspecifika egenskaper för den här resursen.
tags		object	Resursetiketter.

Svar

Name	Typ	Description
200 OK	GeoCatalog	Resursens 'GeoCatalog'-uppdateringsoperation lyckades
201 Created	GeoCatalog	Resursen 'GeoCatalog' skapade operationen lyckades Sidhuvuden Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

GeoCatalogs_Create

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Statuskod:

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

Definitioner

Name	Description
AutoGeneratedDomainNameLabelScope	Det område där den automatiskt genererade domännamnsetiketten genereras och där resursnamnet kan återanvändas.
CatalogTier	Microsoft Planetary Computer Pro GeoCatalog-nivån
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
GeoCatalog	En Microsoft Planetary Computer Pro GeoCatalog-resurs
GeoCatalogProperties	Detaljerna i Microsoft Planetary Computer Pro GeoCatalog.
ManagedServiceIdentity	Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)
ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
ProvisioningState	Status för den aktuella åtgärden.
systemData	Metadata som rör skapande och senaste ändring av resursen.
UserAssignedIdentity	Användartilldelade identitetsegenskaper

AutoGeneratedDomainNameLabelScope

Uppräkning

Det område där den automatiskt genererade domännamnsetiketten genereras och där resursnamnet kan återanvändas.

Värde	Description
NoReuse	Domännamnsetiketten genereras slumpmässigt. Resursnamnet kan inte återanvändas inom samma region.
TenantReuse	Domännamnsetiketten genereras deterministiskt med hjälp av resursnamnet och hyresgäst-ID:t. Resursnamnet kan inte återanvändas inom samma region och hyresgäst.
SubscriptionReuse	Domännamnsetiketten genereras deterministiskt med resursnamn, hyresgäst-id och prenumerations-id. Resursnamnet kan inte återanvändas inom samma region och prenumeration.
ResourceGroupReuse	Domännamnsetiketten genereras deterministiskt med resursnamn, hyresgäst-ID, prenumerations-id och resursgruppsnamn. Resursnamnet kan inte återanvändas inom samma resursgrupp.

CatalogTier

Uppräkning

Microsoft Planetary Computer Pro GeoCatalog-nivån

Värde	Description
Basic	Den grundläggande nivån som använder delade resurser över kataloginstanser

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

GeoCatalog

Objekt

En Microsoft Planetary Computer Pro GeoCatalog-resurs

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	De hanterade tjänstidentiteter som tilldelats den här resursen.
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties	GeoCatalogProperties	Resursspecifika egenskaper för den här resursen.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Resursetiketter.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

GeoCatalogProperties

Objekt

Detaljerna i Microsoft Planetary Computer Pro GeoCatalog.

Name	Typ	Standardvärde	Description
autoGeneratedDomainNameLabelScope	AutoGeneratedDomainNameLabelScope	TenantReuse	Omfånget för den automatiskt genererade domännamnsetiketten. Om det inte anges används TenantReuse som standard.
catalogUri	string		URI:n för kataloghanteringsgränssnittet.
provisioningState	ProvisioningState		Status för den senaste åtgärden.
tier	CatalogTier	Basic	Nivå i katalogen. Detta kan inte ändras när katalogen har skapats. Om det inte anges är standardvärdet Basic.

ManagedServiceIdentity

Objekt

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

Name	Typ	Description
principalId	string (uuid)	Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string (uuid)	Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
type	ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned identiteter Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

ManagedServiceIdentityType

Uppräkning

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

Värde	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

ProvisioningState

Uppräkning

Status för den aktuella åtgärden.

Värde	Description
Succeeded	Resursen har skapats.
Failed	Det gick inte att skapa resurser.
Canceled	Resursskapandet avbröts.
Provisioning	Katalogen förbereds.
Updating	Katalogen uppdateras.
Deleting	Katalogen tas bort.
Accepted	Katalogförfrågan har godkänts.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UserAssignedIdentity

Objekt

Användartilldelade identitetsegenskaper

Name	Typ	Description
clientId	string (uuid)	Klient-ID för den tilldelade identiteten.
principalId	string (uuid)	Huvud-ID för den tilldelade identiteten.