Analiz OData meta verileri

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Analiz için varlık modeliyle ilişkili meta verileri anlamak, Analiz için Veri modelini program aracılığıyla sorgulamanın önkoşullarından biridir. OData meta verileri, istemci tüketimini etkinleştirmek için tasarlanmış varlık modelinin makine tarafından okunabilir bir açıklamasıdır.

Not

"Açık Veri Protokolü (OData), HTTP gibi temel protokoller ve web için REST gibi yaygın olarak kabul edilen yöntemler üzerine oluşturulmuş bir veri erişim protokolüdür. OData hizmetlerini kullanmak için kullanılabilecek çeşitli kitaplıklar ve araçlar vardır." - OData Kuruluşu Temel Öğreticisi.

Bu makalede şunların nasıl yapıldığını öğreneceksiniz:

• Belirli bir projedeki meta verileri sorgulama
• Kuruluşta meta verileri sorgulama
• Varlıkla ilişkili anahtarları, özellikleri ve gezinti özelliklerini tanımlama
• Analytics OData uç noktasının özelliklerini belirleme

Tüm OData öğelerinin ayrıntılı açıklamaları için bkz. OData modeli. Meta verileri sorgulama hakkında bilgi için bkz. Analiz için OData sorguları oluşturma.

Not

Analiz hizmeti tüm Azure DevOps Services için üretimde otomatik olarak etkinleştirilir ve desteklenir. Power BI tümleştirmesi ve Analiz Hizmeti'nin OData akışına erişim genel olarak kullanılabilir. Bunu kullanmanızı ve bize geri bildirim göndermenizi öneririz. Kullanılabilir veriler sürüme bağlıdır. Desteklenen en son sürüm, v2.0en son önizleme sürümü ise sürümüdür v4.0-preview. Daha fazla bilgi için bkz. OData API sürümü oluşturma.

Varlık kümeleri ve varlık türleri

Varlıklar, veri modelindeki temel kimlik türleridir. Varlık kümeleri, varlık koleksiyonları olarak adlandırılır. Örneğin, Projects varlıkları içeren Project bir varlık kümesidir. Bir varlık en fazla bir varlık kümesinin üyesi olabilir.

EntitySets ve EntityTypes özellikler ve ilişkiler dahil olmak üzere Analiz modelindeki varlıkların her birini tanımlayın. Varlık türleri, bir varlığın adlandırılmış özelliklerini ve ilişkilerini tanımlar. Varlık türleri, diğer varlık türlerinden tek devralma yoluyla türetilebilir. Varlık türünün anahtarı, temel özelliklerinin bir alt kümesinden oluşturulur.

Aşağıdaki örnekte varlık türüyle ilişkilendirilmiş meta veriler gösterilmektedir Project .

<EntityType Name="Project">
  <Key>
    <PropertyRef Name="ProjectSK"/>
  </Key>
  <Property Name="ProjectSK" Type="Edm.Guid" Nullable="false"/>
  <Property Name="ProjectId" Type="Edm.Guid" Nullable="false">
    <Annotation Term="Display.DisplayName" String="Project Id"/>
  </Property>
  <Property Name="ProjectName" Type="Edm.String" Nullable="false">
    <Annotation Term="Display.DisplayName" String="Project Name"/>
  </Property>
  <Property Name="AnalyticsUpdatedDate" Type="Edm.DateTimeOffset"/>
  <Property Name="ProjectVisibility" Type="Microsoft.VisualStudio.Services.Analytics.Model.ProjectVisibility">
    <Annotation Term="Display.DisplayName" String="Project Visibility"/>
  </Property>
  <NavigationProperty Name="Areas" Type="Collection(Microsoft.VisualStudio.Services.Analytics.Model.Area)"/>
  <NavigationProperty Name="Iterations" Type="Collection(Microsoft.VisualStudio.Services.Analytics.Model.Iteration)"/>
  <NavigationProperty Name="Teams" Type="Collection(Microsoft.VisualStudio.Services.Analytics.Model.Team)"/>
</EntityType>

Anahtarlar

Keys Gezinti Özelliği olarak kullanılabilen Varlık özelliklerini tanımlayın.

<Key>
   <PropertyRef Name="ProjectSK"/>
</Key>

Özellikler

Sorgu için kullanılabilen 'Varlık özellikleri' kümesi. Ek açıklamalar, belirli bir özellik hakkındaki diğer ayrıntıları temsil eder.

Analytics'in son kullanıcılara görünür olması gereken tüm özelliklerine ile DisplayNameek açıklama eklenir.

<Property Name="ProjectSK" Nullable="false" Type="Edm.Guid"/>
<Property Name="ProjectId" Nullable="false" Type="Edm.Guid">
   <Annotation String="Project Id" Term="Display.DisplayName"/>
</Property>
<Property Name="ProjectName" Nullable="false" Type="Edm.String">
   <Annotation String="Project Name" Term="Display.DisplayName"/>
</Property>

ReferenceName, belirli bir özelliğin sistem tanımlayıcısını tanımlamak için kullanılan bir diğer yaygın ek açıklamadır.

<Property Name="State" Type="Edm.String">
   <Annotation String="State" Term="Display.DisplayName"/>
   <Annotation String="System.State" Term="Ref.ReferenceName"/>
</Property>

Gezinti özellikleri

Tek bir Varlığı sorgulamak yararlıdır. Sonunda, büyük olasılıkla başka bir Varlığın ayrıntılarını filtrelemek veya genişletmek isteyeceksiniz. Bunu yapmak için Varlık modelinin Gezinti Özelliklerini kullanmayı anlamanız gerekir.

NavigationaProperty Koleksiyon türüne sahip A, modelde çoka çok ilişkiyi temsil eder.

<NavigationProperty Name="Teams" Type="Collection(Microsoft.VisualStudio.Services.Analytics.Model.Team)"/>

ReferentialConstraints gezinti özelliklerini, modeldeki çoka bir ilişkiyi temsil eden bir varlığın belirli bir anahtarına bağlayın.

<NavigationProperty Name="Project" Type="Microsoft.VisualStudio.Services.Analytics.Model.Project">
   <ReferentialConstraint ReferencedProperty="ProjectSK" Property="ProjectSK"/>
</NavigationProperty>

Kapsayıcılar (OData özellikleri)

EntitySets

Varlıklar, veri modelindeki temel kimlik türleridir. Varlık kümeleri, varlık koleksiyonları olarak adlandırılır. Örneğin ve WorkItems adlandırılmış içindedir EntitySetsEntityContainer.ContainerWorkItemRevisions Bir varlık en fazla bir varlık kümesinin üyesi olabilir. Varlık kümeleri, veri modeline birincil giriş noktaları sağlar ve varlık koleksiyonunu ve ilişkili Gezinti özelliği bağlamalarını ve ek açıklamalarını temsil eder.

Aşağıdaki söz dizimi varlık kümesi veri modelini gösterir Projects . Her varlık kümesinin açıklaması için bkz. Analiz için veri modeli.

<EntitySet Name="Projects" EntityType="Microsoft.VisualStudio.Services.Analytics.Model.Project">
  <NavigationPropertyBinding Path="Areas" Target="Areas"/>
  <NavigationPropertyBinding Path="Iterations" Target="Iterations"/>
  <NavigationPropertyBinding Path="Teams" Target="Teams"/>
  <Annotation Term="Org.OData.Display.V1.DisplayName" String="Projects"/>
</EntitySet>

Özellikler

Özellikler, Analytics OData uç noktası tarafından anlaşılan işlev kümesini tanımlar.

<Annotation Term="Org.OData.Capabilities.V1.FilterFunctions">
   <Collection>
      <String>contains</String>
      <String>endswith</String>
      <String>startswith</String>
      <String>length</String>
      <String>indexof</String>
      <String>substring</String>
      <String>tolower</String>
      <String>toupper</String>
      <String>trim</String>
      <String>concat</String>
      <String>year</String>
      <String>month</String>
      <String>day</String>
      <String>hour</String>
      <String>minute</String>
      <String>second</String>
      <String>fractionalseconds</String>
      <String>round</String>
      <String>floor</String>
      <String>ceiling</String>
      <String>date</String>
      <String>time</String>
      <String>isof</String>
      <String>cast</String>
   </Collection>
</Annotation>

Toplamalar

Toplama ek açıklamaları, Analytics OData uç noktası tarafından anlaşılan dönüştürme kümesini tanımlar.

<Annotation Term="Org.OData.Aggregation.V1.ApplySupported">
   <Record>
      <PropertyValue Property="Transformations">
         <Collection>
            <String>aggregate</String>
            <String>filter</String>
            <String>groupby</String>
            <String>compute</String>
            <String>expand</String>
         </Collection>
      </PropertyValue>
      <PropertyValue Property="CustomAggregationMethods ">
         <Collection>
           <String>ax.ApproxCountDistinct</String>
           <String>ax.StandardDeviation</String>
           <String>ax.StandardDeviationP</String>
           <String>ax.Variance</String>
           <String>ax.VarianceP</String>
         </Collection>
      </PropertyValue>
   </Record>
</Annotation>

<Annotation Term="Org.OData.Capabilities.V1.BatchSupportType" Bool="true"/>
<Annotation Term="Org.OData.Capabilities.V1.BatchSupportType">
   <Record>
      <PropertyValue Property="Supported" Bool="true"/>
      <PropertyValue Property="ContinueOnErrorSupported" Bool="false"/>
      <PropertyValue Property="ReferencesInRequestBodiesSupported" Bool="false"/>
      <PropertyValue Property="ReferencesAcrossChangeSetsSupported" Bool="false"/>
      <PropertyValue Property="EtagReferencesSupported" Bool="false"/>
   </Record>
</Annotation>

Sonraki adımlar

Analiz için veri modeli

İlgili makaleler:

• Analiz için veri modeli
• Kuruluş ve proje kapsamlı sorgular.
• Analytics'ten edinilebilen veriler
• Analytics kullanarak iş izleme verilerini sorgulama
• Azure Boards için varlıklar ve özellikler başvurusu

İlgili kaynaklar

• Wiql-OData Market uzantısı
• OData Kuruluşu Temel Öğreticisi
• OData Sürüm 4.0. Bölüm 3: Common Schema Definition Language (CSDL) Plus Errata 03, Entity Model Wrapper