Feature State - Get Stateset

Odwołanie

Usługa:: Maps Creator

Wersja interfejsu API:: 2.0

Użyj polecenia , aby pobrać informacje o zestawie stanów.

Uwaga

Wycofanie usługi Azure Maps Creator

Usługa mapy wewnętrznej usługi Azure Maps Creator jest teraz przestarzała i zostanie wycofana w dniu 30.09.25. Aby uzyskać więcej informacji, zobacz Ogłoszenie o zakończeniu życia twórcy usługi Azure Maps.

Interfejs API Get Stateset jest żądaniem GET HTTP używanym do pobierania określonych informacji zestawu stanów, w tym datasetId skojarzonych z zestawem stanów i jego stylów.

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 twórcy usługi Azure Maps. 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 usługi 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ń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń identyfikatora Entra firmy Microsoft 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 Microsoft Entra OAuth 2.0. Po połączeniu z dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi mogą mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.

Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera 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.

Notatki

Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania usługami Maps.

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

Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Microsoft identity platform overview.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

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

subscription-key

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

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

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie poufnych aplikacji klienckich podejście do uzyskiwania dostępu do interfejsów API REST usługi Azure Maps, aby klucz mógł być bezpiecznie przechowywany.

Typ: apiKey
W: query

SAS Token

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

Dzięki temu tokenowi 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 SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.

Typ: apiKey
W: header

Przykłady

Get stateset information with a statesetId

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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 logicznej 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, w który wchodzi.
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ą mieć wartość true.
Stateset	Model odpowiedzi dla pomyślnego zestawu stanów Get API.
StringStyleRule	Obiekt reguły stylu typu ciągu.
StyleRules	Model stylów.

BooleanRule

Objekt

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

Nazwa	Typ	Opis
false	string	Kolor, gdy wartość jest fałsz. 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)"). Dozwolone są również wstępnie zdefiniowane nazwy kolorów HTML, takie jak żółte i niebieskie.
true	string	Kolor, gdy wartość ma wartość true. 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)"). Dozwolone są również wstępnie zdefiniowane nazwy kolorów HTML, takie jak żółte i niebieskie.

BooleanStyleRule

Objekt

Obiekt reguły stylu typu logicznego.

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

ErrorAdditionalInfo

Objekt

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

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

ErrorDetail

Objekt

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

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

NumberRule

Objekt

Reguła liczbowa. Kolor jest wybierany z pierwszego zakresu, w który wchodzi.

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)"). Dozwolone są również wstępnie zdefiniowane nazwy kolorów HTML, takie jak żółte i niebieskie.
range	Range	Zakres wartości liczbowych dla tej reguły stylu. Jeśli wartość znajduje się w zakresie, wszystkie warunki muszą mieć wartość true.

NumberStyleRule

Objekt

Obiekt reguły stylu typu liczbowego.

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

Range

Objekt

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

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

Stateset

Objekt

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

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

Objekt

Obiekt reguły stylu typu ciągu.

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

StyleRules

Objekt

Model stylów.

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

Udostępnij za pośrednictwem

Feature State - Get Stateset

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

AADToken

Notatki

Zakresy

subscription-key

SAS Token

Przykłady

Get stateset information with a statesetId

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

BooleanRule

BooleanStyleRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NumberRule

NumberStyleRule

Range

Stateset

StringStyleRule

StyleRules

Dodatkowe zasoby