Feature State - Create Stateset
Utilize para criar um novo conjunto de estados.
Nota
Azure Maps Descontinuação do serviço Estado da Funcionalidade do Criador
O serviço Azure Maps Creator Feature State foi preterido e será descontinuado a 31/03/25. Para evitar interrupções no serviço, descontinue a utilização dos serviços do Estado da Funcionalidade até 31/31/25. Para obter informações sobre o estilo de funcionalidades em tempo real no Criador, consulte Melhorar os mapas interiores com estilo de funcionalidade de mapa em tempo real.
A Create Stateset
API é um pedido HTTP POST
utilizado para criar um novo conjunto de estados, definindo os valores e estilos correspondentes para as respetivas propriedades no corpo do pedido. Para obter mais informações, veja Create um conjunto de estados de funcionalidades.
O serviço Estado da Funcionalidade permite que o utilizador atualize os estados de uma funcionalidade e consulte-os para serem utilizados noutros serviços. As propriedades dinâmicas de uma funcionalidade que não pertence ao conjunto de dados são referidas como estados aqui.
Este pivot do serviço Estado da Funcionalidade no conjunto de estados. Tal como o conjunto de mosaicos, o stateset encapsula o mecanismo de armazenamento para estados de funcionalidades de um conjunto de dados.
Assim que o stateset for criado, os utilizadores podem utilizá-lo statesetId
para publicar atualizações de estado de funcionalidades e obter os estados de funcionalidade atuais. Uma funcionalidade só pode ter um estado num determinado momento.
O estado da funcionalidade é definido pelo nome da chave, valor e carimbo de data/hora. Quando uma atualização de estado de funcionalidade é publicada no Azure Maps, o valor de estado só é atualizado se o carimbo de data/hora do estado fornecido for posterior ao carimbo de data/hora armazenado.
Azure Maps MapControl fornece uma forma de utilizar estes estados de funcionalidade para modelar as funcionalidades. Para obter mais informações, veja Os serviços de Composição Obtêm Mosaico de Estado do Mapa.
POST https://{geography}.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId={datasetId}
POST https://{geography}.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId={datasetId}&description={description}
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
geography
|
path | True |
string |
Este parâmetro especifica onde está localizado o recurso Azure Maps Creator. Os valores válidos somos nós e eu. |
api-version
|
query | True |
string |
Número da versão da API Azure Maps. |
dataset
|
query | True |
string |
O datasetId deve ter sido obtido a partir de um conjunto de dados Create chamada à API com êxito. |
description
|
query |
string |
Descrição do conjunto de estados. O comprimento máximo permitido é 1000. |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
x-ms-client-id |
string |
Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps veja os seguintes artigos para obter orientações. |
Corpo do Pedido
Name | Tipo | Description |
---|---|---|
styles | StyleRule[]: |
Uma matriz de regras de estilo de conjunto de estados. A regra de estilo pode ser uma regra numérica ou de cadeia ou de estilo booleano. Veja as definições NumberRule, StringRule e BooleanRule aqui. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Stateset criado. |
|
Other Status Codes |
Ocorreu um erro inesperado. |
Segurança
AADToken
Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.
Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.
Notas
- Esta definição de segurança requer a utilização do
x-ms-client-id
cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.
O Authorization URL
é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID.
* O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
* A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.
- Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Esta é uma chave partilhada que é aprovisionada quando Create uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.
Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.
Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.
Type:
apiKey
In:
query
SAS Token
Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.
Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.
Type:
apiKey
In:
header
Exemplos
Create a new stateset with a datasetId
Sample Request
POST https://us.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId=5d34fbe8-87b7-f7c0-3144-c50e003a3c75&description=Stateset for Azure Maps POC.
{
"styles": [
{
"keyName": "s1",
"type": "boolean",
"rules": [
{
"true": "#FF0000",
"false": "#00FF00"
}
]
},
{
"keyName": "s2",
"type": "number",
"rules": [
{
"range": {
"exclusiveMaximum": "50"
},
"color": "#343deb"
},
{
"range": {
"minimum": "50",
"exclusiveMaximum": "70"
},
"color": "#34ebb1"
},
{
"range": {
"minimum": "70",
"exclusiveMaximum": "90"
},
"color": "#eba834"
},
{
"range": {
"minimum": "90"
},
"color": "#eb3434"
}
]
},
{
"keyName": "s3",
"type": "string",
"rules": [
{
"stateValue1": "#FF0000",
"stateValue2": "#FF00AA",
"stateValueN": "#00FF00"
}
]
}
]
}
Sample Response
{
"statesetId": "b24bdb73-1305-3212-1909-a428d937b64f"
}
Definições
Name | Description |
---|---|
Boolean |
A regra booleana. A cor é selecionada com base no valor lógico da chave. |
Boolean |
O objeto de regra de estilo de tipo booleano. |
Error |
Informações adicionais sobre o erro de gestão de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta a erros |
Number |
A regra numérica. A cor é selecionada a partir do primeiro intervalo em que se insere. |
Number |
O objeto de regra de estilo de tipo numérico. |
Range |
O intervalo de valores numéricos para esta regra de estilo. Se o valor estiver no intervalo, todas as condições têm de ser verdadeiras. |
Stateset |
O modelo de resposta para a API de Create do Stateset bem-sucedida. |
String |
O objeto de regra de estilo de tipo de cadeia. |
Style |
O modelo de estilos. |
BooleanRule
A regra booleana. A cor é selecionada com base no valor lógico da chave.
Name | Tipo | Description |
---|---|---|
false |
string |
A cor quando o valor é falso. A cor é uma cadeia JSON numa variedade de formatos permitidos, valores hexadecimais de 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)"). Também são permitidos nomes de cores HTML predefinidos, como amarelo e azul. |
true |
string |
A cor quando o valor é verdadeiro. A cor é uma cadeia JSON numa variedade de formatos permitidos, valores hexadecimais de 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)"). Também são permitidos nomes de cores HTML predefinidos, como amarelo e azul. |
BooleanStyleRule
O objeto de regra de estilo de tipo booleano.
Name | Tipo | Description |
---|---|---|
keyName |
string |
Nome da chave de estilo stateset. Os nomes das chaves são cadeias aleatórias, mas devem ser exclusivos dentro da matriz de estilos. |
rules |
Regras de estilo booleano. |
|
type |
string:
boolean |
O tipo de estilo de conjunto de estados. |
ErrorAdditionalInfo
Informações adicionais sobre o erro de gestão de recursos.
Name | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
Name | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta a erros
Name | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
NumberRule
A regra numérica. A cor é selecionada a partir do primeiro intervalo em que se insere.
Name | Tipo | Description |
---|---|---|
color |
string |
A cor quando o valor está dentro do intervalo. A cor é uma cadeia JSON numa variedade de formatos permitidos, valores hexadecimais de 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)"). Também são permitidos nomes de cores HTML predefinidos, como amarelo e azul. |
range |
O intervalo de valores numéricos para esta regra de estilo. Se o valor estiver no intervalo, todas as condições têm de ser verdadeiras. |
NumberStyleRule
O objeto de regra de estilo de tipo numérico.
Name | Tipo | Description |
---|---|---|
keyName |
string |
Nome da chave de estilo stateset. Os nomes das chaves são cadeias aleatórias, mas devem ser exclusivos dentro da matriz de estilos. |
rules |
Regras de estilo numérico. |
|
type |
string:
number |
O tipo de estilo de conjunto de estados. |
Range
O intervalo de valores numéricos para esta regra de estilo. Se o valor estiver no intervalo, todas as condições têm de ser verdadeiras.
Name | 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. |
StatesetCreatedResult
O modelo de resposta para a API de Create do Stateset bem-sucedida.
Name | Tipo | Description |
---|---|---|
statesetId |
string |
O ID do novo conjunto de estados criado. |
StringStyleRule
O objeto de regra de estilo de tipo de cadeia.
Name | Tipo | Description |
---|---|---|
keyName |
string |
Nome da chave de estilo stateset. Os nomes das chaves são cadeias aleatórias, mas devem ser exclusivos dentro da matriz de estilos. |
rules |
object[] |
Regras de estilo de cadeia. |
type |
string:
string |
O tipo de estilo de conjunto de estados. |
StyleRules
O modelo de estilos.
Name | Tipo | Description |
---|---|---|
styles | StyleRule[]: |
Uma matriz de regras de estilo de conjunto de estados. A regra de estilo pode ser uma regra numérica ou de cadeia ou de estilo booleano. Veja as definições NumberRule, StringRule e BooleanRule aqui. |