Release v0.3.0

Author: brownemi

Documentation/APIReference.md

@@ -728,6 +728,14 @@ azure.identity.CredentialBuilderBase is a class.
 
 ```
 
+*azure.identity.ManagedIdentityCredentialBuilder.resourceId*
+
+```notalanguage
+  RESOURCEID Sets client id
+  An updated ManagedIdentityCredentialBuilder is returned.
+
+```
+
 
 #### azure.identity.ChainedTokenCredential
 
@@ -900,7 +908,7 @@ azure.identity.SharedTokenCacheCredential.restFlow is an undocumented builtin st
 
 ```notalanguage
   GETCLIENTID Gets the client ID of user assigned or system assigned identity
-  The accountName is returned as a character vector.
+  The client ID is returned as a character vector.
 
 ```
 
@@ -5749,7 +5757,7 @@ Logger.warning is a function.
   installation of the storage explorer in the configuration file.
  
   By default the MATLAB path will be searched for a configuration file called
-  settings.json, however an alternative filename can be provided as
+  storagesettings.json, however an alternative filename can be provided as
   an argument to this function.
 
 ```
@@ -5828,8 +5836,9 @@ Logger.warning is a function.
     clientSecret
     interactiveBrowser
     deviceCode
+    sharedTokenCache
+    managedIdentity
     azurecli
-    managedIdentityCredentialBuilder
  
   The resulting credential object can then be used by the corresponding client
   builder.
@@ -5945,7 +5954,9 @@ Logger.warning is a function.
   filename using 'ConfigurationFile'. It is also possible to provide
   'Credentials' or 'SASToken' and 'AccountName' as inputs to the function
   directly in case which no configuration file may be needed. See the Name,
-  Value pairs below for more details.
+  Value pairs below for more details. An endpoint can be set if required
+  e.g. if it does not conform to the default https://<AccountName>.<TYPE>.core.windows.net
+  pattern, see below for EndPoint details.
  
   Additional Name, Value pairs can be supplied to configure non-default
   options:
@@ -5997,10 +6008,19 @@ Logger.warning is a function.
         building the client. 
     
     'AccountName', explicitly specify the AccountName used to configure the
-        endpoint for the client. If not specified createStorageClient uses
-        loadConfigurationSettings to load configuration options from 
-        'ConfigurationFile'. This file must then contain a "AccountName" 
-        setting.
+        account and potentially the endpoint for the client.
+        If not specified createStorageClient uses loadConfigurationSettings
+        to load configuration options from 'ConfigurationFile'.
+        This file must then contain a "AccountName" setting.
+ 
+    'EndPoint', enables endpoint naming patterns other than:
+        https://<AccountName>.<TYPE>.core.windows.net
+        by explicitly specify the EndPoint used to configure the client.
+        If 'EndPoint' is not specified as an argument and an 'AccountName' is
+        provided then the 'AccountName' will be used to create a default endpoint.
+        If neither an 'EndPoint' or 'AccountName' argument is provided the
+        corresponding configuration file fields will be used with priority given
+        to "EndPoint".
  
     See also CONFIGURECREDENTIALS, LOADCONFIGURATIONSETTINGS
 
@@ -6033,7 +6053,7 @@ Logger.warning is a function.
 
     Other uses of initialize
 
-       matlab.internal.cef.webwindow/initialize
+       dlnetwork/initialize
        matlab.net.http.io.ContentConsumer/initialize
        matlab.net.http.io.ImageConsumer/initialize
        matlab.net.http.io.JSONConsumer/initialize
@@ -6047,11 +6067,11 @@ Logger.warning is a function.
 ##### loadConfigurationSettings
 
 ```notalanguage
-  LOADCONFIGURATIONSETTINGS Method to read configuration settings from a file
-  By default the file is named settings.json or an alternative name can be
-  as an specified argument. JSON values must be compatible with MATLAB JSON
-  conversion rules. See jsondecode() help for details. A MATLAB struct is
-  returned.
+  LOADCONFIGURATIONSETTINGS Method to read a JSON configuration settings from a file
+  The file name must be as a specified argument.
+  JSON values must be compatible with MATLAB JSON conversion rules.
+  See jsondecode() help for details. A MATLAB struct is returned.
+  Field names are case sensitive.
 
 ```
 

Documentation/Authentication.md

@@ -38,15 +38,15 @@ files.
 
 The following authentication approaches are supported:
 
-1.  [Azure CLI](#azure-cli)
-2.  [Managed Identity](#managed-identity)
-3.  [Client Secret](#client-secret)
-4.  [Environment Variable](#environment-variable)
-5.  [Shared Token Cache](#shared-token-cache)
-6.  [Interactive Browser](#interactive-browser)
-7.  [Device Code](#device-code)
-8.  [Default Azure](#default-azure)
-9.  [Storage Shared Key](#storage-shared-key)
+1. [Azure CLI](#azure-cli)
+2. [Managed Identity](#managed-identity)
+3. [Client Secret](#client-secret)
+4. [Environment Variable](#environment-variable)
+5. [Shared Token Cache](#shared-token-cache)
+6. [Interactive Browser](#interactive-browser)
+7. [Device Code](#device-code)
+8. [Default Azure](#default-azure)
+9. [Storage Shared Key](#storage-shared-key)
 10. [Connection String](#connection-string)
 11. [Chained Token](#chained-token)
 
@@ -81,15 +81,24 @@ effect derive its credentials by virtue of the machine hosting it in Azure.
 
 ```json
 {
-    "AuthMethod": "ManagedIdentity"
+    "AuthMethod": "ManagedIdentity",
+    "ClientId" : "811<REDACTED>8ee",
 }
 ```
 
+In the case of a system assigned managed identity the Azure portal refers to the
+ClientId value as the "Application ID". In the case of a user assigned managed
+identity the ClientId value is referred to as a "Client ID" in the Azure portal.
+
+An identity's Resource ID can be provided as an alternative to the Client ID.
+Both should not be provided. The corresponding configuration file setting field
+is ResourceId.
+
 ## Client Secret
 
 A Client Secret credential is an Azure AD credential that acquires a token with
 a client secret. The secret can be provided in the form as a string specified as
-```ClientSecret``` or can be a certificate referred to by ```pemCertificate```.
+```ClientSecret``` or can be a certificate referred to by ```PemCertificate```.
 
 ### Client Secret ```myServiceSpecificSettings.json```
 
@@ -99,7 +108,7 @@ a client secret. The secret can be provided in the form as a string specified as
     "TenantId" : "99d<REDACTED>1e6",
     "ClientId" : "811<REDACTED>8ee",
     "ClientSecret": "i6Q<REDACTED>p72", //Either 
-    "pemCertificate": "c:/path/to/clientCert.pem", //Or
+    "PemCertificate": "c:/path/to/clientCert.pem", //Or
     "AuthorityHost": "https://myauthority.com/" //Optional
 }
 ```
@@ -119,6 +128,7 @@ Environment Variable credentials can often be used in CI/CD based processes.
 Additional note the support for a certificate file path.
 
 ### Environment Variable ```myServiceSpecificSettings.json```
+
 ```json
 {
     "AuthMethod": "Environment",
@@ -169,7 +179,7 @@ authenticate to must have delegated user login permissions and
 have```http://localhost:port``` listed as a valid Redirect URI for the Azure
 App.
 
-### TokenCachePersistenceOptions
+### TokenCachePersistenceOptions (Interactive Browser)
 
 Interactive Browser can optionally be configured with
 `TokenCachePersistenceOptions`. When these are configured,
@@ -270,7 +280,7 @@ function myExampleCallbackFunction(deviceCodeInfo)
     web(deviceCodeInfo.getVerificationUrl);
 ```
 
-### TokenCachePersistenceOptions
+### TokenCachePersistenceOptions (Device Code)
 
 Device Code can optionally be configured with `TokenCachePersistenceOptions`.
 When these are configured, `configureCredentials` will actually build and return
@@ -292,6 +302,7 @@ internal workflow is as follows then:
    `DeviceCodeCredential`.
 
 ### Device Code ```myServiceSpecificSettings.json```
+
 ```json
 {
     "AuthMethod": "DeviceCode",
@@ -327,6 +338,7 @@ AuthorityHost are optional fields depending on which means of authentication is
 expected to be used.
 
 ### Default Azure ```myServiceSpecificSettings.json```
+
 ```json
 {
     "AuthMethod": "DefaultAzure",
@@ -441,4 +453,4 @@ credentials by passing a specific path e.g.:
 clientSecretCredentials = configureCredentials(fullfile(AzureCommonRoot, 'config', 'settings_ClientSecret.json'));
 ```
 
-[//]: #  (Copyright 2020-2022 The MathWorks, Inc.)
+[//]: #  (Copyright 2020-2023 The MathWorks, Inc.)

Documentation/Blob.md

@@ -59,8 +59,7 @@ builder = azure.storage.blob.BlobServiceClientBuilder();
 
 % configureCredentials is a convenience method that simplifies creating a credentials
 % argument for the client's builder. In this case a Connection String is used to
-% authenticate. Other authentication methods may required different build steps,
-% e.g. setting an endpoint
+% authenticate. Other authentication methods may required different build steps.
 credentials = configureCredentials(fullfile(AzureCommonRoot, 'config', 'settings_ConnectionString.json'));
 builder = builder.connectionString(credentials);
 
@@ -251,6 +250,7 @@ results = containerClient.listBlobs;
 % Display the name of the 1st blob assuming the container is not empty
 results(1).getName()
 ```
+
 See also [Advanced listing support](#advanced-listing-support) below.
 
 #### Create a BlobClient
@@ -459,7 +459,7 @@ blobClient.uploadFromFile('myfile.txt','overwrite',true,'leaseId',leaseId);
 blobClient.deleteBlob('leaseId',leaseId);
 ```
 
-### Advanced listing support
+## Advanced listing support
 
 A basic listing of a container's contents can be done as follows:
 
@@ -603,7 +603,12 @@ ans =
     {'barMetadataVal'}
 ```
 
-
 For more information, see [https://azuresdkdocs.blob.core.windows.net/$web/java/azure-storage-blob/12.21.0/com/azure/storage/blob/BlobContainerClient.html#listBlobs()](https://azuresdkdocs.blob.core.windows.net/$web/java/azure-storage-blob/12.21.0/com/azure/storage/blob/BlobContainerClient.html#listBlobs())
 
+## Custom EndPoints
+
+Typically and by default Azure storage endpoints follow the pattern: `https://AccountName.Type.core.windows.net`, e.g. `https://mystorageaccount.blob.core.windows.net`. However, endpoints may vary e.g. if using Azure Government or private endpoints, which are respectively `https://AccountName.Type.core.usgovcloudapi.net` and `https://AccountName.privatelink.Type.core.windows.net`. If configuring a client builder then the `endpoint()` method can be used to set such an endpoint directly. By default if using the `createStorageClient()` function it will use the account name and storage type to create a default endpoint. This can be overridden by passing an `EndPoint` named value argument pair or by setting and "EndPoint" field in the JSON configuration file used to provide settings and credentials.
+
+For details of private endpoint use see: [https://learn.microsoft.com/en-us/azure/storage/common/storage-private-endpoints](https://learn.microsoft.com/en-us/azure/storage/common/storage-private-endpoints)
+
 [//]: #  (Copyright 2020-2023 The MathWorks, Inc.)

Documentation/Configuration.md

@@ -25,7 +25,7 @@ An example `mysettings.json` file could look something like the following:
 And then in MATLAB this could be used as:
 
 ```matlab
-settings = loadConfigurationSettings('settings.json');
+settings = loadConfigurationSettings('mysettings.json');
 homePage = webread(settings.myURL);
 ```
 
@@ -51,4 +51,4 @@ configuration file name if needed:
 * [Key Vault](KeyVault.md)
 * [Data Lake Storage Gen2](DataLakeStorageGen2.md)
 
-[//]: #  (Copyright 2022 The MathWorks, Inc.)
+[//]: #  (Copyright 2022-2023 The MathWorks, Inc.)

RELEASENOTES.md

@@ -2,11 +2,20 @@
 
 ## Release Notes
 
+## Release 0.3.0 March 27th 2023
+
+* Added EndPoint setting support
+* Documentation updates
+* Added Managed Identity Resource ID support
+* Increase Azure SDK bom version to 1.2.11
+* Standardized ClientId settings field name
+* Standardized PemCertificate settings field name
+
 ## Release 0.2.0 March 13th 2023
 
 * Added additional blob listing support
 * Increase Azure SDK bom version to 1.2.10
-* Documentation update
+* Documentation updates
 
 ## Release 0.1.1 September 7th 2022
 

Software/Java/pom.xml

@@ -22,7 +22,7 @@
         <dependency>
           <groupId>com.azure</groupId>
           <artifactId>azure-sdk-bom</artifactId>
-          <version>1.2.10</version>
+          <version>1.2.11</version>
           <type>pom</type>
           <scope>import</scope>
         </dependency>

Software/MATLAB/app/functions/AzureStorageExplorer.m

@@ -4,10 +4,10 @@ function AzureStorageExplorer(varargin)
 % installation of the storage explorer in the configuration file.
 %
 % By default the MATLAB path will be searched for a configuration file called
-% settings.json, however an alternative filename can be provided as
+% storagesettings.json, however an alternative filename can be provided as
 % an argument to this function.
 
-% Copyright 2020-2022 The MathWorks, Inc.
+% Copyright 2020-2023 The MathWorks, Inc.
 
 % Create a logger object
 logObj = Logger.getLogger();
@@ -18,7 +18,7 @@ function AzureStorageExplorer(varargin)
 end
 
 if isempty(varargin)
-    configFile = which('settings.json');
+    configFile = which('storagesettings.json');
 else
     configFile = varargin{1};
 end
@@ -39,8 +39,8 @@ function AzureStorageExplorer(varargin)
             write(logObj,'error',['Storage explorer not found at path: ', sePath]);
         end
     else
-        write(logObj,'error','LocalPathToStorageExplorer not set in settings.json');
+        write(logObj,'error','LocalPathToStorageExplorer not set in storagesettings.json');
     end
 else
-    write(logObj,'error','settings.json with Storage Explorer path not found');
+    write(logObj,'error','storagesettings.json with Storage Explorer path not found');
 end %function