Skip to content

Commit 56b22be

Browse files
Michael BrowneMichael Browne
Michael Browne
authored and
Michael Browne
committed
v1.0.2 updates
1 parent c6d1ee9 commit 56b22be

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+4301
-4072
lines changed

Documentation/html/ADXAuthentication.html

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE html>
22
<html class="writer-html5" lang="en" >
33
<head>
4-
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
4+
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
77
<title>Authentication &mdash; MATLAB Interface for Azure Services documentation</title>
@@ -12,10 +12,11 @@
1212
<script src="_static/js/html5shiv.min.js"></script>
1313
<![endif]-->
1414

15-
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
1615
<script src="_static/jquery.js"></script>
17-
<script src="_static/underscore.js"></script>
16+
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
17+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
1818
<script src="_static/doctools.js"></script>
19+
<script src="_static/sphinx_highlight.js"></script>
1920
<script src="_static/js/theme.js"></script>
2021
<link rel="index" title="Index" href="genindex.html" />
2122
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +29,15 @@
2829
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
2930
<div class="wy-side-scroll">
3031
<div class="wy-side-nav-search" >
31-
<a href="index.html" class="icon icon-home"> MATLAB Interface for Azure Services
32+
33+
34+
35+
<a href="index.html" class="icon icon-home">
36+
MATLAB Interface for Azure Services
3237
</a>
3338
<div role="search">
3439
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
35-
<input type="text" name="q" placeholder="Search docs" />
40+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
3641
<input type="hidden" name="check_keywords" value="yes" />
3742
<input type="hidden" name="area" value="default" />
3843
</form>
@@ -96,8 +101,8 @@
96101
<div class="rst-content">
97102
<div role="navigation" aria-label="Page navigation">
98103
<ul class="wy-breadcrumbs">
99-
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
100-
<li>Authentication</li>
104+
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
105+
<li class="breadcrumb-item active">Authentication</li>
101106
<li class="wy-breadcrumbs-aside">
102107
<a href="https://github.com/mathworks-ref-arch/matlab-azure-services/blob/main/Documentation/ADXAuthentication.md" class="fa fa-github"> Edit on GitHub</a>
103108
</li>
@@ -108,20 +113,20 @@
108113
<div itemprop="articleBody">
109114

110115
<section id="authentication">
111-
<h1>Authentication<a class="headerlink" href="#authentication" title="Permalink to this headline"></a></h1>
116+
<h1>Authentication<a class="headerlink" href="#authentication" title="Permalink to this heading"></a></h1>
112117
<p>To create a settings file interactively use: <code class="docutils literal notranslate"><span class="pre">mathworks.internal.adx.buildSettingsFile</span></code>.</p>
113118
<p>Template JSON configuration files for various authentication approaches can be
114119
found in <code class="docutils literal notranslate"><span class="pre">matlab-azure-adx/Software/MATLAB/config</span></code></p>
115120
<p>In general for initial testing Client Secret based authentication is the simplest
116121
to configure an work with. To use other approaches it is recommended to contact
117122
MathWorks®: <a class="reference external" href="mailto:mwlab&#37;&#52;&#48;mathworks&#46;com">mwlab<span>&#64;</span>mathworks<span>&#46;</span>com</a>.</p>
118123
<p>Certain authentication methods require the additional use of the Azure Java SDK
119-
authentication support as documented in <a class="reference internal" href="Authentication.html"><span class="doc std std-doc">Authentication.md</span></a>.</p>
120-
<table class="colwidths-auto docutils align-default">
124+
authentication support as documented in <a class="reference internal" href="Authentication.html"><span class="std std-doc">Authentication.md</span></a>.</p>
125+
<table class="docutils align-default">
121126
<thead>
122-
<tr class="row-odd"><th class="text-left head"><p>Authentication Method</p></th>
123-
<th class="text-left head"><p>JSON file field value</p></th>
124-
<th class="text-center head"><p>Java SDK support required</p></th>
127+
<tr class="row-odd"><th class="head text-left"><p>Authentication Method</p></th>
128+
<th class="head text-left"><p>JSON file field value</p></th>
129+
<th class="head text-center"><p>Java SDK support required</p></th>
125130
</tr>
126131
</thead>
127132
<tbody>
@@ -145,7 +150,7 @@ <h1>Authentication<a class="headerlink" href="#authentication" title="Permalink
145150
</table>
146151
<p>If you wish to use an Azure authentication method that is not listed please contact MathWorks at: <a class="reference external" href="mailto:mwlab&#37;&#52;&#48;mathworks&#46;com">mwlab<span>&#64;</span>mathworks<span>&#46;</span>com</a>.</p>
147152
<section id="settings-file-fields">
148-
<h2>Settings file fields<a class="headerlink" href="#settings-file-fields" title="Permalink to this headline"></a></h2>
153+
<h2>Settings file fields<a class="headerlink" href="#settings-file-fields" title="Permalink to this heading"></a></h2>
149154
<p>The default settings file is: <code class="docutils literal notranslate"><span class="pre">matlab-azure-adx/Software/MATLAB/config/adx.Client.Settings.json</span></code>
150155
Alternative names and paths can be used if required.
151156
Depending on the authentication method used different fields are required. The
@@ -164,10 +169,10 @@ <h2>Settings file fields<a class="headerlink" href="#settings-file-fields" title
164169
</div>
165170
<p>In use the fields <code class="docutils literal notranslate"><span class="pre">controlBearerToken</span></code> and <code class="docutils literal notranslate"><span class="pre">dataBearerToken</span></code> will be added to the file
166171
to cache the short lived bearer token values the control and data planes. These values are sensitive and should not be exposed.</p>
167-
<table class="colwidths-auto docutils align-default">
172+
<table class="docutils align-default">
168173
<thead>
169-
<tr class="row-odd"><th class="text-left head"><p>Field name</p></th>
170-
<th class="text-left head"><p>Description</p></th>
174+
<tr class="row-odd"><th class="head text-left"><p>Field name</p></th>
175+
<th class="head text-left"><p>Description</p></th>
171176
</tr>
172177
</thead>
173178
<tbody>
@@ -199,30 +204,30 @@ <h2>Settings file fields<a class="headerlink" href="#settings-file-fields" title
199204
</table>
200205
</section>
201206
<section id="client-secret">
202-
<h2>Client Secret<a class="headerlink" href="#client-secret" title="Permalink to this headline"></a></h2>
207+
<h2>Client Secret<a class="headerlink" href="#client-secret" title="Permalink to this heading"></a></h2>
203208
<p>Client Secret authentication is sometimes referred to as “Application Secret” as the
204209
secrets created apply to Application Registrations. This package uses the term “Client
205210
Secret or <code class="docutils literal notranslate"><span class="pre">clientSecret</span></code>as appropriate.</p>
206211
<p>Client secret does not use the “Secret ID” value and it should not be confused with the
207212
Client ID (sometimes called the App ID) or the Client Secret itself.</p>
208213
</section>
209214
<section id="baseclient-extension">
210-
<h2>BaseClient extension<a class="headerlink" href="#baseclient-extension" title="Permalink to this headline"></a></h2>
215+
<h2>BaseClient extension<a class="headerlink" href="#baseclient-extension" title="Permalink to this heading"></a></h2>
211216
<p>The file <code class="docutils literal notranslate"><span class="pre">matlab-azure-adx/Software/MATLAB/app/system/+adx/+control/BaseClient.m</span></code>
212217
implements the base client for the interface’s API call classes.
213218
In this file there are well commented hook points to which custom authentication
214219
code can be integrated if required. This topic should be discussed with MathWorks
215220
to clarify is custom code is necessary.</p>
216221
</section>
217222
<section id="bearer-tokens">
218-
<h2>Bearer Tokens<a class="headerlink" href="#bearer-tokens" title="Permalink to this headline"></a></h2>
223+
<h2>Bearer Tokens<a class="headerlink" href="#bearer-tokens" title="Permalink to this heading"></a></h2>
219224
<p>The lower-level <code class="docutils literal notranslate"><span class="pre">+api</span></code> classes and some higher-level functions accept an optional
220225
argument <code class="docutils literal notranslate"><span class="pre">bearerToken</span></code> directly if the authentication process to obtain the token
221226
is handled by some external means. Note that the KQL queries and management commands
222227
will require different tokens as they use different endpoints.</p>
223228
</section>
224229
<section id="references">
225-
<h2>References<a class="headerlink" href="#references" title="Permalink to this headline"></a></h2>
230+
<h2>References<a class="headerlink" href="#references" title="Permalink to this heading"></a></h2>
226231
<ul class="simple">
227232
<li><p>Azure Services authentication <a class="reference external" href="https://github.com/mathworks-ref-arch/matlab-azure-services/blob/main/Documentation/Authentication.md">https://github.com/mathworks-ref-arch/matlab-azure-services/blob/main/Documentation/Authentication.md</a></p></li>
228233
</ul>

0 commit comments

Comments
 (0)