Dela via


Tileset - Validate Configuration

Använd för att verifiera en paneluppsättningskonfiguration.

Skicka verifiera konfigurationsbegäran

API:et Validate Configuration är en HTTP-begäran POST som används för att verifiera den angivna paneluppsättningskonfigurationen baserat på den angivna datasetId.

POST https://{geography}.atlas.microsoft.com/tilesets:validateConfiguration?api-version=2023-03-01-preview&datasetId={datasetId}

URI-parametrar

Name I Obligatorisk Typ Description
geography
path True

string

Den här parametern anger var Azure Maps Creator-resursen finns. Giltiga värden är vi och eu.

api-version
query True

string

Versionsnummer för Azure Maps API.

datasetId
query True

string

Det unika datasetId som paneluppsättningen skapar API:et använder för att hämta funktioner för att generera paneler. datasetId måste ha hämtats från ett lyckat API-anrop för datauppsättningsskapande.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-id

string

Anger vilket konto som är avsett för användning tillsammans med Microsoft Entra ID säkerhetsmodell. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från konto-API:et för Azure Maps hanteringsplan. Information om hur du använder Microsoft Entra ID säkerhet i Azure Maps finns i följande artiklar.

Begärandetext

Name Obligatorisk Typ Description
layers True

<string,  LayerObject>

Namnen på lagren och deras konfigurationsalternativ. Objektet för konfigurationsskikt innehåller nyckel/värde-par som associerar namnen på panelskikten med deras konfiguration. För varje nyckel/värde-par är nyckeln namnet på lagret och värdet är en LayerObject som innehåller konfigurationen och alternativen för lagret. Varje lager måste ha ett namn. Det här är den unika identifieraren för datalagret i den slutliga paneluppsättningen. Varje lagernamn måste vara unikt i valfri paneluppsättning. Lagernamnet måste vara en sträng med endast understreck (_) och alfanumeriska tecken. Motsvarande LayerObject för varje lagernamn beskriver hur vektorpanellagret ska skapas. Den anger vilka funktionsklasser som ska hämta funktionsdata, precisionen för data via zoomnivåer och hur du transformerar funktioner och renderar dem till paneler.

version True

integer

Den version av Azure Maps konfigurationsreferensen för tilingtjänsten som används av paneluppsättningskonfigurationen. För närvarande är endast version 1 tillåten. Om du använder någon annan version av den aktuella versionen eller en tidigare version resulterar det i ett fel.

Svar

Name Typ Description
200 OK

TilesetConfigurationValidationResult

Verifiera att konfigurationsbegäran för paneluppsättningen har slutförts. Svarstexten innehåller valideringsresultaten.

Other Status Codes

ErrorResponse

Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Azure Active Directory OAuth2-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.

Kommentarer

  • Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Azure Active Directory-konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

  • För närvarande har Azure Active Directory v1.0 eller v2.0 stöd för arbete, skola och gäster, men har inte stöd för personliga konton.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

subscription-key

Det här är en delad nyckel som etableras när du skapar ett Azure Maps-konto i Azure Portal eller använder PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Typ: apiKey
I: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett säkrare sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Typ: apiKey
I: header

Exempel

Validates the correctness of a tileset configuration

Exempelbegäran

POST https://us.atlas.microsoft.com/tilesets:validateConfiguration?api-version=2023-03-01-preview&datasetId=[datasetId]

{
  "version": 1,
  "layers": {
    "Indoor test": {
      "minZoom": 10,
      "maxZoom": 18,
      "features": {
        "featureClasses": [
          "unit"
        ],
        "filter": [
          "any",
          [
            "!=",
            [
              "get",
              "featureType"
            ],
            "conference"
          ],
          [
            "!=",
            [
              "get",
              "featureType"
            ],
            "restroom"
          ]
        ]
      }
    }
  }
}

Exempelsvar

{
  "valid": false,
  "warnings": [],
  "errors": [
    {
      "code": "CustomLayerNameNotSupported",
      "message": "Custom layerName 'Indoor test' is not supported yet.",
      "target": "Indoor test"
    }
  ]
}

Definitioner

Name Description
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorCode

Verifieringsfelkod.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

Feature

Funktionskonfiguration för paneluppsättningskonfiguration.

LayerObject

Layer-objekt för paneluppsättningskonfiguration.

TilesetConfiguration

Paneluppsättningens konfigurationsfält på den översta nivån. En paneluppsättningskonfiguration är ett JSON-objekt som måste innehålla följande fält på den översta nivån:

TilesetConfigurationValidationResult

Valideringsresultat för paneluppsättningskonfiguration.

ValidationError

Konfigurationsvalideringsfel för paneluppsättningar.

ValidationWarning

Konfigurationsvalideringsfel för paneluppsättningar.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Den ytterligare informationstypen.

ErrorCode

Verifieringsfelkod.

Name Typ Description
CustomLayerNameNotSupported

string

Anpassat lagernamn stöds inte just nu.

CustomOntologyNotSupported

string

Anpassad ontologi stöds inte just nu, "Facility-2.0" är den ontologi som stöds.

DuplicateFeatureClassFound

string

Funktionsklassnamnet ska vara unikt.

DuplicateLayerNameFound

string

Lagernamnet ska vara unikt.

UndefinedFeatureClasses

string

Funktionsklassen bör definieras i ontologidefinitionen och funktionsklassnamnet är skiftlägeskänsligt.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

Feature

Funktionskonfiguration för paneluppsättningskonfiguration.

Name Typ Description
featureClasses

string[]

Listan över funktionsklasser som ska användas för att skapa lagret. Giltiga funktionsklasser finns i dess ontologidefinition. Till exempel Anläggnings ontologi

filter

object

Tar bort funktioner som inte matchar ett mönster. Se MapLibre-filteruttryck

LayerObject

Layer-objekt för paneluppsättningskonfiguration.

Name Typ Description
features

Feature

Anger funktionsklasser och filter.

maxZoom

integer

Den högsta zoomnivån för lagret som ska byggas.

minZoom

integer

Den lägsta zoomnivån för lagret som ska byggas.

TilesetConfiguration

Paneluppsättningens konfigurationsfält på den översta nivån. En paneluppsättningskonfiguration är ett JSON-objekt som måste innehålla följande fält på den översta nivån:

Name Typ Description
layers

<string,  LayerObject>

Namnen på lagren och deras konfigurationsalternativ. Objektet för konfigurationsskikt innehåller nyckel/värde-par som associerar namnen på panelskikten med deras konfiguration. För varje nyckel/värde-par är nyckeln namnet på lagret och värdet är en LayerObject som innehåller konfigurationen och alternativen för lagret. Varje lager måste ha ett namn. Det här är den unika identifieraren för datalagret i den slutliga paneluppsättningen. Varje lagernamn måste vara unikt i valfri paneluppsättning. Lagernamnet måste vara en sträng med endast understreck (_) och alfanumeriska tecken. Motsvarande LayerObject för varje lagernamn beskriver hur vektorpanellagret ska skapas. Den anger vilka funktionsklasser som ska hämta funktionsdata, precisionen för data via zoomnivåer och hur du transformerar funktioner och renderar dem till paneler.

version

integer

Den version av Azure Maps konfigurationsreferensen för tilingtjänsten som används av paneluppsättningskonfigurationen. För närvarande är endast version 1 tillåten. Om du använder någon annan version av den aktuella versionen eller en tidigare version resulterar det i ett fel.

TilesetConfigurationValidationResult

Valideringsresultat för paneluppsättningskonfiguration.

Name Typ Description
errors

ValidationError[]

Listan över valideringsfel.

valid

boolean

Valideringsresultat.

warnings

ValidationWarning[]

Listan över valideringsvarningar.

ValidationError

Konfigurationsvalideringsfel för paneluppsättningar.

Name Typ Description
code

ErrorCode

Verifieringsfelkod.

message

string

Valideringsfelmeddelande.

target

string

Målelementet för verifieringsfelet.

ValidationWarning

Konfigurationsvalideringsfel för paneluppsättningar.

Name Typ Description
code

string

Verifieringsvarningskod.

message

string

Varningsmeddelande för validering.

target

string

Målelementet för verifieringsvarningen.