Data - Delete Preview
O pedido Eliminar permite que o autor da chamada elimine os dados carregados anteriormente através do Carregamento de Dados.
Aplica-se a: Escalão de preço S1.
Esta API permite que o autor da chamada elimine um conteúdo de dados carregado anteriormente.
Pode utilizar esta API num cenário como remover geofences anteriormente carregados com a API de Carregamento de Dados para utilização no nosso Serviço de Perímetro Geográfico do Azure Maps. Também pode utilizar esta API para eliminar conteúdos carregados antigos/não utilizados e criar espaço para novos conteúdos.
Nota
descontinuação do Serviço de dados do Azure Maps
O serviço Azure Maps Dados (v1 e v2) foi preterido e será descontinuado a 16/09/24. Para evitar interrupções do serviço, todas as chamadas para o serviço de Dados terão de ser atualizadas para utilizar o serviço Azure Maps Registo de Dados até 16/09/24. Para obter mais informações, veja Como criar um registo de dados.
Submeter Pedido de Eliminação
Para eliminar o conteúdo, emitirá um DELETE
pedido em que o caminho irá conter os udid
dados a eliminar.
Por exemplo, para eliminar uma coleção de geofences anteriormente carregados com a API de Carregamento, defina o udid
parâmetro no caminho para o udid
dos dados recebidos anteriormente na resposta da API de carregamento.
Eliminar Resposta de Dados
A API de Eliminação de Dados devolve uma resposta HTTP 204 No Content
com um corpo vazio, se o recurso de dados tiver sido eliminado com êxito.
Será devolvida uma resposta de erro HTTP 400 Bad Request
se o recurso de dados com o pass-in udid
não for encontrado.
DELETE https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=1.0
DELETE https://{geography}.atlas.microsoft.com/mapData/{udid}?subscription-key={subscription-key}&api-version=1.0
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. |
udid
|
path | True |
string |
O ID de dados exclusivo do conteúdo. O |
api-version
|
query | True |
string |
Número da versão da API Azure Maps. A versão atual é 1.0 |
subscription-key
|
query |
string |
Uma das chaves de Azure Maps fornecidas a partir de uma Conta do Azure Map. Veja este artigo para obter detalhes sobre como gerir a autenticação. |
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 |
---|---|---|
204 No Content |
object |
O pedido de eliminação de dados foi concluído com êxito. O conteúdo para |
400 Bad Request |
Pedido incorreto: 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 token de portador de Microsoft Entra ID inválido. Confirme que fornece uma chave válida para uma subscrição ativa do Azure e um recurso do Maps. Caso contrário, verifique o cabeçalho WWW-Authenticate para obter o código de erro e a descrição do token de portador de Microsoft Entra ID fornecido. Headers WWW-Authenticate: string |
|
403 Forbidden |
Problemas de permissão, capacidade ou autenticação. |
|
404 Not Found |
Não Encontrado: não foi possível localizar o recurso pedido, mas poderá estar novamente disponível no futuro. |
|
500 Internal Server Error |
Ocorreu um erro ao processar o pedido. Tente novamente mais tarde. |
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
Delete previously uploaded GeoJSON data containing geometries that represent a collection of geofences
Sample Request
DELETE https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?subscription-key=[subscription-key]&api-version=1.0
Sample Response
{}
{
"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
Name | Description |
---|---|
OData |
Este objeto é devolvido quando ocorre um erro na API de Azure Maps. |
OData |
Este objeto de resposta é devolvido quando ocorre um erro na API Azure Maps. |
ODataError
Este objeto é devolvido quando ocorre um erro na API de Azure Maps.
Name | Tipo | Description |
---|---|---|
code |
string |
O código ODataError. |
details |
Este objeto é devolvido quando ocorre um erro na API de Azure Maps. |
|
message |
string |
Se disponível, uma descrição legível por humanos do erro. |
target |
string |
Se disponível, o destino está a causar o erro. |
ODataErrorResponse
Este objeto de resposta é devolvido quando ocorre um erro na API Azure Maps.
Name | Tipo | Description |
---|---|---|
error |
Este objeto é devolvido quando ocorre um erro na API de Azure Maps. |