Data Registry - Get Operation

Referencia

Servicio:: Maps

Versión de la API:: 2023-06-01

Use para comprobar el estado del registro de datos o reemplazar la solicitud.
La Get Operation API es una solicitud HTTP GET que se usa para obtener el estado de un registro de datos o reemplazar solicitud se devuelve en el encabezado del registro o reemplazar la respuesta como el valor de la Operation-Location clave. Mientras está en curso, se devolverá una respuesta HTTP 200 OK con Retry-After el encabezado , seguido de un HTTP 200 OK sin encabezado adicional una vez completado.

El punto de conexión de servicio del Registro de datos está limitado en el ámbito de la región de la cuenta de Azure Maps y no está disponible para las cuentas globales de Azure Maps.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description

Nombre	En	Requerido	Tipo	Description
geography	path	True	string	Este parámetro especifica dónde se encuentra la cuenta de Azure Maps. Los valores válidos son nosotros (Este de EE. UU., Centro-oeste de EE. UU., Oeste de EE. UU. 2) y eu (Norte de Europa, Oeste de Europa).
operationId	path	True	string	Identificador usado para consultar el estado de una solicitud de registro de datos. Patrón de Regex: `^[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	Número de versión de la API de Azure Maps.

geography

path

True

string

Este parámetro especifica dónde se encuentra la cuenta de Azure Maps. Los valores válidos son nosotros (Este de EE. UU., Centro-oeste de EE. UU., Oeste de EE. UU. 2) y eu (Norte de Europa, Oeste de Europa).

operationId

path

True

string

Identificador usado para consultar el estado de una solicitud de registro de datos.

Patrón de Regex: ^[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

Número de versión de la API de Azure Maps.

Respuestas

Nombre	Tipo	Description
200 OK	LongRunningOperationResult	Estado de la operación de ejecución prolongada. Encabezados Retry-After: integer
Other Status Codes	MapsErrorResponse	Se ha producido un error inesperado. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

LongRunningOperationResult

Estado de la operación de ejecución prolongada.

Encabezados

Retry-After: integer

Other Status Codes

MapsErrorResponse

Se ha producido un error inesperado.

Encabezados

x-ms-error-code: string

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0 . Cuando se empareja con el control de acceso basado en rol de Azure , se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio mediante un rol integrado o un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.

Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST. * El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

Para obtener más información sobre la plataforma de identidad de Microsoft, consulte Introducción a la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

subscription-key

Se trata de una clave compartida que se aprovisiona al crear un recurso de Azure Maps a través del plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.

Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de las API REST de Azure Maps donde esta clave se puede almacenar de forma segura.

Tipo: apiKey
En: header

SAS Token

Se trata de un token de firma de acceso compartido que se crea a partir de la operación List SAS en el recurso de Azure Maps a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. En otras palabras, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de asignación para limitar la representación del abuso y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Get the status of an operation that failed

Get the status of an operation that finished successfully

Get the status of an operation that is still running

Get the status of an operation that failed

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Failed",
  "error": {
    "code": "InvalidData",
    "message": "The data is not a valid GeoJSON."
  }
}

Get the status of an operation that finished successfully

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Completed"
}

Get the status of an operation that is still running

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

Retry-After: 10

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Running"
}

Definiciones

Nombre	Description
LongRunningOperationResult	Modelo de respuesta para una operación de larga duración.
LongRunningOperationStatus	Estado de una operación de larga duración.
MapsErrorDetail	Detalle del error.
MapsErrorResponse	Respuesta de error común para las API de Azure Maps para devolver los detalles de error de las operaciones con errores.
MapsInnerError	Objeto que contiene información más específica que el objeto actual sobre el error.

LongRunningOperationResult

Modelo de respuesta para una operación de larga duración.

Nombre	Tipo	Description
error	MapsErrorDetail	Detalle del error.
id	string	OperationId
status	LongRunningOperationStatus	Estado de una operación de larga duración.

LongRunningOperationStatus

Estado de una operación de larga duración.

Nombre	Tipo	Description
Completed	string	La solicitud se completó correctamente.
Failed	string	La solicitud tiene uno o varios errores.
Running	string	La solicitud se está procesando actualmente.

MapsErrorDetail

Detalle del error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	MapsErrorDetail[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	MapsInnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

MapsErrorResponse

Respuesta de error común para las API de Azure Maps para devolver los detalles de error de las operaciones con errores.

Nombre	Tipo	Description
error	MapsErrorDetail	Detalle del error.

MapsInnerError

Objeto que contiene información más específica que el objeto actual sobre el error.

Nombre	Tipo	Description
code	string	Código de error.
innererror	MapsInnerError	Objeto que contiene información más específica que el objeto actual sobre el error.

Compartir a través de

Data Registry - Get Operation

Parámetros de identificador URI

Respuestas

Seguridad

AADToken

Notas

Ámbitos

subscription-key

SAS Token

Ejemplos

Get the status of an operation that failed

Solicitud de ejemplo

Respuesta de muestra

Get the status of an operation that finished successfully

Solicitud de ejemplo

Respuesta de muestra

Get the status of an operation that is still running

Solicitud de ejemplo

Respuesta de muestra

Definiciones

LongRunningOperationResult

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Recursos adicionales