Data Registry - Get Operation

Ссылка

Служба:: Maps

Версия API:: 2023-06-01

Используйте для проверки состояния регистра данных или запроса замены .
Get Operation API — это HTTP-запросGET, используемый для получения состояния регистра данных, или запрос на замену возвращается в заголовке регистра или ответа на замену в качестве значения Operation-Location ключа. Во время выполнения будет возвращен HTTP-ответ 200 OK с Retry-After заголовком , за которым следует HTTP 200 OK без дополнительного заголовка после завершения.

Конечная точка службы реестра данных ограничена регионом учетной записи Azure Maps и недоступна для глобальных учетных записей Azure Maps.

GET https://{geography}.atlas.microsoft.com/dataRegistries/operations/{operationId}?api-version=2023-06-01

Параметры URI

Имя В Обязательно Тип Описание

Имя	В	Обязательно	Тип	Описание
geography	path	True	string	Этот параметр указывает, где находится учетная запись Azure Maps. Допустимые значения: us (восточная часть США, центрально-западная часть США, западная часть США 2) и eu (Северная Европа, Западная Европа).
operationId	path	True	string	Идентификатор, используемый для запроса состояния запроса на регистрацию данных. Шаблон регулярного выражения: `^[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	Номер версии API Azure Maps.

geography

path

True

string

Этот параметр указывает, где находится учетная запись Azure Maps. Допустимые значения: us (восточная часть США, центрально-западная часть США, западная часть США 2) и eu (Северная Европа, Западная Европа).

operationId

path

True

string

Идентификатор, используемый для запроса состояния запроса на регистрацию данных.

Шаблон регулярного выражения: ^[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

Номер версии API Azure Maps.

Ответы

Имя	Тип	Описание
200 OK	LongRunningOperationResult	Состояние длительной операции. Заголовки Retry-After: integer
Other Status Codes	MapsErrorResponse	Произошла непредвиденная ошибка. Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

LongRunningOperationResult

Состояние длительной операции.

Заголовки

Retry-After: integer

Other Status Codes

MapsErrorResponse

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

Заголовки

x-ms-error-code: string

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

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 с помощью портала Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

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

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

Тип: apiKey
В: header

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

Get the status of an operation that failed

Get the status of an operation that finished successfully

Get the status of an operation that is still running

Get the status of an operation that failed

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

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

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

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

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Failed",
  "error": {
    "code": "InvalidData",
    "message": "The data is not a valid GeoJSON."
  }
}

Get the status of an operation that finished successfully

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

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

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

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

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Completed"
}

Get the status of an operation that is still running

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

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

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

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

Retry-After: 10

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Running"
}

Определения

Имя	Описание
LongRunningOperationResult	Модель ответа для длительной операции.
LongRunningOperationStatus	Состояние длительной операции.
MapsErrorDetail	Сведения об ошибке.
MapsErrorResponse	Распространенные ответы об ошибках, которые API-интерфейсы Azure Maps возвращают сведения об ошибках для неудачных операций.
MapsInnerError	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.

LongRunningOperationResult

Модель ответа для длительной операции.

Имя	Тип	Описание
error	MapsErrorDetail	Сведения об ошибке.
id	string	Идентификатор операции
status	LongRunningOperationStatus	Состояние длительной операции.

LongRunningOperationStatus

Состояние длительной операции.

Имя	Тип	Описание
Completed	string	Запрос успешно выполнен.
Failed	string	Запрос имеет один или несколько сбоев.
Running	string	Запрос в настоящее время обрабатывается.

MapsErrorDetail

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

Имя	Тип	Описание
code	string	Один из серверных наборов кодов ошибок.
details	MapsErrorDetail[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
innererror	MapsInnerError	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Понятное представление ошибки.
target	string	Целевой объект ошибки.

MapsErrorResponse

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

Имя	Тип	Описание
error	MapsErrorDetail	Сведения об ошибке.

MapsInnerError

Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.

Имя	Тип	Описание
code	string	Код ошибки.
innererror	MapsInnerError	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.

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

Data Registry - Get Operation

Параметры URI

Ответы

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

AADToken

Примечания

Области

subscription-key

SAS Token

Примеры

Get the status of an operation that failed

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

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

Get the status of an operation that finished successfully

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

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

Get the status of an operation that is still running

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

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

Определения

LongRunningOperationResult

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

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