Implement authentication with custom credentials. Persist credentials…

… for a local repository
microsoft · Jul 23, 2019 · e6f5d5b · e6f5d5b
1 parent c197c01
commit e6f5d5b
Show file tree

Hide file tree

Showing 18 changed files with 401 additions and 653 deletions.
diff --git a/docfx/webservices.filter.yaml b/docfx/webservices.filter.yaml
@@ -8,6 +8,10 @@ apiRules:
     uidRegex: ^Microsoft\.UpdateServices\.WebServices\.ServerSync$
     type: Namespace
 
+- exclude:
+    uidRegex: ^Microsoft\.AspNetCore\.Mvc$
+    type: Namespace
+
 - exclude:
     uidRegex: ^System\.Object
     type: Type

diff --git a/docs/api/Microsoft.UpdateServices.Client.ClientAuthenticator.html b/docs/api/Microsoft.UpdateServices.Client.ClientAuthenticator.html
@@ -137,6 +137,48 @@ <h5 class="parameters">Parameters</h5>
       </tr>
     </tbody>
   </table>
+
+
+  <a id="Microsoft_UpdateServices_Client_ClientAuthenticator__ctor_" data-uid="Microsoft.UpdateServices.Client.ClientAuthenticator.#ctor*"></a>
+  <h4 id="Microsoft_UpdateServices_Client_ClientAuthenticator__ctor_Microsoft_UpdateServices_Client_Endpoint_System_String_System_Guid_" data-uid="Microsoft.UpdateServices.Client.ClientAuthenticator.#ctor(Microsoft.UpdateServices.Client.Endpoint,System.String,System.Guid)">ClientAuthenticator(Endpoint, String, Guid)</h4>
+  <div class="markdown level1 summary"><p>Initializes a new instance of the ClientAuthenticator class to authenticate with the specified endpoint, using
+specified credentials.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public ClientAuthenticator(Endpoint endpoint, string accountName, Guid accountGuid)</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.Client.Endpoint.html">Endpoint</a></td>
+        <td><span class="parametername">endpoint</span></td>
+        <td><p>The endpoint to authenticate with.</p>
+</td>
+      </tr>
+      <tr>
+        <td><span class="xref">System.String</span></td>
+        <td><span class="parametername">accountName</span></td>
+        <td><p>Account name.</p>
+</td>
+      </tr>
+      <tr>
+        <td><span class="xref">System.Guid</span></td>
+        <td><span class="parametername">accountGuid</span></td>
+        <td><p>Account GUID.</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
   <h3 id="fields">Fields
   </h3>
 

diff --git a/docs/api/Microsoft.UpdateServices.Client.UpstreamServerClient.html b/docs/api/Microsoft.UpdateServices.Client.UpstreamServerClient.html
@@ -123,7 +123,7 @@ <h5 class="parameters">Parameters</h5>
     </tbody>
   </table>
   <h5 id="Microsoft_UpdateServices_Client_UpstreamServerClient__ctor_Microsoft_UpdateServices_Client_Endpoint__remarks">Remarks</h5>
-  <div class="markdown level1 remarks"><p>Thsi constructor is not recommended for performance reasons. It is recommended to use the constructor that takes a local repository.
+  <div class="markdown level1 remarks"><p>This constructor is not recommended for performance reasons. It is recommended to use the constructor that takes a local repository.
 Queries take a significant amount of time, and using a local repository enables delta queries, where only changes on the upstream server are retrieved.</p>
 </div>
 

diff --git a/docs/api/Microsoft.UpdateServices.Server.ContentController.html b/docs/api/Microsoft.UpdateServices.Server.ContentController.html
diff --git a/docs/api/Microsoft.UpdateServices.Storage.FileSystemRepository.html b/docs/api/Microsoft.UpdateServices.Storage.FileSystemRepository.html
@@ -874,6 +874,41 @@ <h5 class="returns">Returns</h5>
       </tr>
     </tbody>
   </table>
+
+
+  <a id="Microsoft_UpdateServices_Storage_FileSystemRepository_SetRemoteEndpointCredentials_" data-uid="Microsoft.UpdateServices.Storage.FileSystemRepository.SetRemoteEndpointCredentials*"></a>
+  <h4 id="Microsoft_UpdateServices_Storage_FileSystemRepository_SetRemoteEndpointCredentials_System_String_System_Guid_" data-uid="Microsoft.UpdateServices.Storage.FileSystemRepository.SetRemoteEndpointCredentials(System.String,System.Guid)">SetRemoteEndpointCredentials(String, Guid)</h4>
+  <div class="markdown level1 summary"><p>Set the account name and account GUID for authenticating with the remote endpoint</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public void SetRemoteEndpointCredentials(string accountName, Guid accountGuid)</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.String</span></td>
+        <td><span class="parametername">accountName</span></td>
+        <td><p>Account name</p>
+</td>
+      </tr>
+      <tr>
+        <td><span class="xref">System.Guid</span></td>
+        <td><span class="parametername">accountGuid</span></td>
+        <td><p>Account GUID</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
   <h3 id="events">Events
   </h3>
 

diff --git a/docs/api/Microsoft.UpdateServices.Storage.RepoConfiguration.html b/docs/api/Microsoft.UpdateServices.Storage.RepoConfiguration.html
@@ -91,6 +91,60 @@ <h3 id="properties">Properties
   </h3>
 
 
+  <a id="Microsoft_UpdateServices_Storage_RepoConfiguration_AccountGuid_" data-uid="Microsoft.UpdateServices.Storage.RepoConfiguration.AccountGuid*"></a>
+  <h4 id="Microsoft_UpdateServices_Storage_RepoConfiguration_AccountGuid" data-uid="Microsoft.UpdateServices.Storage.RepoConfiguration.AccountGuid">AccountGuid</h4>
+  <div class="markdown level1 summary"><p>The account GUID used when authenticating with the upstream server</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">[JsonProperty]
+public Guid? AccountGuid { get; set; }</code></pre>
+  </div>
+  <h5 class="propertyValue">Property 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.Nullable</span>&lt;<span class="xref">System.Guid</span>&gt;</td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
+
+
+  <a id="Microsoft_UpdateServices_Storage_RepoConfiguration_AccountName_" data-uid="Microsoft.UpdateServices.Storage.RepoConfiguration.AccountName*"></a>
+  <h4 id="Microsoft_UpdateServices_Storage_RepoConfiguration_AccountName" data-uid="Microsoft.UpdateServices.Storage.RepoConfiguration.AccountName">AccountName</h4>
+  <div class="markdown level1 summary"><p>The account name used when authenticating with the upstream server</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">[JsonProperty]
+public string AccountName { get; set; }</code></pre>
+  </div>
+  <h5 class="propertyValue">Property 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.String</span></td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
+
+
   <a id="Microsoft_UpdateServices_Storage_RepoConfiguration_UpstreamServerEndpoint_" data-uid="Microsoft.UpdateServices.Storage.RepoConfiguration.UpstreamServerEndpoint*"></a>
   <h4 id="Microsoft_UpdateServices_Storage_RepoConfiguration_UpstreamServerEndpoint" data-uid="Microsoft.UpdateServices.Storage.RepoConfiguration.UpstreamServerEndpoint">UpstreamServerEndpoint</h4>
   <div class="markdown level1 summary"><p>The address of the upstream server from which this repository was cloned</p>