Tileset - Get Operation
Use para obter o status de uma criação de conjunto de blocos.
A Get Operation
API é uma solicitação HTTP GET
usada para marcar o status do processo de criação do conjunto de blocos e recuperar o tilesetId
valor. O caminho é obtido de uma chamada para Tileset – Criar. Enquanto estiver em andamento, um HTTP 200 é retornado sem cabeçalhos extras. Depois de concluído com êxito, um HTTP 200 é retornado com um Resource-Location
cabeçalho. Para obter mais informações, consulte Verificar a status da criação do conjunto de blocos.
GET https://{geography}.atlas.microsoft.com/tilesets/operations/{operationId}?api-version=2.0
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
geography
|
path | True |
string |
Esse parâmetro especifica onde o recurso Azure Mapas Creator está localizado. Os valores válidos são nós e eu. |
operation
|
path | True |
string |
A ID para consultar o status para a solicitação de criação/importação do conjunto de blocos. |
api-version
|
query | True |
string |
Número de versão da API de Mapas Azure. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
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 |
|
Other Status Codes |
Erro inesperado. |
Segurança
AADToken
Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso a Azure Mapas APIs REST. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. 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 Azure Mapas APIs REST.
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 acessar o controle em APIs e escopos específicos.
Observações
- Essa definição de segurança requer o uso do
x-ms-client-id
cabeçalho para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.
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 Microsoft Entra ID.
* O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou 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.
- Para obter mais informações sobre plataforma de identidade da Microsoft, consulte visão geral plataforma de identidade da Microsoft.
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ê cria uma conta 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 master na conta em que elas são emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST 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 com base na operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou 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 a expiração, a taxa e as regiõ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 maneira mais segura do que a chave compartilhada.
Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta de mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.
Tipo:
apiKey
Em:
header
Exemplos
Get the status of an operation which has finished successfully |
Get the status of an operation which is still running |
Get the status of an operation which has finished successfully
Solicitação de exemplo
GET https://us.atlas.microsoft.com/tilesets/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0
Resposta de exemplo
Resource-Location: https://us.atlas.microsoft.com/tilesets/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"
}
Get the status of an operation which is still running
Solicitação de exemplo
GET https://us.atlas.microsoft.com/tilesets/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0
Resposta de exemplo
{
"operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"created": "2021-04-23T19:14:03.2452596+00:00",
"status": "Running"
}
Definições
Nome | Description |
---|---|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
Os detalhes do erro. |
Error |
Resposta de erro |
Long |
O modelo de resposta para uma API de Operações Long-Running. |
Lro |
O estado status da solicitação. |
ErrorAdditionalInfo
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
Os detalhes do erro.
Nome | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
LongRunningOperationResult
O modelo de resposta para uma API de Operações Long-Running.
Nome | Tipo | Description |
---|---|---|
created |
string |
O carimbo de data/hora criado. |
error |
Os detalhes do erro. |
|
operationId |
string |
A ID dessa operação de execução prolongada. |
status |
O estado status da solicitação. |
|
warning |
Os detalhes do erro. |
LroStatus
O estado status da solicitação.
Nome | Tipo | Description |
---|---|---|
Failed |
string |
A solicitação tem uma ou mais falhas. |
NotStarted |
string |
A solicitação ainda não iniciou o processamento. |
Running |
string |
A solicitação iniciou o processamento. |
Succeeded |
string |
A solicitação foi concluída com êxito. |