Feature State - Get Stateset

Referência

Service:: Maps Creator

API Version:: 2.0

Use para recuperar informações do conjunto de estados.

A Get Stateset API é uma solicitação HTTP GET usada para recuperar as informações de conjunto de estados especificadas, incluindo o datasetId associado ao conjunto de estados e seus estilos.

GET https://{geography}.atlas.microsoft.com/featureStateSets/{statesetId}?api-version=2.0

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
geography	path	True	string	Esse parâmetro especifica onde o recurso criador de Azure Mapas está localizado. Os valores válidos são nós e eu.
statesetId	path	True	string	A ID do conjunto de estados que foi criada.
api-version	query	True	string	Número de versão da API de Mapas Azure.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Nome	Tipo	Description
200 OK	Stateset	Obtenha a solicitação concluída com êxito.
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso ao qual o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de Microsoft Entra ID. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Para obter mais informações sobre plataforma de identidade da Microsoft, consulte visão geral plataforma de identidade da Microsoft.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Essa é uma chave compartilhada provisionada quando você cria uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave master na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST para que sua chave possa ser armazenada com segurança.

Type: apiKey
In: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado à expiração, taxa e regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta do Mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Type: apiKey
In: header

Exemplos

Get stateset information with a statesetId

Sample Request

HTTP

GET https://us.atlas.microsoft.com/featureStateSets/b24bdb73-1305-3212-1909-a428d937b64?api-version=2.0

Sample Response

Status code:: 200

{
  "description": "Stateset for Azure Maps POC.",
  "datasetIds": [
    "8d700cc7-fd2c-4e21-b402-ad3f5e524f36"
  ],
  "statesetStyle": {
    "styles": [
      {
        "keyName": "s1",
        "type": "boolean",
        "rules": [
          {
            "true": "#FFFF00",
            "false": "#FFFFFF"
          }
        ]
      },
      {
        "keyName": "s2",
        "type": "number",
        "rules": [
          {
            "range": {
              "minimum": null,
              "maximum": null,
              "exclusiveMinimum": null,
              "exclusiveMaximum": "50"
            },
            "color": "#343deb"
          },
          {
            "range": {
              "minimum": "50",
              "maximum": null,
              "exclusiveMinimum": null,
              "exclusiveMaximum": "69"
            },
            "color": "#34ebb1"
          },
          {
            "range": {
              "minimum": "69",
              "maximum": null,
              "exclusiveMinimum": null,
              "exclusiveMaximum": "90"
            },
            "color": "#eba834"
          },
          {
            "range": {
              "minimum": "90",
              "maximum": null,
              "exclusiveMinimum": null,
              "exclusiveMaximum": null
            },
            "color": "#eb3434"
          }
        ]
      }
    ]
  }
}

Definições

Nome	Description
BooleanRule	A regra booliana. A cor é selecionada com base no valor lógico da chave.
BooleanStyleRule	O objeto de regra de estilo de tipo booliano.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
NumberRule	A regra numérica. A cor é selecionada no primeiro intervalo em que se enquadra.
NumberStyleRule	O objeto de regra de estilo de tipo numérico.
Range	O intervalo de valor numérico para essa regra de estilo. Se o valor estiver no intervalo, todas as condições deverão ser verdadeiras.
Stateset	O modelo de resposta para a API Get do Conjunto de Estados bem-sucedida.
StringStyleRule	O objeto de regra de estilo de tipo de cadeia de caracteres.
StyleRules	O modelo de estilos.

BooleanRule

A regra booliana. A cor é selecionada com base no valor lógico da chave.

Nome	Tipo	Description
false	string	A cor quando o valor é false. Cor é uma cadeia de caracteres JSON em uma variedade de formatos permitidos, valores hexadecimais no estilo HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)" e HSLA("hsla(100, 50%, 50%, 1)"). Nomes de cores HTML predefinidos, como amarelo e azul, também são permitidos.
true	string	A cor quando o valor é true. Cor é uma cadeia de caracteres JSON em uma variedade de formatos permitidos, valores hexadecimais no estilo HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)" e HSLA("hsla(100, 50%, 50%, 1)"). Nomes de cores HTML predefinidos, como amarelo e azul, também são permitidos.

BooleanStyleRule

O objeto de regra de estilo de tipo booliano.

Nome	Tipo	Description
keyName	string	Nome da chave de estilo de conjunto de estados. Os nomes de chave são cadeias de caracteres aleatórias, mas devem ser exclusivos dentro da matriz de estilo.
rules	BooleanRule[]	Regras de estilo booliano.
type	string: boolean	O tipo de estilo de conjunto de estados.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

NumberRule

A regra numérica. A cor é selecionada no primeiro intervalo em que se enquadra.

Nome	Tipo	Description
color	string	A cor quando o valor está dentro do intervalo. Cor é uma cadeia de caracteres JSON em uma variedade de formatos permitidos, valores hexadecimais no estilo HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)" e HSLA("hsla(100, 50%, 50%, 1)"). Nomes de cores HTML predefinidos, como amarelo e azul, também são permitidos.
range	Range	O intervalo de valor numérico para essa regra de estilo. Se o valor estiver no intervalo, todas as condições deverão ser verdadeiras.

NumberStyleRule

O objeto de regra de estilo de tipo numérico.

Nome	Tipo	Description
keyName	string	Nome da chave de estilo de conjunto de estados. Os nomes de chave são cadeias de caracteres aleatórias, mas devem ser exclusivos dentro da matriz de estilo.
rules	NumberRule[]	Regras de estilo numérico.
type	string: number	O tipo de estilo de conjunto de estados.

Range

O intervalo de valor numérico para essa regra de estilo. Se o valor estiver no intervalo, todas as condições deverão ser verdadeiras.

Nome	Tipo	Description
exclusiveMaximum	string	Todo o número x que x < exclusiveMaximum.
exclusiveMinimum	string	Todo o número x que x > exclusiveMinimum.
maximum	string	Todo o número x que x ≤ máximo.
minimum	string	Todo o número x que x ≥ mínimo.

Stateset

O modelo de resposta para a API Get do Conjunto de Estados bem-sucedida.

Nome	Tipo	Description
datasetIds	string[]	ID do conjunto de dados associada ao conjunto de estados.
description	string	Descrição associada ao conjunto de estados.
statesetStyle	StyleRules	O modelo de estilos.

StringStyleRule

O objeto de regra de estilo de tipo de cadeia de caracteres.

Nome	Tipo	Description
keyName	string	Nome da chave de estilo de conjunto de estados. Os nomes de chave são cadeias de caracteres aleatórias, mas devem ser exclusivos dentro da matriz de estilo.
rules	object[]	Regras de estilo de cadeia de caracteres.
type	string: string	O tipo de estilo de conjunto de estados.

StyleRules

O modelo de estilos.

Nome	Tipo	Description
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Uma matriz de regras de estilo de conjunto de estados. A regra de estilo pode ser numérica ou cadeia de caracteres ou uma regra de estilo de tipo booliano. Veja as definições de NumberRule, StringRule e BooleanRule aqui.