Data Registry - Register Or Replace

Service:

Maps

API-versie:

2023-06-01

Gebruik om gegevens te registreren die zijn opgeslagen in een Azure Storage-account met een Azure Maps-account.

De Register API is een HTTP-aanvraag PUT die wordt gebruikt voor het registreren van de gegevens in een Azure Storage-account met een Azure Maps-account. De maximale bestandsgrootte die kan worden geregistreerd, is één gigabyte.

Dit is handig in scenario's zoals het registreren van een verzameling Geofences in GeoJSON indeling voor gebruik in Azure Maps Geofencing Service of het registreren van een set DWG-ontwerpbestanden als een gezipt tekenpakket voor gebruik in de Azure Maps Creator Conversion Service.

Het service-eindpunt van het gegevensregister is beperkt tot de regio van uw Azure Maps-account en is niet beschikbaar voor globale Azure Maps-accounts.

Registratie- of vervangingsaanvraag indienen

De Register aanvragen en Replace zijn beide langlopende bewerkingen die een AzureBlob JSON-object bevatten in de hoofdtekst van de aanvraag waarmee de gegevensregisterdetails worden gedefinieerd.

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

URI-parameters

Name	In	Vereist	Type	Description
geography	path	True	string	Deze parameter geeft aan waar het Azure Maps-account zich bevindt. Geldige waarden zijn us (VS - oost, VS - west-centraal, VS - west 2) en eu (Europa - noord, Europa - west).
udid	path	True	string	De gebruikersgegevens-id van het gegevensregister. Regex-patroon: ^[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	Het versienummer van de Azure Maps-API.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps-beheervlak Account-API. Als u Microsoft Entra ID-beveiliging in Azure Maps wilt gebruiken, raadpleegt u de volgende artikelen voor hulp.
Operation-Id		string	De bewerkings-id, in GUID-indeling. Regex-patroon: ^[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}$

Aanvraagbody

Name	Type	Description
azureBlob	AzureBlob	Registerdetails van Azure Blob-gegevens.
description	string	De beschrijving van het gegevensregister. De maximale lengte is 1024 tekens.
kind	DataRegistryKind	Soort gegevensregister.

Antwoorden

Name	Type	Description
200 OK	DataRegistry	Resource wordt vervangen: de aanvraag is geaccepteerd voor verwerking. Kopteksten Operation-Id: string Operation-Location: string
201 Created	DataRegistry	Resource maken: de aanvraag is geaccepteerd voor verwerking. Kopteksten Operation-Id: string Operation-Location: string
Other Status Codes	MapsErrorResponse	Er is een onverwachte fout opgetreden. Kopteksten x-ms-error-code: string

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen . Wanneer het wordt gekoppeld met op rollen gebaseerd toegangsbeheer van Azure , kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps-resourceaccounts of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

• Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt het mogelijk om een toepassing op basis van configuraties in te stellen voor meerdere gebruiksvoorbeelden.

• Zie Overzicht van Microsoft Identity Platform voor meer informatie over Microsoft Identity Platform.

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

Dit is een gedeelde sleutel die wordt ingericht bij het maken van een Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met deze sleutel is elke toepassing gemachtigd voor toegang tot alle REST API's. Met andere woorden, deze kunnen momenteel worden behandeld als hoofdsleutels voor het account waarvoor ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om server-naar-servertoegang van Azure Maps REST API's te gebruiken, waar deze sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een Shared Access Signature-token dat is gemaakt op basis van de SAS-bewerking List op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Register or replace a udid

Sample request

HTTP

PUT https://us.atlas.microsoft.com/dataRegistries/29a92cab-74af-49e7-a326-66898220aa9d?api-version=2023-06-01

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

Sample response

Status code:

201

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2

{
  "udid": "29a92cab-74af-49e7-a326-66898220aa9d",
  "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
  },
  "status": "Running"
}

Status code:

200

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2

{
  "udid": "29a92cab-74af-49e7-a326-66898220aa9d",
  "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
  },
  "status": "Running"
}

Definities

Name	Description
AzureBlob	Registerdetails van Azure Blob-gegevens.
DataFormat	De gegevensindeling van de geüploade inhoud die wordt gebruikt voor validatiedoeleinden.
DataRegistry	Het gegevensregister in Azure Maps.
DataRegistryKind	Soort gegevensregister.
LongRunningOperationStatus	De status van een langlopende bewerking.
MapsErrorDetail	De foutdetails.
MapsErrorResponse	Veelvoorkomende foutreacties voor Azure Maps-API's om foutdetails te retourneren voor mislukte bewerkingen.
MapsInnerError	Een object met specifiekere informatie dan het huidige object over de fout.

AzureBlob

Registerdetails van Azure Blob-gegevens.

Name	Type	Description
blobUrl	string	De blob-URL bevat het pad naar het bestand dat wordt geregistreerd.
contentMD5	string	De inhouds-MD5 van de inhoud, die wordt gebruikt voor gegevensvalidatie.
dataFormat	DataFormat	De gegevensindeling van de geüploade inhoud die wordt gebruikt voor validatiedoeleinden.
linkedResource	string	De id van het gegevensarchief in het Azure Maps-account.
msiClientId	string	Client-id van door de gebruiker toegewezen beheerde identiteit. Gebruik door het systeem toegewezen beheerde identiteit als deze niet is opgegeven.
sizeInBytes	integer	De grootte van de inhoud in bytes.

DataFormat

De gegevensindeling van de geüploade inhoud die wordt gebruikt voor validatiedoeleinden.

Name	Type	Description
geojson	string	GeoJSON is een indeling voor georuimtelijke gegevensuitwisseling op basis van JSON.
zip	string	Gecomprimeerde gegevensindeling.

DataRegistry

Het gegevensregister in Azure Maps.

Name	Type	Description
azureBlob	AzureBlob	Registerdetails van Azure Blob-gegevens.
description	string	De beschrijving van het gegevensregister. De maximale lengte is 1024 tekens.
error	MapsErrorDetail	De foutdetails.
kind	DataRegistryKind	Soort gegevensregister.
status	LongRunningOperationStatus	De status van een langlopende bewerking.
udid	string	De gebruikersgegevens-id voor het gegevensregister.

DataRegistryKind

Soort gegevensregister.

Name	Type	Description
AzureBlob	string	Azure Blob

LongRunningOperationStatus

De status van een langlopende bewerking.

Name	Type	Description
Completed	string	De aanvraag is voltooid.
Failed	string	De aanvraag heeft een of meer fouten.
Running	string	De aanvraag wordt momenteel verwerkt.

MapsErrorDetail

De foutdetails.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	MapsErrorDetail[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	MapsInnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

MapsErrorResponse

Veelvoorkomende foutreacties voor Azure Maps-API's om foutdetails te retourneren voor mislukte bewerkingen.

Name	Type	Description
error	MapsErrorDetail	De foutdetails.

MapsInnerError

Een object met specifiekere informatie dan het huidige object over de fout.

Name	Type	Description
code	string	De foutcode.
innererror	MapsInnerError	Een object met specifiekere informatie dan het huidige object over de fout.