Data Registry - Get Operation
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 istek değiştirme veya anahtarın değeri Operation-Location
olarak yanıtı değiştirme döndürülür. Devam ederken, üst bilgi ile Retry-After
bir HTTP 200 OK
yanıtı döndürülür ve ardından tamamlandıktan sonra ek üst bilgisi olmayan 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). |
operation
|
path | True |
string |
Veri yazmaç isteğinin durumunu sorgulamak için kullanılan kimlik. Normal ifade deseni: |
api-version
|
query | True |
string |
Azure Haritalar API'sinin sürüm numarası. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Uzun süre çalışan işlemin durumu. Üst Bilgiler Retry-After: integer |
|
Other Status Codes |
Beklenmeyen bir hata oluştu. Üst Bilgiler 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ğına erişimi belirtmek için kullanılır. Herhangi bir kullanıcı, grup veya hizmet sorumlusuna 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ı modellemeye yönelik bir çözüm sağlar.
Notlar
- Bu güvenlik tanımı, uygulamanın erişim isteğinde
x-ms-client-id
bulunduğu Azure Haritalar kaynağını belirtmek için üst bilginin kullanılmasını gerektirir. Bu, Haritalar yönetim API'sinden edinilebilir.
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 portalı, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzleminden yapılandırılır.
* Azure Haritalar Web SDK'sının kullanımı, birden çok kullanım örneği için bir uygulamanın yapılandırma tabanlı kurulumuna olanak tanır.
- Microsoft kimlik platformu hakkında daha fazla bilgi için bkz. Microsoft kimlik platformuna genel bakış.
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
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 bir 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 kabul edilebilir.
Herkese açık uygulamalar için önerimiz, bu anahtarın güvenli bir şekilde depolanabildiği Azure Haritalar REST API'lerinin sunucudan sunucuya erişiminin kullanılmasıdır.
Tür:
apiKey
İçinde:
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 Haritalar kaynağındaki Sas Listeleme işleminden oluşturulur.
Bu belirteçle, tüm uygulamalar Azure rol tabanlı erişim denetimleri ve belirli bir belirtecin kullanım süresi, oranı ve bölgelerine yönelik ayrıntılı denetim ile erişim yetkisine sahip olur. Başka bir deyişle SAS Belirteci, uygulamaların erişimi paylaşılan anahtardan daha güvenli bir şekilde denetlemesine izin vermek için kullanılabilir.
Herkese açık uygulamalar için önerimiz, uygunsuz işlemeyi 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ırmanızdır.
Tür:
apiKey
İçinde:
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
Örnek isteği
GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01
Örnek yanıt
{
"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
Örnek isteği
GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01
Örnek yanıt
{
"id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
"status": "Completed"
}
Get the status of an operation that is still running
Örnek isteği
GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01
Örnek yanıt
Retry-After: 10
{
"id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
"status": "Running"
}
Tanımlar
Name | Description |
---|---|
Long |
Uzun süre çalışan bir işlem için yanıt modeli. |
Long |
Uzun süre çalışan bir işlemin durumu. |
Maps |
Hata ayrıntısı. |
Maps |
Başarısız işlemlerin hata ayrıntılarını döndürmek için Azure Haritalar API'leri için genel hata yanıtı. |
Maps |
Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne. |
LongRunningOperationResult
Uzun süre çalışan bir işlem için yanıt modeli.
Name | Tür | Description |
---|---|---|
error |
Hata ayrıntısı. |
|
id |
string |
operationId |
status |
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 |
Bu bildirilen hataya yol açan belirli hatalarla ilgili bir dizi ayrıntı. |
|
innererror |
Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne. |
|
message |
string |
Hatanın insanlar tarafından okunabilir 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 genel hata yanıtı.
Name | Tür | Description |
---|---|---|
error |
Hata ayrıntısı. |
MapsInnerError
Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
Name | Tür | Description |
---|---|---|
code |
string |
Hata kodu. |
innererror |
Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne. |