Compartilhar via

Conversion - Convert

  • Referência
Serviço:
Maps Creator
Versão da API:
2.0

Use para converter um pacote de desenho importado anteriormente em dados de mapa.

Observação

Desativação do Criador do Azure Mapas

O serviço de mapa do interior do Criador do Azure Mapas foi preterido e será desativado em 30/09/25. Para obter mais informações, confira Comunicado de fim de vida útil do Criador do Azure Mapas.

A API Conversion é uma solicitação HTTP POST que permite ao chamador importar um conjunto de arquivos de design DWG como um pacote de desenho de compactado para o Azure Mapas. O pacote de desenho é referenciado pelo udid usado quando ele foi carregado no registro dedados . Para obter mais informações sobre o serviço de registro de dados, consulte Como criarde registro de dados.

Converter pacote DWG

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

Depurar problemas de pacote DWG

Durante o processo de conversão, se houver problemas com o pacote DWG erros e avisos serão fornecidos na resposta, juntamente com um pacote de diagnóstico para visualizar e diagnosticar esses problemas. Caso haja problemas com seu pacote DWG, o processo de status da operação de conversão conforme detalhado aqui retorna o local do pacote de diagnóstico que pode ser baixado pelo chamador para ajudá-los a visualizar e diagnosticar esses problemas. O pacote de diagnóstico local pode ser encontrado na seção propriedades da resposta de status da operação de conversão e se parece com o seguinte:

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

O pacote de diagnóstico pode ser baixado executando uma solicitação de HTTP GET no diagnosticPackageLocation. Para obter mais detalhes sobre como usar a ferramenta para visualizar e diagnosticar todos os erros e avisos, consulte Visualizador de Erros de Desenho.

Uma operação de conversão será marcada como êxito se houver zero ou mais avisos, mas será marcada como falha se houver erros.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
geography
 path True

string

Esse parâmetro especifica onde o recurso criador do Azure Mapas está localizado. Valores válidos são nós e eu.
api-version
 query True

string

Número de versão da API do Azure Mapas.
outputOntology
 query True

OutputOntology

Versão de ontologia de saída. "facility-2.0" é o único valor com suporte no momento. Consulte este artigo para obter mais informações sobre ontologias do Criador do Azure Mapas.
udid
 query True

string

A ID de dados exclusiva (udid) para o conteúdo. Deve ser a mesma udid usada ao criar o registro de dados .
description
 query

string

O usuário forneceu a descrição do conteúdo que está sendo convertido.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-client-id

string

Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança da ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança da ID do Microsoft Entra no Azure Mapas, consulte os artigos de a seguir para obter diretrizes.

Respostas

Nome Tipo Description
200 OK

LongRunningOperationResult

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

Cabeçalhos

Resource-Location: string
202 Accepted

Solicitação Aceita: a solicitação foi aceita para processamento. Use a URL no cabeçalho Operation-Location para obter o status.

Cabeçalhos

Operation-Location: string
Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de controlar o acesso em APIs e escopos específicos.

Anotações

  • Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. Nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. * O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

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

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada quando você Criar uma conta do Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o aplicativos cliente confidenciais abordagem para acessar AS APIs REST do Azure Mapas para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais protegida do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta de mapa de para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Convert previously uploaded DWG Package

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200 
Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0
{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}
Código de status:
202 
Operation-Location: https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

Definições

Nome Description
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
LongRunningOperationResult

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

O estado de status da solicitação.
OutputOntology

Versão de ontologia de saída. "facility-2.0" é o único valor com suporte no momento. Consulte este artigo para obter mais informações sobre ontologias do Criador do Azure Mapas.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome 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

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

LongRunningOperationResult

Objeto

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

Nome Tipo Description
created

string (date-time)

O carimbo de data/hora criado.
error

ErrorDetail

O detalhe do erro.
operationId

string

A ID desta operação de execução prolongada.
status

LroStatus

O estado de status da solicitação.
warning

ErrorDetail

O detalhe do erro.

LroStatus

Enumeração

O estado de status da solicitação.

Valor Description
Failed

A solicitação tem uma ou mais falhas.
NotStarted

A solicitação ainda não iniciou o processamento.
Running

A solicitação iniciou o processamento.
Succeeded

A solicitação foi concluída com êxito.

OutputOntology

Enumeração

Versão de ontologia de saída. "facility-2.0" é o único valor com suporte no momento. Consulte este artigo para obter mais informações sobre ontologias do Criador do Azure Mapas.

Valor Description
facility-2.0

A ontologia de instalação define como o Criador do Azure Mapas armazena internamente dados de instalação em um conjunto de dados do Criador.