Partilhar via


Map Configuration - Get Operation

Utilize para verificar o estado do processo de criação da configuração do mapa.

A Get Operation API é um pedido HTTP GET utilizado para verificar o estado do processo de criação da configuração do mapa.

Submeter Pedido de Operações

Para ver o progresso atual de uma operação de configuração de mapa, irá utilizar um GET pedido em que o operationId caminho especificado é o ID que representa a operação.

Resposta da Operação

Enquanto estiver em curso, é devolvido um 200-OK código de estado http sem cabeçalhos adicionais. Se a operação for bem-sucedida, é devolvido um 200-OK código de estado http com o Resource-Location no cabeçalho.

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

Parâmetros do URI

Name Em Necessário Tipo Description
geography
path True

string

Este parâmetro especifica onde está localizado o recurso Azure Maps Creator. Os valores válidos somos nós e eu.

operationId
path True

string

O ID para consultar o estado do pedido de criação da configuração do mapa.

api-version
query True

string

Número da versão da API Azure Maps.

Respostas

Name Tipo Description
200 OK

LongRunningOperationResult

A operação está em execução ou concluída. Se a operação tiver sido bem-sucedida, utilize o cabeçalho Resource-Location para obter o caminho para o resultado.

Cabeçalhos

Resource-Location: string

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

  • Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Azure Active Directory. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

  • Atualmente, o Azure Active Directory v1.0 ou v2.0 suporta Trabalho, Escola e Convidados, mas não suporta contas pessoais.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave partilhada que é aprovisionada quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Tipo: apiKey
Em: header

Exemplos

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

Pedido de amostra

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

Resposta da amostra

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

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta a erros

LongRunningOperationResult

O modelo de resposta de uma API de Operações Long-Running.

LroStatus

O estado do pedido.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

LongRunningOperationResult

O modelo de resposta de uma API de Operações Long-Running.

Name Tipo Description
created

string

O carimbo de data/hora criado.

error

ErrorDetail

O detalhe do erro.

operationId

string

O ID desta operação de execução prolongada.

status

LroStatus

O estado do pedido.

warning

ErrorDetail

O detalhe do erro.

LroStatus

O estado do pedido.

Name Tipo Description
Failed

string

O pedido tem uma ou mais falhas.

NotStarted

string

O pedido ainda não começou a ser processado.

Running

string

O pedido começou a ser processado.

Succeeded

string

O pedido foi concluído com êxito.