Data Registry - Get Data Registry

Referens

Service:: Maps

API Version:: 2023-06-01

Använd för att hämta den angivna dataregisterinformationen.

API:et Get Data Registry är en HTTP-begäran GET som returnerar dataregisterinformation, som ett AzureBlob-objekt i JSON-format, i svarets brödtext, tillsammans med HTTP-statuskoden 200, när det lyckas. Om Azure Maps inte kan komma åt det underliggande innehållet eller om integritetskontrollen misslyckas, status är inställt på Failed och ett fel returneras.

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 begäran om att hämta dataregister

En dataregisterbegäran GET returnerar information om det begärda dataregistret, enligt angiven udid. Informationen returneras i brödtexten i svaret i JSON-format.

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

URI-parametrar

Name I Obligatorisk Typ Description

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).
udid	path	True	string	Användardata-ID för dataregistret. Regex pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
api-version	query	True	string	Versionsnumret för Azure Maps API.

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

udid

path

True

string

Användardata-ID för dataregistret.

Regex pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

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

Svar

Name Typ Description

200 OK

Name	Typ	Description
200 OK	DataRegistry	Begäran `Get Data Registry` har slutförts. Svarstexten innehåller dataregistret för den angivna `udid`.
Other Status Codes	MapsErrorResponse	Det uppstod ett oväntat fel. Headers x-ms-error-code: string

DataRegistry

Begäran Get Data Registry har slutförts. Svarstexten innehåller dataregistret för den angivna udid.

Other Status Codes

MapsErrorResponse

Det uppstod ett oväntat fel.

Headers

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 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 Microsoft Entra ID 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.

Mer information om Microsofts identitetsplattform finns i Microsofts identitetsplattform översikt.

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

Scopes

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 Portal, 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 Azure Maps REST-API:er där den här nyckeln kan lagras på ett säkert sätt.

Type: apiKey
In: header

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.

Type: apiKey
In: header

Exempel

Get the data registry of a completed udid

Get the data registry of a failed udid

Get the data registry of a completed udid

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:: 200

{
  "udid": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "description": "Contoso Geofence GeoJSON",
  "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/path.json",
    "sizeInBytes": 1339,
    "contentMD5": "sOJMJvFParkSxBsvvrPOMQ=="
  },
  "status": "Completed"
}

Get the data registry of a failed udid

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:: 200

{
  "udid": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "description": "Contoso Geofence GeoJSON",
  "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/path.json"
  },
  "status": "Failed",
  "error": {
    "code": "AuthorizationPermissionMismatch",
    "message": "Not authorized to perform this operation on resource: https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json."
  }
}

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

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.

Share via

Data Registry - Get Data Registry

Skicka begäran om att hämta dataregister

URI-parametrar

Begärandehuvud

Svar

Säkerhet

AADToken

Kommentarer

Scopes

subscription-key

SAS Token

Exempel

Get the data registry of a completed udid

Sample Request

Sample Response

Get the data registry of a failed udid

Sample Request

Sample Response

Definitioner

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Ytterligare resurser