Data Registry - Unregister

Serviço:

Maps

Versão da API:

2023-06-01

Utilize para anular o registo de dados armazenados numa Conta de Armazenamento do Azure registada numa conta do Azure Maps.

A Unregister API é um pedido HTTP DELETE que remove um registo de dados sem eliminar o conteúdo subjacente da conta de armazenamento do Azure.

Útil em cenários como anular o registo de ficheiros geofence anteriormente registados com a API registar ou Substituir para utilização no Azure Maps Geofencing Service ou anular o registo de um ficheiro zip comprimido que contenha ficheiros de estrutura DWG utilizados pelo Serviço de Conversão de Criadores do Azure Maps.

O ponto final do serviço de registo de dados está limitado no âmbito da região da sua conta do Azure Maps e não está disponível para contas globais do Azure Maps.

Submeter Pedido de Anulação do Registo

Utilize um pedido HTTP DELETE com o udid registo de dados para anular o registo.

Anular Registo de Resposta

O Unregister pedido devolve uma resposta HTTP "204 Sem Conteúdo" com um corpo vazio, se o registo de dados tiver sido eliminado com êxito.

DELETE https://{geography}.atlas.microsoft.com/dataRegistries/{udid}?api-version=2023-06-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
geography	path	True	string	Este parâmetro especifica onde está localizada a Conta do Azure Maps. Os valores válidos são nós (E.U.A. Leste, E.U.A. Centro-Oeste, E.U.A. Oeste 2) e eu (Europa do Norte, Europa Ocidental).
udid	path	True	string	O ID de dados de utilizador do registo de dados. Padrão Regex: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
api-version	query	True	string	O número da versão da API do Azure Maps.

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 do Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão do Azure Maps. Para utilizar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
204 No Content		O Unregister pedido foi concluído com êxito. O registo de dados é eliminado, mas os dados não foram removidos da conta de armazenamento.
Other Status Codes	MapsErrorResponse	Ocorreu um erro inesperado. Cabeçalhos x-ms-error-code: string

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 do Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais contas de recursos ou sub-recursos do Azure Maps. 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 as APIs REST do Azure Maps.

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 do Azure Maps 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 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 do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * A utilização do SDK Web do 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 a plataforma de identidades da Microsoft, consulte Descrição geral da plataforma de identidades 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 partilhada que é aprovisionada ao criar um recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

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

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

Tipo: apiKey
Em: header

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das 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

Unregister a data registry without deleting the underlying contents

Pedido de amostra

HTTP

DELETE https://us.atlas.microsoft.com/dataRegistries/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2023-06-01

Resposta da amostra

Código de estado:

204

Definições

Name	Description
MapsErrorDetail	O detalhe do erro.
MapsErrorResponse	Resposta de erro comum às APIs do Azure Maps para devolver detalhes de erro para operações falhadas.
MapsInnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

MapsErrorDetail

O detalhe do erro.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	MapsErrorDetail[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
innererror	MapsInnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O destino do erro.

MapsErrorResponse

Resposta de erro comum às APIs do Azure Maps para devolver detalhes de erro para operações falhadas.

Name	Tipo	Description
error	MapsErrorDetail	O detalhe do erro.

MapsInnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

Name	Tipo	Description
code	string	O código de erro.
innererror	MapsInnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.