Stac Collection Render Options - Create

Serviço:: Planetary Computer

Versão da API:: 2026-04-15

Adicionar opção de renderização de coleção
Adicionar uma opção de renderização para uma determinada coleção

POST {endpoint}/stac/collections/{collectionId}/configurations/render-options?api-version=2026-04-15

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
collectionId	path	True	string maxLength: 500 pattern: .*	Identificador exclusivo para a coleção STAC.
endpoint	path	True	string (uri)	Endpoint GeoCatalog, por exemplo, `https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com`
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
id	True	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Identificador exclusivo para a opção de renderização.
name	True	string maxLength: 40	Nome descritivo curto para a opção de renderização.
conditions		RenderOptionCondition[]	Uma lista de condições de propriedade/valor que devem estar no CQL do mosaico ativo para que essa opção de renderização seja habilitada
description		string	Uma descrição mais longa da opção de renderização que pode ser usada para explicar seu conteúdo.
legend		RenderOptionLegend	Configuração de legenda para esta opção de renderização.
minZoom		integer (int32) maximum: 24	Nível mínimo de zoom no qual exibir esta camada.
options		string	Uma string codificada de string de consulta de URL de opções de renderização do TiTiler. Válido apenas para `raster-tile` tipos. Veja parâmetros de consulta.
type		RenderOptionType	O tipo de renderização a ser aplicada (raster ou vetor).
vectorOptions		RenderOptionVectorOptions	Opções para renderizar blocos vetoriais. Válido apenas para `vt-polygon` e `vt-line` tipos.

Respostas

Nome	Tipo	Description
201 Created	RenderOption	A solicitação foi bem-sucedida e um novo recurso foi criado como resultado.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

201 Created

RenderOption

A solicitação foi bem-sucedida e um novo recurso foi criado como resultado.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
https://geocatalog.spatio.azure.com/.default

Exemplos

StacCollectionRenderOptions_Create

Solicitação de exemplo

HTTP

POST {endpoint}/stac/collections/naip-atl/configurations/render-options?api-version=2026-04-15

{
  "id": "test-natural-color",
  "name": "Test Natural color",
  "type": "raster-tile",
  "options": "assets=image&asset_bidx=image|1,2,3",
  "minZoom": 6
}

Resposta de exemplo

Código de status:: 201

{
  "id": "test-natural-color",
  "name": "Test Natural color",
  "type": "raster-tile",
  "options": "assets=image&asset_bidx=image|1,2,3",
  "minZoom": 6
}

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
LegendConfigType	Tipo de legenda a ser feito, um dos seguintes: `continuous`, `classmap`, `interval` ou `none` (nota, `none` é um literal de cadeia de caracteres).
RenderOption	Define parâmetros de visualização para renderizar dados em um mapa.
RenderOptionCondition	Define uma condição para habilitar uma opção de renderização.
RenderOptionLegend	Configuração para gerar uma legenda de dados.
RenderOptionType	Especifica os tipos de opções de renderização para visualização de mapa.
RenderOptionVectorOptions	Define parâmetros para renderização de blocos vetoriais.

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

LegendConfigType

Enumeração

Tipo de legenda a ser feito, um dos seguintes: continuous, classmap, interval ou none (nota, none é um literal de cadeia de caracteres).

Valor	Description
continuous	Legenda de rampa de cores contínua.
classmap	Mapa classificado com cores discretas para as classes.
interval	Legenda baseada em intervalo com intervalos discretos.
none	Sem lenda.

RenderOption

Objeto

Define parâmetros de visualização para renderizar dados em um mapa.

Nome	Tipo	Valor padrão	Description
conditions	RenderOptionCondition[]		Uma lista de condições de propriedade/valor que devem estar no CQL do mosaico ativo para que essa opção de renderização seja habilitada
description	string		Uma descrição mais longa da opção de renderização que pode ser usada para explicar seu conteúdo.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Identificador exclusivo para a opção de renderização.
legend	RenderOptionLegend		Configuração de legenda para esta opção de renderização.
minZoom	integer (int32) maximum: 24	12	Nível mínimo de zoom no qual exibir esta camada.
name	string maxLength: 40		Nome descritivo curto para a opção de renderização.
options	string		Uma string codificada de string de consulta de URL de opções de renderização do TiTiler. Válido apenas para `raster-tile` tipos. Veja parâmetros de consulta.
type	RenderOptionType	raster-tile	O tipo de renderização a ser aplicada (raster ou vetor).
vectorOptions	RenderOptionVectorOptions		Opções para renderizar blocos vetoriais. Válido apenas para `vt-polygon` e `vt-line` tipos.

RenderOptionCondition

Objeto

Define uma condição para habilitar uma opção de renderização.

Nome	Tipo	Description
property	string	Nome da propriedade para fazer check-in do filtro CQL ativo.
value	string	Valor que a propriedade deve igualar.

RenderOptionLegend

Objeto

Configuração para gerar uma legenda de dados.

Nome	Tipo	Description
labels	string[]	Rótulos de texto a serem exibidos na legenda.
scaleFactor	number (float)	Um fator pelo qual multiplicar rótulos de legenda de intervalo. Útil para rasters dimensionados cujas definições de mapa de cores são mapeadas para valores não dimensionados, mostrando efetivamente rótulos de legenda como valores dimensionados.
trimEnd	integer (int32)	Número de itens a serem cortados do final da legenda.
trimStart	integer (int32)	O número de itens a serem cortados desde o início da definição da legenda. Usado se houver valores importantes para renderização (por exemplo, nodata) que não são desejáveis na legenda.
type	LegendConfigType	Tipo de legenda a ser feito, um dos seguintes: `continuous`, `classmap`, `interval` ou `none` (nota, `none` é um literal de cadeia de caracteres).

RenderOptionType

Enumeração

Especifica os tipos de opções de renderização para visualização de mapa.

Valor	Description
raster-tile	Tipo de renderização de bloco raster.
vt-polygon	Tipo de renderização de polígono de bloco vetorial.
vt-line	Tipo de renderização de linha de bloco vetorial.

RenderOptionVectorOptions

Objeto

Define parâmetros para renderização de blocos vetoriais.

Nome	Tipo	Description
fillColor	string	Cor de preenchimento para feições de polígono.
filter	string[]	Expressão de filtro GL do MapBox para filtrar recursos.
sourceLayer	string	Nome da camada de origem nos blocos de vetor.
strokeColor	string	Cor do traçado para feições de linha.
strokeWidth	integer (int32)	Largura dos traços de linha em pixels.
tilejsonKey	string	Chave de ativo que contém a URL TileJSON.

Compartilhar via

Stac Collection Render Options - Create

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

OAuth2Auth

Escopos

Exemplos

StacCollectionRenderOptions_Create

Solicitação de exemplo

Resposta de exemplo

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions