GeoCatalogs - Create

Служба:

Planetary Computer

Версия API:

2026-04-15

Создать геокаталог

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

Параметры URI

Имя.	В	Обязательно	Тип	Описание
catalogName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	Имя каталога
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Текст запроса

Имя.	Обязательно	Тип	Описание
location	True	string	Географическое расположение, в котором находится ресурс
identity		ManagedServiceIdentity	Удостоверения управляемой службы, назначенные этому ресурсу.
properties		GeoCatalogProperties	Свойства, относящиеся к ресурсу, для этого ресурса.
tags		object	Теги ресурсов.

Ответы

Имя.	Тип	Описание
200 OK	GeoCatalog	Операция обновления ресурса 'GeoCatalog' успешно прошла
201 Created	GeoCatalog	Операция создания ресурса 'GeoCatalog' успешно выполнена Заголовки Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя.	Описание
user_impersonation	Выдача себя за свою учетную запись пользователя

Примеры

GeoCatalogs_Create

Образец запроса

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

Пример ответа

Код состояния:

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

Код состояния:

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

Определения

Имя.	Описание
AutoGeneratedDomainNameLabelScope	Область, в которой генерируется автоматически сгенерированная метка доменного имени и в которой имя ресурса может быть использовано повторно.
CatalogTier	Уровень Microsoft Planetary Computer Pro GeoCatalog
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
GeoCatalog	Ресурс Microsoft Planetary Computer Pro GeoCatalog
GeoCatalogProperties	Детали GeoCatalog Microsoft Planetary Computer Pro GeoCatalog.
ManagedServiceIdentity	Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
ProvisioningState	Состояние текущей операции.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения

AutoGeneratedDomainNameLabelScope

Перечисление

Область, в которой генерируется автоматически сгенерированная метка доменного имени и в которой имя ресурса может быть использовано повторно.

Значение	Описание
NoReuse	Метка доменного имени генерируется случайным образом. Имя ресурса нельзя повторно использовать в пределах одного и того же региона.
TenantReuse	Метка доменного имени детерминированно генерируется с использованием имени ресурса и идентификатора арендатора. Имя ресурса нельзя повторно использовать в пределах одного региона и арендатора.
SubscriptionReuse	Метка доменного имени детерминированно генерируется с использованием имени ресурса, идентификатора арендатора и идентификатора подписки. Имя ресурса нельзя повторно использовать в пределах одного региона и подписки.
ResourceGroupReuse	Метка доменного имени детерминированно генерируется с использованием имени ресурса, идентификатора арендатора, идентификатора подписки и имени группы ресурсов. Имя ресурса нельзя повторно использовать внутри той же группы ресурсов.

CatalogTier

Перечисление

Уровень Microsoft Planetary Computer Pro GeoCatalog

Значение	Описание
Basic	Базовый уровень, который использует общие ресурсы между экземплярами каталога

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя.	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя.	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя.	Тип	Описание
error	ErrorDetail	Объект ошибки.

GeoCatalog

Объект

Ресурс Microsoft Planetary Computer Pro GeoCatalog

Имя.	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	Удостоверения управляемой службы, назначенные этому ресурсу.
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties	GeoCatalogProperties	Свойства, относящиеся к ресурсу, для этого ресурса.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

GeoCatalogProperties

Объект

Детали GeoCatalog Microsoft Planetary Computer Pro GeoCatalog.

Имя.	Тип	Значение по умолчанию	Описание
autoGeneratedDomainNameLabelScope	AutoGeneratedDomainNameLabelScope	TenantReuse	Область действия автоматически созданной метки доменного имени. Если не указано, по умолчанию используется TenantReuse.
catalogUri	string		URI интерфейса управления каталогом.
provisioningState	ProvisioningState		Состояние последней операции.
tier	CatalogTier	Basic	Уровень каталога. Это нельзя изменить после создания каталога. Если не указано, по умолчанию используется значение Basic.

ManagedServiceIdentity

Объект

Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения

Имя.	Тип	Описание
principalId	string (uuid)	Идентификатор субъекта-службы назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
tenantId	string (uuid)	Идентификатор клиента назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
type	ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
userAssignedIdentities	<string,  UserAssignedIdentity>	удостоверения User-Assigned Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

ManagedServiceIdentityType

Перечисление

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

Значение	Описание
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

ProvisioningState

Перечисление

Состояние текущей операции.

Значение	Описание
Succeeded	Ресурс создан.
Failed	Не удалось создать ресурс.
Canceled	Создание ресурсов было отменено.
Provisioning	Каталог пополняется.
Updating	Каталог обновляется.
Deleting	Каталог удаляется.
Accepted	Запрос на каталог был принят.

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя.	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

UserAssignedIdentity

Объект

Свойства назначаемого пользователем удостоверения

Имя.	Тип	Описание
clientId	string (uuid)	Идентификатор клиента назначенного удостоверения.
principalId	string (uuid)	Основной идентификатор назначенного удостоверения.