Style - Get Operation

Service:

Maps Creator

API Version:

2023-03-01-preview

Use para comprobar el estado del proceso de creación de estilos.

La Get Operation API es una solicitud HTTP GET que se usa para comprobar el estado del proceso de creación de estilos y recuperar .styletId

Enviar solicitud de operaciones

Para ver el progreso actual de una operación de estilo, usará una GET solicitud en la que la operationId ruta de acceso especificada es el identificador que representa la operación.

Respuesta de la operación

Mientras está en curso, se devuelve un 200-OK código de estado HTTP sin encabezados adicionales. Si la operación se realiza correctamente, se devuelve un 200-OK código de estado HTTP con en Resource-Location el encabezado .

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
geography	path	True	string	Este parámetro especifica dónde se encuentra el recurso Azure Maps Creator. Los valores válidos son nosotros y eu.
operationId	path	True	string	Identificador para consultar el estado de la solicitud de creación de estilo.
api-version	query	True	string	Número de versión de la API de Azure Maps.

Respuestas

Nombre	Tipo	Description
200 OK	LongRunningOperationResult	La operación se está ejecutando o completa. Si la operación se realizó correctamente, use el encabezado Resource-Location para obtener la ruta de acceso al resultado. Headers Resource-Location: string
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de OAuth2 de Azure Active Directory . Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.

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 Azure Maps la aplicación solicita acceso. 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 Azure Active Directory. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o 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.

• Actualmente, Azure Active Directory v1.0 o v2.0 admite Work, School e Invitados, pero no admite cuentas personales.

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

Scopes

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 una cuenta de Azure Maps en el Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a Azure Maps API REST para que la clave se pueda almacenar de forma segura.

Type: apiKey
In: query

SAS Token

Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure 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.

Type: apiKey
In: header

Ejemplos

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

Sample Request

HTTP

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

Sample Response

Status code:

200

Resource-Location: https://us.atlas.microsoft.com/styles/{styleId}?api-version=2023-03-01-preview

Response Body

{
  "operationId": "{operationId}",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Get the status of an operation which is still running

Sample Request

HTTP

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

Sample Response

Status code:

200

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

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
LongRunningOperationResult	Modelo de respuesta para una API de operaciones de Long-Running.
LroStatus	Estado de estado de la solicitud.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

LongRunningOperationResult

Modelo de respuesta para una API de operaciones de Long-Running.

Nombre	Tipo	Description
created	string	Marca de tiempo creada.
error	ErrorDetail	Detalle del error.
operationId	string	Identificador de esta operación de ejecución prolongada.
status	LroStatus	Estado de estado de la solicitud.
warning	ErrorDetail	Detalle del error.

LroStatus

Estado de estado de la solicitud.

Nombre	Tipo	Description
Failed	string	La solicitud tiene uno o varios errores.
NotStarted	string	La solicitud aún no ha iniciado el procesamiento.
Running	string	La solicitud ha iniciado el procesamiento.
Succeeded	string	La solicitud se ha completado correctamente.