Conversion - Convert

Referência

Service:: Maps Creator

API Version:: 2.0

Utilize para converter um Pacote de Desenho importado anteriormente em dados de mapa.

A Conversion API é um pedido HTTP POST que permite ao autor da chamada importar um conjunto de ficheiros de estrutura DWG como um Pacote de Desenho zipado para Azure Maps. O pacote de desenho é referenciado pelo udid utilizado quando foi carregado para o Registo de Dados. Para obter mais informações sobre o serviço de registo de dados, veja Como criar um registo de dados.

Converter pacote DWG

A API de Conversão executa uma operação de execução prolongada.

Depurar problemas do pacote DWG

Durante o processo de Conversão, se existirem problemas com os erros e avisos do pacote DWG, são fornecidos na resposta juntamente com um pacote de diagnóstico para visualizar e diagnosticar estes problemas. Caso sejam encontrados problemas com o seu pacote DWG, o processo de estado da operação de conversão conforme detalhado aqui devolve a localização do pacote de diagnóstico que pode ser transferido pelo autor da chamada para os ajudar a visualizar e diagnosticar estes problemas. A localização do pacote de diagnóstico pode ser encontrada na secção de propriedades da resposta do estado da operação de conversão e tem o seguinte aspeto:

{
    "properties": {
        "diagnosticPackageLocation": "https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0"                
    }            
}

O pacote de diagnóstico pode ser transferido ao executar um HTTP GET pedido no diagnosticPackageLocation. Para obter mais detalhes sobre como utilizar a ferramenta para visualizar e diagnosticar todos os erros e avisos, veja Drawing Error Visualizer (Visualização de Erros de Desenho).

Uma operação de conversão será marcada como com êxito se existirem zero ou mais avisos, mas será marcada como falhada se forem encontrados erros.

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0

With optional parameters:

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0&description={description}

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 Criador. Os valores válidos são nós e eu.
api-version	query	True	string	Número da versão da API Azure Maps.
outputOntology	query	True	OutputOntology	Versão da onologia de saída. "facility-2.0" é o único valor suportado neste momento. Consulte este artigo para obter mais informações sobre as topologias Azure Maps Criador.
udid	query	True	string	O ID de dados exclusivo (`udid`) do conteúdo. Tem de ser o mesmo `udid` utilizado ao criar o Registo de dados.
description	query		string	O utilizador forneceu uma descrição do conteúdo que está a ser convertido.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps consulte os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	LongRunningOperationResult	A operação está em execução ou concluída. Se a operação tiver sido concluída com êxito, utilize o cabeçalho Resource-Location para obter o caminho para o resultado. Headers Resource-Location: string
202 Accepted		Pedido Aceite: o pedido foi aceite para processamento. Utilize o URL no Cabeçalho do Operation-Location para obter o estado. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Name

Tipo

Description

200 OK

LongRunningOperationResult

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

Headers

Resource-Location: string

202 Accepted

Pedido Aceite: o pedido foi aceite para processamento. Utilize o URL no Cabeçalho do Operation-Location para obter o estado.

Headers

Operation-Location: string

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. 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 recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.

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 de Microsoft Entra ID. * 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.

Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

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

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.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso 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.

Type: apiKey
In: header

Exemplos

Convert previously uploaded DWG Package

Sample Request

HTTP

POST https://us.atlas.microsoft.com/conversions?api-version=2.0&udid=25084fb7-307a-4720-8f91-7952a0b91012&outputOntology=facility-2.0

Sample Response

Status code:: 200

Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

Response Body

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Status code:: 202

Operation-Location: https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

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.
OutputOntology	Versão da onologia de saída. "facility-2.0" é o único valor suportado neste momento. Consulte este artigo para obter mais informações sobre as topologias Azure Maps Criador.

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ções adicionais.

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.

OutputOntology

Versão da onologia de saída. "facility-2.0" é o único valor suportado neste momento. Consulte este artigo para obter mais informações sobre as topologias Azure Maps Criador.

Name	Tipo	Description
facility-2.0	string	A onologia de instalação define como o Azure Maps Creator armazena internamente os dados das instalações num conjunto de dados do Criador.

Conversion - Convert

Converter pacote DWG

Depurar problemas do pacote DWG

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

AADToken

Notas

Scopes

subscription-key

SAS Token

Exemplos

Convert previously uploaded DWG Package

Sample Request

Sample Response

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

OutputOntology

Recursos adicionais