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 do URI

Name	Em	Necessá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 utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
id	True	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Identificador único 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 mosaico CQL ativo para que esta opção de renderização esteja ativada
description		string	Uma descrição mais longa da opção de renderização que pode ser usada para explicar o 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 para mostrar esta camada.
options		string	Uma sequência codificada por URL de opções de renderização TiTiler. Válido apenas para `raster-tile` tipos. Veja Parâmetros de Consulta.
type		RenderOptionType	O tipo de renderização a aplicar (raster ou vetor).
vectorOptions		RenderOptionVectorOptions	Opções para renderização de blocos vetoriais. Válido apenas para `vt-polygon` e `vt-line` tipos.

Respostas

Name	Tipo	Description
201 Created	RenderOption	O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

201 Created

RenderOption

O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

OAuth2Auth

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

Âmbitos

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

Exemplos

StacCollectionRenderOptions_Create

Pedido de amostra

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 da amostra

Código de estado:: 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

Name	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
LegendConfigType	Tipo de legenda a formar, uma de: `continuous`, `classmap`, `interval` ou `none` (nota, `none` é um literal de corda).
RenderOption	Define parâmetros de visualização para renderizar dados num mapa.
RenderOptionCondition	Define uma condição para ativar 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 mapas.
RenderOptionVectorOptions	Define parâmetros para renderização de tiles vetoriais.

Azure.Core.Foundations.Error

Object

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
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 por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Object

Uma resposta contendo detalhes do erro.

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

Azure.Core.Foundations.InnerError

Object

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

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

LegendConfigType

Enumeração

Tipo de legenda a formar, uma de: continuous, classmap, interval ou none (nota, none é um literal de corda).

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

RenderOption

Object

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

Name	Tipo	Default value	Description
conditions	RenderOptionCondition[]		Uma lista de condições de propriedade/valor que devem estar no mosaico CQL ativo para que esta opção de renderização esteja ativada
description	string		Uma descrição mais longa da opção de renderização que pode ser usada para explicar o seu conteúdo.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Identificador único 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 para mostrar esta camada.
name	string maxLength: 40		Nome descritivo curto para a opção de renderização.
options	string		Uma sequência codificada por URL de opções de renderização TiTiler. Válido apenas para `raster-tile` tipos. Veja Parâmetros de Consulta.
type	RenderOptionType	raster-tile	O tipo de renderização a aplicar (raster ou vetor).
vectorOptions	RenderOptionVectorOptions		Opções para renderização de blocos vetoriais. Válido apenas para `vt-polygon` e `vt-line` tipos.

RenderOptionCondition

Object

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

Name	Tipo	Description
property	string	Nome da propriedade para verificar no filtro CQL ativo.
value	string	Valor que a propriedade deve igualar.

RenderOptionLegend

Object

Configuração para gerar uma legenda de dados.

Name	Tipo	Description
labels	string[]	Etiquetas de texto para mostrar na legenda.
scaleFactor	number (float)	Um fator para multiplicar rótulos de legendas de intervalos por. Útil para rasters escalados cujas definições de colormap mapeiam para valores não escalados, mostrando efetivamente as legendas como valores escalados.
trimEnd	integer (int32)	Número de itens a cortar a partir do final da lenda.
trimStart	integer (int32)	O número de itens a cortar desde o início da definição da lenda. 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 formar, uma de: `continuous`, `classmap`, `interval` ou `none` (nota, `none` é um literal de corda).

RenderOptionType

Enumeração

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

Valor	Description
raster-tile	Tipo de renderização de tiles raster.
vt-polygon	Tipo de renderização de polígonos em tiles vetoriais.
vt-line	Tipo de renderização de linhas de tiles vetoriais.

RenderOptionVectorOptions

Object

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

Name	Tipo	Description
fillColor	string	Cor de preenchimento para características de polígonos.
filter	string[]	MapBox GL filtra expressão para características de filtro.
sourceLayer	string	Nome da camada de origem nos tiles vetoriais.
strokeColor	string	Cor do traço para as características das linhas.
strokeWidth	integer (int32)	Largura dos traços de linha em pixels.
tilejsonKey	string	Chave de ativo contendo a URL TileJSON.

Partilhar via

Stac Collection Render Options - Create

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

OAuth2Auth

Âmbitos

Exemplos

StacCollectionRenderOptions_Create

Pedido de amostra

Resposta da amostra

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions