Delen via


Map Configuration - Get Operation

Gebruik om de status van het proces voor het maken van de kaartconfiguratie te controleren.

De Get Operation API is een HTTP-aanvraag GET die wordt gebruikt om de status van het proces voor het maken van de toewijzingsconfiguratie te controleren.

Bewerkingsaanvraag verzenden

Als u de huidige voortgang van een toewijzingsconfiguratiebewerking wilt weergeven, gebruikt u een GET aanvraag waarbij het operationId opgegeven pad de id is die de bewerking vertegenwoordigt.

Bewerkingsreactie

Tijdens de uitvoering wordt een 200-OK HTTP-statuscode geretourneerd zonder extra headers. Als de bewerking slaagt, wordt een 200-OK HTTP-statuscode geretourneerd met de Resource-Location in de header.

GET https://{geography}.atlas.microsoft.com/styles/mapconfigurations/operations/{operationId}?api-version=2023-03-01-preview

URI-parameters

Name In Vereist Type Description
geography
path True

string

Deze parameter geeft aan waar de resource Azure Maps Creator zich bevindt. Geldige waarden zijn wij en eu.

operationId
path True

string

De id voor het opvragen van de status voor de aanvraag voor het maken van de kaartconfiguratie.

api-version
query True

string

Versienummer van Azure Maps API.

Antwoorden

Name Type Description
200 OK

LongRunningOperationResult

De bewerking wordt uitgevoerd of voltooid. Als de bewerking is geslaagd, gebruikt u de header Resource-Location om het pad naar het resultaat op te halen.

Kopteksten

Resource-Location: string

Other Status Codes

ErrorResponse

Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Azure Active Directory OAuth2-stromen . Wanneer het is gekoppeld aan 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 resourceaccount 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 Azure Active Directory-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 configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

  • Momenteel ondersteunt Azure Active Directory v1.0 of v2.0 werk, school en gasten, maar geen persoonlijke accounts.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account maakt in de Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

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

Get the status of an operation which has finished successfully
Get the status of an operation which is still running

Get the status of an operation which has finished successfully

Voorbeeldaanvraag

GET https://us.atlas.microsoft.com/styles/mapconfigurations/operations/{operationId}?api-version=2023-03-01-preview

Voorbeeldrespons

Resource-Location: https://us.atlas.microsoft.com/styles/mapConfigurations/{operationId}?api-version=2023-03-01-preview
{
  "operationId": "{operationId}",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Get the status of an operation which is still running

Voorbeeldaanvraag

GET https://us.atlas.microsoft.com/styles/mapconfigurations/operations/{operationId}?api-version=2023-03-01-preview

Voorbeeldrespons

{
  "operationId": "{operationId}",
  "created": "2021-04-23T19:14:03.2452596+00:00",
  "status": "Running"
}

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

LongRunningOperationResult

Het antwoordmodel voor een Long-Running Operations-API.

LroStatus

De statusstatus van de aanvraag.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

Aanvullende informatie over de fout.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

LongRunningOperationResult

Het antwoordmodel voor een Long-Running Operations-API.

Name Type Description
created

string

Het gemaakte tijdstempel.

error

ErrorDetail

De foutdetails.

operationId

string

De id voor deze langdurige bewerking.

status

LroStatus

De statusstatus van de aanvraag.

warning

ErrorDetail

De foutdetails.

LroStatus

De statusstatus van de aanvraag.

Name Type Description
Failed

string

De aanvraag heeft een of meer fouten.

NotStarted

string

De aanvraag is nog niet verwerkt.

Running

string

De verwerking van de aanvraag is gestart.

Succeeded

string

De aanvraag is voltooid.