Dataset - Get Operation

Ссылка

Служба:: Maps Creator

Версия API:: 2.0

Используется для проверки состояния процесса создания набора данных.

Заметка

Azure Maps Creator

Служба azure Maps Creator в помещении теперь устарела и будет прекращена 9.30.25. Дополнительные сведения см. в объявлении о завершении жизни создателя Azure Maps.

API Get Operation — это запрос HTTP GET, используемый для проверки состояния процесса создания набора данных и получения значения datasetId.

Отправка запроса операций

Чтобы просмотреть текущий ход выполнения операции набора данных, вы будете использовать запрос GET, где operationId заданный путь — это идентификатор, представляющий операцию.

Ответ операции

Во время выполнения возвращается код состояния http 200-OK без дополнительных заголовков. Если операция выполнена успешно, возвращается код состояния http 200-OK с заголовком Resource-Location.

GET https://{geography}.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
geography	path	True	string	Этот параметр указывает расположение ресурса Создателя Azure Maps. Допустимые значения являются нами и eu.
operationId	path	True	string	Идентификатор для запроса состояния набора данных create/import request.
api-version	query	True	string	Номер версии API Azure Maps.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности идентификатора Microsoft Entra. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Сведения о том, как использовать безопасность идентификатора Microsoft Entra в Azure Maps, см. в следующих статьях .

Ответы

Имя	Тип	Описание
200 OK	LongRunningOperationResult	Операция выполняется или завершается. Если операция выполнена успешно, используйте заголовок Resource-Location, чтобы получить путь к результату. Заголовки Resource-Location: string
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

Имя

Тип

Описание

200 OK

LongRunningOperationResult

Операция выполняется или завершается. Если операция выполнена успешно, используйте заголовок Resource-Location, чтобы получить путь к результату.

Заголовки

Resource-Location: string

Other Status Codes

ErrorResponse

Произошла непредвиденная ошибка.

Безопасность

AADToken

Это потоки Microsoft Entra OAuth 2.0. При паре с доступом на основе ролей Azure его можно использовать для управления доступом к REST API Azure Maps. Управление доступом на основе ролей Azure используется для назначения доступа к одной или нескольким учетным записям ресурсов Azure Maps или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.

Для реализации сценариев рекомендуется просматривать концепции проверки подлинности . В целом, это определение безопасности предоставляет решение для моделирования приложений через объекты, способные управлять доступом в определенных API и областях.

Примечания

Для этого определения безопасности требуется использовать заголовок x-ms-client-id, чтобы указать, к какой ресурсу Azure Maps приложение запрашивает доступ. Это можно получить изAPI управления картами .

Authorization URL зависит от экземпляра общедоступного облака Azure. В национальных облаках есть уникальные URL-адреса авторизации и конфигурации идентификатора Microsoft Entra. * Управление доступом на основе ролей Azure настраивается с плоскости управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API. * Использование веб-пакета SDK Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.

Дополнительные сведения о платформе удостоверений Майкрософт см. в обзоре платформы удостоверений Майкрософт.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, подготовленный при создания учетной записи Azure Maps на портале Azure или с помощью PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого ключа любой приложение может получить доступ ко всем REST API. Другими словами, этот ключ можно использовать в качестве главного ключа в учетной записи, в которую они выданы.

Для общедоступных приложений мы рекомендуем использовать конфиденциальные клиентские приложения, подход для доступа к REST API Azure Maps, чтобы ваш ключ можно было безопасно хранить.

Тип: apiKey
В: query

SAS Token

Это маркер подписанного URL-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого маркера любой приложению разрешен доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Другими словами, маркер SAS можно использовать для разрешения приложений управлять доступом более защищенным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты карты, чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Тип: apiKey
В: header

Примеры

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

Образец запроса

HTTP

GET https://us.atlas.microsoft.com/datasets/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0

Пример ответа

Код состояния:: 200

Resource-Location: https://us.atlas.microsoft.com/datasets/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

Образец запроса

HTTP

GET https://us.atlas.microsoft.com/datasets/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0

Пример ответа

Код состояния:: 200

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-23T19:14:03.2452596+00:00",
  "status": "Running"
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
LongRunningOperationResult	Модель ответа для API операций Long-Running.
LroStatus	Состояние запроса.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

LongRunningOperationResult

Object

Модель ответа для API операций Long-Running.

Имя	Тип	Описание
created	string (date-time)	Созданная метка времени.
error	ErrorDetail	Сведения об ошибке.
operationId	string	Идентификатор для этой длительной операции.
status	LroStatus	Состояние запроса.
warning	ErrorDetail	Сведения об ошибке.

LroStatus

Перечисление

Состояние запроса.

Значение	Описание
Failed	Запрос имеет один или несколько сбоев.
NotStarted	Запрос еще не начал обработку.
Running	Запрос начал обработку.
Succeeded	Запрос успешно завершен.

Поделиться через

Dataset - Get Operation

Отправка запроса операций

Ответ операции

Параметры URI

Заголовок запроса

Ответы

Безопасность

AADToken

Примечания

Области

subscription-key

SAS Token

Примеры

Get the status of an operation which has finished successfully

Образец запроса

Пример ответа

Get the status of an operation which is still running

Образец запроса

Пример ответа

Определения

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

Дополнительные ресурсы