Data Registry - Get Operation

Service:

Maps

API Version:

2023-06-01

Veri yazmaç veya değiştirme isteğinin durumunu denetlemek için kullanın.
Get Operation API, bir veri yazmaç durumunu almak için kullanılan bir HTTP GET isteğidir veya yazmaç üst bilgisinde değiştirme isteği döndürülür veya anahtarın Operation-Location değeri olarak yanıtı değiştirir. Devam ederken, üst bilgi içeren Retry-After bir HTTP 200 OK yanıtı döndürülür ve ardından tamamlandıktan sonra ek üst bilgi içermeyen bir HTTP 200 OK gönderilir.

Veri kayıt defteri hizmet uç noktası kapsamı, Azure Haritalar hesabınızın bölgesiyle sınırlıdır ve genel Azure Haritalar hesaplarında kullanılamaz.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
geography	path	True	string	Bu parametre, Azure Haritalar Hesabının nerede bulunduğunu belirtir. Geçerli değerler: abd (Doğu ABD, Orta Batı ABD, Batı ABD 2) ve AB (Kuzey Avrupa, Batı Avrupa).
operationId	path	True	string	Veri kaydı isteğinin durumunu sorgulamak için kullanılan kimlik. Regex pattern: ^[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	Azure Haritalar API'sinin sürüm numarası.

Yanıtlar

Name	Tür	Description
200 OK	LongRunningOperationResult	Uzun süre çalışan işlemin durumu. Headers Retry-After: integer
Other Status Codes	MapsErrorResponse	Beklenmeyen bir hata oluştu. Headers x-ms-error-code: string

Güvenlik

AADToken

Bunlar Microsoft Entra OAuth 2.0 Akışlarıdır. Azure rol tabanlı erişim denetimiyle eşleştirildiğinde, Azure Haritalar REST API'lerine erişimi denetlemek için kullanılabilir. Azure rol tabanlı erişim denetimleri, bir veya daha fazla Azure Haritalar kaynak hesabına veya alt kaynağa erişim tanımlamak için kullanılır. Tüm kullanıcılara, gruplara veya hizmet sorumlularına yerleşik bir rol veya Azure Haritalar REST API'leri için bir veya daha fazla izinden oluşan özel bir rol aracılığıyla erişim verilebilir.

Senaryoları uygulamak için kimlik doğrulama kavramlarını görüntülemenizi öneririz. Özetle, bu güvenlik tanımı belirli API'ler ve kapsamlar üzerinde erişim denetimi yapabilen nesneler aracılığıyla uygulamaları modellemek için bir çözüm sağlar.

Notlar

• Bu güvenlik tanımı, uygulamanın erişim istediği Azure Haritalar kaynağı belirtmek için üst bilgi kullanımını x-ms-client-idgerektirir. Bu, Haritalar yönetim API'sinden alınabilir.

Authorization URL, Azure genel bulut örneğine özgüdür. Bağımsız bulutların benzersiz Yetkilendirme URL'leri ve Microsoft Entra ID yapılandırmaları vardır. * Azure rol tabanlı erişim denetimi azure yönetim düzleminden Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla yapılandırılır. * Azure Haritalar Web SDK'sının kullanımı, bir uygulamanın birden çok kullanım örneği için yapılandırma tabanlı kurulumuna olanak tanır.

• Microsoft kimlik platformu hakkında daha fazla bilgi için bkz. Microsoft kimlik platformu genel bakış.

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

Bu, Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzlemi aracılığıyla Azure Haritalar kaynağı oluştururken sağlanan paylaşılan bir anahtardır.

Bu anahtarla, tüm uygulamalar tüm REST API'lerine erişim yetkisine sahip olur. Başka bir deyişle, bunlar şu anda verildikleri hesabın ana anahtarları olarak değerlendirilebilir.

Herkese açık uygulamalar için önerimiz, bu anahtarın güvenli bir şekilde depolanabileceği Azure Haritalar REST API'lerinin sunucudan sunucuya erişiminin kullanılmasıdır.

Type: apiKey
In: header

SAS Token

Bu paylaşılan erişim imzası belirteci, Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzlemi aracılığıyla Azure Haritalar kaynağındaki SAS listeleme işleminden oluşturulur.

Bu belirteçle, tüm uygulamalar Azure rol tabanlı erişim denetimleri ve belirli bir belirteç için kullanım süre sonu, oran ve bölgeler için ayrıntılı denetim ile erişim yetkisine sahip olur. Başka bir deyişle SAS Belirteci, uygulamaların paylaşılan anahtardan daha güvenli bir şekilde erişimi denetlemesine izin vermek için kullanılabilir.

Herkese açık uygulamalar için önerimiz, işleme kötüye kullanımını sınırlamak ve SAS Belirtecini düzenli olarak yenilemek için Harita hesabı kaynağında izin verilen kaynakların belirli bir listesini yapılandırmayı önermektedir.

Type: apiKey
In: header

Örnekler

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

Sample Request

HTTP

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

Sample Response

Status code:

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

Sample Request

HTTP

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

Sample Response

Status code:

200

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

Get the status of an operation that is still running

Sample Request

HTTP

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

Sample Response

Status code:

200

Retry-After: 10

Response Body

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

Tanımlar

Name	Description
LongRunningOperationResult	Uzun süre çalışan bir işlem için yanıt modeli.
LongRunningOperationStatus	Uzun süre çalışan bir işlemin durumu.
MapsErrorDetail	Hata ayrıntısı.
MapsErrorResponse	Başarısız işlemlerin hata ayrıntılarını döndürmek için Azure Haritalar API'leri için yaygın hata yanıtı.
MapsInnerError	Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.

LongRunningOperationResult

Uzun süre çalışan bir işlem için yanıt modeli.

Name	Tür	Description
error	MapsErrorDetail	Hata ayrıntısı.
id	string	operationId
status	LongRunningOperationStatus	Uzun süre çalışan bir işlemin durumu.

LongRunningOperationStatus

Uzun süre çalışan bir işlemin durumu.

Name	Tür	Description
Completed	string	İstek başarıyla tamamlandı.
Failed	string	İstekte bir veya daha fazla hata var.
Running	string	İstek şu anda işleniyor.

MapsErrorDetail

Hata ayrıntısı.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	MapsErrorDetail[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili ayrıntılar dizisi.
innererror	MapsInnerError	Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilen bir gösterimi.
target	string	Hatanın hedefi.

MapsErrorResponse

Başarısız işlemlerin hata ayrıntılarını döndürmek için Azure Haritalar API'leri için yaygın hata yanıtı.

Name	Tür	Description
error	MapsErrorDetail	Hata ayrıntısı.

MapsInnerError

Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.

Name	Tür	Description
code	string	Hata kodu.
innererror	MapsInnerError	Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.