Aracılığıyla paylaş


Tileset - Validate Configuration

Kutucuk kümesi yapılandırmasını doğrulamak için kullanın.

Yapılandırma İsteğini DoğrulamaYı Gönder

Validate Configuration API, sağlanan öğesine göre belirtilen kutucuk kümesi yapılandırmasını doğrulamak için kullanılan bir HTTP POST isteğidirdatasetId.

POST https://{geography}.atlas.microsoft.com/tilesets:validateConfiguration?api-version=2023-03-01-preview&datasetId={datasetId}

URI Parametreleri

Name İçinde Gerekli Tür Description
geography
path True

string

Bu parametre, Azure Haritalar Oluşturucu kaynağının nerede bulunduğunu belirtir. Geçerli değerler biz ve AB'lerdir.

api-version
query True

string

Azure Haritalar API'sinin sürüm numarası.

datasetId
query True

string

Kutucuk kümesi oluşturma API'sinin kutucuk oluşturmak için özellikleri almak için kullandığı benzersiz datasetId . başarılı datasetId bir Veri Kümesi Oluşturma API çağrısından alınmış olmalıdır.

İstek Başlığı

Name Gerekli Tür Description
x-ms-client-id

string

Hangi hesabın Microsoft Entra ID güvenlik modeliyle birlikte kullanıma yönelik olduğunu belirtir. Azure Haritalar hesabı için benzersiz bir kimliği temsil eder ve Azure Haritalar yönetim düzlemi Hesap API'sinden alınabilir. Azure Haritalar'de Microsoft Entra ID güvenliği kullanmak için rehberlik için aşağıdaki makalelere bakın.

İstek Gövdesi

Name Gerekli Tür Description
layers True

<string,  LayerObject>

Katmanların adları ve yapılandırma seçenekleri. Yapılandırma katmanları nesnesi, kutucuk katmanlarının adlarını yapılandırmalarıyla ilişkilendiren anahtar-değer çiftleri içerir. Her anahtar-değer çifti için anahtar katmanın adıdır ve değer katman yapılandırmasını ve seçeneklerini içeren bir LayerObject değeridir. Her katmanın bir adı olmalıdır. Bu, son kutucuk kümesinizdeki veri katmanının benzersiz tanımlayıcısıdır. Herhangi bir kutucuk kümesinde her katman adı benzersiz olmalıdır. Katman adı yalnızca alt çizgi (_) ve alfasayısal karakterler içeren bir dize olmalıdır. Her katman adına karşılık gelen LayerObject, bu vektör kutucuğu katmanının nasıl oluşturulması gerektiğini açıklar. Özellik verilerini almak için hangi özellik sınıflarını, yakınlaştırma düzeyleri aracılığıyla verilerin duyarlığı ve özellikleri dönüştürüp kutucuklara dönüştürmeyi belirtir.

version True

integer

Kutucuk kümesi yapılandırmasının kullandığı Azure Haritalar Tiling hizmeti yapılandırma başvurusu sürümü. Şu anda yalnızca sürüm 1'e izin verilir. Geçerli sürümün veya önceki bir sürümün başka bir sürümünün kullanılması hataya neden olur.

Yanıtlar

Name Tür Description
200 OK

TilesetConfigurationValidationResult

Kutucuk kümesi yapılandırma isteğinin başarıyla tamamlandığını doğrulayın. Yanıt gövdesi doğrulama sonuçlarını içerir.

Other Status Codes

ErrorResponse

Beklenmeyen bir hata oluştu.

Güvenlik

AADToken

Bunlar Azure Active Directory OAuth2 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 Azure Active Directory 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.

  • Şu anda Azure Active Directory v1.0 veya v2.0 , İş, Okul ve Konuklar'ı destekler ancak Kişisel hesapları desteklemez.

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 Azure Haritalar hesabı oluşturduğunuzda veya PowerShell, CLI, Azure SDK'ları veya REST API'sini kullandığınızda sağlanan paylaşılan bir anahtardır.

Bu anahtarla, tüm uygulamalar tüm REST API'lere erişebilir. Başka bir deyişle, bu anahtar, verildikleri hesapta ana anahtar olarak kullanılabilir.

Herkese açık uygulamalar için, anahtarınızın güvenli bir şekilde depolanabilmesi için gizli istemci uygulamaları yaklaşımını kullanarak Azure Haritalar REST API'lerine erişmenizi öneririz.

Tür: apiKey
İçinde: query

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.

Tür: apiKey
İçinde: header

Örnekler

Validates the correctness of a tileset configuration

Örnek isteği

POST https://us.atlas.microsoft.com/tilesets:validateConfiguration?api-version=2023-03-01-preview&datasetId=[datasetId]

{
  "version": 1,
  "layers": {
    "Indoor test": {
      "minZoom": 10,
      "maxZoom": 18,
      "features": {
        "featureClasses": [
          "unit"
        ],
        "filter": [
          "any",
          [
            "!=",
            [
              "get",
              "featureType"
            ],
            "conference"
          ],
          [
            "!=",
            [
              "get",
              "featureType"
            ],
            "restroom"
          ]
        ]
      }
    }
  }
}

Örnek yanıt

{
  "valid": false,
  "warnings": [],
  "errors": [
    {
      "code": "CustomLayerNameNotSupported",
      "message": "Custom layerName 'Indoor test' is not supported yet.",
      "target": "Indoor test"
    }
  ]
}

Tanımlar

Name Description
ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

ErrorCode

Doğrulama hata kodu.

ErrorDetail

Hata ayrıntısı.

ErrorResponse

Hata yanıtı

Feature

Kutucuk kümesi yapılandırması için özellik yapılandırması.

LayerObject

Kutucuk kümesi yapılandırması için katman nesnesi.

TilesetConfiguration

Kutucuk kümesi yapılandırması üst düzey alanları. Kutucuk kümesi yapılandırması, aşağıdaki üst düzey alanları içermesi gereken bir JSON nesnesidir:

TilesetConfigurationValidationResult

Kutucuk kümesi yapılandırma doğrulama sonucu.

ValidationError

Kutucuk kümesi yapılandırma doğrulama hataları.

ValidationWarning

Kutucuk kümesi yapılandırma doğrulama hataları.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.

type

string

Ek bilgi türü.

ErrorCode

Doğrulama hata kodu.

Name Tür Description
CustomLayerNameNotSupported

string

Özel katman adı şu anda desteklenmiyor.

CustomOntologyNotSupported

string

Özel ontoloji şu anda desteklenmiyor, 'Facility-2.0' desteklenen ontolojidir.

DuplicateFeatureClassFound

string

Özellik sınıfı adı benzersiz olmalıdır.

DuplicateLayerNameFound

string

Katman adı benzersiz olmalıdır.

UndefinedFeatureClasses

string

Özellik sınıfı ontoloji tanımında tanımlanmalıdır ve özellik sınıfı adı büyük/küçük harfe duyarlıdır.

ErrorDetail

Hata ayrıntısı.

Name Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgileri.

code

string

Hata kodu.

details

ErrorDetail[]

Hata ayrıntıları.

message

string

Hata iletisi.

target

string

Hata hedefi.

ErrorResponse

Hata yanıtı

Name Tür Description
error

ErrorDetail

Hata nesnesi.

Feature

Kutucuk kümesi yapılandırması için özellik yapılandırması.

Name Tür Description
featureClasses

string[]

Katmanı oluşturmak için kullanılacak özellik sınıflarının listesi. Geçerli özellik sınıfları, ontoloji tanımında bulunabilir. Örneğin, Tesis Ontolojisi

filter

object

Desenle eşleşmeyen özellikleri kaldırır. MapLibre filtre ifadesine bakın

LayerObject

Kutucuk kümesi yapılandırması için katman nesnesi.

Name Tür Description
features

Feature

Özellik sınıflarını ve filtrelerini belirtir.

maxZoom

integer

Katmanın oluşturacak en yüksek yakınlaştırma düzeyi.

minZoom

integer

Oluşturacak katmanın en düşük yakınlaştırma düzeyi.

TilesetConfiguration

Kutucuk kümesi yapılandırması üst düzey alanları. Kutucuk kümesi yapılandırması, aşağıdaki üst düzey alanları içermesi gereken bir JSON nesnesidir:

Name Tür Description
layers

<string,  LayerObject>

Katmanların adları ve yapılandırma seçenekleri. Yapılandırma katmanları nesnesi, kutucuk katmanlarının adlarını yapılandırmalarıyla ilişkilendiren anahtar-değer çiftleri içerir. Her anahtar-değer çifti için anahtar katmanın adıdır ve değer katman yapılandırmasını ve seçeneklerini içeren bir LayerObject değeridir. Her katmanın bir adı olmalıdır. Bu, son kutucuk kümesinizdeki veri katmanının benzersiz tanımlayıcısıdır. Herhangi bir kutucuk kümesinde her katman adı benzersiz olmalıdır. Katman adı yalnızca alt çizgi (_) ve alfasayısal karakterler içeren bir dize olmalıdır. Her katman adına karşılık gelen LayerObject, bu vektör kutucuğu katmanının nasıl oluşturulması gerektiğini açıklar. Özellik verilerini almak için hangi özellik sınıflarını, yakınlaştırma düzeyleri aracılığıyla verilerin duyarlığı ve özellikleri dönüştürüp kutucuklara dönüştürmeyi belirtir.

version

integer

Kutucuk kümesi yapılandırmasının kullandığı Azure Haritalar Tiling hizmeti yapılandırma başvurusu sürümü. Şu anda yalnızca sürüm 1'e izin verilir. Geçerli sürümün veya önceki bir sürümün başka bir sürümünün kullanılması hataya neden olur.

TilesetConfigurationValidationResult

Kutucuk kümesi yapılandırma doğrulama sonucu.

Name Tür Description
errors

ValidationError[]

Doğrulama hatalarının listesi.

valid

boolean

Doğrulama sonucu.

warnings

ValidationWarning[]

Doğrulama uyarılarının listesi.

ValidationError

Kutucuk kümesi yapılandırma doğrulama hataları.

Name Tür Description
code

ErrorCode

Doğrulama hata kodu.

message

string

Doğrulama hata iletisi.

target

string

Doğrulama hatasının hedef öğesi.

ValidationWarning

Kutucuk kümesi yapılandırma doğrulama hataları.

Name Tür Description
code

string

Doğrulama uyarı kodu.

message

string

Doğrulama uyarı iletisi.

target

string

Doğrulama uyarısının hedef öğesi.