Dela via


Data Registry - List

Använd för att hämta en lista över alla dataregister i Azure Maps-kontot.

API:et List är en HTTP-begäran GET som returnerar en matris som innehåller alla dataregister som tidigare registrerats med hjälp av API:et Registrera eller Ersätt.

Tjänstslutpunkten för dataregistret är begränsad i omfånget till regionen för ditt Azure Maps-konto och är inte tillgänglig för globala Azure Maps-konton.

Skicka listbegäran

Om du vill visa en lista över alla dina dataregister utfärdar du en GET begäran utan ytterligare parametrar.

Listsvar

Begäran List returnerar en matris med dataregister i JSON format i brödtexten i svaret.

GET https://{geography}.atlas.microsoft.com/dataRegistries?api-version=2023-06-01

URI-parametrar

Name I Obligatorisk Typ Description
geography
path True

string

Den här parametern anger var Azure Maps-kontot finns. Giltiga värden är vi (USA, östra; USA, västra centrala, USA, västra 2) och eu (Europa, norra; Europa, västra).

api-version
query True

string

Versionsnumret för Azure Maps API.

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äkerhetsmodellen. 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 .

Svar

Name Typ Description
200 OK

DataRegistryList

Begäran List har slutförts. Svarstexten innehåller en matris med dataregister.

Other Status Codes

MapsErrorResponse

Det uppstod ett oväntat fel.

Sidhuvuden

x-ms-error-code: string

Säkerhet

AADToken

Det här är Microsoft Entra OAuth 2.0-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till REST-API:er för Azure Maps. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton 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 till Rest-API:er för Azure Maps.

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 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 Microsoft Entra-ID-konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure-portalen, 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.

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 en Azure Maps-resurs via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här nyckeln har alla program behörighet att komma åt alla REST-API:er. Med andra ord kan dessa för närvarande behandlas som huvudnycklar till det konto som de har utfärdats för.

För offentligt exponerade program rekommenderar vi att du använder server-till-server-åtkomst för Rest-API:er för Azure Maps där den här nyckeln kan lagras på ett säkert sätt.

Typ: apiKey
I: header

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden List SAS på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, 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

List all previously registered data registries

Exempelbegäran

GET https://us.atlas.microsoft.com/dataRegistries?api-version=2023-06-01

Exempelsvar

{
  "value": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "description": "Contoso Indoor Design",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "zip",
        "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path1.zip",
        "sizeInBytes": 29920,
        "contentMD5": "CsFxZ2YSfxw3cRPlqokV0w=="
      },
      "status": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "geojson",
        "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path2.geojson",
        "sizeInBytes": 1339
      },
      "status": "Running"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "description": "Contoso Geofence GeoJSON",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "geojson",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path3.geojson",
        "sizeInBytes": 1650,
        "contentMD5": "rYpEfIeLbWZPyaICGEGy3A=="
      },
      "status": "Failed",
      "error": {
        "code": "ContentMD5Mismatch",
        "message": "Actual content MD5: sOJMJvFParkSxBsvvrPOMQ== doesn't match expected content MD5: CsFxZ2YSfxw3cRPlqokV0w==."
      }
    }
  ]
}

Definitioner

Name Description
AzureBlob

Information om Azure Blob Data Registry.

DataFormat

Dataformatet för det uppladdade innehållet som används för validering.

DataRegistry

Dataregistret i Azure Maps.

DataRegistryKind

Typ av dataregister.

DataRegistryList

Svarsmodellen för API:et för dataregisterlistan. Returnerar en lista över alla tidigare registrerade data.

LongRunningOperationStatus

Status för en långvarig åtgärd.

MapsErrorDetail

Felinformationen.

MapsErrorResponse

Vanligt felsvar för Azure Maps-API:er för att returnera felinformation för misslyckade åtgärder.

MapsInnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

AzureBlob

Information om Azure Blob Data Registry.

Name Typ Description
blobUrl

string

Blob-URL:en innehåller sökvägen till filen som registreras.

contentMD5

string

Innehållets MD5 för innehållet, som används för datavalidering.

dataFormat

DataFormat

Dataformatet för det uppladdade innehållet som används för validering.

linkedResource

string

ID:t för datalagringen i Azure Maps-kontot.

msiClientId

string

Klient-ID för användartilldelad hanterad identitet. Använd systemtilldelad hanterad identitet om den inte tillhandahålls.

sizeInBytes

integer

Storleken på innehållet i byte.

DataFormat

Dataformatet för det uppladdade innehållet som används för validering.

Name Typ Description
geojson

string

GeoJSON är ett JSON-baserat geospatialt datautbytesformat.

zip

string

Komprimerat dataformat.

DataRegistry

Dataregistret i Azure Maps.

Name Typ Description
azureBlob

AzureBlob

Information om Azure Blob Data Registry.

description

string

Beskrivningen som ges till dataregistret. Maxlängden är 1 024 tecken.

error

MapsErrorDetail

Felinformationen.

kind

DataRegistryKind

Typ av dataregister.

status

LongRunningOperationStatus

Status för en långvarig åtgärd.

udid

string

Användardata-ID för dataregistret.

DataRegistryKind

Typ av dataregister.

Name Typ Description
AzureBlob

string

Azure-blobb

DataRegistryList

Svarsmodellen för API:et för dataregisterlistan. Returnerar en lista över alla tidigare registrerade data.

Name Typ Description
nextLink

string

URL:en för att hämta nästa uppsättning dataregister.

value

DataRegistry[]

En matris med dataregister.

LongRunningOperationStatus

Status för en långvarig åtgärd.

Name Typ Description
Completed

string

Begäran har slutförts.

Failed

string

Begäran har ett eller flera fel.

Running

string

Begäran bearbetas för närvarande.

MapsErrorDetail

Felinformationen.

Name Typ Description
code

string

En av en serverdefinierad uppsättning felkoder.

details

MapsErrorDetail[]

En matris med information om specifika fel som ledde till det rapporterade felet.

innererror

MapsInnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

message

string

En läsbar återgivning av felet.

target

string

Målet för felet.

MapsErrorResponse

Vanligt felsvar för Azure Maps-API:er för att returnera felinformation för misslyckade åtgärder.

Name Typ Description
error

MapsErrorDetail

Felinformationen.

MapsInnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

Name Typ Description
code

string

Felkoden.

innererror

MapsInnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.