data

Creates, updates, deletes, gets or lists a data resource.

Overview

Name	data
Type	Resource
Id	azure.planetary_computer_dataplane.data

Fields

The following fields are returned by SELECT queries:

get_search_assets_for_tile

Name	Datatype	Description
id	string	Unique identifier for the feature. Required.
assets	object	Assets. Required.
bbox	array	Bounding box coordinates for the feature. Required.
collection	string	ID of the STAC collection this item belongs to.

get_collection_assets_for_tile

Name	Datatype	Description
id	string	Unique identifier for the feature. Required.
assets	object	Assets. Required.
bbox	array	Bounding box coordinates for the feature. Required.
collection	string	ID of the STAC collection this item belongs to.

get_item_feature_statistics

Name	Datatype	Description
geometry	object	Geometry object defining the feature's shape. Required.
statistics	object	Statistical information for each band in the asset. Required.
type	string	GeoJSON type identifier for Feature. Required. "Feature" (Feature)

get_item_point

Name	Datatype	Description
band_names	array	Names of each band in the raster data. Required.
coordinates	array	Geographic coordinates [longitude, latitude] of the queried point. Required.
values	array	Array of pixel values at the queried point for each band. Required.

get_tileset_metadata

Name	Datatype	Description
accessConstraints	string	Access constraints for the tileset.
boundingBox	object	Bounding box of the tileset.
crs	string	Coordinate reference system identifier.
dataType	string	Type of data in the tiles.
links	array	Links related to this tileset.
tileMatrixSetLimits	array	Limits for each tile matrix level in the tileset.
title	string	Human-readable title of the tileset.

get_collection_point

Name	Datatype	Description
band_names	array	Names of each band in the raster data. Required.
coordinates	array	Geographic coordinates [longitude, latitude] of the queried point. Required.
values	array	Array of pixel values at the queried point for each band. Required.

get_search_point

Name	Datatype	Description
band_names	array	Names of each band in the raster data. Required.
coordinates	array	Geographic coordinates [longitude, latitude] of the queried point. Required.
values	array	Array of pixel values at the queried point for each band. Required.

get_tilesets

Name	Datatype	Description
tilesets	array	Array of available tilesets. Required.

get_collection_tileset_metadata

Name	Datatype	Description
accessConstraints	string	Access constraints for the tileset.
boundingBox	object	Bounding box of the tileset.
crs	string	Coordinate reference system identifier.
dataType	string	Type of data in the tiles.
links	array	Links related to this tileset.
tileMatrixSetLimits	array	Limits for each tile matrix level in the tileset.
title	string	Human-readable title of the tileset.

get_search_tileset_metadata

Name	Datatype	Description
accessConstraints	string	Access constraints for the tileset.
boundingBox	object	Bounding box of the tileset.
crs	string	Coordinate reference system identifier.
dataType	string	Type of data in the tiles.
links	array	Links related to this tileset.
tileMatrixSetLimits	array	Limits for each tile matrix level in the tileset.
title	string	Human-readable title of the tileset.

get_tile_matrix_definitions

Name	Datatype	Description
id	string	Unique identifier for the tile matrix set.
boundingBox	object	Geographic extent of the tile matrix set.
crs	string	Coordinate reference system identifier. Required.
description	string	Brief narrative description of this tile matrix set, normally available for display to a human.
keywords	array	Unordered list of one or more commonly used or formalized word(s) or phrase(s) used to describe this tile matrix set.
orderedAxes	array	Names of the coordinate axes in order.
tileMatrices	array	Array of tile matrices at different zoom levels. Required.
title	string	Human-readable title of the tile matrix set.
uri	string	URI reference to the official definition.
wellKnownScaleSet	string	URL reference to a standardized scale set.

get_collection_tilesets

Name	Datatype	Description
tilesets	array	Array of available tilesets. Required.

get_search_tilesets

Name	Datatype	Description
tilesets	array	Array of available tilesets. Required.

get_tile_matrices

Name	Datatype	Description
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_search_assets_for_tile	select	search_id, tile_matrix_set_id, z, x, y, collection, endpoint	scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method	Searches Assets For Tile Tilematrixsetid As Path. Return a list of assets which overlap a given tile.
get_collection_assets_for_tile	select	collection_id, tile_matrix_set_id, z, x, y, endpoint	scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method	Collection Assets For Tile Tilematrixsetid As Path. Return a list of assets which overlap a given tile for a STAC collection (with TileMatrixSetId).
get_item_feature_statistics	select	collection_id, item_id, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, coord_crs, resampling, max_size, categorical, c, p, histogram_bins, histogram_range, dst_crs, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, height, width	Item Geojson Statistics. Get statistics from a GeoJSON feature for a STAC item.
get_item_point	select	collection_id, item_id, longitude, latitude, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, subdataset_name, subdataset_bands, crs, datetime, sel_method, coord_crs, resampling	Item Point. Get point value for a STAC item dataset.
get_tileset_metadata	select	collection_id, item_id, tile_matrix_set_id, endpoint	subdataset_name, subdataset_bands, crs, datetime, sel_method	Tileset Metadata. Return metadata for a specific tileset of a STAC item.
get_collection_point	select	collection_id, longitude, latitude, endpoint	scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, expression, asset_bidx, asset_as_band, nodata, unscale, reproject, coord_crs, resampling	Collection Point. Get Point value for a collection dataset.
get_search_point	select	search_id, longitude, latitude, endpoint	scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, expression, asset_bidx, asset_as_band, nodata, unscale, reproject, coord_crs, resampling	Searches Point. Get Point value for a search dataset.
get_tilesets	select	collection_id, item_id, endpoint	subdataset_name, subdataset_bands, crs, datetime, sel_method	Tileset List. Return a list of available tilesets for a STAC item.
get_collection_tileset_metadata	select	collection_id, tile_matrix_set_id, endpoint	ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method	Collection Tileset Metadata. Return metadata for a specific tileset of a STAC collection.
get_search_tileset_metadata	select	search_id, tile_matrix_set_id, endpoint	subdataset_name, subdataset_bands, crs, datetime, sel_method	Searches Tileset Metadata. Return metadata for a specific tileset of a mosaic search.
get_tile_matrix_definitions	select	tile_matrix_set_id, endpoint		Matrix Definition. Return Matrix Definition.
get_collection_tilesets	select	collection_id, endpoint	ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method	Collection Tileset List. Return a list of available tilesets for a STAC collection.
get_search_tilesets	select	search_id, endpoint	subdataset_name, subdataset_bands, crs, datetime, sel_method	Searches Tileset List. Return a list of available tilesets for a mosaic search.
get_tile_matrices	select	endpoint		Matrix List. Return Matrix List.
get_class_map_legend	exec	classmap_name, endpoint	trim_start, trim_end	Get ClassMap Legend. Generate values and color swatches mapping for a given classmap.
get_interval_legend	exec	classmap_name, endpoint	trim_start, trim_end	Get Interval Legend. Generate values and color swatches mapping for a given interval classmap. Returns a color map for intervals, where each interval is defined by a numeric range [min, max] representing the interval boundaries and an RGBA color [red, green, blue, alpha] associated with the interval. The response is a 2D array of interval definitions, where each element is a pair: the first element is an array of two numbers [min, max] defining the interval, and the second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color. Example: [[ [-2, 0], [0, 0, 0, 0] ], [ [1, 32], [255, 255, 178, 255] ]]. This defines two intervals: [-2, 0] mapped to transparent black and [1, 32] mapped to opaque yellow.
get_legend	exec	color_map_name, endpoint	height, width, trim_start, trim_end	Get Legend. Generate a legend image for a given colormap. If the colormap has non-contiguous values at the beginning or end, which aren't desired in the output image, they can be trimmed by specifying the number of values to trim.
get_tile	exec	collection_id, item_id, tile_matrix_set_id, z, x, y, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, format, scale, buffer, color_formula, resampling, colormap_name, colormap, return_mask, padding, subdataset_name, subdataset_bands, crs, datetime, sel_method	Tile Tilematrixsetid Plain. Create map tile from a dataset (without scale or format in path).
get_tile_by_format	exec	collection_id, item_id, tile_matrix_set_id, z, x, y, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, scale, buffer, color_formula, resampling, colormap_name, colormap, return_mask, padding, subdataset_name, subdataset_bands, crs, datetime, sel_method	Tile Tilematrixsetid Format. Create map tile from a dataset (with format in path, without scale).
get_tile_by_scale	exec	collection_id, item_id, tile_matrix_set_id, z, x, y, scale, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, format, buffer, color_formula, resampling, colormap_name, colormap, return_mask, padding, subdataset_name, subdataset_bands, crs, datetime, sel_method	Tile Tilematrixsetid Scale. Create map tile from a dataset (with scale in path, without format).
get_tile_by_scale_and_format	exec	collection_id, item_id, tile_matrix_set_id, z, x, y, scale, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, buffer, color_formula, resampling, colormap_name, colormap, return_mask, padding, subdataset_name, subdataset_bands, crs, datetime, sel_method	Tile Tilematrixsetid. Create map tile from a dataset (with TileMatrixSetId, scale, and format in path).
get_tile_no_tms	exec	collection_id, item_id, z, x, y, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, TileMatrixSetId, format, scale, buffer, color_formula, resampling, colormap_name, colormap, return_mask, padding, subdataset_name, subdataset_bands, crs, datetime, sel_method	Tile Plain. Create map tile from a dataset (without TileMatrixSetId, scale or format in path).
get_tile_no_tms_by_format	exec	collection_id, item_id, z, x, y, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, TileMatrixSetId, scale, buffer, color_formula, resampling, colormap_name, colormap, return_mask, padding, subdataset_name, subdataset_bands, crs, datetime, sel_method	Tile Format. Create map tile from a dataset (with format in path, without TileMatrixSetId or scale).
get_tile_no_tms_by_scale	exec	collection_id, item_id, z, x, y, scale, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, TileMatrixSetId, format, buffer, color_formula, resampling, colormap_name, colormap, return_mask, padding, subdataset_name, subdataset_bands, crs, datetime, sel_method	Tile Scale. Create map tile from a dataset (with scale in path, without TileMatrixSetId or format).
get_tile_no_tms_by_scale_and_format	exec	collection_id, item_id, z, x, y, scale, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, TileMatrixSetId, buffer, color_formula, resampling, colormap_name, colormap, return_mask, padding, subdataset_name, subdataset_bands, crs, datetime, sel_method	Tile. Create map tile from a dataset (with scale and format in path, without TileMatrixSetId).
get_item_bounds	exec	collection_id, item_id, endpoint	subdataset_name, subdataset_bands, crs, datetime, sel_method	Item Bounds. Return the bounds for a STAC item.
get_item_info	exec	collection_id, item_id, endpoint	subdataset_name, subdataset_bands, crs, datetime, sel_method	Item Info. Return dataset's basic info for a STAC item.
get_item_info_geo_json	exec	collection_id, item_id, endpoint	subdataset_name, subdataset_bands, crs, datetime, sel_method	Item Info Geojson. Return info as GeoJSON for a STAC item.
get_item_available_assets	exec	collection_id, item_id, endpoint	subdataset_name, subdataset_bands, crs, datetime, sel_method	Item Available Assets. Return a list of supported assets for a STAC item.
get_item_asset_statistics	exec	collection_id, item_id, endpoint	asset_bidx, nodata, unscale, reproject, resampling, max_size, categorical, c, p, histogram_bins, histogram_range, subdataset_name, subdataset_bands, crs, datetime, sel_method, asset_expression, height, width	Item Asset Statistics. Per asset statistics for a STAC item.
get_item_statistics	exec	collection_id, item_id, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, resampling, max_size, categorical, c, p, histogram_bins, histogram_range, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, height, width	Item Statistics. Merged assets statistics for a STAC item.
get_item_tile_json	exec	collection_id, item_id, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, TileMatrixSetId, tile_format, tile_scale, minzoom, maxzoom, buffer, color_formula, resampling, colormap_name, colormap, return_mask, padding, subdataset_name, subdataset_bands, crs, datetime, sel_method	Item TileJson. Return TileJSON document for a STAC item.
get_item_tile_json_by_tms	exec	collection_id, item_id, tile_matrix_set_id, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, tile_format, tile_scale, minzoom, maxzoom, buffer, color_formula, resampling, colormap_name, colormap, return_mask, padding, subdataset_name, subdataset_bands, crs, datetime, sel_method	Item TileJson Tilematrixsetid As Path. Return TileJSON document for a STAC item with TileMatrixSetId as path.
get_item_wmts_capabilities	exec	collection_id, item_id, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, TileMatrixSetId, tile_format, tile_scale, minzoom, maxzoom, buffer, color_formula, resampling, colormap_name, colormap, return_mask, padding, subdataset_name, subdataset_bands, crs, datetime, sel_method	Item Wmts. OGC WMTS endpoint for a STAC item.
get_item_wmts_capabilities_by_tms	exec	collection_id, item_id, tile_matrix_set_id, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, tile_format, tile_scale, minzoom, maxzoom, buffer, color_formula, resampling, colormap_name, colormap, return_mask, padding, subdataset_name, subdataset_bands, crs, datetime, sel_method	Item Wmts Tilematrixsetid As Path. OGC WMTS endpoint for a STAC item with TileMatrixSetId as path.
get_item_preview	exec	collection_id, item_id, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, format, color_formula, dst_crs, resampling, max_size, height, width, colormap_name, colormap, return_mask, subdataset_name, subdataset_bands, crs, datetime, sel_method	Item Preview. Create preview of a STAC item dataset.
get_item_preview_with_format	exec	collection_id, item_id, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, color_formula, dst_crs, resampling, max_size, height, width, colormap_name, colormap, return_mask, subdataset_name, subdataset_bands, crs, datetime, sel_method	Item Preview With Format. Create preview of a STAC item dataset with format.
get_item_bbox_crop	exec	collection_id, item_id, minx, miny, maxx, maxy, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, color_formula, coord_crs, dst_crs, resampling, max_size, height, width, colormap_name, colormap, return_mask, subdataset_name, subdataset_bands, crs, datetime, sel_method	Item Bbox. Create an image from part of a STAC item dataset (bounding box crop).
get_item_bbox_crop_with_dimensions	exec	collection_id, item_id, minx, miny, maxx, maxy, width, height, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, color_formula, coord_crs, dst_crs, resampling, max_size, colormap_name, colormap, return_mask, subdataset_name, subdataset_bands, crs, datetime, sel_method	Item Bbox With Dimensions. Create an image from part of a STAC item dataset (bounding box crop with dimensions).
get_collection_tile_by_scale_and_format	exec	collection_id, tile_matrix_set_id, z, x, y, scale, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Collection Tile Tilematrixsetid. Create map tile for a STAC collection (with TileMatrixSetId, scale, and format in path).
get_collection_tile	exec	collection_id, tile_matrix_set_id, z, x, y, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, format, scale, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Collection Tile Tilematrixsetid Plain. Create map tile for a STAC collection (with TileMatrixSetId, without scale or format).
get_collection_tile_by_format	exec	collection_id, tile_matrix_set_id, z, x, y, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, scale, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Collection Tile Tilematrixsetid Format. Create map tile for a STAC collection (with TileMatrixSetId and format, without scale).
get_collection_tile_by_scale	exec	collection_id, tile_matrix_set_id, z, x, y, scale, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, format, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Collection Tile Tilematrixsetid Scale. Create map tile for a STAC collection (with TileMatrixSetId and scale, without format).
get_collection_tile_no_tms_by_scale_and_format	exec	collection_id, z, x, y, scale, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, TileMatrixSetId, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Collection Tile. Create map tile for a STAC collection (without TileMatrixSetId, with scale and format).
get_collection_tile_no_tms	exec	collection_id, z, x, y, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, TileMatrixSetId, format, scale, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Collection Tile Plain. Create map tile for a STAC collection (without TileMatrixSetId, scale, or format).
get_collection_tile_no_tms_by_format	exec	collection_id, z, x, y, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, TileMatrixSetId, scale, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Collection Tile Format. Create map tile for a STAC collection (with format, without TileMatrixSetId or scale).
get_collection_tile_no_tms_by_scale	exec	collection_id, z, x, y, scale, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, TileMatrixSetId, format, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Collection Tile Scale. Create map tile for a STAC collection (with scale, without TileMatrixSetId or format).
get_collection_tile_json	exec	collection_id, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, TileMatrixSetId, tile_format, tile_scale, minzoom, maxzoom, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Collection TileJson. Return TileJSON document for a STAC collection.
get_collection_tile_json_by_tms	exec	collection_id, tile_matrix_set_id, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, tile_format, tile_scale, minzoom, maxzoom, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Collection TileJson Tilematrixsetid As Path. Return TileJSON document for a STAC collection with TileMatrixSetId as path.
get_collection_wmts_capabilities	exec	collection_id, endpoint	ids, bbox, query, sortby, datetime, TileMatrixSetId, tile_format, tile_scale, minzoom, maxzoom, expression, asset_bidx, asset_as_band, nodata, unscale, reproject	Collection Wmts. OGC WMTS endpoint for a STAC collection.
get_collection_wmts_capabilities_by_tms	exec	collection_id, tile_matrix_set_id, endpoint	ids, bbox, query, sortby, datetime, tile_format, tile_scale, minzoom, maxzoom, expression, asset_bidx, asset_as_band, nodata, unscale, reproject	Collection Wmts Tilematrixsetid As Path. OGC WMTS endpoint for a STAC collection with TileMatrixSetId as path.
get_collection_assets_for_tile_no_tms	exec	collection_id, z, x, y, endpoint	scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, TileMatrixSetId	Collection Assets For Tile. Return a list of assets which overlap a given tile for a STAC collection (without TileMatrixSetId).
get_collection_assets_for_bbox	exec	collection_id, minx, miny, maxx, maxy, endpoint	scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, coord_crs	Collection Assets For Bbox. Return a list of assets which overlap a given bounding box for a STAC collection.
get_collection_info	exec	collection_id, endpoint		Collection Info. Return search query info from a STAC collection identifier.
get_collection_bbox_crop	exec	collection_id, minx, miny, maxx, maxy, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, coord_crs, dst_crs, max_size, height, width, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask	Collection Bbox. Create an image from part of a STAC collection dataset (bounding box crop).
get_collection_bbox_crop_with_dimensions	exec	collection_id, minx, miny, maxx, maxy, width, height, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, coord_crs, dst_crs, max_size, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask	Collection Bbox With Dimensions. Create an image from part of a STAC collection dataset (bounding box crop with dimensions).
get_collection_point_assets	exec	collection_id, longitude, latitude, endpoint	scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, coord_crs	Collection Point Assets. Return a list of assets for a given point in a collection.
get_search_tile_by_scale_and_format	exec	search_id, tile_matrix_set_id, z, x, y, scale, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Searches Tile Tilematrixsetid. Create map tile (with TileMatrixSetId, scale, and format in path).
get_search_tile	exec	search_id, tile_matrix_set_id, z, x, y, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, format, scale, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Searches Tile Tilematrixsetid Plain. Create map tile (with TileMatrixSetId, without scale or format).
get_search_tile_by_format	exec	search_id, tile_matrix_set_id, z, x, y, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, scale, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Searches Tile Tilematrixsetid Format. Create map tile (with TileMatrixSetId and format, without scale).
get_search_tile_by_scale	exec	search_id, tile_matrix_set_id, z, x, y, scale, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, format, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Searches Tile Tilematrixsetid Scale. Create map tile (with TileMatrixSetId and scale, without format).
get_search_tile_json_by_tms	exec	search_id, tile_matrix_set_id, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, minzoom, maxzoom, tile_format, tile_scale, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Searches TileJson Tilematrixsetid As Path. Return TileJSON document for a search with TileMatrixSetId as path.
get_search_wmts_capabilities_by_tms	exec	search_id, tile_matrix_set_id, endpoint	tile_format, tile_scale, minzoom, maxzoom, expression, asset_bidx, asset_as_band, nodata, unscale, reproject	Searches Wmts Tilematrixsetid As Path. OGC WMTS endpoint with TileMatrixSetId as path.
get_search_info	exec	search_id, endpoint		Searches Info. Get Search query metadata.
get_search_bbox_crop	exec	search_id, minx, miny, maxx, maxy, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, coord_crs, dst_crs, max_size, height, width, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask	Searches Bbox. Create an image from part of a dataset (bounding box crop).
get_search_bbox_crop_with_dimensions	exec	search_id, minx, miny, maxx, maxy, width, height, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, coord_crs, dst_crs, max_size, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask	Searches Bbox With Dimensions. Create an image from part of a dataset (bounding box crop with dimensions).
get_search_bbox_assets	exec	search_id, minx, miny, maxx, maxy, endpoint	scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, coord_crs	Searches Assets For Bbox. Return a list of assets which overlap a given bounding box for a search.
get_search_wmts_capabilities	exec	search_id, endpoint	TileMatrixSetId, tile_format, tile_scale, minzoom, maxzoom, expression, asset_bidx, asset_as_band, nodata, unscale, reproject	Searches Wmts. OGC WMTS endpoint.
get_search_tile_json	exec	search_id, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, TileMatrixSetId, tile_format, tile_scale, minzoom, maxzoom, padding, buffer, color_formula, collection, resampling, pixel_selection, algorithm, algorithm_params, colormap_name, colormap, return_mask	Searches TileJson. Return TileJSON document for a search.
get_search_tile_no_tms	exec	search_id, z, x, y, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, TileMatrixSetId, format, scale, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Searches Tile Plain. The most basic operation.
get_search_tile_no_tms_by_format	exec	search_id, z, x, y, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, TileMatrixSetId, scale, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Searches Tile Format. The most basic operation.
get_search_tile_no_tms_by_scale	exec	search_id, z, x, y, scale, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, TileMatrixSetId, format, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Searches Tile Scale. The most basic operation.
get_search_tile_no_tms_by_scale_and_format	exec	search_id, z, x, y, scale, format, endpoint	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, TileMatrixSetId, buffer, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, padding	Searches Tile. The most basic operation.
get_search_assets_for_tile_no_tms	exec	search_id, z, x, y, endpoint	scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, TileMatrixSetId	Searches Assets For Tile. The most basic operation.
get_search_point_with_assets	exec	search_id, longitude, latitude, endpoint	scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, coord_crs	Searches Point Assets. Return a list of assets for a given point in a search.
register_mosaics_search	exec	endpoint		Register Search. Register a Search query.
crop_feature	exec	collection_id, item_id, endpoint, geometry, type	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, color_formula, coord_crs, resampling, max_size, height, width, colormap_name, colormap, return_mask, dst_crs, subdataset_name, subdataset_bands, crs, datetime, sel_method, format	Geojson Feature. Create image from a geojson feature (without format in path).
crop_feature_by_format	exec	collection_id, item_id, format, endpoint, geometry, type	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, color_formula, coord_crs, resampling, max_size, height, width, colormap_name, colormap, return_mask, dst_crs, subdataset_name, subdataset_bands, crs, datetime, sel_method	Geojson Feature Crop With Format. Create image from a geojson feature with format.
crop_feature_width_by_height	exec	collection_id, item_id, width, height, format, endpoint, geometry, type	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, algorithm, algorithm_params, color_formula, coord_crs, resampling, max_size, colormap_name, colormap, return_mask, dst_crs, subdataset_name, subdataset_bands, crs, datetime, sel_method	Geojson Feature Crop With Dimensions. Create image from a geojson feature with dimensions.
crop_collection_feature	exec	collection_id, endpoint, geometry, type	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, coord_crs, max_size, height, width, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, dst_crs, format	Collection Geojson Feature. Create image from a geojson feature (without format in path).
crop_collection_feature_by_format	exec	collection_id, format, endpoint, geometry, type	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, coord_crs, max_size, height, width, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, dst_crs	Collection Geojson Feature Crop With Format. Create image from a geojson feature with format.
crop_collection_feature_width_by_height	exec	collection_id, width, height, format, endpoint, geometry, type	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, ids, bbox, query, sortby, datetime, subdataset_name, subdataset_bands, crs, sel_method, algorithm, algorithm_params, coord_crs, max_size, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, dst_crs	Collection Geojson Feature Crop With Dimensions. Create image from a geojson feature with dimensions.
crop_search_feature	exec	search_id, endpoint, geometry, type	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, coord_crs, max_size, height, width, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, dst_crs, format	Searches Geojson Feature. Create image from a geojson feature (without format in path).
crop_search_feature_by_format	exec	search_id, format, endpoint, geometry, type	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, coord_crs, max_size, height, width, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, dst_crs	Searches Geojson Feature Crop With Format. Create image from a geojson feature with format.
crop_search_feature_width_by_height	exec	search_id, width, height, format, endpoint, geometry, type	expression, asset_bidx, asset_as_band, nodata, unscale, reproject, scan_limit, items_limit, time_limit, exitwhenfull, skipcovered, subdataset_name, subdataset_bands, crs, datetime, sel_method, algorithm, algorithm_params, coord_crs, max_size, color_formula, collection, resampling, pixel_selection, colormap_name, colormap, return_mask, dst_crs	Searches Geojson Feature Crop With Dimensions. Create image from a geojson feature with dimensions.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
classmap_name	string	classmap name. Required.
collection	string	STAC Collection Identifier. Required.
collection_id	string	STAC Collection Identifier. Required.
color_map_name	string	The name of the registered colormap to generate a legend for. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
format	string	Output format for the tile or image (e.g., png, jpeg, webp). Required.
height	integer	Height in pixels for the output image. Required.
item_id	string	STAC Item Identifier. Required.
latitude	number	Latitude. Required.
longitude	number	Longitude. Required.
maxx	number	Bounding box max X. Required.
maxy	number	Bounding box max Y. Required.
minx	number	Bounding box min X. Required.
miny	number	Bounding box min Y. Required.
scale	number	Numeric scale factor for the tile. Higher values produce larger tiles. Required.
search_id	string	Search Id (pgSTAC Search Hash). Required.
tile_matrix_set_id	string	Identifier selecting one of the TileMatrixSetId supported. Required.
width	integer	Width in pixels for the output image. Required.
x	number	Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix. Required.
y	number	Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix. Required.
z	number	Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile. Required.
TileMatrixSetId	string	Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad'). Known values are: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", and "WorldMercatorWGS84Quad". Default value is None.
algorithm	string	Terrain algorithm name. Known values are: "hillshade", "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max", "median", "mean", "std", and "var". Default value is None.
algorithm_params	string	Terrain algorithm parameters. Default value is None.
asset_as_band	boolean	Asset as Band. Default value is None.
asset_bidx	array	Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). Default value is None.
asset_expression	array	Per asset band expression. Default value is None.
bbox	string	Bounding box (west, south, east, north). Default value is None.
buffer	number	Buffer on each side of the given tile. It must be a multiple of 0.5. Output tilesize will be expanded to tilesize + 2 * buffer (e.g 0.5 = 257x257, 1.0 = 258x258). Default value is None.
c	array	List of pixel categorical values for which to report counts. Default value is None.
categorical	boolean	Return statistics for categorical dataset. Default value is None.
collection	string	STAC Collection ID. Default value is None.
color_formula	string	rio-color formula (info: https://github.com/mapbox/rio-color _). Default value is None.
colormap	string	JSON encoded custom Colormap. Default value is None.
colormap_name	string	Colormap name. Known values are: "accent", "accent_r", "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r", "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r", "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass", "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r", "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r", "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar", "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r", "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r", "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc", "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence", "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative", "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1", "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF", "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges", "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink", "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r", "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r", "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds", "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r", "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r", "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted", "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat", "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter", "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd", "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r", "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter", "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn", "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo", and "turbo_r". Default value is None.
coord_crs	string	Coordinate Reference System of the input coords. Default to epsg:4326. Default value is None.
crs	string	Coordinate Reference System. Default value is None.
datetime	string	Datetime to use for subsetting the asset. Default value is None.
dst_crs	string	Output Coordinate Reference System. Default value is None.
exitwhenfull	boolean	Return as soon as the geometry is fully covered (defaults to True). Default value is None.
expression	string	Band math expression between assets. Default value is None.
format	string	Output image format. Known values are: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", and "pngraw". Default value is None.
height	integer	Height in pixels for the output image. Default value is None.
histogram_bins	string	Defines the number of equal-width bins in the given range (10, by default). If bins is a sequence (comma , delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths. link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html _. Default value is None.
histogram_range	string	Comma , delimited range of the bins. The lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()). Values outside the range are ignored. The first element of the range must be less than or equal to the second. range affects the automatic bin computation as well. link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html _. Default value is None.
ids	string	Array of Item ids. Default value is None.
items_limit	integer	Return as soon as we have N items per geometry (defaults to 100). Default value is None.
max_size	integer	Image output size limit if width and height limits are not set. Default value is None.
maxzoom	integer	Overwrite default maxzoom. Default value is None.
minzoom	integer	Overwrite default minzoom. Default value is None.
nodata	string	Overwrite internal Nodata value. Default value is None.
p	array	List of percentile values (default to [2, 98]). Default value is None.
padding	integer	Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to 0. Default value is None.
pixel_selection	string	Pixel selection method. Known values are: "first", "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", and "count". Default value is None.
query	string	JSON query expression for filtering items. Default value is None.
reproject	string	WarpKernel resampling algorithm (only used when doing re-projection). Defaults to nearest. Known values are: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "max", "min", "med", "q1", "q3", "sum", and "rms". Default value is None.
resampling	string	Resampling method. Known values are: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", and "rms". Default value is None.
return_mask	boolean	Add mask to the output data. Default value is None.
scale	integer	Numeric scale factor for the tile. Higher values produce larger tiles. Default value is None.
scan_limit	integer	Return as soon as we scan N items (defaults to 10000). Default value is None.
sel_method	string	Xarray indexing method to use for inexact matches. Known values are: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", and "mode". Default value is None.
skipcovered	boolean	Skip any items that would show up completely under the previous items (defaults to True). Default value is None.
sortby	string	Sorting expression (e.g. +/-property). Default value is None.
subdataset_bands	array	The index of a subdataset band within the asset. Default value is None.
subdataset_name	string	The name of a subdataset within the asset. Default value is None.
tile_format	string	Default will be automatically defined if the output image needs a mask (png) or not (jpeg). Known values are: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", and "pngraw". Default value is None.
tile_scale	integer	Tile scale factor affecting output size. Values > 1 produce larger tiles (e.g., 1=256x256, 2=512x512). Default value is None.
time_limit	integer	Return after N seconds to avoid long requests (defaults to 5). Default value is None.
trim_end	integer	Number of items to trim from the end of the cmap. Default value is None.
trim_start	integer	Number of items to trim from the start of the cmap. Default value is None.
unscale	boolean	Apply internal Scale or Offset. Default value is None.
width	integer	Width in pixels for the output image. Default value is None.

SELECT examples

get_search_assets_for_tile

Searches Assets For Tile Tilematrixsetid As Path. Return a list of assets which overlap a given tile.

SELECT
id,
assets,
bbox,
collection
FROM azure.planetary_computer_dataplane.data
WHERE search_id = '{{ search_id }}' -- required
AND tile_matrix_set_id = '{{ tile_matrix_set_id }}' -- required
AND z = '{{ z }}' -- required
AND x = '{{ x }}' -- required
AND y = '{{ y }}' -- required
AND collection = '{{ collection }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND scan_limit = '{{ scan_limit }}'
AND items_limit = '{{ items_limit }}'
AND time_limit = '{{ time_limit }}'
AND exitwhenfull = '{{ exitwhenfull }}'
AND skipcovered = '{{ skipcovered }}'
AND subdataset_name = '{{ subdataset_name }}'
AND subdataset_bands = '{{ subdataset_bands }}'
AND crs = '{{ crs }}'
AND datetime = '{{ datetime }}'
AND sel_method = '{{ sel_method }}'
;

get_collection_assets_for_tile

Collection Assets For Tile Tilematrixsetid As Path. Return a list of assets which overlap a given tile for a STAC collection (with TileMatrixSetId).

SELECT
id,
assets,
bbox,
collection
FROM azure.planetary_computer_dataplane.data
WHERE collection_id = '{{ collection_id }}' -- required
AND tile_matrix_set_id = '{{ tile_matrix_set_id }}' -- required
AND z = '{{ z }}' -- required
AND x = '{{ x }}' -- required
AND y = '{{ y }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND scan_limit = '{{ scan_limit }}'
AND items_limit = '{{ items_limit }}'
AND time_limit = '{{ time_limit }}'
AND exitwhenfull = '{{ exitwhenfull }}'
AND skipcovered = '{{ skipcovered }}'
AND ids = '{{ ids }}'
AND bbox = '{{ bbox }}'
AND query = '{{ query }}'
AND sortby = '{{ sortby }}'
AND datetime = '{{ datetime }}'
AND subdataset_name = '{{ subdataset_name }}'
AND subdataset_bands = '{{ subdataset_bands }}'
AND crs = '{{ crs }}'
AND sel_method = '{{ sel_method }}'
;

get_item_feature_statistics

Item Geojson Statistics. Get statistics from a GeoJSON feature for a STAC item.

SELECT
geometry,
statistics,
type
FROM azure.planetary_computer_dataplane.data
WHERE collection_id = '{{ collection_id }}' -- required
AND item_id = '{{ item_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND expression = '{{ expression }}'
AND asset_bidx = '{{ asset_bidx }}'
AND asset_as_band = '{{ asset_as_band }}'
AND nodata = '{{ nodata }}'
AND unscale = '{{ unscale }}'
AND reproject = '{{ reproject }}'
AND coord_crs = '{{ coord_crs }}'
AND resampling = '{{ resampling }}'
AND max_size = '{{ max_size }}'
AND categorical = '{{ categorical }}'
AND c = '{{ c }}'
AND p = '{{ p }}'
AND histogram_bins = '{{ histogram_bins }}'
AND histogram_range = '{{ histogram_range }}'
AND dst_crs = '{{ dst_crs }}'
AND subdataset_name = '{{ subdataset_name }}'
AND subdataset_bands = '{{ subdataset_bands }}'
AND crs = '{{ crs }}'
AND datetime = '{{ datetime }}'
AND sel_method = '{{ sel_method }}'
AND algorithm = '{{ algorithm }}'
AND algorithm_params = '{{ algorithm_params }}'
AND height = '{{ height }}'
AND width = '{{ width }}'
;

get_item_point

Item Point. Get point value for a STAC item dataset.

SELECT
band_names,
coordinates,
values
FROM azure.planetary_computer_dataplane.data
WHERE collection_id = '{{ collection_id }}' -- required
AND item_id = '{{ item_id }}' -- required
AND longitude = '{{ longitude }}' -- required
AND latitude = '{{ latitude }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND expression = '{{ expression }}'
AND asset_bidx = '{{ asset_bidx }}'
AND asset_as_band = '{{ asset_as_band }}'
AND nodata = '{{ nodata }}'
AND unscale = '{{ unscale }}'
AND reproject = '{{ reproject }}'
AND subdataset_name = '{{ subdataset_name }}'
AND subdataset_bands = '{{ subdataset_bands }}'
AND crs = '{{ crs }}'
AND datetime = '{{ datetime }}'
AND sel_method = '{{ sel_method }}'
AND coord_crs = '{{ coord_crs }}'
AND resampling = '{{ resampling }}'
;

get_tileset_metadata

Tileset Metadata. Return metadata for a specific tileset of a STAC item.

SELECT
accessConstraints,
boundingBox,
crs,
dataType,
links,
tileMatrixSetLimits,
title
FROM azure.planetary_computer_dataplane.data
WHERE collection_id = '{{ collection_id }}' -- required
AND item_id = '{{ item_id }}' -- required
AND tile_matrix_set_id = '{{ tile_matrix_set_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND subdataset_name = '{{ subdataset_name }}'
AND subdataset_bands = '{{ subdataset_bands }}'
AND crs = '{{ crs }}'
AND datetime = '{{ datetime }}'
AND sel_method = '{{ sel_method }}'
;

get_collection_point

Collection Point. Get Point value for a collection dataset.

SELECT
band_names,
coordinates,
values
FROM azure.planetary_computer_dataplane.data
WHERE collection_id = '{{ collection_id }}' -- required
AND longitude = '{{ longitude }}' -- required
AND latitude = '{{ latitude }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND scan_limit = '{{ scan_limit }}'
AND items_limit = '{{ items_limit }}'
AND time_limit = '{{ time_limit }}'
AND exitwhenfull = '{{ exitwhenfull }}'
AND skipcovered = '{{ skipcovered }}'
AND ids = '{{ ids }}'
AND bbox = '{{ bbox }}'
AND query = '{{ query }}'
AND sortby = '{{ sortby }}'
AND datetime = '{{ datetime }}'
AND subdataset_name = '{{ subdataset_name }}'
AND subdataset_bands = '{{ subdataset_bands }}'
AND crs = '{{ crs }}'
AND sel_method = '{{ sel_method }}'
AND expression = '{{ expression }}'
AND asset_bidx = '{{ asset_bidx }}'
AND asset_as_band = '{{ asset_as_band }}'
AND nodata = '{{ nodata }}'
AND unscale = '{{ unscale }}'
AND reproject = '{{ reproject }}'
AND coord_crs = '{{ coord_crs }}'
AND resampling = '{{ resampling }}'
;

get_search_point

Searches Point. Get Point value for a search dataset.

SELECT
band_names,
coordinates,
values
FROM azure.planetary_computer_dataplane.data
WHERE search_id = '{{ search_id }}' -- required
AND longitude = '{{ longitude }}' -- required
AND latitude = '{{ latitude }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND scan_limit = '{{ scan_limit }}'
AND items_limit = '{{ items_limit }}'
AND time_limit = '{{ time_limit }}'
AND exitwhenfull = '{{ exitwhenfull }}'
AND skipcovered = '{{ skipcovered }}'
AND subdataset_name = '{{ subdataset_name }}'
AND subdataset_bands = '{{ subdataset_bands }}'
AND crs = '{{ crs }}'
AND datetime = '{{ datetime }}'
AND sel_method = '{{ sel_method }}'
AND expression = '{{ expression }}'
AND asset_bidx = '{{ asset_bidx }}'
AND asset_as_band = '{{ asset_as_band }}'
AND nodata = '{{ nodata }}'
AND unscale = '{{ unscale }}'
AND reproject = '{{ reproject }}'
AND coord_crs = '{{ coord_crs }}'
AND resampling = '{{ resampling }}'
;

get_tilesets

Tileset List. Return a list of available tilesets for a STAC item.

SELECT
tilesets
FROM azure.planetary_computer_dataplane.data
WHERE collection_id = '{{ collection_id }}' -- required
AND item_id = '{{ item_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND subdataset_name = '{{ subdataset_name }}'
AND subdataset_bands = '{{ subdataset_bands }}'
AND crs = '{{ crs }}'
AND datetime = '{{ datetime }}'
AND sel_method = '{{ sel_method }}'
;

get_collection_tileset_metadata

Collection Tileset Metadata. Return metadata for a specific tileset of a STAC collection.

SELECT
accessConstraints,
boundingBox,
crs,
dataType,
links,
tileMatrixSetLimits,
title
FROM azure.planetary_computer_dataplane.data
WHERE collection_id = '{{ collection_id }}' -- required
AND tile_matrix_set_id = '{{ tile_matrix_set_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND ids = '{{ ids }}'
AND bbox = '{{ bbox }}'
AND query = '{{ query }}'
AND sortby = '{{ sortby }}'
AND datetime = '{{ datetime }}'
AND subdataset_name = '{{ subdataset_name }}'
AND subdataset_bands = '{{ subdataset_bands }}'
AND crs = '{{ crs }}'
AND sel_method = '{{ sel_method }}'
;

get_search_tileset_metadata

Searches Tileset Metadata. Return metadata for a specific tileset of a mosaic search.

SELECT
accessConstraints,
boundingBox,
crs,
dataType,
links,
tileMatrixSetLimits,
title
FROM azure.planetary_computer_dataplane.data
WHERE search_id = '{{ search_id }}' -- required
AND tile_matrix_set_id = '{{ tile_matrix_set_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND subdataset_name = '{{ subdataset_name }}'
AND subdataset_bands = '{{ subdataset_bands }}'
AND crs = '{{ crs }}'
AND datetime = '{{ datetime }}'
AND sel_method = '{{ sel_method }}'
;

get_tile_matrix_definitions

Matrix Definition. Return Matrix Definition.

SELECT
id,
boundingBox,
crs,
description,
keywords,
orderedAxes,
tileMatrices,
title,
uri,
wellKnownScaleSet
FROM azure.planetary_computer_dataplane.data
WHERE tile_matrix_set_id = '{{ tile_matrix_set_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get_collection_tilesets

Collection Tileset List. Return a list of available tilesets for a STAC collection.

SELECT
tilesets
FROM azure.planetary_computer_dataplane.data
WHERE collection_id = '{{ collection_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND ids = '{{ ids }}'
AND bbox = '{{ bbox }}'
AND query = '{{ query }}'
AND sortby = '{{ sortby }}'
AND datetime = '{{ datetime }}'
AND subdataset_name = '{{ subdataset_name }}'
AND subdataset_bands = '{{ subdataset_bands }}'
AND crs = '{{ crs }}'
AND sel_method = '{{ sel_method }}'
;

get_search_tilesets

Searches Tileset List. Return a list of available tilesets for a mosaic search.

SELECT
tilesets
FROM azure.planetary_computer_dataplane.data
WHERE search_id = '{{ search_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND subdataset_name = '{{ subdataset_name }}'
AND subdataset_bands = '{{ subdataset_bands }}'
AND crs = '{{ crs }}'
AND datetime = '{{ datetime }}'
AND sel_method = '{{ sel_method }}'
;

get_tile_matrices

Matrix List. Return Matrix List.

SELECT
value
FROM azure.planetary_computer_dataplane.data
WHERE endpoint = '{{ endpoint }}' -- required
;

Lifecycle Methods

get_class_map_legend

Get ClassMap Legend. Generate values and color swatches mapping for a given classmap.

EXEC azure.planetary_computer_dataplane.data.get_class_map_legend 
@classmap_name='{{ classmap_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@trim_start='{{ trim_start }}', 
@trim_end='{{ trim_end }}'
;

get_interval_legend

Get Interval Legend. Generate values and color swatches mapping for a given interval classmap. Returns a color map for intervals, where each interval is defined by a numeric range [min, max] representing the interval boundaries and an RGBA color [red, green, blue, alpha] associated with the interval. The response is a 2D array of interval definitions, where each element is a pair: the first element is an array of two numbers [min, max] defining the interval, and the second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color. Example: [[ [-2, 0], [0, 0, 0, 0] ], [ [1, 32], [255, 255, 178, 255] ]]. This defines two intervals: [-2, 0] mapped to transparent black and [1, 32] mapped to opaque yellow.

EXEC azure.planetary_computer_dataplane.data.get_interval_legend 
@classmap_name='{{ classmap_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@trim_start='{{ trim_start }}', 
@trim_end='{{ trim_end }}'
;

get_legend

Get Legend. Generate a legend image for a given colormap. If the colormap has non-contiguous values at the beginning or end, which aren't desired in the output image, they can be trimmed by specifying the number of values to trim.

EXEC azure.planetary_computer_dataplane.data.get_legend 
@color_map_name='{{ color_map_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@height='{{ height }}', 
@width='{{ width }}', 
@trim_start='{{ trim_start }}', 
@trim_end='{{ trim_end }}'
;

get_tile

Tile Tilematrixsetid Plain. Create map tile from a dataset (without scale or format in path).

EXEC azure.planetary_computer_dataplane.data.get_tile 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@format='{{ format }}', 
@scale='{{ scale }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@resampling='{{ resampling }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_tile_by_format

Tile Tilematrixsetid Format. Create map tile from a dataset (with format in path, without scale).

EXEC azure.planetary_computer_dataplane.data.get_tile_by_format 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@scale='{{ scale }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@resampling='{{ resampling }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_tile_by_scale

Tile Tilematrixsetid Scale. Create map tile from a dataset (with scale in path, without format).

EXEC azure.planetary_computer_dataplane.data.get_tile_by_scale 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@scale='{{ scale }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@format='{{ format }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@resampling='{{ resampling }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_tile_by_scale_and_format

Tile Tilematrixsetid. Create map tile from a dataset (with TileMatrixSetId, scale, and format in path).

EXEC azure.planetary_computer_dataplane.data.get_tile_by_scale_and_format 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@scale='{{ scale }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@resampling='{{ resampling }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_tile_no_tms

Tile Plain. Create map tile from a dataset (without TileMatrixSetId, scale or format in path).

EXEC azure.planetary_computer_dataplane.data.get_tile_no_tms 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@format='{{ format }}', 
@scale='{{ scale }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@resampling='{{ resampling }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_tile_no_tms_by_format

Tile Format. Create map tile from a dataset (with format in path, without TileMatrixSetId or scale).

EXEC azure.planetary_computer_dataplane.data.get_tile_no_tms_by_format 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@scale='{{ scale }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@resampling='{{ resampling }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_tile_no_tms_by_scale

Tile Scale. Create map tile from a dataset (with scale in path, without TileMatrixSetId or format).

EXEC azure.planetary_computer_dataplane.data.get_tile_no_tms_by_scale 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@scale='{{ scale }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@format='{{ format }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@resampling='{{ resampling }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_tile_no_tms_by_scale_and_format

Tile. Create map tile from a dataset (with scale and format in path, without TileMatrixSetId).

EXEC azure.planetary_computer_dataplane.data.get_tile_no_tms_by_scale_and_format 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@scale='{{ scale }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@resampling='{{ resampling }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_item_bounds

Item Bounds. Return the bounds for a STAC item.

EXEC azure.planetary_computer_dataplane.data.get_item_bounds 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_item_info

Item Info. Return dataset's basic info for a STAC item.

EXEC azure.planetary_computer_dataplane.data.get_item_info 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_item_info_geo_json

Item Info Geojson. Return info as GeoJSON for a STAC item.

EXEC azure.planetary_computer_dataplane.data.get_item_info_geo_json 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_item_available_assets

Item Available Assets. Return a list of supported assets for a STAC item.

EXEC azure.planetary_computer_dataplane.data.get_item_available_assets 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_item_asset_statistics

Item Asset Statistics. Per asset statistics for a STAC item.

EXEC azure.planetary_computer_dataplane.data.get_item_asset_statistics 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@asset_bidx='{{ asset_bidx }}', 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@resampling='{{ resampling }}', 
@max_size='{{ max_size }}', 
@categorical={{ categorical }}, 
@c='{{ c }}', 
@p='{{ p }}', 
@histogram_bins='{{ histogram_bins }}', 
@histogram_range='{{ histogram_range }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@asset_expression='{{ asset_expression }}', 
@height='{{ height }}', 
@width='{{ width }}'
;

get_item_statistics

Item Statistics. Merged assets statistics for a STAC item.

EXEC azure.planetary_computer_dataplane.data.get_item_statistics 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@resampling='{{ resampling }}', 
@max_size='{{ max_size }}', 
@categorical={{ categorical }}, 
@c='{{ c }}', 
@p='{{ p }}', 
@histogram_bins='{{ histogram_bins }}', 
@histogram_range='{{ histogram_range }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@height='{{ height }}', 
@width='{{ width }}'
;

get_item_tile_json

Item TileJson. Return TileJSON document for a STAC item.

EXEC azure.planetary_computer_dataplane.data.get_item_tile_json 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@tile_format='{{ tile_format }}', 
@tile_scale='{{ tile_scale }}', 
@minzoom='{{ minzoom }}', 
@maxzoom='{{ maxzoom }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@resampling='{{ resampling }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_item_tile_json_by_tms

Item TileJson Tilematrixsetid As Path. Return TileJSON document for a STAC item with TileMatrixSetId as path.

EXEC azure.planetary_computer_dataplane.data.get_item_tile_json_by_tms 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@tile_format='{{ tile_format }}', 
@tile_scale='{{ tile_scale }}', 
@minzoom='{{ minzoom }}', 
@maxzoom='{{ maxzoom }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@resampling='{{ resampling }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_item_wmts_capabilities

Item Wmts. OGC WMTS endpoint for a STAC item.

EXEC azure.planetary_computer_dataplane.data.get_item_wmts_capabilities 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@tile_format='{{ tile_format }}', 
@tile_scale='{{ tile_scale }}', 
@minzoom='{{ minzoom }}', 
@maxzoom='{{ maxzoom }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@resampling='{{ resampling }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_item_wmts_capabilities_by_tms

Item Wmts Tilematrixsetid As Path. OGC WMTS endpoint for a STAC item with TileMatrixSetId as path.

EXEC azure.planetary_computer_dataplane.data.get_item_wmts_capabilities_by_tms 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@tile_format='{{ tile_format }}', 
@tile_scale='{{ tile_scale }}', 
@minzoom='{{ minzoom }}', 
@maxzoom='{{ maxzoom }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@resampling='{{ resampling }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_item_preview

Item Preview. Create preview of a STAC item dataset.

EXEC azure.planetary_computer_dataplane.data.get_item_preview 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@format='{{ format }}', 
@color_formula='{{ color_formula }}', 
@dst_crs='{{ dst_crs }}', 
@resampling='{{ resampling }}', 
@max_size='{{ max_size }}', 
@height='{{ height }}', 
@width='{{ width }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_item_preview_with_format

Item Preview With Format. Create preview of a STAC item dataset with format.

EXEC azure.planetary_computer_dataplane.data.get_item_preview_with_format 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@color_formula='{{ color_formula }}', 
@dst_crs='{{ dst_crs }}', 
@resampling='{{ resampling }}', 
@max_size='{{ max_size }}', 
@height='{{ height }}', 
@width='{{ width }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_item_bbox_crop

Item Bbox. Create an image from part of a STAC item dataset (bounding box crop).

EXEC azure.planetary_computer_dataplane.data.get_item_bbox_crop 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@minx='{{ minx }}' --required, 
@miny='{{ miny }}' --required, 
@maxx='{{ maxx }}' --required, 
@maxy='{{ maxy }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@color_formula='{{ color_formula }}', 
@coord_crs='{{ coord_crs }}', 
@dst_crs='{{ dst_crs }}', 
@resampling='{{ resampling }}', 
@max_size='{{ max_size }}', 
@height='{{ height }}', 
@width='{{ width }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_item_bbox_crop_with_dimensions

Item Bbox With Dimensions. Create an image from part of a STAC item dataset (bounding box crop with dimensions).

EXEC azure.planetary_computer_dataplane.data.get_item_bbox_crop_with_dimensions 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@minx='{{ minx }}' --required, 
@miny='{{ miny }}' --required, 
@maxx='{{ maxx }}' --required, 
@maxy='{{ maxy }}' --required, 
@width='{{ width }}' --required, 
@height='{{ height }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@color_formula='{{ color_formula }}', 
@coord_crs='{{ coord_crs }}', 
@dst_crs='{{ dst_crs }}', 
@resampling='{{ resampling }}', 
@max_size='{{ max_size }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}'
;

get_collection_tile_by_scale_and_format

Collection Tile Tilematrixsetid. Create map tile for a STAC collection (with TileMatrixSetId, scale, and format in path).

EXEC azure.planetary_computer_dataplane.data.get_collection_tile_by_scale_and_format 
@collection_id='{{ collection_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@scale='{{ scale }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_collection_tile

Collection Tile Tilematrixsetid Plain. Create map tile for a STAC collection (with TileMatrixSetId, without scale or format).

EXEC azure.planetary_computer_dataplane.data.get_collection_tile 
@collection_id='{{ collection_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@format='{{ format }}', 
@scale='{{ scale }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_collection_tile_by_format

Collection Tile Tilematrixsetid Format. Create map tile for a STAC collection (with TileMatrixSetId and format, without scale).

EXEC azure.planetary_computer_dataplane.data.get_collection_tile_by_format 
@collection_id='{{ collection_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@scale='{{ scale }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_collection_tile_by_scale

Collection Tile Tilematrixsetid Scale. Create map tile for a STAC collection (with TileMatrixSetId and scale, without format).

EXEC azure.planetary_computer_dataplane.data.get_collection_tile_by_scale 
@collection_id='{{ collection_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@scale='{{ scale }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@format='{{ format }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_collection_tile_no_tms_by_scale_and_format

Collection Tile. Create map tile for a STAC collection (without TileMatrixSetId, with scale and format).

EXEC azure.planetary_computer_dataplane.data.get_collection_tile_no_tms_by_scale_and_format 
@collection_id='{{ collection_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@scale='{{ scale }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_collection_tile_no_tms

Collection Tile Plain. Create map tile for a STAC collection (without TileMatrixSetId, scale, or format).

EXEC azure.planetary_computer_dataplane.data.get_collection_tile_no_tms 
@collection_id='{{ collection_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@format='{{ format }}', 
@scale='{{ scale }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_collection_tile_no_tms_by_format

Collection Tile Format. Create map tile for a STAC collection (with format, without TileMatrixSetId or scale).

EXEC azure.planetary_computer_dataplane.data.get_collection_tile_no_tms_by_format 
@collection_id='{{ collection_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@scale='{{ scale }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_collection_tile_no_tms_by_scale

Collection Tile Scale. Create map tile for a STAC collection (with scale, without TileMatrixSetId or format).

EXEC azure.planetary_computer_dataplane.data.get_collection_tile_no_tms_by_scale 
@collection_id='{{ collection_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@scale='{{ scale }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@format='{{ format }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_collection_tile_json

Collection TileJson. Return TileJSON document for a STAC collection.

EXEC azure.planetary_computer_dataplane.data.get_collection_tile_json 
@collection_id='{{ collection_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@tile_format='{{ tile_format }}', 
@tile_scale='{{ tile_scale }}', 
@minzoom='{{ minzoom }}', 
@maxzoom='{{ maxzoom }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_collection_tile_json_by_tms

Collection TileJson Tilematrixsetid As Path. Return TileJSON document for a STAC collection with TileMatrixSetId as path.

EXEC azure.planetary_computer_dataplane.data.get_collection_tile_json_by_tms 
@collection_id='{{ collection_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@tile_format='{{ tile_format }}', 
@tile_scale='{{ tile_scale }}', 
@minzoom='{{ minzoom }}', 
@maxzoom='{{ maxzoom }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_collection_wmts_capabilities

Collection Wmts. OGC WMTS endpoint for a STAC collection.

EXEC azure.planetary_computer_dataplane.data.get_collection_wmts_capabilities 
@collection_id='{{ collection_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@tile_format='{{ tile_format }}', 
@tile_scale='{{ tile_scale }}', 
@minzoom='{{ minzoom }}', 
@maxzoom='{{ maxzoom }}', 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}'
;

get_collection_wmts_capabilities_by_tms

Collection Wmts Tilematrixsetid As Path. OGC WMTS endpoint for a STAC collection with TileMatrixSetId as path.

EXEC azure.planetary_computer_dataplane.data.get_collection_wmts_capabilities_by_tms 
@collection_id='{{ collection_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@tile_format='{{ tile_format }}', 
@tile_scale='{{ tile_scale }}', 
@minzoom='{{ minzoom }}', 
@maxzoom='{{ maxzoom }}', 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}'
;

get_collection_assets_for_tile_no_tms

Collection Assets For Tile. Return a list of assets which overlap a given tile for a STAC collection (without TileMatrixSetId).

EXEC azure.planetary_computer_dataplane.data.get_collection_assets_for_tile_no_tms 
@collection_id='{{ collection_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}'
;

get_collection_assets_for_bbox

Collection Assets For Bbox. Return a list of assets which overlap a given bounding box for a STAC collection.

EXEC azure.planetary_computer_dataplane.data.get_collection_assets_for_bbox 
@collection_id='{{ collection_id }}' --required, 
@minx='{{ minx }}' --required, 
@miny='{{ miny }}' --required, 
@maxx='{{ maxx }}' --required, 
@maxy='{{ maxy }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@coord_crs='{{ coord_crs }}'
;

get_collection_info

Collection Info. Return search query info from a STAC collection identifier.

EXEC azure.planetary_computer_dataplane.data.get_collection_info 
@collection_id='{{ collection_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_collection_bbox_crop

Collection Bbox. Create an image from part of a STAC collection dataset (bounding box crop).

EXEC azure.planetary_computer_dataplane.data.get_collection_bbox_crop 
@collection_id='{{ collection_id }}' --required, 
@minx='{{ minx }}' --required, 
@miny='{{ miny }}' --required, 
@maxx='{{ maxx }}' --required, 
@maxy='{{ maxy }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@coord_crs='{{ coord_crs }}', 
@dst_crs='{{ dst_crs }}', 
@max_size='{{ max_size }}', 
@height='{{ height }}', 
@width='{{ width }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}
;

get_collection_bbox_crop_with_dimensions

Collection Bbox With Dimensions. Create an image from part of a STAC collection dataset (bounding box crop with dimensions).

EXEC azure.planetary_computer_dataplane.data.get_collection_bbox_crop_with_dimensions 
@collection_id='{{ collection_id }}' --required, 
@minx='{{ minx }}' --required, 
@miny='{{ miny }}' --required, 
@maxx='{{ maxx }}' --required, 
@maxy='{{ maxy }}' --required, 
@width='{{ width }}' --required, 
@height='{{ height }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@coord_crs='{{ coord_crs }}', 
@dst_crs='{{ dst_crs }}', 
@max_size='{{ max_size }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}
;

get_collection_point_assets

Collection Point Assets. Return a list of assets for a given point in a collection.

EXEC azure.planetary_computer_dataplane.data.get_collection_point_assets 
@collection_id='{{ collection_id }}' --required, 
@longitude='{{ longitude }}' --required, 
@latitude='{{ latitude }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@coord_crs='{{ coord_crs }}'
;

get_search_tile_by_scale_and_format

Searches Tile Tilematrixsetid. Create map tile (with TileMatrixSetId, scale, and format in path).

EXEC azure.planetary_computer_dataplane.data.get_search_tile_by_scale_and_format 
@search_id='{{ search_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@scale='{{ scale }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_search_tile

Searches Tile Tilematrixsetid Plain. Create map tile (with TileMatrixSetId, without scale or format).

EXEC azure.planetary_computer_dataplane.data.get_search_tile 
@search_id='{{ search_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@format='{{ format }}', 
@scale='{{ scale }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_search_tile_by_format

Searches Tile Tilematrixsetid Format. Create map tile (with TileMatrixSetId and format, without scale).

EXEC azure.planetary_computer_dataplane.data.get_search_tile_by_format 
@search_id='{{ search_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@scale='{{ scale }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_search_tile_by_scale

Searches Tile Tilematrixsetid Scale. Create map tile (with TileMatrixSetId and scale, without format).

EXEC azure.planetary_computer_dataplane.data.get_search_tile_by_scale 
@search_id='{{ search_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@scale='{{ scale }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@format='{{ format }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_search_tile_json_by_tms

Searches TileJson Tilematrixsetid As Path. Return TileJSON document for a search with TileMatrixSetId as path.

EXEC azure.planetary_computer_dataplane.data.get_search_tile_json_by_tms 
@search_id='{{ search_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@minzoom='{{ minzoom }}', 
@maxzoom='{{ maxzoom }}', 
@tile_format='{{ tile_format }}', 
@tile_scale='{{ tile_scale }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_search_wmts_capabilities_by_tms

Searches Wmts Tilematrixsetid As Path. OGC WMTS endpoint with TileMatrixSetId as path.

EXEC azure.planetary_computer_dataplane.data.get_search_wmts_capabilities_by_tms 
@search_id='{{ search_id }}' --required, 
@tile_matrix_set_id='{{ tile_matrix_set_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@tile_format='{{ tile_format }}', 
@tile_scale='{{ tile_scale }}', 
@minzoom='{{ minzoom }}', 
@maxzoom='{{ maxzoom }}', 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}'
;

get_search_info

Searches Info. Get Search query metadata.

EXEC azure.planetary_computer_dataplane.data.get_search_info 
@search_id='{{ search_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_search_bbox_crop

Searches Bbox. Create an image from part of a dataset (bounding box crop).

EXEC azure.planetary_computer_dataplane.data.get_search_bbox_crop 
@search_id='{{ search_id }}' --required, 
@minx='{{ minx }}' --required, 
@miny='{{ miny }}' --required, 
@maxx='{{ maxx }}' --required, 
@maxy='{{ maxy }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@coord_crs='{{ coord_crs }}', 
@dst_crs='{{ dst_crs }}', 
@max_size='{{ max_size }}', 
@height='{{ height }}', 
@width='{{ width }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}
;

get_search_bbox_crop_with_dimensions

Searches Bbox With Dimensions. Create an image from part of a dataset (bounding box crop with dimensions).

EXEC azure.planetary_computer_dataplane.data.get_search_bbox_crop_with_dimensions 
@search_id='{{ search_id }}' --required, 
@minx='{{ minx }}' --required, 
@miny='{{ miny }}' --required, 
@maxx='{{ maxx }}' --required, 
@maxy='{{ maxy }}' --required, 
@width='{{ width }}' --required, 
@height='{{ height }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@coord_crs='{{ coord_crs }}', 
@dst_crs='{{ dst_crs }}', 
@max_size='{{ max_size }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}
;

get_search_bbox_assets

Searches Assets For Bbox. Return a list of assets which overlap a given bounding box for a search.

EXEC azure.planetary_computer_dataplane.data.get_search_bbox_assets 
@search_id='{{ search_id }}' --required, 
@minx='{{ minx }}' --required, 
@miny='{{ miny }}' --required, 
@maxx='{{ maxx }}' --required, 
@maxy='{{ maxy }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@coord_crs='{{ coord_crs }}'
;

get_search_wmts_capabilities

Searches Wmts. OGC WMTS endpoint.

EXEC azure.planetary_computer_dataplane.data.get_search_wmts_capabilities 
@search_id='{{ search_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@tile_format='{{ tile_format }}', 
@tile_scale='{{ tile_scale }}', 
@minzoom='{{ minzoom }}', 
@maxzoom='{{ maxzoom }}', 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}'
;

get_search_tile_json

Searches TileJson. Return TileJSON document for a search.

EXEC azure.planetary_computer_dataplane.data.get_search_tile_json 
@search_id='{{ search_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@tile_format='{{ tile_format }}', 
@tile_scale='{{ tile_scale }}', 
@minzoom='{{ minzoom }}', 
@maxzoom='{{ maxzoom }}', 
@padding='{{ padding }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}
;

get_search_tile_no_tms

Searches Tile Plain. The most basic operation.

EXEC azure.planetary_computer_dataplane.data.get_search_tile_no_tms 
@search_id='{{ search_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@format='{{ format }}', 
@scale='{{ scale }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_search_tile_no_tms_by_format

Searches Tile Format. The most basic operation.

EXEC azure.planetary_computer_dataplane.data.get_search_tile_no_tms_by_format 
@search_id='{{ search_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@scale='{{ scale }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_search_tile_no_tms_by_scale

Searches Tile Scale. The most basic operation.

EXEC azure.planetary_computer_dataplane.data.get_search_tile_no_tms_by_scale 
@search_id='{{ search_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@scale='{{ scale }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@format='{{ format }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_search_tile_no_tms_by_scale_and_format

Searches Tile. The most basic operation.

EXEC azure.planetary_computer_dataplane.data.get_search_tile_no_tms_by_scale_and_format 
@search_id='{{ search_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@scale='{{ scale }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}', 
@buffer='{{ buffer }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@padding='{{ padding }}'
;

get_search_assets_for_tile_no_tms

Searches Assets For Tile. The most basic operation.

EXEC azure.planetary_computer_dataplane.data.get_search_assets_for_tile_no_tms 
@search_id='{{ search_id }}' --required, 
@z='{{ z }}' --required, 
@x='{{ x }}' --required, 
@y='{{ y }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@TileMatrixSetId='{{ TileMatrixSetId }}'
;

get_search_point_with_assets

Searches Point Assets. Return a list of assets for a given point in a search.

EXEC azure.planetary_computer_dataplane.data.get_search_point_with_assets 
@search_id='{{ search_id }}' --required, 
@longitude='{{ longitude }}' --required, 
@latitude='{{ latitude }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@coord_crs='{{ coord_crs }}'
;

register_mosaics_search

Register Search. Register a Search query.

EXEC azure.planetary_computer_dataplane.data.register_mosaics_search 
@endpoint='{{ endpoint }}' --required
;

crop_feature

Geojson Feature. Create image from a geojson feature (without format in path).

EXEC azure.planetary_computer_dataplane.data.crop_feature 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@color_formula='{{ color_formula }}', 
@coord_crs='{{ coord_crs }}', 
@resampling='{{ resampling }}', 
@max_size='{{ max_size }}', 
@height='{{ height }}', 
@width='{{ width }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@dst_crs='{{ dst_crs }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@format='{{ format }}' 
@@json=
'{
"geometry": "{{ geometry }}", 
"type": "{{ type }}", 
"properties": "{{ properties }}"
}'
;

crop_feature_by_format

Geojson Feature Crop With Format. Create image from a geojson feature with format.

EXEC azure.planetary_computer_dataplane.data.crop_feature_by_format 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@color_formula='{{ color_formula }}', 
@coord_crs='{{ coord_crs }}', 
@resampling='{{ resampling }}', 
@max_size='{{ max_size }}', 
@height='{{ height }}', 
@width='{{ width }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@dst_crs='{{ dst_crs }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}' 
@@json=
'{
"geometry": "{{ geometry }}", 
"type": "{{ type }}", 
"properties": "{{ properties }}"
}'
;

crop_feature_width_by_height

Geojson Feature Crop With Dimensions. Create image from a geojson feature with dimensions.

EXEC azure.planetary_computer_dataplane.data.crop_feature_width_by_height 
@collection_id='{{ collection_id }}' --required, 
@item_id='{{ item_id }}' --required, 
@width='{{ width }}' --required, 
@height='{{ height }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@color_formula='{{ color_formula }}', 
@coord_crs='{{ coord_crs }}', 
@resampling='{{ resampling }}', 
@max_size='{{ max_size }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@dst_crs='{{ dst_crs }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}' 
@@json=
'{
"geometry": "{{ geometry }}", 
"type": "{{ type }}", 
"properties": "{{ properties }}"
}'
;

crop_collection_feature

Collection Geojson Feature. Create image from a geojson feature (without format in path).

EXEC azure.planetary_computer_dataplane.data.crop_collection_feature 
@collection_id='{{ collection_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@coord_crs='{{ coord_crs }}', 
@max_size='{{ max_size }}', 
@height='{{ height }}', 
@width='{{ width }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@dst_crs='{{ dst_crs }}', 
@format='{{ format }}' 
@@json=
'{
"geometry": "{{ geometry }}", 
"type": "{{ type }}", 
"properties": "{{ properties }}"
}'
;

crop_collection_feature_by_format

Collection Geojson Feature Crop With Format. Create image from a geojson feature with format.

EXEC azure.planetary_computer_dataplane.data.crop_collection_feature_by_format 
@collection_id='{{ collection_id }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@coord_crs='{{ coord_crs }}', 
@max_size='{{ max_size }}', 
@height='{{ height }}', 
@width='{{ width }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@dst_crs='{{ dst_crs }}' 
@@json=
'{
"geometry": "{{ geometry }}", 
"type": "{{ type }}", 
"properties": "{{ properties }}"
}'
;

crop_collection_feature_width_by_height

Collection Geojson Feature Crop With Dimensions. Create image from a geojson feature with dimensions.

EXEC azure.planetary_computer_dataplane.data.crop_collection_feature_width_by_height 
@collection_id='{{ collection_id }}' --required, 
@width='{{ width }}' --required, 
@height='{{ height }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@ids='{{ ids }}', 
@bbox='{{ bbox }}', 
@query='{{ query }}', 
@sortby='{{ sortby }}', 
@datetime='{{ datetime }}', 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@coord_crs='{{ coord_crs }}', 
@max_size='{{ max_size }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@dst_crs='{{ dst_crs }}' 
@@json=
'{
"geometry": "{{ geometry }}", 
"type": "{{ type }}", 
"properties": "{{ properties }}"
}'
;

crop_search_feature

Searches Geojson Feature. Create image from a geojson feature (without format in path).

EXEC azure.planetary_computer_dataplane.data.crop_search_feature 
@search_id='{{ search_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@coord_crs='{{ coord_crs }}', 
@max_size='{{ max_size }}', 
@height='{{ height }}', 
@width='{{ width }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@dst_crs='{{ dst_crs }}', 
@format='{{ format }}' 
@@json=
'{
"geometry": "{{ geometry }}", 
"type": "{{ type }}", 
"properties": "{{ properties }}"
}'
;

crop_search_feature_by_format

Searches Geojson Feature Crop With Format. Create image from a geojson feature with format.

EXEC azure.planetary_computer_dataplane.data.crop_search_feature_by_format 
@search_id='{{ search_id }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@coord_crs='{{ coord_crs }}', 
@max_size='{{ max_size }}', 
@height='{{ height }}', 
@width='{{ width }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@dst_crs='{{ dst_crs }}' 
@@json=
'{
"geometry": "{{ geometry }}", 
"type": "{{ type }}", 
"properties": "{{ properties }}"
}'
;

crop_search_feature_width_by_height

Searches Geojson Feature Crop With Dimensions. Create image from a geojson feature with dimensions.

EXEC azure.planetary_computer_dataplane.data.crop_search_feature_width_by_height 
@search_id='{{ search_id }}' --required, 
@width='{{ width }}' --required, 
@height='{{ height }}' --required, 
@format='{{ format }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@expression='{{ expression }}', 
@asset_bidx='{{ asset_bidx }}', 
@asset_as_band={{ asset_as_band }}, 
@nodata='{{ nodata }}', 
@unscale={{ unscale }}, 
@reproject='{{ reproject }}', 
@scan_limit='{{ scan_limit }}', 
@items_limit='{{ items_limit }}', 
@time_limit='{{ time_limit }}', 
@exitwhenfull={{ exitwhenfull }}, 
@skipcovered={{ skipcovered }}, 
@subdataset_name='{{ subdataset_name }}', 
@subdataset_bands='{{ subdataset_bands }}', 
@crs='{{ crs }}', 
@datetime='{{ datetime }}', 
@sel_method='{{ sel_method }}', 
@algorithm='{{ algorithm }}', 
@algorithm_params='{{ algorithm_params }}', 
@coord_crs='{{ coord_crs }}', 
@max_size='{{ max_size }}', 
@color_formula='{{ color_formula }}', 
@collection='{{ collection }}', 
@resampling='{{ resampling }}', 
@pixel_selection='{{ pixel_selection }}', 
@colormap_name='{{ colormap_name }}', 
@colormap='{{ colormap }}', 
@return_mask={{ return_mask }}, 
@dst_crs='{{ dst_crs }}' 
@@json=
'{
"geometry": "{{ geometry }}", 
"type": "{{ type }}", 
"properties": "{{ properties }}"
}'
;