Udostępnij za pośrednictwem


Feature State - Create Stateset

Użyj polecenia , aby utworzyć nowy zestaw stanów.

Uwaga

wycofanie usługi stanu funkcji Azure Maps dla twórców

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 stylów funkcji w czasie rzeczywistym w kreatorze, zobacz Ulepszanie map wnętrz za pomocą stylów funkcji mapy w czasie rzeczywistym.

Interfejs Create Stateset API jest żądaniem HTTP POST używanym do tworzenia nowego zestawu stanów, definiując wartości i odpowiadające im style dla jego właściwości w treści żądania. Aby uzyskać więcej informacji, zobacz Twórca zestawu stanów funkcji.

Usługa Stanu funkcji umożliwia użytkownikowi aktualizowanie stanów funkcji i wykonywanie zapytań dotyczących ich użycia w innych usługach. Właściwości dynamiczne funkcji, które nie należą do zestawu danych, są tutaj określane jako stany .

Ta usługa stanu funkcji jest przestawiana na zestawie stanów. Podobnie jak zestaw kafelków, zestaw stanów hermetyzuje mechanizm przechowywania stanów funkcji dla zestawu danych.

Po utworzeniu zestawu stanów użytkownicy mogą używać ich statesetId do publikowania aktualizacji stanu funkcji i pobierania bieżących stanów funkcji. Funkcja może mieć tylko jeden stan w danym punkcie w czasie.

Stan funkcji jest definiowany przez nazwę klucza, wartość i sygnaturę czasową. Po opublikowaniu aktualizacji stanu funkcji do Azure Maps wartość stanu jest aktualizowana tylko wtedy, gdy sygnatura czasowa podanego stanu jest późniejsza niż przechowywana sygnatura czasowa.

Azure Maps MapControl umożliwia używanie tych stanów funkcji do stylu funkcji. Aby uzyskać więcej informacji, zobacz Render services Get Map State Tile (Pobieranie kafelka stanu mapy).

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}

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.

api-version
query True

string

Numer wersji interfejsu API Azure Maps.

datasetId
query True

string

Identyfikator zestawu danych musi zostać uzyskany z pomyślnego wywołania interfejsu API zestawu danych Twórca.

description
query

string

Opis zestawu stanów. Dozwolona maksymalna długość to 1000.

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.

Treść żądania

Nazwa Typ Opis
styles StyleRule[]:

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.

Odpowiedzi

Nazwa Typ Opis
200 OK

StatesetCreatedResult

Utworzony zestaw stanów.

Other Status Codes

ErrorResponse

Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy Microsoft Entra OAuth 2.0. Po 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 Azure Maps konta zasobu 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ęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi 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łówka x-ms-client-id w celu wskazania, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps.

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 poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.

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ółużytkowany 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.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do wszystkich interfejsów 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 podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu Azure Maps interfejsów API REST, 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 sygnatur dostępu współdzielonego na zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem 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 oraz 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 bezpieczny 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 SAS.

Typ: apiKey
W: header

Przykłady

Create a new stateset with a datasetId

Przykładowe żądanie

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

Przykładowa odpowiedź

{
  "statesetId": "b24bdb73-1305-3212-1909-a428d937b64f"
}

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, 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.

StatesetCreatedResult

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

StringStyleRule

Obiekt reguły stylu typu ciągu.

StyleRules

Model stylów.

BooleanRule

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

Nazwa Typ Opis
false

string

Kolor, gdy wartość ma wartość false. Color to ciąg JSON w różnych dozwolonych formatach, wartościach szesnastkowe 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 żółty i niebieski.

true

string

Kolor, gdy wartość ma wartość true. Color to ciąg JSON w różnych dozwolonych formatach, wartościach szesnastkowe 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 żółty i niebieski.

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 error.

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. Color to ciąg JSON w różnych dozwolonych formatach, wartościach szesnastkowe 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 żółty i niebieski.

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.

StatesetCreatedResult

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

Nazwa Typ Opis
statesetId

string

Identyfikator nowo utworzonego zestawu stanó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[]:

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.