Conversion - Convert

Aplica-se a: ver níveisde preços .

O Criador permite desenvolver aplicações com base nos dados do seu mapa interior privado utilizando a Azure Mapas API e SDK. Este artigo introduz conceitos e ferramentas que se aplicam ao Azure Mapas Criador.

A API de Conversão permite ao chamador importar um conjunto de ficheiros de design DWG como um pacote de desenho fechado em Azure Mapas. O pacote de desenho deve ser primeiro carregado usando o Serviço de Dados Azure Mapas. Uma vez carregado, utilize o udid devolvido pela API de upload de dados para chamar esta API de Conversão.

Converter pacote DWG

A API de Conversão realiza um pedido de longa duração.

Questões do pacote Debug DWG

Durante o processo de Conversão, se houver 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 estas questões. Caso se encontrem problemas com o seu pacote DWG, o processo de estado de operação de Conversão, conforme detalhado aqui, devolve a localização do pacote de diagnóstico que pode ser descarregado pelo chamador para ajudá-los 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 parece o seguinte:

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

O pacote de diagnóstico pode ser descarregado executando um pedido no HTTP GET diagnosticPackageLocation . Para obter mais detalhes sobre como utilizar a ferramenta para visualizar e diagnosticar todos os erros e avisos consulte o Visualizador de Erros de Desenho.

Uma operação de conversão será marcada como um sucesso se houver zero ou mais avisos, mas será marcado como falhado se forem encontrados erros.

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

Parâmetros do URI

Name In Required Type Description
geography
path True
  • string

Este parâmetro especifica onde está localizado o recurso Azure Mapas Creator. Valores válidos somos nós e a UE.

api-version
query True
  • string

Número de versão do Azure Mapas API. Versão atual é 2.0

outputOntology
query True
  • string

Versão ontologia de saída. "facilidade-2.0" é o único valor suportado neste momento. Consulte este artigo para mais informações sobre as inologias do Azure Mapas Creator.

udid
query True
  • string

O id de dados único para o conteúdo. O udid deve ter sido obtido a partir de uma chamada de API de data upload bem sucedida.

description
query
  • string

O utilizador forneceu a descrição do conteúdo que está a ser convertido.

subscription-key
query
  • string

Uma das chaves Azure Mapas fornecidas a partir de uma conta de mapa Azure. Consulte este artigo para mais detalhes sobre como gerir a autenticação.

Cabeçalho do Pedido

Name Required Type Description
x-ms-client-id
  • string

Especifica qual a conta destinada a ser utilizada em conjunto com o modelo de segurança Azure AD. Representa um ID único para a conta Azure Mapas e pode ser recuperado do Azure Mapas conta de gestão API. Para utilizar a segurança Azure AD em Azure Mapas consulte os seguintes artigos para obter orientação.

Respostas

Name Type Description
202 Accepted

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

Headers

  • Operation-Location: string
400 Bad Request

Mau pedido: um ou mais parâmetros foram especificados incorretamente ou são mutuamente exclusivos.

401 Unauthorized

Acesso negado devido a chave de subscrição inválida ou símbolo de portador de Azure Ative Directory (Azure AD). Certifique-se de fornecer uma chave válida para uma subscrição ativa do Azure e Mapas recurso. Caso contrário, verifique o cabeçalho WWW-Authenticate para obter código de erro e descrição do sinal fornecido pelo portador da Ad Azure.

Headers

  • WWW-Authenticate: string
403 Forbidden

Problemas de permissão, capacidade ou autenticação.

404 Not Found

Não Encontrado: o recurso solicitado não foi encontrado, mas pode estar novamente disponível no futuro.

500 Internal Server Error

Ocorreu um erro durante o processamento do pedido. Tente novamente mais tarde.

Segurança

azure_auth

Estes são os Azure Ative Directory OAuth2 Flows. Quando emparelhado com o controlo de acesso baseado em funções Azure, pode ser usado para controlar o acesso a Azure Mapas REST APIs. Os controlos de acesso baseados em funções Azure são utilizados para designar o acesso a uma ou mais conta de recursos Mapas Azure 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 a Azure Mapas REST APIs.

Para implementar cenários, recomendamos visualizar conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para aplicações de modelação através de objetos capazes de aceder ao controlo 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 Mapas recurso a que a aplicação está a solicitar acesso. Isto pode ser adquirido à API de gestão de Mapas.

O Authorization URL é específico para o exemplo de nuvem pública Azure. As nuvens soberanas têm URLs de Autorização única e configurações de diretório Azure Ative. * O controlo de acesso baseado em funções Azure é configurado a partir do plano de gestão Azure através do portal Azure, PowerShell, CLI, Azure SDKs ou REST APIs. * A utilização do Azure Mapas Web SDK permite a configuração baseada na configuração de uma aplicação para múltiplos casos de uso.

  • Atualmente, Azure Ative Directory tokens v1.0 são suportados.

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

subscription-key

Esta é uma chave partilhada que é aprovisionada ao criar um recurso Azure Mapas através do plano de gestão Azure via portal Azure, PowerShell, CLI, Azure SDKs ou REST APIs.

Com esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estes podem atualmente ser tratados como chaves-chave principais da conta para a qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor-servidor do Azure Mapas REST APIs onde esta chave pode ser armazenada de forma segura.

Type: apiKey
In: query

Exemplos

Convert previously uploaded DWG Package

Sample Request

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

Sample Response

Operation-Location: https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Definições

ODataError

Este objeto é devolvido quando ocorre um erro na API Azure Mapas.

ODataErrorResponse

Este objeto de resposta é devolvido quando ocorre um erro na API Azure Mapas.

ODataError

Este objeto é devolvido quando ocorre um erro na API Azure Mapas.

Name Type Description
code
  • string

O código ODataError.

details

Este objeto é devolvido quando ocorre um erro na API Azure Mapas.

message
  • string

Se disponível, uma descrição legível pelo homem do erro.

target
  • string

Se disponível, o alvo está a causar o erro.

ODataErrorResponse

Este objeto de resposta é devolvido quando ocorre um erro na API Azure Mapas.

Name Type Description
error

Este objeto é devolvido quando ocorre um erro na API Azure Mapas.