Dataset - Create

Referência

Serviço:: Maps Creator

Versão da API:: 2.0

Use para criar um conjunto de dados.

Observação

de desativação do Azure Maps Creator

O serviço de mapa interno do Azure Maps Creator foi preterido e será desativado em 30/09/25. Para obter mais informações, consulte Anúncio de Fim da Vida Útil do Azure Maps Creator.

A API Create é uma solicitação HTTP POST que usa o valor conversionId do pacote de desenho convertido e retorna a propriedade datasetId do conjunto de dados recém-criado. Para obter mais informações, consulte Criar um conjunto de dados.

Você pode usar essa solicitação em um cenário como carregar um pacote zip DWG para um edifício, converter o pacote zip usando o serviço de Conversão do Azure Maps e criar um conjunto de dados a partir do pacote zip convertido. O conjunto de dados criado pode ser usado para criar conjuntos de blocos usando o serviço de do do Azure Maps Tileset e pode ser consultado por meio do serviço de do Azure Maps WFS.

Enviar Criar Pedido

Para criar seu conjunto de dados, você usará uma solicitação de POST em que o parâmetro de consulta conversionId é uma ID que representa o pacote zip DWG convertido, o parâmetro datasetId é a ID de um conjunto de dados criado anteriormente para anexar com o conjunto de dados atual e, opcionalmente, o parâmetro de consulta description conterá uma descrição (se a descrição não for fornecida, uma descrição padrão será fornecida).

A Create API é uma operação de longa duração.

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}

Com parâmetros opcionais:

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}&datasetId={datasetId}&description={description}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
geography	path	True	string	Este parâmetro especifica onde o recurso Azure Maps Creator está localizado. Os valores válidos são nós e eu.
api-version	query	True	string	Número da versão da API do Azure Maps.
conversionId	query	True	string	A ID exclusiva usada para criar o conjunto de dados. O `conversionId` deve ter sido obtido de uma chamada bem-sucedida para o serviço de conversão de API de conversão e pode ser fornecido com vários parâmetros de consulta com o mesmo nome (se mais de um for fornecido).
datasetId	query		string	A ID do conjunto de dados a ser acrescentado. O conjunto de dados deve ser originado de uma chamada de criação de conjunto de dados anterior que corresponda ao datasetId
description	query		string	A descrição a fornecer ao conjunto de dados.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica qual conta deve ser usada em conjunto com o modelo de segurança do Microsoft Entra ID. Ele representa uma ID exclusiva para a conta do Azure Maps e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Maps. Para usar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientação.

Respostas

Name	Tipo	Description
200 OK	LongRunningOperationResult	A operação está em execução ou concluída. Se a operação foi bem-sucedida, use o cabeçalho Resource-Location para obter o caminho para o resultado. Cabeçalhos Resource-Location: string
202 Accepted		Pedido aceite: O pedido foi aceite para processamento. Utilize o URL no cabeçalho Operation-Location para obter o estado. Cabeçalhos 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 foi bem-sucedida, use o cabeçalho Resource-Location para obter o caminho para o resultado.

Cabeçalhos

Resource-Location: string

202 Accepted

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

Cabeçalhos

Operation-Location: string

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. 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 Maps.

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

Observações

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

O Authorization URL é específico para a instância de nuvem pública do Azure. As 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 a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

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 compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

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

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(ões) 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 segura 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 do Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Create dataset from a converted CAD file provided by conversionId

Pedido de amostra

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2.0&conversionId=[conversionId]

Resposta da amostra

Código de estado:: 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 estado:: 202

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

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
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.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

LongRunningOperationResult

Object

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

Name	Tipo	Description
created	string (date-time)	O carimbo de data/hora criado.
error	ErrorDetail	O detalhe do erro.
operationId	string	O Id para esta operação de longa duração.
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	O pedido ainda não começou a ser processado.
Running	O pedido começou a ser processado.
Succeeded	O pedido foi concluído com êxito.

Partilhar via

Dataset - Create

Enviar Criar Pedido

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

AADToken

Observações

Âmbitos

subscription-key

SAS Token

Exemplos

Create dataset from a converted CAD file provided by conversionId

Pedido de amostra

Resposta da amostra

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus