Add KBArticle index to metadata source

microsoft · Sep 27, 2019 · aed8770 · aed8770
1 parent 810c736
commit aed8770
Show file tree

Hide file tree

Showing 18 changed files with 418 additions and 85 deletions.
diff --git a/docs/api/Microsoft.UpdateServices.Metadata.Identity.html b/docs/api/Microsoft.UpdateServices.Metadata.Identity.html
@@ -92,6 +92,43 @@ <h5 id="Microsoft_UpdateServices_Metadata_Identity_syntax">Syntax</h5>
   <div class="codewrapper">
     <pre><code class="lang-csharp hljs">public class Identity : IComparable</code></pre>
   </div>
+  <h3 id="constructors">Constructors
+  </h3>
+
+
+  <a id="Microsoft_UpdateServices_Metadata_Identity__ctor_" data-uid="Microsoft.UpdateServices.Metadata.Identity.#ctor*"></a>
+  <h4 id="Microsoft_UpdateServices_Metadata_Identity__ctor_System_Guid_System_Int32_" data-uid="Microsoft.UpdateServices.Metadata.Identity.#ctor(System.Guid,System.Int32)">Identity(Guid, Int32)</h4>
+  <div class="markdown level1 summary"><p>Initialize an update identity from GUID and revision</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public Identity(Guid id, int revision)</code></pre>
+  </div>
+  <h5 class="parameters">Parameters</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Name</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><span class="xref">System.Guid</span></td>
+        <td><span class="parametername">id</span></td>
+        <td><p>Update GUID</p>
+</td>
+      </tr>
+      <tr>
+        <td><span class="xref">System.Int32</span></td>
+        <td><span class="parametername">revision</span></td>
+        <td><p>Update revision</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
   <h3 id="properties">Properties
   </h3>
 

diff --git a/docs/api/Microsoft.UpdateServices.Metadata.MetadataFilter.html b/docs/api/Microsoft.UpdateServices.Metadata.MetadataFilter.html
@@ -234,6 +234,32 @@ <h5 class="fieldValue">Field Value</h5>
   </table>
 
 
+  <h4 id="Microsoft_UpdateServices_Metadata_MetadataFilter_KbArticleFilter" data-uid="Microsoft.UpdateServices.Metadata.MetadataFilter.KbArticleFilter">KbArticleFilter</h4>
+  <div class="markdown level1 summary"><p>Get or set the KB article filter</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public List&lt;string&gt; KbArticleFilter</code></pre>
+  </div>
+  <h5 class="fieldValue">Field Value</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><span class="xref">System.Collections.Generic.List</span>&lt;<span class="xref">System.String</span>&gt;</td>
+        <td><p>List of KB article ids - numbers only</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
+
+
   <h4 id="Microsoft_UpdateServices_Metadata_MetadataFilter_ProductFilter" data-uid="Microsoft.UpdateServices.Metadata.MetadataFilter.ProductFilter">ProductFilter</h4>
   <div class="markdown level1 summary"><p>Get or set the Product filter.</p>
 </div>

diff --git a/docs/api/Microsoft.UpdateServices.Storage.CompressedMetadataStore.html b/docs/api/Microsoft.UpdateServices.Storage.CompressedMetadataStore.html
@@ -1058,6 +1058,50 @@ <h5 class="returns">Returns</h5>
   </table>
 
 
+  <a id="Microsoft_UpdateServices_Storage_CompressedMetadataStore_GetKbArticle_" data-uid="Microsoft.UpdateServices.Storage.CompressedMetadataStore.GetKbArticle*"></a>
+  <h4 id="Microsoft_UpdateServices_Storage_CompressedMetadataStore_GetKbArticle_Microsoft_UpdateServices_Metadata_Identity_" data-uid="Microsoft.UpdateServices.Storage.CompressedMetadataStore.GetKbArticle(Microsoft.UpdateServices.Metadata.Identity)">GetKbArticle(Identity)</h4>
+  <div class="markdown level1 summary"><p>Retrieves the KB article for a software update</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public string GetKbArticle(Identity updateIdentity)</code></pre>
+  </div>
+  <h5 class="parameters">Parameters</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Name</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><a class="xref" href="Microsoft.UpdateServices.Metadata.Identity.html">Identity</a></td>
+        <td><span class="parametername">updateIdentity</span></td>
+        <td><p>update identity</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
+  <h5 class="returns">Returns</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><span class="xref">System.String</span></td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
+
+
   <a id="Microsoft_UpdateServices_Storage_CompressedMetadataStore_GetLeafUpdates_" data-uid="Microsoft.UpdateServices.Storage.CompressedMetadataStore.GetLeafUpdates*"></a>
   <h4 id="Microsoft_UpdateServices_Storage_CompressedMetadataStore_GetLeafUpdates" data-uid="Microsoft.UpdateServices.Storage.CompressedMetadataStore.GetLeafUpdates">GetLeafUpdates()</h4>
   <div class="markdown level1 summary"><p>Gets updates that have prerequisites and no other update depends on them</p>

diff --git a/docs/api/Microsoft.UpdateServices.Storage.IMetadataSource.html b/docs/api/Microsoft.UpdateServices.Storage.IMetadataSource.html
@@ -803,6 +803,50 @@ <h5 class="returns">Returns</h5>
   </table>
 
 
+  <a id="Microsoft_UpdateServices_Storage_IMetadataSource_GetKbArticle_" data-uid="Microsoft.UpdateServices.Storage.IMetadataSource.GetKbArticle*"></a>
+  <h4 id="Microsoft_UpdateServices_Storage_IMetadataSource_GetKbArticle_Microsoft_UpdateServices_Metadata_Identity_" data-uid="Microsoft.UpdateServices.Storage.IMetadataSource.GetKbArticle(Microsoft.UpdateServices.Metadata.Identity)">GetKbArticle(Identity)</h4>
+  <div class="markdown level1 summary"><p>Retrieves the KB article for a software update</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">string GetKbArticle(Identity updateIdentity)</code></pre>
+  </div>
+  <h5 class="parameters">Parameters</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Name</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><a class="xref" href="Microsoft.UpdateServices.Metadata.Identity.html">Identity</a></td>
+        <td><span class="parametername">updateIdentity</span></td>
+        <td><p>update identity</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
+  <h5 class="returns">Returns</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><span class="xref">System.String</span></td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
+
+
   <a id="Microsoft_UpdateServices_Storage_IMetadataSource_GetLeafUpdates_" data-uid="Microsoft.UpdateServices.Storage.IMetadataSource.GetLeafUpdates*"></a>
   <h4 id="Microsoft_UpdateServices_Storage_IMetadataSource_GetLeafUpdates" data-uid="Microsoft.UpdateServices.Storage.IMetadataSource.GetLeafUpdates">GetLeafUpdates()</h4>
   <div class="markdown level1 summary"><p>Gets updates that have prerequisites and no other update depends on them</p>