Feature State - Get Stateset

Odwołanie

Service:: Maps Creator

API Version:: 2.0

Służy do pobierania informacji o zestawie stanów.

Uwaga

wycofanie usługi stanu funkcji twórcy Azure Maps

Usługa stanu funkcji twórcy Azure Maps jest teraz przestarzała i zostanie wycofana w dniu 3/31/25. Aby uniknąć przerw w działaniu usługi, zaprzestaj korzystania z usług stanu funkcji przez 3/31/25. Aby uzyskać informacje na temat stylu funkcji w czasie rzeczywistym w kreatorze, zobacz Ulepszanie map wewnętrznych za pomocą stylu funkcji mapy w czasie rzeczywistym.

Interfejs Get Stateset API to żądanie HTTP GET używane do pobierania określonych informacji o zestawie stanów, w tym datasetId skojarzonych z zestawem stanów i jego stylach.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
geography	path	True	string	Ten parametr określa, gdzie znajduje się zasób Azure Maps Creator. Prawidłowe wartości to my i eu.
statesetId	path	True	string	Identyfikator zestawu stanów, który został utworzony.
api-version	query	True	string	Numer wersji interfejsu API Azure Maps.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Tożsamość Microsoft Entra. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby użyć zabezpieczeń Tożsamość Microsoft Entra w usłudze Azure Maps, zobacz następujące artykuły, aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Stateset	Pomyślnie ukończono żądanie.
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu OAuth 2.0 Microsoft Entra. W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

Ta definicja zabezpieczeń wymaga użycia nagłówkax-ms-client-id, aby wskazać, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje Tożsamość Microsoft Entra. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

Aby uzyskać więcej informacji na temat Platforma tożsamości Microsoft, zobacz omówienie Platforma tożsamości Microsoft.

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

Scopes

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas Twórca konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST Azure Maps w celu bezpiecznego przechowywania klucza.

Type: apiKey
In: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.

Type: apiKey
In: header

Przykłady

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"
          }
        ]
      }
    ]
  }
}

Definicje

Nazwa	Opis
BooleanRule	Reguła logiczna. Kolor jest wybierany na podstawie wartości logiki klucza.
BooleanStyleRule	Obiekt reguły stylu typu logicznego.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
NumberRule	Reguła liczbowa. Kolor jest wybierany z pierwszego zakresu, do których należy.
NumberStyleRule	Obiekt reguły stylu typu liczbowego.
Range	Zakres wartości liczbowych dla tej reguły stylu. Jeśli wartość znajduje się w zakresie, wszystkie warunki muszą zawierać wartość true.
Stateset	Model odpowiedzi dla pomyślnego interfejsu API pobierania zestawu stanów.
StringStyleRule	Obiekt reguły stylu typu ciągu.
StyleRules	Model stylów.

BooleanRule

Reguła logiczna. Kolor jest wybierany na podstawie wartości logiki klucza.

Nazwa	Typ	Opis
false	string	Kolor, gdy wartość jest fałszem. Kolor to ciąg JSON w różnych dozwolonych formatach, wartościach szesnastkowych w stylu HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") i HSLA("hsla(100, 50%, 50%, 1)"). Wstępnie zdefiniowane nazwy kolorów HTML, takie jak żółte i niebieskie, są również dozwolone.
true	string	Kolor, gdy wartość jest prawdziwa. Kolor to ciąg JSON w różnych dozwolonych formatach, wartościach szesnastkowych w stylu HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") i HSLA("hsla(100, 50%, 50%, 1)"). Wstępnie zdefiniowane nazwy kolorów HTML, takie jak żółte i niebieskie, są również dozwolone.

BooleanStyleRule

Obiekt reguły stylu typu logicznego.

Nazwa	Typ	Opis
keyName	string	Nazwa klucza stylu zestawu stanów. Nazwy kluczy są ciągami losowymi, ale powinny być unikatowe wewnątrz tablicy stylów.
rules	BooleanRule[]	Reguły stylu logicznego.
type	string: boolean	Typ stylu zestawu stanów.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

NumberRule

Reguła liczbowa. Kolor jest wybierany z pierwszego zakresu, do których należy.

Nazwa	Typ	Opis
color	string	Kolor, gdy wartość znajduje się w zakresie. Kolor to ciąg JSON w różnych dozwolonych formatach, wartościach szesnastkowych w stylu HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") i HSLA("hsla(100, 50%, 50%, 1)"). Wstępnie zdefiniowane nazwy kolorów HTML, takie jak żółte i niebieskie, są również dozwolone.
range	Range	Zakres wartości liczbowych dla tej reguły stylu. Jeśli wartość znajduje się w zakresie, wszystkie warunki muszą zawierać wartość true.

NumberStyleRule

Obiekt reguły stylu typu liczbowego.

Nazwa	Typ	Opis
keyName	string	Nazwa klucza stylu zestawu stanów. Nazwy kluczy są ciągami losowymi, ale powinny być unikatowe wewnątrz tablicy stylów.
rules	NumberRule[]	Reguły stylu liczbowego.
type	string: number	Typ stylu zestawu stanów.

Range

Zakres wartości liczbowych dla tej reguły stylu. Jeśli wartość znajduje się w zakresie, wszystkie warunki muszą zawierać wartość true.

Nazwa	Typ	Opis
exclusiveMaximum	string	Wszystkie liczby x x < exclusiveMaximum.
exclusiveMinimum	string	Wszystkie liczby x x > exclusiveMinimum.
maximum	string	Cała liczba x x ≤ maksimum.
minimum	string	Wszystkie liczby x x ≥ minimum.

Stateset

Model odpowiedzi dla pomyślnego interfejsu API pobierania zestawu stanów.

Nazwa	Typ	Opis
datasetIds	string[]	Identyfikator zestawu danych skojarzony z zestawem stanów.
description	string	Opis skojarzony z zestawem stanów.
statesetStyle	StyleRules	Model stylów.

StringStyleRule

Obiekt reguły stylu typu ciągu.

Nazwa	Typ	Opis
keyName	string	Nazwa klucza stylu zestawu stanów. Nazwy kluczy są ciągami losowymi, ale powinny być unikatowe wewnątrz tablicy stylów.
rules	object[]	Reguły stylu ciągu.
type	string: string	Typ stylu zestawu stanów.

StyleRules

Model stylów.

Nazwa	Typ	Opis
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Tablica reguł stylu zestawu stanów. Reguła stylu może być numeryczną lub ciągową albo regułą stylu typu logicznego. Zapoznaj się z definicjami NumberRule, StringRule i BooleanRule tutaj.