Azure.Analytics.PlanetaryComputer Namespace

Classes

Name Description
AssetMetadata

Asset metadata model.

AssetStatisticsResult

Return dataset's statistics.

AzureAnalyticsPlanetaryComputerContext

Context class which will be filled in by the System.ClientModel.SourceGeneration. For more information https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/System.ClientModel/src/docs/ModelReaderWriterContext.md

BandStatistics

Statistical information about a data band.

ClassMapLegendResult

ClassMap legend response model.

CropCollectionFeatureByFormatOptions

Options for the cropCollectionFeatureByFormat operation.

CropCollectionFeatureOptions

Options for the cropCollectionFeature operation.

CropCollectionFeatureWidthByHeightOptions

Options for the cropCollectionFeatureWidthByHeight operation.

CropFeatureByFormatOptions

Options for the cropFeatureByFormat operation.

CropFeatureOptions

Options for the cropFeature operation.

CropFeatureWidthByHeightOptions

Options for the cropFeatureWidthByHeight operation.

CropSearchFeatureByFormatOptions

Options for the cropSearchFeatureByFormat operation.

CropSearchFeatureOptions

Options for the cropSearchFeature operation.

CropSearchFeatureWidthByHeightOptions

Options for the cropSearchFeatureWidthByHeight operation.

DataClient

The DataClient sub-client.

DefaultLocation

Defines a default geographic location for map visualization.

GeoJsonFeature

GeoJSON Feature object representing a geographic entity.

GeoJsonGeometry

Represents a GeoJSON geometry object as defined by RFC 7946. Supported geometry types include:

  • Point: A single geographic coordinate.
  • LineString: A sequence of geographic coordinates forming a line.
  • Polygon: A closed shape defined by linear rings.
  • MultiPoint: A collection of Points.
  • MultiLineString: A collection of LineStrings.
  • MultiPolygon: A collection of Polygons.
Used for spatial filtering in STAC. Please note this is the abstract base class. The derived classes available for instantiation are: PointGeometry, PolygonGeometry, MultiPolygon, MultiLineString, LineString, and MultiPoint.
GetCollectionAssetsForBboxOptions

Options for the getCollectionAssetsForBbox operation.

GetCollectionAssetsForTileNoTmsOptions

Options for the getCollectionAssetsForTileNoTms operation.

GetCollectionAssetsForTileOptions

Options for the getCollectionAssetsForTile operation.

GetCollectionBboxCropOptions

Options for the getCollectionBboxCrop operation.

GetCollectionBboxCropWithDimensionsOptions

Options for the getCollectionBboxCropWithDimensions operation.

GetCollectionPointAssetsOptions

Options for the getCollectionPointAssets operation.

GetCollectionPointOptions

Options for collection-level point query operations.

GetCollectionThumbnailOptions

Options for the getCollectionThumbnail operation.

GetCollectionTileByFormatOptions

Options for the getCollectionTileByFormat operation.

GetCollectionTileByScaleAndFormatOptions

Options for the getCollectionTileByScaleAndFormat operation.

GetCollectionTileByScaleOptions

Options for the getCollectionTileByScale operation.

GetCollectionTileJsonByTmsOptions

Options for collection-level TileJSON with TileMatrixSetId as path.

GetCollectionTileJsonOptions

Options for collection-level TileJSON metadata operations.

GetCollectionTileNoTmsByFormatOptions

Options for the getCollectionTileNoTmsByFormat operation.

GetCollectionTileNoTmsByScaleAndFormatOptions

Options for the getCollectionTileNoTmsByScaleAndFormat operation.

GetCollectionTileNoTmsByScaleOptions

Options for the getCollectionTileNoTmsByScale operation.

GetCollectionTileNoTmsOptions

Options for the getCollectionTileNoTms operation.

GetCollectionTileOptions

Options for the getCollectionTile operation.

GetCollectionTilesetMetadataOptions

Options for collection tileset metadata operations.

GetCollectionTilesetsOptions

Options for collection tileset list operations.

GetCollectionWmtsCapabilitiesByTmsOptions

Options for the getCollectionWmtsCapabilitiesByTms operation.

GetCollectionWmtsCapabilitiesOptions

Options for the getCollectionWmtsCapabilities operation.

GetItemAssetStatisticsOptions

Options for item per-asset statistics operations.

GetItemAvailableAssetsOptions

Options for the getItemAvailableAssets operation.

GetItemBboxCropOptions

Options for the getItemBboxCrop operation.

GetItemBboxCropWithDimensionsOptions

Options for the getItemBboxCropWithDimensions operation.

GetItemCollectionOptions

Options for the getItemCollection operation.

GetItemFeatureStatisticsOptions

Options for item GeoJSON feature statistics operations.

GetItemInfoOptions

Options for item info operations.

GetItemPointOptions

Options for item point query operations.

GetItemPreviewOptions

Options for the getItemPreview operation.

GetItemPreviewWithFormatOptions

Options for the getItemPreviewWithFormat operation.

GetItemStatisticsOptions

Options for item merged statistics operations.

GetItemTileJsonByTmsOptions

Options for item TileJSON metadata operations with TileMatrixSetId as path.

GetItemTileJsonOptions

Options for item TileJSON metadata operations.

GetItemTilesetMetadataOptions

Options for item tileset metadata operations.

GetItemTilesetsOptions

Options for item tileset list and bounds operations.

GetItemWmtsCapabilitiesByTmsOptions

Options for the getItemWmtsCapabilitiesByTms operation.

GetItemWmtsCapabilitiesOptions

Options for the getItemWmtsCapabilities operation.

GetLegendOptions

Options for the getLegend operation.

GetSearchAssetsForTileNoTmsOptions

Options for the getSearchAssetsForTileNoTms operation.

GetSearchAssetsForTileOptions

Options for the getSearchAssetsForTile operation.

GetSearchBboxAssetsOptions

Options for the getSearchBboxAssets operation.

GetSearchBboxCropOptions

Options for the getSearchBboxCrop operation.

GetSearchBboxCropWithDimensionsOptions

Options for the getSearchBboxCropWithDimensions operation.

GetSearchPointOptions

Options for search-based point query operations.

GetSearchPointWithAssetsOptions

Options for the getSearchPointWithAssets operation.

GetSearchTileByFormatOptions

Options for the getSearchTileByFormat operation.

GetSearchTileByScaleAndFormatOptions

Options for the getSearchTileByScaleAndFormat operation.

GetSearchTileByScaleOptions

Options for the getSearchTileByScale operation.

GetSearchTileJsonByTmsOptions

Options for search-based TileJSON with TileMatrixSetId as path.

GetSearchTileJsonOptions

Options for search-based TileJSON metadata operations.

GetSearchTileNoTmsByFormatOptions

Options for the getSearchTileNoTmsByFormat operation.

GetSearchTileNoTmsByScaleAndFormatOptions

Options for the getSearchTileNoTmsByScaleAndFormat operation.

GetSearchTileNoTmsByScaleOptions

Options for the getSearchTileNoTmsByScale operation.

GetSearchTileNoTmsOptions

Options for the getSearchTileNoTms operation.

GetSearchTileOptions

Options for the getSearchTile operation.

GetSearchTilesetMetadataOptions

Options for search tileset metadata operations.

GetSearchTilesetsOptions

Options for search tileset list operations.

GetSearchWmtsCapabilitiesByTmsOptions

Options for the getSearchWmtsCapabilitiesByTms operation.

GetSearchWmtsCapabilitiesOptions

Options for the getSearchWmtsCapabilities operation.

GetTileByFormatOptions

Options for the getTileByFormat operation.

GetTileByScaleAndFormatOptions

Options for the getTileByScaleAndFormat operation.

GetTileByScaleOptions

Options for the getTileByScale operation.

GetTileNoTmsByFormatOptions

Options for the getTileNoTmsByFormat operation.

GetTileNoTmsByScaleAndFormatOptions

Options for the getTileNoTmsByScaleAndFormat operation.

GetTileNoTmsByScaleOptions

Options for the getTileNoTmsByScale operation.

GetTileNoTmsOptions

Options for the getTileNoTms operation.

GetTileOptions

Options for the getTile operation.

IngestionClient

The IngestionClient sub-client.

IngestionInformation

Microsoft Planetary Computer Pro geo-catalog ingestion creation model.

IngestionRun

Microsoft Planetary Computer Pro geo-catalog ingestion run.

IngestionRunInformation

Microsoft Planetary Computer Pro geo-catalog ingestion run operation.

IngestionSource

Ingestion Source Please note this is the abstract base class. The derived classes available for instantiation are: SharedAccessSignatureTokenIngestionSource and ManagedIdentityIngestionSource.

IngestionSourceSummary

Ingestion source summary.

LineString

Represents a LineString.

ManagedIdentityConnection

Managed Identity connection information.

ManagedIdentityIngestionSource

Managed Identity ingestion source.

ManagedIdentityMetadata

Managed Identity metadata.

ManagedStorageSharedAccessSignatureClient

The ManagedStorageSharedAccessSignatureClient sub-client.

MosaicMetadata

Metadata information for mosaic or search results.

MultiLineString

Represents a MultiLineString.

MultiPoint

Represents a MultiPoint.

MultiPolygon

Represents a MultiPolygon.

PartitionKind

Defines how data is partitioned for efficient storage and retrieval.

PlanetaryComputerErrorInfo

Error information wrapper.

PlanetaryComputerModelFactory

A factory class for creating instances of the models for mocking.

PlanetaryComputerOperation

Microsoft Planetary Computer Pro geo-catalog operation.

PlanetaryComputerOperationStatusHistoryItem

Operation status history item.

PlanetaryComputerProClient

The PlanetaryComputerProClient.

PlanetaryComputerProClientHostExtensions

Extension methods to add PlanetaryComputerProClient to an IHostApplicationBuilder.

PlanetaryComputerProClientOptions

Client options for PlanetaryComputerProClient.

PlanetaryComputerProClientSettings

Represents the settings used to configure a PlanetaryComputerProClient that can be loaded from an IConfigurationSection.

PointGeometry

Represents a GeoJSON Point geometry.

PolygonGeometry

Represents a Polygon.

QueryableDefinitionsResult

Queryable definitions response.

RegisterMosaic

Input parameters for registering a new mosaic of STAC items.

RenderConfiguration

Defines visualization parameters for rendering data on a map.

RenderOptionCondition

Defines a condition for enabling a render option.

RenderOptionLegend

Configuration for generating a data legend.

RenderOptionVectorOptions

Defines parameters for vector tile rendering.

SearchOptionsFields

FieldsExtension. Attributes: include: set of fields to include. exclude: set of fields to exclude. Controls which fields to include or exclude from the response.

SharedAccessSignatureSignedLink

UnsignedLink.

SharedAccessSignatureToken

Managed Storage Shared Access Signature (SAS) Token.

SharedAccessSignatureTokenConnection

SAS Token connection information.

SharedAccessSignatureTokenIngestionSource

SAS Token ingestion source.

StacAsset

https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/item-spec.md#asset-object Represents a STAC asset, which is a file or resource associated with a STAC item.

StacAssetData

FormContent model for file upload.

StacCatalogCollections

http://docs.opengeospatial.org/is/17-069r3/17-069r3.html#_feature_collections_rootcollections Represents a collection of STAC collections with links.

StacClient

The StacClient sub-client.

StacCollection

https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md Represents a STAC collection.

StacCollectionTemporalExtent

https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#temporal-extent-object Represents the temporal extent of a STAC collection with time intervals.

StacConformanceClasses

https://github.com/radiantearth/stac-api-spec/blob/master/api-spec.md#ogc-api---features-endpoints Represents the OGC API conformance declaration.

StacContextExtension

https://github.com/radiantearth/stac-api-spec/tree/master/extensions/context#context-extension-specification Context information for a search response including pagination details.

StacExtensionExtent

https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#extent-object Represents the spatial and temporal extent of a STAC collection.

StacExtensionSpatialExtent

https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#spatial-extent-object Represents the spatial extent of a STAC collection with bounding boxes.

StacItem

Represents a STAC Item, which is a GeoJSON Feature with additional metadata.

StacItemAsset

https://github.com/stac-extensions/item-assets Represents a STAC item asset, which describes the assets available under any item in the collection.

StacItemBounds

Geographic extent of a dataset expressed as a bounding box.

StacItemCollection

https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/itemcollection-spec.md Represents a collection of STAC Items as a GeoJSON FeatureCollection.

StacItemOrStacItemCollection

Base type for STAC items and collections with discriminator. Please note this is the abstract base class. The derived classes available for instantiation are: StacItemCollection and StacItem.

StacItemPointAsset

Asset information for the specified point.

StacItemProperties

Properties of a STAC Item containing metadata about the asset. https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/item-spec.md#properties-object

StacItemStatisticsGeoJson

STAC Item representing a spatiotemporal asset with statistical information.

StacItemStatisticsGeoJsonProperties

Properties for STAC Item statistics GeoJSON Feature.

StacLandingPage

https://github.com/radiantearth/stac-api-spec/blob/master/api-spec.md#ogc-api---features-endpoints Represents the STAC API landing page with links to available resources.

StacLink

Link model. Ref: http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/link.yaml Represents a link.

StacMosaic

Defines a named mosaic with filtering criteria.

StacMosaicConfiguration

Configuration for data mosaic visualization.

StacProvider

https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#provider-object Represents information about a data provider for STAC collections and items.

StacQueryable

Definition of a queryable field for STAC API filtering.

StacSearchParameters

Search model. * Defines parameters for a STAC search POST request.

StacSortExtension

https://github.com/radiantearth/stac-api-spec/tree/master/extensions/sort#sort-api-extension Represents a sort specification for STAC API queries.

TileJsonMetadata

TileJSON metadata describing a tile set according to the TileJSON specification Based on https://github.com/mapbox/tilejson-spec/tree/master/2.2.0

TileMatrix

Tile Matrix Definition A tile matrix, usually corresponding to a particular zoom level of a TileMatrixSet. ref: https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/tileMatrix.json Definition of a tile matrix at a specific zoom level within a tile matrix set

TileMatrixSet

https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/tileMatrixSet.json A definition of a tile matrix set following the Tile Matrix Set standard. For tileset metadata, such a description (in tileMatrixSet property) is only required for offline use, as an alternative to a link with a http://www.opengis.net/def/rel/ogc/1.0/tiling-scheme relation type.

TileMatrixSetBoundingBox

Geographic extent of the tile matrix set expressed in the specified coordinate reference system.

TileMatrixSetLimitsEntry

Limits for a specific tile matrix within a tileset, defining the valid row/column range.

TilerAssetGeoJson

Represents GeoJSON with feature with an asset property.

TilerCoreModelsResponsesPoint

Response model for point query operations providing values at a specific location.

TilerInfo

TilerInfo.

TilerInfoGeoJsonFeature

GeoJSON Feature object containing rio-tiler model information.

TilerInfoMapResult

Return dataset's basic info.

TilerMosaicSearchRegistrationResult

Response from a successful mosaic registration with search ID and related links.

TilerStacItemStatistics

Return dataset's statistics.

TilerStacSearchDefinition

Stored search query See: https://github.com/stac-utils/pgstac/blob/3499daa2bfa700ae7bb07503795c169bf2ebafc7/sql/004_search.sql#L907-L915

TilerStacSearchRegistration

Information about a registered STAC search query.

TileSetBoundingBox

Bounding box for a tile set.

TileSetEntry

Summary information about a single tileset within a list of available tilesets.

TileSetLink

A link object used in OGC tile resources.

TileSetList

Response containing a list of available tilesets.

TileSetMetadata

Detailed metadata about a specific tileset, including tile matrix set limits.

TileSettings

Configuration for map tile visualization.

UserCollectionSettings

User-specific collection settings for visualization.

VariableMatrixWidth

Model for variableMatrixWidth.

Structs

Name Description
ColorMapNames

Available color maps for data visualization.

FeatureKind

Type identifier for GeoJSON Feature objects.

FilterLanguage

Choices for filter-lang value in a POST request. Based on https://github.com/stac-api-extensions/filter#queryables Note the addition of cql2-json, which is used by the pgstac backend, but is not included in the spec above. Defines the supported filter languages for STAC API queries.

IngestionKind

Ingestion type.

IngestionSourceKind

Ingestion source type.

IngestionStatus

Ingestion status.

LegendConfigKind

Legend type to make, one of: continuous, classmap, interval or none (note, none is a string literal).

MosaicMetadataKind

Type of metadata resource in the system.

NoDataKind

NoDataType.

PartitionKindScheme

Defines partitioning schemes for temporal data organization.

PixelSelection

Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad') Represents the method used to select or compute pixels when creating composites from multiple sources

PlanetaryComputerOperationStatus

Operation status.

RenderOptionKind

Specifies the types of render options for map visualization.

ResamplingMethod

Resampling algorithm to use when reading source raster data at different resolutions.

SelMethod

Xarray indexing method to use for inexact matches.

StacAssetUrlSigningMode

Represent the signature type for asset URLs.

StacLinkKind

MIME types for links.

StacLinkMethod
StacQueryableDefinitionDataKind

Queryable data types for the queryables extension. These are the data types supported by Basic CQL2.

StacSearchSortingDirection

Defines the sorting directions for query results in STAC API.

TerrainAlgorithm

Supported algorithms for terrain and index-based analysis.

TileAddressingScheme

Scheme for tile addressing in TileJSON specification.

TileMatrixCornerOfOrigin

The corner of the tile matrix (topLeft or bottomLeft) used as the origin for numbering tile rows and columns. This corner is also a corner of the (0, 0) tile.

TileMatrixSetId

Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad') Standard identifier for a coordinate reference system and tiling scheme used for serving map tiles

TilerImageFormat

Image format specifier for tile and image requests.

WarpKernelResampling

WarpKernel resampling algorithm used when doing re-projection. Defaults to nearest.

Enums

Name Description
PlanetaryComputerProClientOptions.ServiceVersion

The version of the service to use.