azure.mgmt.planetarycomputer.operations module

class azure.mgmt.planetarycomputer.operations.GeoCatalogsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PlanetaryComputerMgmtClient’s geo_catalogs attribute.

begin_create(resource_group_name: str, catalog_name: str, resource: GeoCatalog | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) LROPoller[GeoCatalog][source]

Create a GeoCatalog.

Parameters:
  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • catalog_name (str) – The name of the catalog. Required.

  • resource (GeoCatalog or JSON or IO[bytes]) – Resource create parameters. Is one of the following types: GeoCatalog, JSON, IO[bytes] Required.

Returns:

An instance of LROPoller that returns GeoCatalog. The GeoCatalog is compatible with MutableMapping

Return type:

LROPoller[GeoCatalog]

Raises:

HttpResponseError

begin_delete(resource_group_name: str, catalog_name: str, **kwargs: Any) LROPoller[None][source]

Delete a GeoCatalog.

Parameters:
  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • catalog_name (str) – The name of the catalog. Required.

Returns:

An instance of LROPoller that returns None

Return type:

LROPoller[None]

Raises:

HttpResponseError

begin_update(resource_group_name: str, catalog_name: str, properties: GeoCatalogUpdate | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) LROPoller[GeoCatalog][source]

Update a GeoCatalog.

Parameters:
  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • catalog_name (str) – The name of the catalog. Required.

  • properties (GeoCatalogUpdate or JSON or IO[bytes]) – The resource properties to be updated. Is one of the following types: GeoCatalogUpdate, JSON, IO[bytes] Required.

Returns:

An instance of LROPoller that returns GeoCatalog. The GeoCatalog is compatible with MutableMapping

Return type:

LROPoller[GeoCatalog]

Raises:

HttpResponseError

get(resource_group_name: str, catalog_name: str, **kwargs: Any) GeoCatalog[source]

Get a GeoCatalog.

Parameters:
  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • catalog_name (str) – The name of the catalog. Required.

Returns:

GeoCatalog. The GeoCatalog is compatible with MutableMapping

Return type:

GeoCatalog

Raises:

HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) Iterable[GeoCatalog][source]

List GeoCatalog resources by resource group.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

Returns:

An iterator like instance of GeoCatalog

Return type:

ItemPaged[GeoCatalog]

Raises:

HttpResponseError

list_by_subscription(**kwargs: Any) Iterable[GeoCatalog][source]

List GeoCatalog resources by subscription ID.

Returns:

An iterator like instance of GeoCatalog

Return type:

ItemPaged[GeoCatalog]

Raises:

HttpResponseError