MATLAB Interface for Azure Services - API Reference

Classes, methods and functions that include the terms private or internal in their namespace should not be used directly. They are subject to change or removal without notice. The majority of adx.control APIs are generated using OpenAPI. see: OpenAPI.md

Index

MATLAB Interface for Azure Services

Help

adx

adx.control

adx.control.api

adx.control.api.AttachedDatabaseConfigurations

Superclass: adx.control.BaseClient

AttachedDatabaseConfigurations No description provided
 
  AttachedDatabaseConfigurations Properties:
 
    serverUri           - Base URI to use when calling the API. Allows using a different server
                          than specified in the original API spec.
    httpOptions         - HTTPOptions used by all requests.
    preferredAuthMethod - If operation supports multiple authentication methods, specified which
                          method to prefer.
    bearerToken         - If Bearer token authentication is used, the token can be supplied 
                          here. Note the token is only used if operations are called for which
                          the API explicitly specified that Bearer authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require Bearer authentication, consider adding the relevant header to
                          all requests in the preSend method.
    apiKey              - If API key authentication is used, the key can be supplied here. 
                          Note the key is only used if operations are called for which
                          the API explicitly specified that API key authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require API key authentication, consider adding the API key to all
                          requests in the preSend method.
    httpCredentials     - If Basic or Digest authentication is supported username/password
                          credentials can be supplied here as matlab.net.http.Credentials. Note 
                          these are only actively used if operations are called for which the 
                          API spec has specified they require Basic authentication. If this has
                          not been specified in the spec but most operations do require
                          Basic authentication, consider setting the Credentials property in the
                          httpOptions rather than through httpCredentials.
    cookies             - Cookie jar. The cookie jar is shared across all Api classes in the 
                          same package. All responses are automatically parsed for Set-Cookie
                          headers and cookies are automatically added to the jar. Similarly
                          cookies are added to outgoing requests if there are matching cookies 
                          in the jar for the given request. Cookies can also be added manually
                          by calling the setCookies method on the cookies property. The cookie
                          jar is also saved to disk (cookies.mat in the same directory as 
                          BaseClient) and reloaded in new MATLAB sessions.
 
  AttachedDatabaseConfigurations Methods:
 
    AttachedDatabaseConfigurations - Constructor
    attachedDatabaseConfigurationsCheckNameAvailability - 
    attachedDatabaseConfigurationsCreateOrUpdate - 
    attachedDatabaseConfigurationsDelete - 
    attachedDatabaseConfigurationsGet - 
    attachedDatabaseConfigurationsListByCluster - 
 
  See Also: matlab.net.http.HTTPOptions, matlab.net.http.Credentials, 
    CookieJar.setCookies, control.BaseClient

adx.control.api.AttachedDatabaseConfigurations.AttachedDatabaseConfigurations

AttachedDatabaseConfigurations Constructor, creates a AttachedDatabaseConfigurations instance.
  When called without inputs, tries to load configuration
  options from JSON file 'adx.Client.Settings.json'.
  If this file is not present, the instance is initialized with 
  default configuration option. An alternative configuration 
  file can be provided through the "configFile" Name-Value pair.
  All other properties of the instance can also be overridden 
  using Name-Value pairs where Name equals the property name.
  
  Examples:
 
    % Create a client with default options and serverUri
    % as parsed from OpenAPI spec (if available)
    client = adx.control.api.AttachedDatabaseConfigurations();
 
    % Create a client for alternative server/base URI
    client = adx.control.api.AttachedDatabaseConfigurations("serverUri","https://example.com:1234/api/");
 
    % Create a client loading configuration options from 
    % JSON configuration file
    client = adx.control.api.AttachedDatabaseConfigurations("configFile","myconfig.json");
 
    % Create a client with alternative HTTPOptions and an API key
    client = adx.control.api.AttachedDatabaseConfigurations("httpOptions",...
        matlab.net.http.HTTPOptions("ConnectTimeout",42),...
        "apiKey", "ABC123");

adx.control.api.AttachedDatabaseConfigurations.attachedDatabaseConfigurationsCheckNameAvailability

attachedDatabaseConfigurationsCheckNameAvailability No summary provided
  Checks that the attached database configuration resource name is valid and is not already in use.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    AttachedDatabaseConfigurationsCheckNameRequest - The name of the resource., Type: AttachedDatabaseConfigurationsCheckNameRequest
        Required properties in the model for this call:
            name
            type
        Optional properties in the model for this call:
 
  No optional parameters
 
  Responses:
    200: OK -- Operation to check the kusto resource name availability was successful.
    0: Error response describing why the operation failed.
 
  Returns: CheckNameResult
 
  See Also: adx.control.models.CheckNameResult

adx.control.api.AttachedDatabaseConfigurations.attachedDatabaseConfigurationsCreateOrUpdate

attachedDatabaseConfigurationsCreateOrUpdate No summary provided
  Creates or updates an attached database configuration.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    attachedDatabaseConfigurationName - The name of the attached database configuration., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
    AttachedDatabaseConfiguration - The database parameters supplied to the CreateOrUpdate operation., Type: AttachedDatabaseConfiguration
        Required properties in the model for this call:
        Optional properties in the model for this call:
            location
            xproperties
 
  No optional parameters
 
  Responses:
    200: Successfully updated the database.
    201: Successfully created the database.
    202: Accepted the create database request.
    0: Error response describing why the operation failed.
 
  Returns: AttachedDatabaseConfiguration
 
  See Also: adx.control.models.AttachedDatabaseConfiguration

adx.control.api.AttachedDatabaseConfigurations.attachedDatabaseConfigurationsDelete

attachedDatabaseConfigurationsDelete No summary provided
  Deletes the attached database configuration with the given name.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    attachedDatabaseConfigurationName - The name of the attached database configuration., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully deleted the database.
    202: Accepted.
    204: The specified database does not exist.
    0: Error response describing why the operation failed.
 
  Returns: 
 
  See Also: adx.control.models.

adx.control.api.AttachedDatabaseConfigurations.attachedDatabaseConfigurationsGet

attachedDatabaseConfigurationsGet No summary provided
  Returns an attached database configuration.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    attachedDatabaseConfigurationName - The name of the attached database configuration., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully retrieved the specified attached database configuration.
    0: Error response describing why the operation failed.
 
  Returns: AttachedDatabaseConfiguration
 
  See Also: adx.control.models.AttachedDatabaseConfiguration

adx.control.api.AttachedDatabaseConfigurations.attachedDatabaseConfigurationsListByCluster

attachedDatabaseConfigurationsListByCluster No summary provided
  Returns the list of attached database configurations of the given Kusto cluster.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully retrieved the list of attached database configurations.
    0: Error response describing why the operation failed.
 
  Returns: AttachedDatabaseConfigurationListResult
 
  See Also: adx.control.models.AttachedDatabaseConfigurationListResult

adx.control.api.ClusterPrincipalAssignments

Superclass: adx.control.BaseClient

ClusterPrincipalAssignments No description provided
 
  ClusterPrincipalAssignments Properties:
 
    serverUri           - Base URI to use when calling the API. Allows using a different server
                          than specified in the original API spec.
    httpOptions         - HTTPOptions used by all requests.
    preferredAuthMethod - If operation supports multiple authentication methods, specified which
                          method to prefer.
    bearerToken         - If Bearer token authentication is used, the token can be supplied 
                          here. Note the token is only used if operations are called for which
                          the API explicitly specified that Bearer authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require Bearer authentication, consider adding the relevant header to
                          all requests in the preSend method.
    apiKey              - If API key authentication is used, the key can be supplied here. 
                          Note the key is only used if operations are called for which
                          the API explicitly specified that API key authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require API key authentication, consider adding the API key to all
                          requests in the preSend method.
    httpCredentials     - If Basic or Digest authentication is supported username/password
                          credentials can be supplied here as matlab.net.http.Credentials. Note 
                          these are only actively used if operations are called for which the 
                          API spec has specified they require Basic authentication. If this has
                          not been specified in the spec but most operations do require
                          Basic authentication, consider setting the Credentials property in the
                          httpOptions rather than through httpCredentials.
    cookies             - Cookie jar. The cookie jar is shared across all Api classes in the 
                          same package. All responses are automatically parsed for Set-Cookie
                          headers and cookies are automatically added to the jar. Similarly
                          cookies are added to outgoing requests if there are matching cookies 
                          in the jar for the given request. Cookies can also be added manually
                          by calling the setCookies method on the cookies property. The cookie
                          jar is also saved to disk (cookies.mat in the same directory as 
                          BaseClient) and reloaded in new MATLAB sessions.
 
  ClusterPrincipalAssignments Methods:
 
    ClusterPrincipalAssignments - Constructor
    clusterPrincipalAssignmentsCheckNameAvailability - 
    clusterPrincipalAssignmentsCreateOrUpdate - 
    clusterPrincipalAssignmentsDelete - 
    clusterPrincipalAssignmentsGet - 
    clusterPrincipalAssignmentsList - 
 
  See Also: matlab.net.http.HTTPOptions, matlab.net.http.Credentials, 
    CookieJar.setCookies, control.BaseClient

adx.control.api.ClusterPrincipalAssignments.ClusterPrincipalAssignments

ClusterPrincipalAssignments Constructor, creates a ClusterPrincipalAssignments instance.
  When called without inputs, tries to load configuration
  options from JSON file 'adx.Client.Settings.json'.
  If this file is not present, the instance is initialized with 
  default configuration option. An alternative configuration 
  file can be provided through the "configFile" Name-Value pair.
  All other properties of the instance can also be overridden 
  using Name-Value pairs where Name equals the property name.
  
  Examples:
 
    % Create a client with default options and serverUri
    % as parsed from OpenAPI spec (if available)
    client = adx.control.api.ClusterPrincipalAssignments();
 
    % Create a client for alternative server/base URI
    client = adx.control.api.ClusterPrincipalAssignments("serverUri","https://example.com:1234/api/");
 
    % Create a client loading configuration options from 
    % JSON configuration file
    client = adx.control.api.ClusterPrincipalAssignments("configFile","myconfig.json");
 
    % Create a client with alternative HTTPOptions and an API key
    client = adx.control.api.ClusterPrincipalAssignments("httpOptions",...
        matlab.net.http.HTTPOptions("ConnectTimeout",42),...
        "apiKey", "ABC123");

adx.control.api.ClusterPrincipalAssignments.clusterPrincipalAssignmentsCheckNameAvailability

clusterPrincipalAssignmentsCheckNameAvailability No summary provided
  Checks that the principal assignment name is valid and is not already in use.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    ClusterPrincipalAssignmentCheckNameRequest - The name of the principal assignment., Type: ClusterPrincipalAssignmentCheckNameRequest
        Required properties in the model for this call:
            name
            type
        Optional properties in the model for this call:
 
  No optional parameters
 
  Responses:
    200: OK -- Operation to check the kusto resource name availability was successful.
    0: Error response describing why the operation failed.
 
  Returns: CheckNameResult
 
  See Also: adx.control.models.CheckNameResult

adx.control.api.ClusterPrincipalAssignments.clusterPrincipalAssignmentsCreateOrUpdate

clusterPrincipalAssignmentsCreateOrUpdate No summary provided
  Create a Kusto cluster principalAssignment.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    principalAssignmentName - The name of the Kusto principalAssignment., Type: string
    api_version - The API version to use for this operation., Type: string
    ClusterPrincipalAssignment - The Kusto cluster principalAssignment''s parameters supplied for the operation., Type: ClusterPrincipalAssignment
        Required properties in the model for this call:
        Optional properties in the model for this call:
            xproperties
 
  No optional parameters
 
  Responses:
    200: Successfully updated the PrincipalAssignment.
    201: Successfully created the principalAssignment.
    0: Error response describing why the operation failed.
 
  Returns: ClusterPrincipalAssignment
 
  See Also: adx.control.models.ClusterPrincipalAssignment

adx.control.api.ClusterPrincipalAssignments.clusterPrincipalAssignmentsDelete

clusterPrincipalAssignmentsDelete No summary provided
  Deletes a Kusto cluster principalAssignment.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    principalAssignmentName - The name of the Kusto principalAssignment., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: OK -- principalAssignments deleted successfully.
    202: Accepted the delete principalAssignments request.
    204: NoContent -- principalAssignments does not exist in the subscription.
    0: Error response describing why the operation failed.
 
  Returns: 
 
  See Also: adx.control.models.

adx.control.api.ClusterPrincipalAssignments.clusterPrincipalAssignmentsGet

clusterPrincipalAssignmentsGet No summary provided
  Gets a Kusto cluster principalAssignment.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    principalAssignmentName - The name of the Kusto principalAssignment., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: The Kusto cluster principal assignment object.
    0: Error response describing why the operation failed.
 
  Returns: ClusterPrincipalAssignment
 
  See Also: adx.control.models.ClusterPrincipalAssignment

adx.control.api.ClusterPrincipalAssignments.clusterPrincipalAssignmentsList

clusterPrincipalAssignmentsList No summary provided
  Lists all Kusto cluster principalAssignments.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: OK.
    0: Error response describing why the operation failed.
 
  Returns: ClusterPrincipalAssignmentListResult
 
  See Also: adx.control.models.ClusterPrincipalAssignmentListResult

adx.control.api.Clusters

Superclass: adx.control.BaseClient

Clusters No description provided
 
  Clusters Properties:
 
    serverUri           - Base URI to use when calling the API. Allows using a different server
                          than specified in the original API spec.
    httpOptions         - HTTPOptions used by all requests.
    preferredAuthMethod - If operation supports multiple authentication methods, specified which
                          method to prefer.
    bearerToken         - If Bearer token authentication is used, the token can be supplied 
                          here. Note the token is only used if operations are called for which
                          the API explicitly specified that Bearer authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require Bearer authentication, consider adding the relevant header to
                          all requests in the preSend method.
    apiKey              - If API key authentication is used, the key can be supplied here. 
                          Note the key is only used if operations are called for which
                          the API explicitly specified that API key authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require API key authentication, consider adding the API key to all
                          requests in the preSend method.
    httpCredentials     - If Basic or Digest authentication is supported username/password
                          credentials can be supplied here as matlab.net.http.Credentials. Note 
                          these are only actively used if operations are called for which the 
                          API spec has specified they require Basic authentication. If this has
                          not been specified in the spec but most operations do require
                          Basic authentication, consider setting the Credentials property in the
                          httpOptions rather than through httpCredentials.
    cookies             - Cookie jar. The cookie jar is shared across all Api classes in the 
                          same package. All responses are automatically parsed for Set-Cookie
                          headers and cookies are automatically added to the jar. Similarly
                          cookies are added to outgoing requests if there are matching cookies 
                          in the jar for the given request. Cookies can also be added manually
                          by calling the setCookies method on the cookies property. The cookie
                          jar is also saved to disk (cookies.mat in the same directory as 
                          BaseClient) and reloaded in new MATLAB sessions.
 
  Clusters Methods:
 
    Clusters - Constructor
    clustersAddLanguageExtensions - 
    clustersCheckNameAvailability - 
    clustersCreateOrUpdate - 
    clustersDelete - 
    clustersDetachFollowerDatabases - 
    clustersDiagnoseVirtualNetwork - 
    clustersGet - 
    clustersList - 
    clustersListByResourceGroup - 
    clustersListFollowerDatabases - 
    clustersListLanguageExtensions - 
    clustersListSkusByResource - 
    clustersMigrate - 
    clustersRemoveLanguageExtensions - 
    clustersStart - 
    clustersStop - 
    clustersUpdate - 
 
  See Also: matlab.net.http.HTTPOptions, matlab.net.http.Credentials, 
    CookieJar.setCookies, control.BaseClient

adx.control.api.Clusters.Clusters

Clusters Constructor, creates a Clusters instance.
  When called without inputs, tries to load configuration
  options from JSON file 'adx.Client.Settings.json'.
  If this file is not present, the instance is initialized with 
  default configuration option. An alternative configuration 
  file can be provided through the "configFile" Name-Value pair.
  All other properties of the instance can also be overridden 
  using Name-Value pairs where Name equals the property name.
  
  Examples:
 
    % Create a client with default options and serverUri
    % as parsed from OpenAPI spec (if available)
    client = adx.control.api.Clusters();
 
    % Create a client for alternative server/base URI
    client = adx.control.api.Clusters("serverUri","https://example.com:1234/api/");
 
    % Create a client loading configuration options from 
    % JSON configuration file
    client = adx.control.api.Clusters("configFile","myconfig.json");
 
    % Create a client with alternative HTTPOptions and an API key
    client = adx.control.api.Clusters("httpOptions",...
        matlab.net.http.HTTPOptions("ConnectTimeout",42),...
        "apiKey", "ABC123");

adx.control.api.Clusters.clustersAddLanguageExtensions

clustersAddLanguageExtensions No summary provided
  Add a list of language extensions that can run within KQL queries.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
    LanguageExtensionsList - The language extensions to add., Type: LanguageExtensionsList
        Required properties in the model for this call:
        Optional properties in the model for this call:
            value
 
  No optional parameters
 
  Responses:
    200: OK.
    202: Accepted
    0: Error response describing why the operation failed.
 
  Returns: 
 
  See Also: adx.control.models.

adx.control.api.Clusters.clustersCheckNameAvailability

clustersCheckNameAvailability No summary provided
  Checks that the cluster name is valid and is not already in use.
 
  Required parameters:
    api_version - The API version to use for this operation., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    location - The name of Azure region., Type: string
    ClusterCheckNameRequest - The name of the cluster., Type: ClusterCheckNameRequest
        Required properties in the model for this call:
            name
            type
        Optional properties in the model for this call:
 
  No optional parameters
 
  Responses:
    200: OK -- Operation to check the kusto resource name availability was successful.
    0: Error response describing why the operation failed.
 
  Returns: CheckNameResult
 
  See Also: adx.control.models.CheckNameResult

adx.control.api.Clusters.clustersCreateOrUpdate

clustersCreateOrUpdate No summary provided
  Create or update a Kusto cluster.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
    Cluster - The Kusto cluster parameters supplied to the CreateOrUpdate operation., Type: Cluster
        Required properties in the model for this call:
            sku
        Optional properties in the model for this call:
            systemData
            zones
            identity
            xproperties
            etag
 
  Optional name-value parameters:
    If_Match - The ETag of the cluster. Omit this value to always overwrite the current cluster. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes., Type: string
    If_None_Match - Set to ''*'' to allow a new cluster to be created, but to prevent updating an existing cluster. Other values will result in a 412 Pre-condition Failed response., Type: string
 
  Responses:
    200: Successfully updated the Cluster.
    201: Successfully created the cluster.
    0: Error response describing why the operation failed.
 
  Returns: Cluster
 
  See Also: adx.control.models.Cluster

adx.control.api.Clusters.clustersDelete

clustersDelete No summary provided
  Deletes a Kusto cluster.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: OK -- cluster deleted successfully.
    202: Accepted the delete cluster request.
    204: NoContent -- cluster does not exist in the subscription.
    0: Error response describing why the operation failed.
 
  Returns: 
 
  See Also: adx.control.models.

adx.control.api.Clusters.clustersDetachFollowerDatabases

clustersDetachFollowerDatabases No summary provided
  Detaches all followers of a database owned by this cluster.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
    FollowerDatabaseDefinition - The follower databases properties to remove., Type: FollowerDatabaseDefinition
        Required properties in the model for this call:
            clusterResourceId
            attachedDatabaseConfigurationName
        Optional properties in the model for this call:
            databaseName
            tableLevelSharingProperties
            databaseShareOrigin
 
  No optional parameters
 
  Responses:
    200: OK.
    202: Accepted
    0: Error response describing why the operation failed.
 
  Returns: 
 
  See Also: adx.control.models.

adx.control.api.Clusters.clustersDiagnoseVirtualNetwork

clustersDiagnoseVirtualNetwork No summary provided
  Diagnoses network connectivity status for external resources on which the service is dependent on.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: OK.
    202: Accepted
    0: Error response describing why the operation failed.
 
  Returns: DiagnoseVirtualNetworkResult
 
  See Also: adx.control.models.DiagnoseVirtualNetworkResult

adx.control.api.Clusters.clustersGet

clustersGet No summary provided
  Gets a Kusto cluster.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: The Kusto cluster.
    0: Error response describing why the operation failed.
 
  Returns: Cluster
 
  See Also: adx.control.models.Cluster

adx.control.api.Clusters.clustersList

clustersList No summary provided
  Lists all Kusto clusters within a subscription.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: OK.
    0: Error response describing why the operation failed.
 
  Returns: ClusterListResult
 
  See Also: adx.control.models.ClusterListResult

adx.control.api.Clusters.clustersListByResourceGroup

clustersListByResourceGroup No summary provided
  Lists all Kusto clusters within a resource group.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: OK.
    0: Error response describing why the operation failed.
 
  Returns: ClusterListResult
 
  See Also: adx.control.models.ClusterListResult

adx.control.api.Clusters.clustersListFollowerDatabases

clustersListFollowerDatabases No summary provided
  Returns a list of databases that are owned by this cluster and were followed by another cluster.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully retrieved the list of followed databases.
    0: Error response describing why the operation failed.
 
  Returns: FollowerDatabaseListResult
 
  See Also: adx.control.models.FollowerDatabaseListResult

adx.control.api.Clusters.clustersListLanguageExtensions

clustersListLanguageExtensions No summary provided
  Returns a list of language extensions that can run within KQL queries.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully retrieved the list of language extensions.
    0: Error response describing why the operation failed.
 
  Returns: LanguageExtensionsList
 
  See Also: adx.control.models.LanguageExtensionsList

adx.control.api.Clusters.clustersListSkusByResource

clustersListSkusByResource No summary provided
  Returns the SKUs available for the provided resource.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
    subscriptionId - The ID of the target subscription., Type: string
 
  No optional parameters
 
  Responses:
    200: OK.
    0: Error response describing why the operation failed.
 
  Returns: ListResourceSkusResult
 
  See Also: adx.control.models.ListResourceSkusResult

adx.control.api.Clusters.clustersMigrate

clustersMigrate No summary provided
  Migrate data from a Kusto cluster to another cluster.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
    ClusterMigrateRequest - The cluster migrate request parameters., Type: ClusterMigrateRequest
        Required properties in the model for this call:
            clusterResourceId
        Optional properties in the model for this call:
 
  No optional parameters
 
  Responses:
    200: OK.
    202: Accepted.
    0: Error response describing why the operation failed.
 
  Returns: 
 
  See Also: adx.control.models.

adx.control.api.Clusters.clustersRemoveLanguageExtensions

clustersRemoveLanguageExtensions No summary provided
  Remove a list of language extensions that can run within KQL queries.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
    LanguageExtensionsList - The language extensions to remove., Type: LanguageExtensionsList
        Required properties in the model for this call:
        Optional properties in the model for this call:
            value
 
  No optional parameters
 
  Responses:
    200: OK.
    202: Accepted
    0: Error response describing why the operation failed.
 
  Returns: 
 
  See Also: adx.control.models.

adx.control.api.Clusters.clustersStart

clustersStart No summary provided
  Starts a Kusto cluster.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: OK.
    202: Accepted.
    0: Error response describing why the operation failed.
 
  Returns: 
 
  See Also: adx.control.models.

adx.control.api.Clusters.clustersStop

clustersStop No summary provided
  Stops a Kusto cluster.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: OK.
    202: Accepted
    0: Error response describing why the operation failed.
 
  Returns: 
 
  See Also: adx.control.models.

adx.control.api.Clusters.clustersUpdate

clustersUpdate No summary provided
  Update a Kusto cluster.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
    ClusterUpdate - The Kusto cluster parameters supplied to the Update operation., Type: ClusterUpdate
        Required properties in the model for this call:
        Optional properties in the model for this call:
            tags
            location
            sku
            identity
            xproperties
 
  Optional name-value parameters:
    If_Match - The ETag of the cluster. Omit this value to always overwrite the current cluster. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes., Type: string
 
  Responses:
    200: Successfully updated the Cluster.
    201: Successfully updated the cluster.
    202: Successfully updated the cluster.
    0: Error response describing why the operation failed.
 
  Returns: Cluster
 
  See Also: adx.control.models.Cluster

adx.control.api.DataConnections

Superclass: adx.control.BaseClient

DataConnections No description provided
 
  DataConnections Properties:
 
    serverUri           - Base URI to use when calling the API. Allows using a different server
                          than specified in the original API spec.
    httpOptions         - HTTPOptions used by all requests.
    preferredAuthMethod - If operation supports multiple authentication methods, specified which
                          method to prefer.
    bearerToken         - If Bearer token authentication is used, the token can be supplied 
                          here. Note the token is only used if operations are called for which
                          the API explicitly specified that Bearer authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require Bearer authentication, consider adding the relevant header to
                          all requests in the preSend method.
    apiKey              - If API key authentication is used, the key can be supplied here. 
                          Note the key is only used if operations are called for which
                          the API explicitly specified that API key authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require API key authentication, consider adding the API key to all
                          requests in the preSend method.
    httpCredentials     - If Basic or Digest authentication is supported username/password
                          credentials can be supplied here as matlab.net.http.Credentials. Note 
                          these are only actively used if operations are called for which the 
                          API spec has specified they require Basic authentication. If this has
                          not been specified in the spec but most operations do require
                          Basic authentication, consider setting the Credentials property in the
                          httpOptions rather than through httpCredentials.
    cookies             - Cookie jar. The cookie jar is shared across all Api classes in the 
                          same package. All responses are automatically parsed for Set-Cookie
                          headers and cookies are automatically added to the jar. Similarly
                          cookies are added to outgoing requests if there are matching cookies 
                          in the jar for the given request. Cookies can also be added manually
                          by calling the setCookies method on the cookies property. The cookie
                          jar is also saved to disk (cookies.mat in the same directory as 
                          BaseClient) and reloaded in new MATLAB sessions.
 
  DataConnections Methods:
 
    DataConnections - Constructor
    dataConnectionsCheckNameAvailability - 
    dataConnectionsCreateOrUpdate - 
    dataConnectionsDataConnectionValidation - 
    dataConnectionsDelete - 
    dataConnectionsGet - 
    dataConnectionsListByDatabase - 
    dataConnectionsUpdate - 
 
  See Also: matlab.net.http.HTTPOptions, matlab.net.http.Credentials, 
    CookieJar.setCookies, control.BaseClient

adx.control.api.DataConnections.DataConnections

DataConnections Constructor, creates a DataConnections instance.
  When called without inputs, tries to load configuration
  options from JSON file 'adx.Client.Settings.json'.
  If this file is not present, the instance is initialized with 
  default configuration option. An alternative configuration 
  file can be provided through the "configFile" Name-Value pair.
  All other properties of the instance can also be overridden 
  using Name-Value pairs where Name equals the property name.
  
  Examples:
 
    % Create a client with default options and serverUri
    % as parsed from OpenAPI spec (if available)
    client = adx.control.api.DataConnections();
 
    % Create a client for alternative server/base URI
    client = adx.control.api.DataConnections("serverUri","https://example.com:1234/api/");
 
    % Create a client loading configuration options from 
    % JSON configuration file
    client = adx.control.api.DataConnections("configFile","myconfig.json");
 
    % Create a client with alternative HTTPOptions and an API key
    client = adx.control.api.DataConnections("httpOptions",...
        matlab.net.http.HTTPOptions("ConnectTimeout",42),...
        "apiKey", "ABC123");

adx.control.api.DataConnections.dataConnectionsCheckNameAvailability

dataConnectionsCheckNameAvailability No summary provided
  Checks that the data connection name is valid and is not already in use.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    DataConnectionCheckNameRequest - The name of the data connection., Type: DataConnectionCheckNameRequest
        Required properties in the model for this call:
            name
            type
        Optional properties in the model for this call:
 
  No optional parameters
 
  Responses:
    200: OK -- Operation to check the Kusto resource name availability was successful.
    0: Error response describing why the operation failed.
 
  Returns: CheckNameResult
 
  See Also: adx.control.models.CheckNameResult

adx.control.api.DataConnections.dataConnectionsCreateOrUpdate

dataConnectionsCreateOrUpdate No summary provided
  Creates or updates a data connection.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    dataConnectionName - The name of the data connection., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
    DataConnection - The data connection parameters supplied to the CreateOrUpdate operation., Type: DataConnection
        Required properties in the model for this call:
            kind
        Optional properties in the model for this call:
            location
 
  No optional parameters
 
  Responses:
    200: Successfully updated the data connection.
    201: Successfully created the data connection.
    202: Accepted the create data connection request.
    0: Error response describing why the operation failed.
 
  Returns: DataConnection
 
  See Also: adx.control.models.DataConnection

adx.control.api.DataConnections.dataConnectionsDataConnectionValidation

dataConnectionsDataConnectionValidation No summary provided
  Checks that the data connection parameters are valid.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    DataConnectionValidation - The data connection parameters supplied to the CreateOrUpdate operation., Type: DataConnectionValidation
        Required properties in the model for this call:
        Optional properties in the model for this call:
            dataConnectionName
            xproperties
 
  No optional parameters
 
  Responses:
    200: OK -- Operation to check the kusto resource name availability was successful.
    202: Accepted
    0: Error response describing why the operation failed.
 
  Returns: DataConnectionValidationListResult
 
  See Also: adx.control.models.DataConnectionValidationListResult

adx.control.api.DataConnections.dataConnectionsDelete

dataConnectionsDelete No summary provided
  Deletes the data connection with the given name.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    dataConnectionName - The name of the data connection., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully deleted the data connection.
    202: Accepted.
    204: The specified data connection does not exist.
    0: Error response describing why the operation failed.
 
  Returns: 
 
  See Also: adx.control.models.

adx.control.api.DataConnections.dataConnectionsGet

dataConnectionsGet No summary provided
  Returns a data connection.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    dataConnectionName - The name of the data connection., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully retrieved the specified data connection.
    0: Error response describing why the operation failed.
 
  Returns: DataConnection
 
  See Also: adx.control.models.DataConnection

adx.control.api.DataConnections.dataConnectionsListByDatabase

dataConnectionsListByDatabase No summary provided
  Returns the list of data connections of the given Kusto database.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully retrieved the list of data connections.
    0: Error response describing why the operation failed.
 
  Returns: DataConnectionListResult
 
  See Also: adx.control.models.DataConnectionListResult

adx.control.api.DataConnections.dataConnectionsUpdate

dataConnectionsUpdate No summary provided
  Updates a data connection.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    dataConnectionName - The name of the data connection., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
    DataConnection - The data connection parameters supplied to the Update operation., Type: DataConnection
        Required properties in the model for this call:
            kind
        Optional properties in the model for this call:
            location
 
  No optional parameters
 
  Responses:
    200: Successfully updated the data connection.
    201: Successfully updated the data connection.
    202: Accepted the update data connection request.
    0: Error response describing why the operation failed.
 
  Returns: DataConnection
 
  See Also: adx.control.models.DataConnection

adx.control.api.DatabasePrincipalAssignments

Superclass: adx.control.BaseClient

DatabasePrincipalAssignments No description provided
 
  DatabasePrincipalAssignments Properties:
 
    serverUri           - Base URI to use when calling the API. Allows using a different server
                          than specified in the original API spec.
    httpOptions         - HTTPOptions used by all requests.
    preferredAuthMethod - If operation supports multiple authentication methods, specified which
                          method to prefer.
    bearerToken         - If Bearer token authentication is used, the token can be supplied 
                          here. Note the token is only used if operations are called for which
                          the API explicitly specified that Bearer authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require Bearer authentication, consider adding the relevant header to
                          all requests in the preSend method.
    apiKey              - If API key authentication is used, the key can be supplied here. 
                          Note the key is only used if operations are called for which
                          the API explicitly specified that API key authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require API key authentication, consider adding the API key to all
                          requests in the preSend method.
    httpCredentials     - If Basic or Digest authentication is supported username/password
                          credentials can be supplied here as matlab.net.http.Credentials. Note 
                          these are only actively used if operations are called for which the 
                          API spec has specified they require Basic authentication. If this has
                          not been specified in the spec but most operations do require
                          Basic authentication, consider setting the Credentials property in the
                          httpOptions rather than through httpCredentials.
    cookies             - Cookie jar. The cookie jar is shared across all Api classes in the 
                          same package. All responses are automatically parsed for Set-Cookie
                          headers and cookies are automatically added to the jar. Similarly
                          cookies are added to outgoing requests if there are matching cookies 
                          in the jar for the given request. Cookies can also be added manually
                          by calling the setCookies method on the cookies property. The cookie
                          jar is also saved to disk (cookies.mat in the same directory as 
                          BaseClient) and reloaded in new MATLAB sessions.
 
  DatabasePrincipalAssignments Methods:
 
    DatabasePrincipalAssignments - Constructor
    databasePrincipalAssignmentsCheckNameAvailability - 
    databasePrincipalAssignmentsCreateOrUpdate - 
    databasePrincipalAssignmentsDelete - 
    databasePrincipalAssignmentsGet - 
    databasePrincipalAssignmentsList - 
 
  See Also: matlab.net.http.HTTPOptions, matlab.net.http.Credentials, 
    CookieJar.setCookies, control.BaseClient

adx.control.api.DatabasePrincipalAssignments.DatabasePrincipalAssignments

DatabasePrincipalAssignments Constructor, creates a DatabasePrincipalAssignments instance.
  When called without inputs, tries to load configuration
  options from JSON file 'adx.Client.Settings.json'.
  If this file is not present, the instance is initialized with 
  default configuration option. An alternative configuration 
  file can be provided through the "configFile" Name-Value pair.
  All other properties of the instance can also be overridden 
  using Name-Value pairs where Name equals the property name.
  
  Examples:
 
    % Create a client with default options and serverUri
    % as parsed from OpenAPI spec (if available)
    client = adx.control.api.DatabasePrincipalAssignments();
 
    % Create a client for alternative server/base URI
    client = adx.control.api.DatabasePrincipalAssignments("serverUri","https://example.com:1234/api/");
 
    % Create a client loading configuration options from 
    % JSON configuration file
    client = adx.control.api.DatabasePrincipalAssignments("configFile","myconfig.json");
 
    % Create a client with alternative HTTPOptions and an API key
    client = adx.control.api.DatabasePrincipalAssignments("httpOptions",...
        matlab.net.http.HTTPOptions("ConnectTimeout",42),...
        "apiKey", "ABC123");

adx.control.api.DatabasePrincipalAssignments.databasePrincipalAssignmentsCheckNameAvailability

databasePrincipalAssignmentsCheckNameAvailability No summary provided
  Checks that the database principal assignment is valid and is not already in use.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    DatabasePrincipalAssignmentCheckNameRequest - The name of the resource., Type: DatabasePrincipalAssignmentCheckNameRequest
        Required properties in the model for this call:
            name
            type
        Optional properties in the model for this call:
 
  No optional parameters
 
  Responses:
    200: OK -- Operation to check the kusto resource name availability was successful.
    0: Error response describing why the operation failed.
 
  Returns: CheckNameResult
 
  See Also: adx.control.models.CheckNameResult

adx.control.api.DatabasePrincipalAssignments.databasePrincipalAssignmentsCreateOrUpdate

databasePrincipalAssignmentsCreateOrUpdate No summary provided
  Creates a Kusto cluster database principalAssignment.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    principalAssignmentName - The name of the Kusto principalAssignment., Type: string
    api_version - The API version to use for this operation., Type: string
    DatabasePrincipalAssignment - The Kusto principalAssignments parameters supplied for the operation., Type: DatabasePrincipalAssignment
        Required properties in the model for this call:
        Optional properties in the model for this call:
            xproperties
 
  No optional parameters
 
  Responses:
    200: Successfully updated the PrincipalAssignments.
    201: Successfully created the principalAssignments.
    0: Error response describing why the operation failed.
 
  Returns: DatabasePrincipalAssignment
 
  See Also: adx.control.models.DatabasePrincipalAssignment

adx.control.api.DatabasePrincipalAssignments.databasePrincipalAssignmentsDelete

databasePrincipalAssignmentsDelete No summary provided
  Deletes a Kusto principalAssignment.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    principalAssignmentName - The name of the Kusto principalAssignment., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: OK -- principalAssignments deleted successfully.
    202: Accepted the delete principalAssignments request.
    204: NoContent -- principalAssignments does not exist in the subscription.
    0: Error response describing why the operation failed.
 
  Returns: 
 
  See Also: adx.control.models.

adx.control.api.DatabasePrincipalAssignments.databasePrincipalAssignmentsGet

databasePrincipalAssignmentsGet No summary provided
  Gets a Kusto cluster database principalAssignment.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    principalAssignmentName - The name of the Kusto principalAssignment., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: The Kusto cluster database principal assignment object.
    0: Error response describing why the operation failed.
 
  Returns: DatabasePrincipalAssignment
 
  See Also: adx.control.models.DatabasePrincipalAssignment

adx.control.api.DatabasePrincipalAssignments.databasePrincipalAssignmentsList

databasePrincipalAssignmentsList No summary provided
  Lists all Kusto cluster database principalAssignments.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: OK.
    0: Error response describing why the operation failed.
 
  Returns: DatabasePrincipalAssignmentListResult
 
  See Also: adx.control.models.DatabasePrincipalAssignmentListResult

adx.control.api.Databases

Superclass: adx.control.BaseClient

Databases No description provided
 
  Databases Properties:
 
    serverUri           - Base URI to use when calling the API. Allows using a different server
                          than specified in the original API spec.
    httpOptions         - HTTPOptions used by all requests.
    preferredAuthMethod - If operation supports multiple authentication methods, specified which
                          method to prefer.
    bearerToken         - If Bearer token authentication is used, the token can be supplied 
                          here. Note the token is only used if operations are called for which
                          the API explicitly specified that Bearer authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require Bearer authentication, consider adding the relevant header to
                          all requests in the preSend method.
    apiKey              - If API key authentication is used, the key can be supplied here. 
                          Note the key is only used if operations are called for which
                          the API explicitly specified that API key authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require API key authentication, consider adding the API key to all
                          requests in the preSend method.
    httpCredentials     - If Basic or Digest authentication is supported username/password
                          credentials can be supplied here as matlab.net.http.Credentials. Note 
                          these are only actively used if operations are called for which the 
                          API spec has specified they require Basic authentication. If this has
                          not been specified in the spec but most operations do require
                          Basic authentication, consider setting the Credentials property in the
                          httpOptions rather than through httpCredentials.
    cookies             - Cookie jar. The cookie jar is shared across all Api classes in the 
                          same package. All responses are automatically parsed for Set-Cookie
                          headers and cookies are automatically added to the jar. Similarly
                          cookies are added to outgoing requests if there are matching cookies 
                          in the jar for the given request. Cookies can also be added manually
                          by calling the setCookies method on the cookies property. The cookie
                          jar is also saved to disk (cookies.mat in the same directory as 
                          BaseClient) and reloaded in new MATLAB sessions.
 
  Databases Methods:
 
    Databases - Constructor
    databaseInviteFollower - 
    databasesAddPrincipals - 
    databasesCheckNameAvailability - 
    databasesCreateOrUpdate - 
    databasesDelete - 
    databasesGet - 
    databasesListByCluster - 
    databasesListPrincipals - 
    databasesRemovePrincipals - 
    databasesUpdate - 
 
  See Also: matlab.net.http.HTTPOptions, matlab.net.http.Credentials, 
    CookieJar.setCookies, control.BaseClient

adx.control.api.Databases.Databases

Databases Constructor, creates a Databases instance.
  When called without inputs, tries to load configuration
  options from JSON file 'adx.Client.Settings.json'.
  If this file is not present, the instance is initialized with 
  default configuration option. An alternative configuration 
  file can be provided through the "configFile" Name-Value pair.
  All other properties of the instance can also be overridden 
  using Name-Value pairs where Name equals the property name.
  
  Examples:
 
    % Create a client with default options and serverUri
    % as parsed from OpenAPI spec (if available)
    client = adx.control.api.Databases();
 
    % Create a client for alternative server/base URI
    client = adx.control.api.Databases("serverUri","https://example.com:1234/api/");
 
    % Create a client loading configuration options from 
    % JSON configuration file
    client = adx.control.api.Databases("configFile","myconfig.json");
 
    % Create a client with alternative HTTPOptions and an API key
    client = adx.control.api.Databases("httpOptions",...
        matlab.net.http.HTTPOptions("ConnectTimeout",42),...
        "apiKey", "ABC123");

adx.control.api.Databases.databaseInviteFollower

databaseInviteFollower No summary provided
  Generates an invitation token that allows attaching a follower database to this database.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
    DatabaseInviteFollowerRequest - The follower invitation request parameters., Type: DatabaseInviteFollowerRequest
        Required properties in the model for this call:
            inviteeEmail
        Optional properties in the model for this call:
            tableLevelSharingProperties
 
  No optional parameters
 
  Responses:
    200: OK.
    0: Error response describing why the operation failed.
 
  Returns: DatabaseInviteFollowerResult
 
  See Also: adx.control.models.DatabaseInviteFollowerResult

adx.control.api.Databases.databasesAddPrincipals

databasesAddPrincipals No summary provided
  Add Database principals permissions.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
    DatabasePrincipalListRequest - List of database principals to add., Type: DatabasePrincipalListRequest
        Required properties in the model for this call:
        Optional properties in the model for this call:
            value
 
  No optional parameters
 
  Responses:
    200: OK -- Successfully added the list of database principals. Returns the updated list of principals.
    0: Error response describing why the operation failed.
 
  Returns: DatabasePrincipalListResult
 
  See Also: adx.control.models.DatabasePrincipalListResult

adx.control.api.Databases.databasesCheckNameAvailability

databasesCheckNameAvailability No summary provided
  Checks that the databases resource name is valid and is not already in use.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    CheckNameRequest - The name of the resource., Type: CheckNameRequest
        Required properties in the model for this call:
            name
            type
        Optional properties in the model for this call:
 
  No optional parameters
 
  Responses:
    200: OK -- Operation to check the kusto resource name availability was successful.
    0: Error response describing why the operation failed.
 
  Returns: CheckNameResult
 
  See Also: adx.control.models.CheckNameResult

adx.control.api.Databases.databasesCreateOrUpdate

databasesCreateOrUpdate No summary provided
  Creates or updates a database.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
    Database - The database parameters supplied to the CreateOrUpdate operation., Type: Database
        Required properties in the model for this call:
            kind
        Optional properties in the model for this call:
            location
 
  Optional name-value parameters:
    callerRole - By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list., Type: string
 
  Responses:
    200: Successfully updated the database.
    201: Successfully created the database.
    202: Accepted the create database request.
    0: Error response describing why the operation failed.
 
  Returns: Database
 
  See Also: adx.control.models.Database

adx.control.api.Databases.databasesDelete

databasesDelete No summary provided
  Deletes the database with the given name.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully deleted the database.
    202: Accepted.
    204: The specified database does not exist.
    0: Error response describing why the operation failed.
 
  Returns: 
 
  See Also: adx.control.models.

adx.control.api.Databases.databasesGet

databasesGet No summary provided
  Returns a database.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully retrieved the specified database.
    0: Error response describing why the operation failed.
 
  Returns: Database
 
  See Also: adx.control.models.Database

adx.control.api.Databases.databasesListByCluster

databasesListByCluster No summary provided
  Returns the list of databases of the given Kusto cluster.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  Optional name-value parameters:
    top - limit the number of results, Type: int32, Format: int32
    skiptoken - Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls., Type: string
 
  Responses:
    200: Successfully retrieved the list of databases.
    0: Error response describing why the operation failed.
 
  Returns: DatabaseListResult
 
  See Also: adx.control.models.DatabaseListResult

adx.control.api.Databases.databasesListPrincipals

databasesListPrincipals No summary provided
  Returns a list of database principals of the given Kusto cluster and database.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully retrieved the list of database principals.
    0: Error response describing why the operation failed.
 
  Returns: DatabasePrincipalListResult
 
  See Also: adx.control.models.DatabasePrincipalListResult

adx.control.api.Databases.databasesRemovePrincipals

databasesRemovePrincipals No summary provided
  Remove Database principals permissions.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
    DatabasePrincipalListRequest - List of database principals to remove., Type: DatabasePrincipalListRequest
        Required properties in the model for this call:
        Optional properties in the model for this call:
            value
 
  No optional parameters
 
  Responses:
    200: OK -- Successfully removed the list of database principals. Returns the updated list of principals.
    0: Error response describing why the operation failed.
 
  Returns: DatabasePrincipalListResult
 
  See Also: adx.control.models.DatabasePrincipalListResult

adx.control.api.Databases.databasesUpdate

databasesUpdate No summary provided
  Updates a database.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    api_version - The API version to use for this operation., Type: string
    Database - The database parameters supplied to the Update operation., Type: Database
        Required properties in the model for this call:
            kind
        Optional properties in the model for this call:
            location
 
  Optional name-value parameters:
    callerRole - By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list., Type: string
 
  Responses:
    200: Successfully updated the database.
    201: Successfully updated the database.
    202: Accepted the update database request.
    0: Error response describing why the operation failed.
 
  Returns: Database
 
  See Also: adx.control.models.Database

adx.control.api.Default

Superclass: adx.control.BaseClient

Default No description provided
 
  Default Properties:
 
    serverUri           - Base URI to use when calling the API. Allows using a different server
                          than specified in the original API spec.
    httpOptions         - HTTPOptions used by all requests.
    preferredAuthMethod - If operation supports multiple authentication methods, specified which
                          method to prefer.
    bearerToken         - If Bearer token authentication is used, the token can be supplied 
                          here. Note the token is only used if operations are called for which
                          the API explicitly specified that Bearer authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require Bearer authentication, consider adding the relevant header to
                          all requests in the preSend method.
    apiKey              - If API key authentication is used, the key can be supplied here. 
                          Note the key is only used if operations are called for which
                          the API explicitly specified that API key authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require API key authentication, consider adding the API key to all
                          requests in the preSend method.
    httpCredentials     - If Basic or Digest authentication is supported username/password
                          credentials can be supplied here as matlab.net.http.Credentials. Note 
                          these are only actively used if operations are called for which the 
                          API spec has specified they require Basic authentication. If this has
                          not been specified in the spec but most operations do require
                          Basic authentication, consider setting the Credentials property in the
                          httpOptions rather than through httpCredentials.
    cookies             - Cookie jar. The cookie jar is shared across all Api classes in the 
                          same package. All responses are automatically parsed for Set-Cookie
                          headers and cookies are automatically added to the jar. Similarly
                          cookies are added to outgoing requests if there are matching cookies 
                          in the jar for the given request. Cookies can also be added manually
                          by calling the setCookies method on the cookies property. The cookie
                          jar is also saved to disk (cookies.mat in the same directory as 
                          BaseClient) and reloaded in new MATLAB sessions.
 
  Default Methods:
 
    Default - Constructor
    clustersListSkus - 
    skusList - 
 
  See Also: matlab.net.http.HTTPOptions, matlab.net.http.Credentials, 
    CookieJar.setCookies, control.BaseClient

adx.control.api.Default.Default

Default Constructor, creates a Default instance.
  When called without inputs, tries to load configuration
  options from JSON file 'adx.Client.Settings.json'.
  If this file is not present, the instance is initialized with 
  default configuration option. An alternative configuration 
  file can be provided through the "configFile" Name-Value pair.
  All other properties of the instance can also be overridden 
  using Name-Value pairs where Name equals the property name.
  
  Examples:
 
    % Create a client with default options and serverUri
    % as parsed from OpenAPI spec (if available)
    client = adx.control.api.Default();
 
    % Create a client for alternative server/base URI
    client = adx.control.api.Default("serverUri","https://example.com:1234/api/");
 
    % Create a client loading configuration options from 
    % JSON configuration file
    client = adx.control.api.Default("configFile","myconfig.json");
 
    % Create a client with alternative HTTPOptions and an API key
    client = adx.control.api.Default("httpOptions",...
        matlab.net.http.HTTPOptions("ConnectTimeout",42),...
        "apiKey", "ABC123");

adx.control.api.Default.clustersListSkus

clustersListSkus No summary provided
  Lists eligible SKUs for Kusto resource provider.
 
  Required parameters:
    api_version - The API version to use for this operation., Type: string
    subscriptionId - The ID of the target subscription., Type: string
 
  No optional parameters
 
  Responses:
    200: OK.
    0: Error response describing why the operation failed.
 
  Returns: SkuDescriptionList
 
  See Also: adx.control.models.SkuDescriptionList

adx.control.api.Default.skusList

skusList No summary provided
  Lists eligible region SKUs for Kusto resource provider by Azure region.
 
  Required parameters:
    api_version - The API version to use for this operation., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    location - The name of Azure region., Type: string
 
  No optional parameters
 
  Responses:
    200: OK.
    0: Error response describing why the operation failed.
 
  Returns: SkuDescriptionList
 
  See Also: adx.control.models.SkuDescriptionList

adx.control.api.ManagedPrivateEndpoints

Superclass: adx.control.BaseClient

ManagedPrivateEndpoints No description provided
 
  ManagedPrivateEndpoints Properties:
 
    serverUri           - Base URI to use when calling the API. Allows using a different server
                          than specified in the original API spec.
    httpOptions         - HTTPOptions used by all requests.
    preferredAuthMethod - If operation supports multiple authentication methods, specified which
                          method to prefer.
    bearerToken         - If Bearer token authentication is used, the token can be supplied 
                          here. Note the token is only used if operations are called for which
                          the API explicitly specified that Bearer authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require Bearer authentication, consider adding the relevant header to
                          all requests in the preSend method.
    apiKey              - If API key authentication is used, the key can be supplied here. 
                          Note the key is only used if operations are called for which
                          the API explicitly specified that API key authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require API key authentication, consider adding the API key to all
                          requests in the preSend method.
    httpCredentials     - If Basic or Digest authentication is supported username/password
                          credentials can be supplied here as matlab.net.http.Credentials. Note 
                          these are only actively used if operations are called for which the 
                          API spec has specified they require Basic authentication. If this has
                          not been specified in the spec but most operations do require
                          Basic authentication, consider setting the Credentials property in the
                          httpOptions rather than through httpCredentials.
    cookies             - Cookie jar. The cookie jar is shared across all Api classes in the 
                          same package. All responses are automatically parsed for Set-Cookie
                          headers and cookies are automatically added to the jar. Similarly
                          cookies are added to outgoing requests if there are matching cookies 
                          in the jar for the given request. Cookies can also be added manually
                          by calling the setCookies method on the cookies property. The cookie
                          jar is also saved to disk (cookies.mat in the same directory as 
                          BaseClient) and reloaded in new MATLAB sessions.
 
  ManagedPrivateEndpoints Methods:
 
    ManagedPrivateEndpoints - Constructor
    managedPrivateEndpointsCheckNameAvailability - 
    managedPrivateEndpointsCreateOrUpdate - 
    managedPrivateEndpointsDelete - 
    managedPrivateEndpointsGet - 
    managedPrivateEndpointsList - 
    managedPrivateEndpointsUpdate - 
 
  See Also: matlab.net.http.HTTPOptions, matlab.net.http.Credentials, 
    CookieJar.setCookies, control.BaseClient

adx.control.api.ManagedPrivateEndpoints.ManagedPrivateEndpoints

ManagedPrivateEndpoints Constructor, creates a ManagedPrivateEndpoints instance.
  When called without inputs, tries to load configuration
  options from JSON file 'adx.Client.Settings.json'.
  If this file is not present, the instance is initialized with 
  default configuration option. An alternative configuration 
  file can be provided through the "configFile" Name-Value pair.
  All other properties of the instance can also be overridden 
  using Name-Value pairs where Name equals the property name.
  
  Examples:
 
    % Create a client with default options and serverUri
    % as parsed from OpenAPI spec (if available)
    client = adx.control.api.ManagedPrivateEndpoints();
 
    % Create a client for alternative server/base URI
    client = adx.control.api.ManagedPrivateEndpoints("serverUri","https://example.com:1234/api/");
 
    % Create a client loading configuration options from 
    % JSON configuration file
    client = adx.control.api.ManagedPrivateEndpoints("configFile","myconfig.json");
 
    % Create a client with alternative HTTPOptions and an API key
    client = adx.control.api.ManagedPrivateEndpoints("httpOptions",...
        matlab.net.http.HTTPOptions("ConnectTimeout",42),...
        "apiKey", "ABC123");

adx.control.api.ManagedPrivateEndpoints.managedPrivateEndpointsCheckNameAvailability

managedPrivateEndpointsCheckNameAvailability No summary provided
  Checks that the managed private endpoints resource name is valid and is not already in use.
 
  Required parameters:
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
    subscriptionId - The ID of the target subscription., Type: string
    ManagedPrivateEndpointsCheckNameRequest - The name of the resource., Type: ManagedPrivateEndpointsCheckNameRequest
        Required properties in the model for this call:
            name
            type
        Optional properties in the model for this call:
 
  No optional parameters
 
  Responses:
    200: OK -- Operation to check the kusto resource name availability was successful.
    0: Error response describing why the operation failed.
 
  Returns: CheckNameResult
 
  See Also: adx.control.models.CheckNameResult

adx.control.api.ManagedPrivateEndpoints.managedPrivateEndpointsCreateOrUpdate

managedPrivateEndpointsCreateOrUpdate No summary provided
  Creates a managed private endpoint.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    managedPrivateEndpointName - The name of the managed private endpoint., Type: string
    api_version - The API version to use for this operation., Type: string
    ManagedPrivateEndpoint - The managed private endpoint parameters., Type: ManagedPrivateEndpoint
        Required properties in the model for this call:
        Optional properties in the model for this call:
            xproperties
            systemData
 
  No optional parameters
 
  Responses:
    200: Successfully updated the managed private endpoint.
    201: Successfully created the managed private endpoint.
    202: Successfully accepted the managed private endpoint.
    0: Error response describing why the operation failed.
 
  Returns: ManagedPrivateEndpoint
 
  See Also: adx.control.models.ManagedPrivateEndpoint

adx.control.api.ManagedPrivateEndpoints.managedPrivateEndpointsDelete

managedPrivateEndpointsDelete No summary provided
  Deletes a managed private endpoint.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    managedPrivateEndpointName - The name of the managed private endpoint., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: OK -- managed private endpoint deleted successfully.
    202: Accepted the delete managed private endpoint request.
    204: NoContent -- If the managed private endpoint resource is already deleted, this is the expected status code.
    0: Error response describing why the operation failed.
 
  Returns: 
 
  See Also: adx.control.models.

adx.control.api.ManagedPrivateEndpoints.managedPrivateEndpointsGet

managedPrivateEndpointsGet No summary provided
  Gets a managed private endpoint.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    managedPrivateEndpointName - The name of the managed private endpoint., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: The managed private endpoint object.
    0: Error response describing why the operation failed.
 
  Returns: ManagedPrivateEndpoint
 
  See Also: adx.control.models.ManagedPrivateEndpoint

adx.control.api.ManagedPrivateEndpoints.managedPrivateEndpointsList

managedPrivateEndpointsList No summary provided
  Returns the list of managed private endpoints.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: The list result of managed private endpoints.
    0: Error response describing why the operation failed.
 
  Returns: ManagedPrivateEndpointListResult
 
  See Also: adx.control.models.ManagedPrivateEndpointListResult

adx.control.api.ManagedPrivateEndpoints.managedPrivateEndpointsUpdate

managedPrivateEndpointsUpdate No summary provided
  Updates a managed private endpoint.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    managedPrivateEndpointName - The name of the managed private endpoint., Type: string
    api_version - The API version to use for this operation., Type: string
    ManagedPrivateEndpoint - The managed private endpoint parameters., Type: ManagedPrivateEndpoint
        Required properties in the model for this call:
        Optional properties in the model for this call:
            xproperties
            systemData
 
  No optional parameters
 
  Responses:
    200: Successfully updated the managed private endpoint.
    202: Accepted the update request of the managed private endpoint.
    0: Error response describing why the operation failed.
 
  Returns: ManagedPrivateEndpoint
 
  See Also: adx.control.models.ManagedPrivateEndpoint

adx.control.api.OperationResults

Superclass: adx.control.BaseClient

OperationResults No description provided
 
  OperationResults Properties:
 
    serverUri           - Base URI to use when calling the API. Allows using a different server
                          than specified in the original API spec.
    httpOptions         - HTTPOptions used by all requests.
    preferredAuthMethod - If operation supports multiple authentication methods, specified which
                          method to prefer.
    bearerToken         - If Bearer token authentication is used, the token can be supplied 
                          here. Note the token is only used if operations are called for which
                          the API explicitly specified that Bearer authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require Bearer authentication, consider adding the relevant header to
                          all requests in the preSend method.
    apiKey              - If API key authentication is used, the key can be supplied here. 
                          Note the key is only used if operations are called for which
                          the API explicitly specified that API key authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require API key authentication, consider adding the API key to all
                          requests in the preSend method.
    httpCredentials     - If Basic or Digest authentication is supported username/password
                          credentials can be supplied here as matlab.net.http.Credentials. Note 
                          these are only actively used if operations are called for which the 
                          API spec has specified they require Basic authentication. If this has
                          not been specified in the spec but most operations do require
                          Basic authentication, consider setting the Credentials property in the
                          httpOptions rather than through httpCredentials.
    cookies             - Cookie jar. The cookie jar is shared across all Api classes in the 
                          same package. All responses are automatically parsed for Set-Cookie
                          headers and cookies are automatically added to the jar. Similarly
                          cookies are added to outgoing requests if there are matching cookies 
                          in the jar for the given request. Cookies can also be added manually
                          by calling the setCookies method on the cookies property. The cookie
                          jar is also saved to disk (cookies.mat in the same directory as 
                          BaseClient) and reloaded in new MATLAB sessions.
 
  OperationResults Methods:
 
    OperationResults - Constructor
    operationsResultsGet - 
 
  See Also: matlab.net.http.HTTPOptions, matlab.net.http.Credentials, 
    CookieJar.setCookies, control.BaseClient

adx.control.api.OperationResults.OperationResults

OperationResults Constructor, creates a OperationResults instance.
  When called without inputs, tries to load configuration
  options from JSON file 'adx.Client.Settings.json'.
  If this file is not present, the instance is initialized with 
  default configuration option. An alternative configuration 
  file can be provided through the "configFile" Name-Value pair.
  All other properties of the instance can also be overridden 
  using Name-Value pairs where Name equals the property name.
  
  Examples:
 
    % Create a client with default options and serverUri
    % as parsed from OpenAPI spec (if available)
    client = adx.control.api.OperationResults();
 
    % Create a client for alternative server/base URI
    client = adx.control.api.OperationResults("serverUri","https://example.com:1234/api/");
 
    % Create a client loading configuration options from 
    % JSON configuration file
    client = adx.control.api.OperationResults("configFile","myconfig.json");
 
    % Create a client with alternative HTTPOptions and an API key
    client = adx.control.api.OperationResults("httpOptions",...
        matlab.net.http.HTTPOptions("ConnectTimeout",42),...
        "apiKey", "ABC123");

adx.control.api.OperationResults.operationsResultsGet

operationsResultsGet No summary provided
  Returns operation results.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    location - The name of Azure region., Type: string
    operationId - The ID of an ongoing async operation., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully retrieved the operation result.
    0: Error response describing why the operation failed.
 
  Returns: OperationResult
 
  See Also: adx.control.models.OperationResult

adx.control.api.Operations

Superclass: adx.control.BaseClient

Operations No description provided
 
  Operations Properties:
 
    serverUri           - Base URI to use when calling the API. Allows using a different server
                          than specified in the original API spec.
    httpOptions         - HTTPOptions used by all requests.
    preferredAuthMethod - If operation supports multiple authentication methods, specified which
                          method to prefer.
    bearerToken         - If Bearer token authentication is used, the token can be supplied 
                          here. Note the token is only used if operations are called for which
                          the API explicitly specified that Bearer authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require Bearer authentication, consider adding the relevant header to
                          all requests in the preSend method.
    apiKey              - If API key authentication is used, the key can be supplied here. 
                          Note the key is only used if operations are called for which
                          the API explicitly specified that API key authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require API key authentication, consider adding the API key to all
                          requests in the preSend method.
    httpCredentials     - If Basic or Digest authentication is supported username/password
                          credentials can be supplied here as matlab.net.http.Credentials. Note 
                          these are only actively used if operations are called for which the 
                          API spec has specified they require Basic authentication. If this has
                          not been specified in the spec but most operations do require
                          Basic authentication, consider setting the Credentials property in the
                          httpOptions rather than through httpCredentials.
    cookies             - Cookie jar. The cookie jar is shared across all Api classes in the 
                          same package. All responses are automatically parsed for Set-Cookie
                          headers and cookies are automatically added to the jar. Similarly
                          cookies are added to outgoing requests if there are matching cookies 
                          in the jar for the given request. Cookies can also be added manually
                          by calling the setCookies method on the cookies property. The cookie
                          jar is also saved to disk (cookies.mat in the same directory as 
                          BaseClient) and reloaded in new MATLAB sessions.
 
  Operations Methods:
 
    Operations - Constructor
    operationsList - 
 
  See Also: matlab.net.http.HTTPOptions, matlab.net.http.Credentials, 
    CookieJar.setCookies, control.BaseClient

adx.control.api.Operations.Operations

Operations Constructor, creates a Operations instance.
  When called without inputs, tries to load configuration
  options from JSON file 'adx.Client.Settings.json'.
  If this file is not present, the instance is initialized with 
  default configuration option. An alternative configuration 
  file can be provided through the "configFile" Name-Value pair.
  All other properties of the instance can also be overridden 
  using Name-Value pairs where Name equals the property name.
  
  Examples:
 
    % Create a client with default options and serverUri
    % as parsed from OpenAPI spec (if available)
    client = adx.control.api.Operations();
 
    % Create a client for alternative server/base URI
    client = adx.control.api.Operations("serverUri","https://example.com:1234/api/");
 
    % Create a client loading configuration options from 
    % JSON configuration file
    client = adx.control.api.Operations("configFile","myconfig.json");
 
    % Create a client with alternative HTTPOptions and an API key
    client = adx.control.api.Operations("httpOptions",...
        matlab.net.http.HTTPOptions("ConnectTimeout",42),...
        "apiKey", "ABC123");

adx.control.api.Operations.operationsList

operationsList No summary provided
  Lists available operations for the Microsoft.Kusto provider.
 
  Required parameters:
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: The operation was successful. The response contains the list of available operations.
    0: Error response describing why the operation failed.
 
  Returns: OperationListResult
 
  See Also: adx.control.models.OperationListResult

adx.control.api.OutboundNetworkDependenciesEndpoints

Superclass: adx.control.BaseClient

OutboundNetworkDependenciesEndpoints No description provided
 
  OutboundNetworkDependenciesEndpoints Properties:
 
    serverUri           - Base URI to use when calling the API. Allows using a different server
                          than specified in the original API spec.
    httpOptions         - HTTPOptions used by all requests.
    preferredAuthMethod - If operation supports multiple authentication methods, specified which
                          method to prefer.
    bearerToken         - If Bearer token authentication is used, the token can be supplied 
                          here. Note the token is only used if operations are called for which
                          the API explicitly specified that Bearer authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require Bearer authentication, consider adding the relevant header to
                          all requests in the preSend method.
    apiKey              - If API key authentication is used, the key can be supplied here. 
                          Note the key is only used if operations are called for which
                          the API explicitly specified that API key authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require API key authentication, consider adding the API key to all
                          requests in the preSend method.
    httpCredentials     - If Basic or Digest authentication is supported username/password
                          credentials can be supplied here as matlab.net.http.Credentials. Note 
                          these are only actively used if operations are called for which the 
                          API spec has specified they require Basic authentication. If this has
                          not been specified in the spec but most operations do require
                          Basic authentication, consider setting the Credentials property in the
                          httpOptions rather than through httpCredentials.
    cookies             - Cookie jar. The cookie jar is shared across all Api classes in the 
                          same package. All responses are automatically parsed for Set-Cookie
                          headers and cookies are automatically added to the jar. Similarly
                          cookies are added to outgoing requests if there are matching cookies 
                          in the jar for the given request. Cookies can also be added manually
                          by calling the setCookies method on the cookies property. The cookie
                          jar is also saved to disk (cookies.mat in the same directory as 
                          BaseClient) and reloaded in new MATLAB sessions.
 
  OutboundNetworkDependenciesEndpoints Methods:
 
    OutboundNetworkDependenciesEndpoints - Constructor
    clustersListOutboundNetworkDependenciesEndpoints - 
 
  See Also: matlab.net.http.HTTPOptions, matlab.net.http.Credentials, 
    CookieJar.setCookies, control.BaseClient

adx.control.api.OutboundNetworkDependenciesEndpoints.OutboundNetworkDependenciesEndpoints

OutboundNetworkDependenciesEndpoints Constructor, creates a OutboundNetworkDependenciesEndpoints instance.
  When called without inputs, tries to load configuration
  options from JSON file 'adx.Client.Settings.json'.
  If this file is not present, the instance is initialized with 
  default configuration option. An alternative configuration 
  file can be provided through the "configFile" Name-Value pair.
  All other properties of the instance can also be overridden 
  using Name-Value pairs where Name equals the property name.
  
  Examples:
 
    % Create a client with default options and serverUri
    % as parsed from OpenAPI spec (if available)
    client = adx.control.api.OutboundNetworkDependenciesEndpoints();
 
    % Create a client for alternative server/base URI
    client = adx.control.api.OutboundNetworkDependenciesEndpoints("serverUri","https://example.com:1234/api/");
 
    % Create a client loading configuration options from 
    % JSON configuration file
    client = adx.control.api.OutboundNetworkDependenciesEndpoints("configFile","myconfig.json");
 
    % Create a client with alternative HTTPOptions and an API key
    client = adx.control.api.OutboundNetworkDependenciesEndpoints("httpOptions",...
        matlab.net.http.HTTPOptions("ConnectTimeout",42),...
        "apiKey", "ABC123");

adx.control.api.OutboundNetworkDependenciesEndpoints.clustersListOutboundNetworkDependenciesEndpoints

clustersListOutboundNetworkDependenciesEndpoints No summary provided
  Gets the network endpoints of all outbound dependencies of a Kusto cluster
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: OK
    0: Error from the RP
 
  Returns: OutboundNetworkDependenciesEndpointListResult
 
  See Also: adx.control.models.OutboundNetworkDependenciesEndpointListResult

adx.control.api.PrivateEndpointConnections

Superclass: adx.control.BaseClient

PrivateEndpointConnections No description provided
 
  PrivateEndpointConnections Properties:
 
    serverUri           - Base URI to use when calling the API. Allows using a different server
                          than specified in the original API spec.
    httpOptions         - HTTPOptions used by all requests.
    preferredAuthMethod - If operation supports multiple authentication methods, specified which
                          method to prefer.
    bearerToken         - If Bearer token authentication is used, the token can be supplied 
                          here. Note the token is only used if operations are called for which
                          the API explicitly specified that Bearer authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require Bearer authentication, consider adding the relevant header to
                          all requests in the preSend method.
    apiKey              - If API key authentication is used, the key can be supplied here. 
                          Note the key is only used if operations are called for which
                          the API explicitly specified that API key authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require API key authentication, consider adding the API key to all
                          requests in the preSend method.
    httpCredentials     - If Basic or Digest authentication is supported username/password
                          credentials can be supplied here as matlab.net.http.Credentials. Note 
                          these are only actively used if operations are called for which the 
                          API spec has specified they require Basic authentication. If this has
                          not been specified in the spec but most operations do require
                          Basic authentication, consider setting the Credentials property in the
                          httpOptions rather than through httpCredentials.
    cookies             - Cookie jar. The cookie jar is shared across all Api classes in the 
                          same package. All responses are automatically parsed for Set-Cookie
                          headers and cookies are automatically added to the jar. Similarly
                          cookies are added to outgoing requests if there are matching cookies 
                          in the jar for the given request. Cookies can also be added manually
                          by calling the setCookies method on the cookies property. The cookie
                          jar is also saved to disk (cookies.mat in the same directory as 
                          BaseClient) and reloaded in new MATLAB sessions.
 
  PrivateEndpointConnections Methods:
 
    PrivateEndpointConnections - Constructor
    privateEndpointConnectionsCreateOrUpdate - 
    privateEndpointConnectionsDelete - 
    privateEndpointConnectionsGet - 
    privateEndpointConnectionsList - 
 
  See Also: matlab.net.http.HTTPOptions, matlab.net.http.Credentials, 
    CookieJar.setCookies, control.BaseClient

adx.control.api.PrivateEndpointConnections.PrivateEndpointConnections

PrivateEndpointConnections Constructor, creates a PrivateEndpointConnections instance.
  When called without inputs, tries to load configuration
  options from JSON file 'adx.Client.Settings.json'.
  If this file is not present, the instance is initialized with 
  default configuration option. An alternative configuration 
  file can be provided through the "configFile" Name-Value pair.
  All other properties of the instance can also be overridden 
  using Name-Value pairs where Name equals the property name.
  
  Examples:
 
    % Create a client with default options and serverUri
    % as parsed from OpenAPI spec (if available)
    client = adx.control.api.PrivateEndpointConnections();
 
    % Create a client for alternative server/base URI
    client = adx.control.api.PrivateEndpointConnections("serverUri","https://example.com:1234/api/");
 
    % Create a client loading configuration options from 
    % JSON configuration file
    client = adx.control.api.PrivateEndpointConnections("configFile","myconfig.json");
 
    % Create a client with alternative HTTPOptions and an API key
    client = adx.control.api.PrivateEndpointConnections("httpOptions",...
        matlab.net.http.HTTPOptions("ConnectTimeout",42),...
        "apiKey", "ABC123");

adx.control.api.PrivateEndpointConnections.privateEndpointConnectionsCreateOrUpdate

privateEndpointConnectionsCreateOrUpdate No summary provided
  Approve or reject a private endpoint connection with a given name.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    privateEndpointConnectionName - The name of the private endpoint connection., Type: string
    api_version - The API version to use for this operation., Type: string
    PrivateEndpointConnection - No description provided, Type: PrivateEndpointConnection
        Required properties in the model for this call:
        Optional properties in the model for this call:
            xproperties
            systemData
 
  No optional parameters
 
  Responses:
    200: Successfully approved or rejected private endpoint connection.
    201: Accepted. The private endpoint connection update will complete asynchronously.
    0: Error response describing why the operation failed.
 
  Returns: PrivateEndpointConnection
 
  See Also: adx.control.models.PrivateEndpointConnection

adx.control.api.PrivateEndpointConnections.privateEndpointConnectionsDelete

privateEndpointConnectionsDelete No summary provided
  Deletes a private endpoint connection with a given name.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    privateEndpointConnectionName - The name of the private endpoint connection., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully deleted the private endpoint connection.
    202: Accepted. The private endpoint connection delete will complete asynchronously.
    204: Private endpoint connection does not exist.
    0: Error response describing why the operation failed.
 
  Returns: 
 
  See Also: adx.control.models.

adx.control.api.PrivateEndpointConnections.privateEndpointConnectionsGet

privateEndpointConnectionsGet No summary provided
  Gets a private endpoint connection.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    privateEndpointConnectionName - The name of the private endpoint connection., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully retrieved a specified private endpoint connection.
    0: Error response describing why the operation failed.
 
  Returns: PrivateEndpointConnection
 
  See Also: adx.control.models.PrivateEndpointConnection

adx.control.api.PrivateEndpointConnections.privateEndpointConnectionsList

privateEndpointConnectionsList No summary provided
  Returns the list of private endpoint connections.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: The list result of private endpoint connections.
    0: Error response describing why the operation failed.
 
  Returns: PrivateEndpointConnectionListResult
 
  See Also: adx.control.models.PrivateEndpointConnectionListResult

adx.control.api.PrivateLinkResources

Superclass: adx.control.BaseClient

PrivateLinkResources No description provided
 
  PrivateLinkResources Properties:
 
    serverUri           - Base URI to use when calling the API. Allows using a different server
                          than specified in the original API spec.
    httpOptions         - HTTPOptions used by all requests.
    preferredAuthMethod - If operation supports multiple authentication methods, specified which
                          method to prefer.
    bearerToken         - If Bearer token authentication is used, the token can be supplied 
                          here. Note the token is only used if operations are called for which
                          the API explicitly specified that Bearer authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require Bearer authentication, consider adding the relevant header to
                          all requests in the preSend method.
    apiKey              - If API key authentication is used, the key can be supplied here. 
                          Note the key is only used if operations are called for which
                          the API explicitly specified that API key authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require API key authentication, consider adding the API key to all
                          requests in the preSend method.
    httpCredentials     - If Basic or Digest authentication is supported username/password
                          credentials can be supplied here as matlab.net.http.Credentials. Note 
                          these are only actively used if operations are called for which the 
                          API spec has specified they require Basic authentication. If this has
                          not been specified in the spec but most operations do require
                          Basic authentication, consider setting the Credentials property in the
                          httpOptions rather than through httpCredentials.
    cookies             - Cookie jar. The cookie jar is shared across all Api classes in the 
                          same package. All responses are automatically parsed for Set-Cookie
                          headers and cookies are automatically added to the jar. Similarly
                          cookies are added to outgoing requests if there are matching cookies 
                          in the jar for the given request. Cookies can also be added manually
                          by calling the setCookies method on the cookies property. The cookie
                          jar is also saved to disk (cookies.mat in the same directory as 
                          BaseClient) and reloaded in new MATLAB sessions.
 
  PrivateLinkResources Methods:
 
    PrivateLinkResources - Constructor
    privateLinkResourcesGet - 
    privateLinkResourcesList - 
 
  See Also: matlab.net.http.HTTPOptions, matlab.net.http.Credentials, 
    CookieJar.setCookies, control.BaseClient

adx.control.api.PrivateLinkResources.PrivateLinkResources

PrivateLinkResources Constructor, creates a PrivateLinkResources instance.
  When called without inputs, tries to load configuration
  options from JSON file 'adx.Client.Settings.json'.
  If this file is not present, the instance is initialized with 
  default configuration option. An alternative configuration 
  file can be provided through the "configFile" Name-Value pair.
  All other properties of the instance can also be overridden 
  using Name-Value pairs where Name equals the property name.
  
  Examples:
 
    % Create a client with default options and serverUri
    % as parsed from OpenAPI spec (if available)
    client = adx.control.api.PrivateLinkResources();
 
    % Create a client for alternative server/base URI
    client = adx.control.api.PrivateLinkResources("serverUri","https://example.com:1234/api/");
 
    % Create a client loading configuration options from 
    % JSON configuration file
    client = adx.control.api.PrivateLinkResources("configFile","myconfig.json");
 
    % Create a client with alternative HTTPOptions and an API key
    client = adx.control.api.PrivateLinkResources("httpOptions",...
        matlab.net.http.HTTPOptions("ConnectTimeout",42),...
        "apiKey", "ABC123");

adx.control.api.PrivateLinkResources.privateLinkResourcesGet

privateLinkResourcesGet No summary provided
  Gets a private link resource.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    privateLinkResourceName - The name of the private link resource., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully retrieved a specified private link resource.
    0: Error response describing why the operation failed.
 
  Returns: PrivateLinkResource
 
  See Also: adx.control.models.PrivateLinkResource

adx.control.api.PrivateLinkResources.privateLinkResourcesList

privateLinkResourcesList No summary provided
  Returns the list of private link resources.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: Successfully retrieved private link resources.
    0: Error response describing why the operation failed.
 
  Returns: PrivateLinkResourceListResult
 
  See Also: adx.control.models.PrivateLinkResourceListResult

adx.control.api.Scripts

Superclass: adx.control.BaseClient

Scripts No description provided
 
  Scripts Properties:
 
    serverUri           - Base URI to use when calling the API. Allows using a different server
                          than specified in the original API spec.
    httpOptions         - HTTPOptions used by all requests.
    preferredAuthMethod - If operation supports multiple authentication methods, specified which
                          method to prefer.
    bearerToken         - If Bearer token authentication is used, the token can be supplied 
                          here. Note the token is only used if operations are called for which
                          the API explicitly specified that Bearer authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require Bearer authentication, consider adding the relevant header to
                          all requests in the preSend method.
    apiKey              - If API key authentication is used, the key can be supplied here. 
                          Note the key is only used if operations are called for which
                          the API explicitly specified that API key authentication is supported.
                          If this has not been specified in the spec but most operations do 
                          require API key authentication, consider adding the API key to all
                          requests in the preSend method.
    httpCredentials     - If Basic or Digest authentication is supported username/password
                          credentials can be supplied here as matlab.net.http.Credentials. Note 
                          these are only actively used if operations are called for which the 
                          API spec has specified they require Basic authentication. If this has
                          not been specified in the spec but most operations do require
                          Basic authentication, consider setting the Credentials property in the
                          httpOptions rather than through httpCredentials.
    cookies             - Cookie jar. The cookie jar is shared across all Api classes in the 
                          same package. All responses are automatically parsed for Set-Cookie
                          headers and cookies are automatically added to the jar. Similarly
                          cookies are added to outgoing requests if there are matching cookies 
                          in the jar for the given request. Cookies can also be added manually
                          by calling the setCookies method on the cookies property. The cookie
                          jar is also saved to disk (cookies.mat in the same directory as 
                          BaseClient) and reloaded in new MATLAB sessions.
 
  Scripts Methods:
 
    Scripts - Constructor
    scriptsListByDatabase - 
 
  See Also: matlab.net.http.HTTPOptions, matlab.net.http.Credentials, 
    CookieJar.setCookies, control.BaseClient

adx.control.api.Scripts.Scripts

Scripts Constructor, creates a Scripts instance.
  When called without inputs, tries to load configuration
  options from JSON file 'adx.Client.Settings.json'.
  If this file is not present, the instance is initialized with 
  default configuration option. An alternative configuration 
  file can be provided through the "configFile" Name-Value pair.
  All other properties of the instance can also be overridden 
  using Name-Value pairs where Name equals the property name.
  
  Examples:
 
    % Create a client with default options and serverUri
    % as parsed from OpenAPI spec (if available)
    client = adx.control.api.Scripts();
 
    % Create a client for alternative server/base URI
    client = adx.control.api.Scripts("serverUri","https://example.com:1234/api/");
 
    % Create a client loading configuration options from 
    % JSON configuration file
    client = adx.control.api.Scripts("configFile","myconfig.json");
 
    % Create a client with alternative HTTPOptions and an API key
    client = adx.control.api.Scripts("httpOptions",...
        matlab.net.http.HTTPOptions("ConnectTimeout",42),...
        "apiKey", "ABC123");

adx.control.api.Scripts.scriptsListByDatabase

scriptsListByDatabase No summary provided
  Returns the list of database scripts for given database.
 
  Required parameters:
    subscriptionId - The ID of the target subscription., Type: string
    resourceGroupName - The name of the resource group. The name is case insensitive., Type: string
    clusterName - The name of the Kusto cluster., Type: string
    databaseName - The name of the database in the Kusto cluster., Type: string
    api_version - The API version to use for this operation., Type: string
 
  No optional parameters
 
  Responses:
    200: The list result of Kusto database scripts.
    0: Error response describing why the operation failed.
 
  Returns: ScriptListResult
 
  See Also: adx.control.models.ScriptListResult

adx.control.models

adx.control.models.AcceptedAudiences

Superclass: adx.control.JSONMapper

AcceptedAudiences Represents an accepted audience trusted by the cluster.
  
  AcceptedAudiences Properties:
    value - GUID or valid URL representing an accepted audience. - type: string

adx.control.models.AcceptedAudiences.AcceptedAudiences

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.AttachedDatabaseConfiDefaultPrincipalsModificationKindEnum_0000

Superclass: adx.control.JSONEnum

AttachedDatabaseConfiDefaultPrincipalsModificationKindEnum_0000 No description provided

Enumeration values:
  Union
  Replace
  None

adx.control.models.AttachedDatabaseConfiDefaultPrincipalsModificationKindEnum_0000.AttachedDatabaseConfiDefaultPrincipalsModificationKindEnum_0000

AttachedDatabaseConfiDefaultPrincipalsModificationKindEnum_0000 No description provided

adx.control.models.AttachedDatabaseConfiDefaultPrincipalsModificationKindEnum_0001

Superclass: adx.control.JSONEnum

AttachedDatabaseConfiDefaultPrincipalsModificationKindEnum_0001 No description provided

Enumeration values:
  Union
  Replace
  None

adx.control.models.AttachedDatabaseConfiDefaultPrincipalsModificationKindEnum_0001.AttachedDatabaseConfiDefaultPrincipalsModificationKindEnum_0001

AttachedDatabaseConfiDefaultPrincipalsModificationKindEnum_0001 No description provided

adx.control.models.AttachedDatabaseConfiguration

Superclass: adx.control.JSONMapper

AttachedDatabaseConfiguration Class representing an attached database configuration.
  
  AttachedDatabaseConfiguration Properties:
    location - Resource location. - type: string
    xproperties - type: AttachedDatabaseConfigurationProperties_1
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.AttachedDatabaseConfiguration.AttachedDatabaseConfiguration

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.AttachedDatabaseConfigurationListResult

Superclass: adx.control.JSONMapper

AttachedDatabaseConfigurationListResult The list attached database configurations operation response.
  
  AttachedDatabaseConfigurationListResult Properties:
    value - The list of attached database configurations. - type: array of AttachedDatabaseConfiguration

adx.control.models.AttachedDatabaseConfigurationListResult.AttachedDatabaseConfigurationListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.AttachedDatabaseConfigurationProperties

Superclass: adx.control.JSONMapper

AttachedDatabaseConfigurationProperties Class representing the an attached database configuration properties of kind specific.
  
  AttachedDatabaseConfigurationProperties Properties:
    provisioningState - type: ProvisioningState
    databaseName - The name of the database which you would like to attach, use * if you want to follow all current and future databases. - type: string
    clusterResourceId - The resource id of the cluster where the databases you would like to attach reside. - type: string
    attachedDatabaseNames - The list of databases from the clusterResourceId which are currently attached to the cluster. - type: array of string
    defaultPrincipalsModificationKind - The default principals modification kind - type: string
    tableLevelSharingProperties - type: TableLevelSharingProperties
    databaseNameOverride - Overrides the original database name. Relevant only when attaching to a specific database. - type: string
    databaseNamePrefix - Adds a prefix to the attached databases name. When following an entire cluster, that prefix would be added to all of the databases original names from leader cluster. - type: string

adx.control.models.AttachedDatabaseConfigurationProperties.AttachedDatabaseConfigurationProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.AttachedDatabaseConfigurationProperties_1

Superclass: adx.control.JSONMapper

AttachedDatabaseConfigurationProperties_1 Class representing the an attached database configuration properties of kind specific.
  
  AttachedDatabaseConfigurationProperties_1 Properties:
    provisioningState - type: ProvisioningState
    databaseName - The name of the database which you would like to attach, use * if you want to follow all current and future databases. - type: string
    clusterResourceId - The resource id of the cluster where the databases you would like to attach reside. - type: string
    attachedDatabaseNames - The list of databases from the clusterResourceId which are currently attached to the cluster. - type: array of string
    defaultPrincipalsModificationKind - The default principals modification kind - type: string
    tableLevelSharingProperties - type: TableLevelSharingProperties
    databaseNameOverride - Overrides the original database name. Relevant only when attaching to a specific database. - type: string
    databaseNamePrefix - Adds a prefix to the attached databases name. When following an entire cluster, that prefix would be added to all of the databases original names from leader cluster. - type: string

adx.control.models.AttachedDatabaseConfigurationProperties_1.AttachedDatabaseConfigurationProperties_1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.AttachedDatabaseConfigurationsCheckNameRequest

Superclass: adx.control.JSONMapper

AttachedDatabaseConfigurationsCheckNameRequest The result returned from a AttachedDatabaseConfigurations check name availability request.
  
  AttachedDatabaseConfigurationsCheckNameRequest Properties:
    name - Attached database resource name. - type: string
    type - The type of resource, for instance Microsoft.Kusto/clusters/attachedDatabaseConfigurations. - type: string

adx.control.models.AttachedDatabaseConfigurationsCheckNameRequest.AttachedDatabaseConfigurationsCheckNameRequest

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.AttachedDatabaseConfigurationsCheckNameRequestTypeEnum

Superclass: adx.control.JSONEnum

AttachedDatabaseConfigurationsCheckNameRequestTypeEnum No description provided

Enumeration values:
  Microsoft_Kusto_clusters_attachedDatabaseConfigurations

adx.control.models.AttachedDatabaseConfigurationsCheckNameRequestTypeEnum.AttachedDatabaseConfigurationsCheckNameRequestTypeEnum

AttachedDatabaseConfigurationsCheckNameRequestTypeEnum No description provided

adx.control.models.AzureCapacity

Superclass: adx.control.JSONMapper

AzureCapacity Azure capacity definition.
  
  AzureCapacity Properties:
    scaleType - Scale type. - type: string
    minimum - Minimum allowed capacity. - type: int32
    maximum - Maximum allowed capacity. - type: int32
    default - The default capacity that would be used. - type: int32

adx.control.models.AzureCapacity.AzureCapacity

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.AzureCapacityScaleTypeEnum

Superclass: adx.control.JSONEnum

AzureCapacityScaleTypeEnum No description provided

Enumeration values:
  automatic
  manual
  none

adx.control.models.AzureCapacityScaleTypeEnum.AzureCapacityScaleTypeEnum

AzureCapacityScaleTypeEnum No description provided

adx.control.models.AzureResourceSku

Superclass: adx.control.JSONMapper

AzureResourceSku Azure resource SKU definition.
  
  AzureResourceSku Properties:
    resourceType - Resource Namespace and Type. - type: string
    sku - type: AzureSku
    capacity - type: AzureCapacity

adx.control.models.AzureResourceSku.AzureResourceSku

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.AzureResourceSku_1

Superclass: adx.control.JSONMapper

AzureResourceSku_1 Azure resource SKU definition.
  
  AzureResourceSku_1 Properties:
    resourceType - Resource Namespace and Type. - type: string
    sku - type: AzureSku
    capacity - type: AzureCapacity

adx.control.models.AzureResourceSku_1.AzureResourceSku_1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.AzureSku

Superclass: adx.control.JSONMapper

AzureSku Azure SKU definition.
  
  AzureSku Properties:
    name - SKU name. - type: string
    capacity - The number of instances of the cluster. - type: int32
    tier - SKU tier. - type: string

adx.control.models.AzureSku.AzureSku

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.AzureSkuNameEnum

Superclass: adx.control.JSONEnum

AzureSkuNameEnum No description provided

Enumeration values:
  Dev_No_SLA_Standard_D11_v2
  Dev_No_SLA_Standard_E2a_v4
  Standard_D11_v2
  Standard_D12_v2
  Standard_D13_v2
  Standard_D14_v2
  Standard_D32d_v4
  Standard_D16d_v5
  Standard_D32d_v5
  Standard_DS13_v21TB_PS
  Standard_DS13_v22TB_PS
  Standard_DS14_v23TB_PS
  Standard_DS14_v24TB_PS
  Standard_L4s
  Standard_L8s
  Standard_L16s
  Standard_L8s_v2
  Standard_L16s_v2
  Standard_L8s_v3
  Standard_L16s_v3
  Standard_L32s_v3
  Standard_L8as_v3
  Standard_L16as_v3
  Standard_L32as_v3
  Standard_E64i_v3
  Standard_E80ids_v4
  Standard_E2a_v4
  Standard_E4a_v4
  Standard_E8a_v4
  Standard_E16a_v4
  Standard_E8as_v41TB_PS
  Standard_E8as_v42TB_PS
  Standard_E16as_v43TB_PS
  Standard_E16as_v44TB_PS
  Standard_E8as_v51TB_PS
  Standard_E8as_v52TB_PS
  Standard_E16as_v53TB_PS
  Standard_E16as_v54TB_PS
  Standard_E2ads_v5
  Standard_E4ads_v5
  Standard_E8ads_v5
  Standard_E16ads_v5
  Standard_EC8as_v51TB_PS
  Standard_EC8as_v52TB_PS
  Standard_EC16as_v53TB_PS
  Standard_EC16as_v54TB_PS
  Standard_EC8ads_v5
  Standard_EC16ads_v5
  Standard_E8s_v41TB_PS
  Standard_E8s_v42TB_PS
  Standard_E16s_v43TB_PS
  Standard_E16s_v44TB_PS
  Standard_E8s_v51TB_PS
  Standard_E8s_v52TB_PS
  Standard_E16s_v53TB_PS
  Standard_E16s_v54TB_PS
  Standard_E2d_v4
  Standard_E4d_v4
  Standard_E8d_v4
  Standard_E16d_v4
  Standard_E2d_v5
  Standard_E4d_v5
  Standard_E8d_v5
  Standard_E16d_v5

adx.control.models.AzureSkuNameEnum.AzureSkuNameEnum

AzureSkuNameEnum No description provided

adx.control.models.AzureSkuTierEnum

Superclass: adx.control.JSONEnum

AzureSkuTierEnum No description provided

Enumeration values:
  Basic
  Standard

adx.control.models.AzureSkuTierEnum.AzureSkuTierEnum

AzureSkuTierEnum No description provided

adx.control.models.BlobStorageEventType

Superclass: adx.control.JSONEnum

BlobStorageEventType The name of blob storage event type to process.

Enumeration values:
  Microsoft_Storage_BlobCreated
  Microsoft_Storage_BlobRenamed

adx.control.models.BlobStorageEventType.BlobStorageEventType

BlobStorageEventType The name of blob storage event type to process.

adx.control.models.CheckNameRequest

Superclass: adx.control.JSONMapper

CheckNameRequest The result returned from a database check name availability request.
  
  CheckNameRequest Properties:
    name - Resource name. - type: string
    type - The type of resource, for instance Microsoft.Kusto/clusters/databases. - type: string

adx.control.models.CheckNameRequest.CheckNameRequest

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.CheckNameRequestTypeEnum

Superclass: adx.control.JSONEnum

CheckNameRequestTypeEnum No description provided

Enumeration values:
  Microsoft_Kusto_clusters_databases
  Microsoft_Kusto_clusters_attachedDatabaseConfigurations

adx.control.models.CheckNameRequestTypeEnum.CheckNameRequestTypeEnum

CheckNameRequestTypeEnum No description provided

adx.control.models.CheckNameResult

Superclass: adx.control.JSONMapper

CheckNameResult The result returned from a check name availability request.
  
  CheckNameResult Properties:
    nameAvailable - Specifies a Boolean value that indicates if the name is available. - type: logical
    name - The name that was checked. - type: string
    message - Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated. - type: string
    reason - Message providing the reason why the given name is invalid. - type: string

adx.control.models.CheckNameResult.CheckNameResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.CheckNameResultReasonEnum

Superclass: adx.control.JSONEnum

CheckNameResultReasonEnum No description provided

Enumeration values:
  Invalid
  AlreadyExists

adx.control.models.CheckNameResultReasonEnum.CheckNameResultReasonEnum

CheckNameResultReasonEnum No description provided

adx.control.models.Cluster

Superclass: adx.control.JSONMapper

Cluster Class representing a Kusto cluster.
  
  Cluster Properties:
    sku - type: AzureSku
    systemData - type: systemData
    zones - An array represents the availability zones of the cluster. - type: array of string
    identity - type: Identity
    xproperties - type: ClusterProperties_1
    etag - A unique read-only string that changes whenever the resource is updated. - type: string
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.Cluster.Cluster

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ClusterCheckNameRequest

Superclass: adx.control.JSONMapper

ClusterCheckNameRequest The result returned from a cluster check name availability request.
  
  ClusterCheckNameRequest Properties:
    name - Cluster name. - type: string
    type - The type of resource, Microsoft.Kusto/clusters. - type: string

adx.control.models.ClusterCheckNameRequest.ClusterCheckNameRequest

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ClusterCheckNameRequestTypeEnum

Superclass: adx.control.JSONEnum

ClusterCheckNameRequestTypeEnum No description provided

Enumeration values:
  Microsoft_Kusto_clusters

adx.control.models.ClusterCheckNameRequestTypeEnum.ClusterCheckNameRequestTypeEnum

ClusterCheckNameRequestTypeEnum No description provided

adx.control.models.ClusterListResult

Superclass: adx.control.JSONMapper

ClusterListResult The list Kusto clusters operation response.
  
  ClusterListResult Properties:
    value - The list of Kusto clusters. - type: array of Cluster

adx.control.models.ClusterListResult.ClusterListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ClusterMigrateRequest

Superclass: adx.control.JSONMapper

ClusterMigrateRequest A cluster migrate request.
  
  ClusterMigrateRequest Properties:
    clusterResourceId - Resource ID of the destination cluster or kusto pool. - type: string

adx.control.models.ClusterMigrateRequest.ClusterMigrateRequest

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ClusterPrincipalAssignment

Superclass: adx.control.JSONMapper

ClusterPrincipalAssignment Class representing a cluster principal assignment.
  
  ClusterPrincipalAssignment Properties:
    xproperties - type: ClusterPrincipalProperties_1
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.ClusterPrincipalAssignment.ClusterPrincipalAssignment

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ClusterPrincipalAssignmentCheckNameRequest

Superclass: adx.control.JSONMapper

ClusterPrincipalAssignmentCheckNameRequest A principal assignment check name availability request.
  
  ClusterPrincipalAssignmentCheckNameRequest Properties:
    name - Principal Assignment resource name. - type: string
    type - The type of resource, Microsoft.Kusto/clusters/principalAssignments. - type: string

adx.control.models.ClusterPrincipalAssignmentCheckNameRequest.ClusterPrincipalAssignmentCheckNameRequest

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ClusterPrincipalAssignmentCheckNameRequestTypeEnum

Superclass: adx.control.JSONEnum

ClusterPrincipalAssignmentCheckNameRequestTypeEnum No description provided

Enumeration values:
  Microsoft_Kusto_clusters_principalAssignments

adx.control.models.ClusterPrincipalAssignmentCheckNameRequestTypeEnum.ClusterPrincipalAssignmentCheckNameRequestTypeEnum

ClusterPrincipalAssignmentCheckNameRequestTypeEnum No description provided

adx.control.models.ClusterPrincipalAssignmentListResult

Superclass: adx.control.JSONMapper

ClusterPrincipalAssignmentListResult The list Kusto cluster principal assignments operation response.
  
  ClusterPrincipalAssignmentListResult Properties:
    value - The list of Kusto cluster principal assignments. - type: array of ClusterPrincipalAssignment

adx.control.models.ClusterPrincipalAssignmentListResult.ClusterPrincipalAssignmentListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ClusterPrincipalProperties

Superclass: adx.control.JSONMapper

ClusterPrincipalProperties A class representing cluster principal property.
  
  ClusterPrincipalProperties Properties:
    principalId - The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. - type: string
    role - Cluster principal role. - type: string
    tenantId - The tenant id of the principal - type: string
    principalType - Principal type. - type: string
    tenantName - The tenant name of the principal - type: string
    principalName - The principal name - type: string
    provisioningState - type: ProvisioningState
    aadObjectId - The service principal object id in AAD (Azure active directory) - type: string

adx.control.models.ClusterPrincipalProperties.ClusterPrincipalProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ClusterPrincipalPropertiesPrincipalTypeEnum

Superclass: adx.control.JSONEnum

ClusterPrincipalPropertiesPrincipalTypeEnum No description provided

Enumeration values:
  App
  Group
  User

adx.control.models.ClusterPrincipalPropertiesPrincipalTypeEnum.ClusterPrincipalPropertiesPrincipalTypeEnum

ClusterPrincipalPropertiesPrincipalTypeEnum No description provided

adx.control.models.ClusterPrincipalPropertiesRoleEnum

Superclass: adx.control.JSONEnum

ClusterPrincipalPropertiesRoleEnum No description provided

Enumeration values:
  AllDatabasesAdmin
  AllDatabasesViewer

adx.control.models.ClusterPrincipalPropertiesRoleEnum.ClusterPrincipalPropertiesRoleEnum

ClusterPrincipalPropertiesRoleEnum No description provided

adx.control.models.ClusterPrincipalProperties_1

Superclass: adx.control.JSONMapper

ClusterPrincipalProperties_1 A class representing cluster principal property.
  
  ClusterPrincipalProperties_1 Properties:
    principalId - The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. - type: string
    role - Cluster principal role. - type: string
    tenantId - The tenant id of the principal - type: string
    principalType - Principal type. - type: string
    tenantName - The tenant name of the principal - type: string
    principalName - The principal name - type: string
    provisioningState - type: ProvisioningState
    aadObjectId - The service principal object id in AAD (Azure active directory) - type: string

adx.control.models.ClusterPrincipalProperties_1.ClusterPrincipalProperties_1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ClusterPrincipalProperties_1PrincipalTypeEnum

Superclass: adx.control.JSONEnum

ClusterPrincipalProperties_1PrincipalTypeEnum No description provided

Enumeration values:
  App
  Group
  User

adx.control.models.ClusterPrincipalProperties_1PrincipalTypeEnum.ClusterPrincipalProperties_1PrincipalTypeEnum

ClusterPrincipalProperties_1PrincipalTypeEnum No description provided

adx.control.models.ClusterPrincipalProperties_1RoleEnum

Superclass: adx.control.JSONEnum

ClusterPrincipalProperties_1RoleEnum No description provided

Enumeration values:
  AllDatabasesAdmin
  AllDatabasesViewer

adx.control.models.ClusterPrincipalProperties_1RoleEnum.ClusterPrincipalProperties_1RoleEnum

ClusterPrincipalProperties_1RoleEnum No description provided

adx.control.models.ClusterProperties

Superclass: adx.control.JSONMapper

ClusterProperties Class representing the Kusto cluster properties.
  
  ClusterProperties Properties:
    state - The state of the resource. - type: string
    provisioningState - type: ProvisioningState
    uri - The cluster URI. - type: string
    dataIngestionUri - The cluster data ingestion URI. - type: string
    stateReason - The reason for the cluster''s current state. - type: string
    trustedExternalTenants - The cluster''s external tenants. - type: array of TrustedExternalTenant
    optimizedAutoscale - type: OptimizedAutoscale
    enableDiskEncryption - A boolean value that indicates if the cluster''s disks are encrypted. - type: logical
    enableStreamingIngest - A boolean value that indicates if the streaming ingest is enabled. - type: logical
    virtualNetworkConfiguration - type: VirtualNetworkConfiguration
    keyVaultProperties - type: KeyVaultProperties
    enablePurge - A boolean value that indicates if the purge operations are enabled. - type: logical
    languageExtensions - type: LanguageExtensionsList
    enableDoubleEncryption - A boolean value that indicates if double encryption is enabled. - type: logical
    publicNetworkAccess - Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed - type: string
    allowedIpRangeList - The list of ips in the format of CIDR allowed to connect to the cluster. - type: array of string
    engineType - The engine type - type: string
    acceptedAudiences - The cluster''s accepted audiences. - type: array of AcceptedAudiences
    enableAutoStop - A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days). - type: logical
    restrictOutboundNetworkAccess - Whether or not to restrict outbound network access.  Value is optional but if passed in, must be ''Enabled'' or ''Disabled'' - type: string
    allowedFqdnList - List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster. - type: array of string
    publicIPType - Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6) - type: string
    virtualClusterGraduationProperties - Virtual Cluster graduation properties - type: string
    privateEndpointConnections - A list of private endpoint connections. - type: array of PrivateEndpointConnection
    migrationCluster - type: MigrationClusterProperties

adx.control.models.ClusterProperties.ClusterProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ClusterPropertiesEngineTypeEnum

Superclass: adx.control.JSONEnum

ClusterPropertiesEngineTypeEnum No description provided

Enumeration values:
  V2
  V3

adx.control.models.ClusterPropertiesEngineTypeEnum.ClusterPropertiesEngineTypeEnum

ClusterPropertiesEngineTypeEnum No description provided

adx.control.models.ClusterPropertiesPublicIPTypeEnum

Superclass: adx.control.JSONEnum

ClusterPropertiesPublicIPTypeEnum No description provided

Enumeration values:
  IPv4
  DualStack

adx.control.models.ClusterPropertiesPublicIPTypeEnum.ClusterPropertiesPublicIPTypeEnum

ClusterPropertiesPublicIPTypeEnum No description provided

adx.control.models.ClusterPropertiesPublicNetworkAccessEnum

Superclass: adx.control.JSONEnum

ClusterPropertiesPublicNetworkAccessEnum No description provided

Enumeration values:
  Enabled
  Disabled

adx.control.models.ClusterPropertiesPublicNetworkAccessEnum.ClusterPropertiesPublicNetworkAccessEnum

ClusterPropertiesPublicNetworkAccessEnum No description provided

adx.control.models.ClusterPropertiesRestrictOutboundNetworkAccessEnum

Superclass: adx.control.JSONEnum

ClusterPropertiesRestrictOutboundNetworkAccessEnum No description provided

Enumeration values:
  Enabled
  Disabled

adx.control.models.ClusterPropertiesRestrictOutboundNetworkAccessEnum.ClusterPropertiesRestrictOutboundNetworkAccessEnum

ClusterPropertiesRestrictOutboundNetworkAccessEnum No description provided

adx.control.models.ClusterPropertiesStateEnum

Superclass: adx.control.JSONEnum

ClusterPropertiesStateEnum No description provided

Enumeration values:
  Creating
  Unavailable
  Running
  Deleting
  Deleted
  Stopping
  Stopped
  Starting
  Updating
  Migrated

adx.control.models.ClusterPropertiesStateEnum.ClusterPropertiesStateEnum

ClusterPropertiesStateEnum No description provided

adx.control.models.ClusterProperties_1

Superclass: adx.control.JSONMapper

ClusterProperties_1 Class representing the Kusto cluster properties.
  
  ClusterProperties_1 Properties:
    state - The state of the resource. - type: string
    provisioningState - type: ProvisioningState
    uri - The cluster URI. - type: string
    dataIngestionUri - The cluster data ingestion URI. - type: string
    stateReason - The reason for the cluster''s current state. - type: string
    trustedExternalTenants - The cluster''s external tenants. - type: array of TrustedExternalTenant
    optimizedAutoscale - type: OptimizedAutoscale
    enableDiskEncryption - A boolean value that indicates if the cluster''s disks are encrypted. - type: logical
    enableStreamingIngest - A boolean value that indicates if the streaming ingest is enabled. - type: logical
    virtualNetworkConfiguration - type: VirtualNetworkConfiguration
    keyVaultProperties - type: KeyVaultProperties
    enablePurge - A boolean value that indicates if the purge operations are enabled. - type: logical
    languageExtensions - type: LanguageExtensionsList
    enableDoubleEncryption - A boolean value that indicates if double encryption is enabled. - type: logical
    publicNetworkAccess - Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed - type: string
    allowedIpRangeList - The list of ips in the format of CIDR allowed to connect to the cluster. - type: array of string
    engineType - The engine type - type: string
    acceptedAudiences - The cluster''s accepted audiences. - type: array of AcceptedAudiences
    enableAutoStop - A boolean value that indicates if the cluster could be automatically stopped (due to lack of data or no activity for many days). - type: logical
    restrictOutboundNetworkAccess - Whether or not to restrict outbound network access.  Value is optional but if passed in, must be ''Enabled'' or ''Disabled'' - type: string
    allowedFqdnList - List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster. - type: array of string
    publicIPType - Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6) - type: string
    virtualClusterGraduationProperties - Virtual Cluster graduation properties - type: string
    privateEndpointConnections - A list of private endpoint connections. - type: array of PrivateEndpointConnection
    migrationCluster - type: MigrationClusterProperties

adx.control.models.ClusterProperties_1.ClusterProperties_1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ClusterProperties_1EngineTypeEnum

Superclass: adx.control.JSONEnum

ClusterProperties_1EngineTypeEnum No description provided

Enumeration values:
  V2
  V3

adx.control.models.ClusterProperties_1EngineTypeEnum.ClusterProperties_1EngineTypeEnum

ClusterProperties_1EngineTypeEnum No description provided

adx.control.models.ClusterProperties_1PublicIPTypeEnum

Superclass: adx.control.JSONEnum

ClusterProperties_1PublicIPTypeEnum No description provided

Enumeration values:
  IPv4
  DualStack

adx.control.models.ClusterProperties_1PublicIPTypeEnum.ClusterProperties_1PublicIPTypeEnum

ClusterProperties_1PublicIPTypeEnum No description provided

adx.control.models.ClusterProperties_1PublicNetworkAccessEnum

Superclass: adx.control.JSONEnum

ClusterProperties_1PublicNetworkAccessEnum No description provided

Enumeration values:
  Enabled
  Disabled

adx.control.models.ClusterProperties_1PublicNetworkAccessEnum.ClusterProperties_1PublicNetworkAccessEnum

ClusterProperties_1PublicNetworkAccessEnum No description provided

adx.control.models.ClusterProperties_1RestrictOutboundNetworkAccessEnum

Superclass: adx.control.JSONEnum

ClusterProperties_1RestrictOutboundNetworkAccessEnum No description provided

Enumeration values:
  Enabled
  Disabled

adx.control.models.ClusterProperties_1RestrictOutboundNetworkAccessEnum.ClusterProperties_1RestrictOutboundNetworkAccessEnum

ClusterProperties_1RestrictOutboundNetworkAccessEnum No description provided

adx.control.models.ClusterProperties_1StateEnum

Superclass: adx.control.JSONEnum

ClusterProperties_1StateEnum No description provided

Enumeration values:
  Creating
  Unavailable
  Running
  Deleting
  Deleted
  Stopping
  Stopped
  Starting
  Updating
  Migrated

adx.control.models.ClusterProperties_1StateEnum.ClusterProperties_1StateEnum

ClusterProperties_1StateEnum No description provided

adx.control.models.ClusterUpdate

Superclass: adx.control.JSONMapper

ClusterUpdate Class representing an update to a Kusto cluster.
  
  ClusterUpdate Properties:
    tags - Resource tags. - type: adx.control.JSONMapperMap
    location - Resource location. - type: string
    sku - type: AzureSku
    identity - type: Identity
    xproperties - type: ClusterProperties_1
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.ClusterUpdate.ClusterUpdate

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.Compression

Superclass: adx.control.JSONEnum

Compression The compression type

Enumeration values:
  None
  GZip

adx.control.models.Compression.Compression

Compression The compression type

adx.control.models.CosmosDbDataConnection

Superclass: adx.control.JSONMapper

CosmosDbDataConnection Class representing a CosmosDb data connection.
  
  CosmosDbDataConnection Properties:
    xproperties - type: CosmosDbDataConnectionProperties_1
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.CosmosDbDataConnection.CosmosDbDataConnection

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.CosmosDbDataConnectionProperties

Superclass: adx.control.JSONMapper

CosmosDbDataConnectionProperties Class representing the Kusto CosmosDb data connection properties.
  
  CosmosDbDataConnectionProperties Properties:
    tableName - The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table. - type: string
    mappingRuleName - The name of an existing mapping rule to use when ingesting the retrieved data. - type: string
    managedIdentityResourceId - The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB. - type: string
    managedIdentityObjectId - The object ID of the managed identity resource. - type: string
    cosmosDbAccountResourceId - The resource ID of the Cosmos DB account used to create the data connection. - type: string
    cosmosDbDatabase - The name of an existing database in the Cosmos DB account. - type: string
    cosmosDbContainer - The name of an existing container in the Cosmos DB database. - type: string
    retrievalStartDate - Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date. - type: datetime
    provisioningState - type: ProvisioningState

adx.control.models.CosmosDbDataConnectionProperties.CosmosDbDataConnectionProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.CosmosDbDataConnectionProperties_1

Superclass: adx.control.JSONMapper

CosmosDbDataConnectionProperties_1 Class representing the Kusto CosmosDb data connection properties.
  
  CosmosDbDataConnectionProperties_1 Properties:
    tableName - The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table. - type: string
    mappingRuleName - The name of an existing mapping rule to use when ingesting the retrieved data. - type: string
    managedIdentityResourceId - The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB. - type: string
    managedIdentityObjectId - The object ID of the managed identity resource. - type: string
    cosmosDbAccountResourceId - The resource ID of the Cosmos DB account used to create the data connection. - type: string
    cosmosDbDatabase - The name of an existing database in the Cosmos DB account. - type: string
    cosmosDbContainer - The name of an existing container in the Cosmos DB database. - type: string
    retrievalStartDate - Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date. - type: datetime
    provisioningState - type: ProvisioningState

adx.control.models.CosmosDbDataConnectionProperties_1.CosmosDbDataConnectionProperties_1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DataConnection

Superclass: adx.control.JSONMapper

DataConnection Class representing an data connection.
  
  DataConnection Properties:
    location - Resource location. - type: string
    kind - Kind of the endpoint for the data connection - type: string
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.DataConnection.DataConnection

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DataConnectionCheckNameRequest

Superclass: adx.control.JSONMapper

DataConnectionCheckNameRequest A data connection check name availability request.
  
  DataConnectionCheckNameRequest Properties:
    name - Data Connection name. - type: string
    type - The type of resource, Microsoft.Kusto/clusters/databases/dataConnections. - type: string

adx.control.models.DataConnectionCheckNameRequest.DataConnectionCheckNameRequest

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DataConnectionCheckNameRequestTypeEnum

Superclass: adx.control.JSONEnum

DataConnectionCheckNameRequestTypeEnum No description provided

Enumeration values:
  Microsoft_Kusto_clusters_databases_dataConnections

adx.control.models.DataConnectionCheckNameRequestTypeEnum.DataConnectionCheckNameRequestTypeEnum

DataConnectionCheckNameRequestTypeEnum No description provided

adx.control.models.DataConnectionKindEnum

Superclass: adx.control.JSONEnum

DataConnectionKindEnum No description provided

Enumeration values:
  EventHub
  EventGrid
  IotHub
  CosmosDb

adx.control.models.DataConnectionKindEnum.DataConnectionKindEnum

DataConnectionKindEnum No description provided

adx.control.models.DataConnectionListResult

Superclass: adx.control.JSONMapper

DataConnectionListResult The list Kusto data connections operation response.
  
  DataConnectionListResult Properties:
    value - The list of Kusto data connections. - type: array of DataConnection

adx.control.models.DataConnectionListResult.DataConnectionListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DataConnectionValidation

Superclass: adx.control.JSONMapper

DataConnectionValidation Class representing an data connection validation.
  
  DataConnectionValidation Properties:
    dataConnectionName - The name of the data connection. - type: string
    xproperties - type: DataConnection

adx.control.models.DataConnectionValidation.DataConnectionValidation

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DataConnectionValidationListResult

Superclass: adx.control.JSONMapper

DataConnectionValidationListResult The list Kusto data connection validation result.
  
  DataConnectionValidationListResult Properties:
    value - The list of Kusto data connection validation errors. - type: array of DataConnectionValidationResult

adx.control.models.DataConnectionValidationListResult.DataConnectionValidationListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DataConnectionValidationResult

Superclass: adx.control.JSONMapper

DataConnectionValidationResult The result returned from a data connection validation request.
  
  DataConnectionValidationResult Properties:
    errorMessage - A message which indicates a problem in data connection validation. - type: string

adx.control.models.DataConnectionValidationResult.DataConnectionValidationResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.Database

Superclass: adx.control.JSONMapper

Database Class representing a Kusto database.
  
  Database Properties:
    location - Resource location. - type: string
    kind - Kind of the database - type: string
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.Database.Database

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DatabaseInviteFollowerRequest

Superclass: adx.control.JSONMapper

DatabaseInviteFollowerRequest The request to invite a follower to a database.
  
  DatabaseInviteFollowerRequest Properties:
    inviteeEmail - The email of the invited user for which the follower invitation is generated. - type: string
    tableLevelSharingProperties - type: TableLevelSharingProperties

adx.control.models.DatabaseInviteFollowerRequest.DatabaseInviteFollowerRequest

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DatabaseInviteFollowerResult

Superclass: adx.control.JSONMapper

DatabaseInviteFollowerResult The result returned from a follower invitation generation request.
  
  DatabaseInviteFollowerResult Properties:
    generatedInvitation - The generated invitation token. - type: string

adx.control.models.DatabaseInviteFollowerResult.DatabaseInviteFollowerResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DatabaseKindEnum

Superclass: adx.control.JSONEnum

DatabaseKindEnum No description provided

Enumeration values:
  ReadWrite
  ReadOnlyFollowing

adx.control.models.DatabaseKindEnum.DatabaseKindEnum

DatabaseKindEnum No description provided

adx.control.models.DatabaseListResult

Superclass: adx.control.JSONMapper

DatabaseListResult The list Kusto databases operation response.
  
  DatabaseListResult Properties:
    nextLink - Link to the next page of results - type: string
    value - The list of Kusto databases. - type: array of Database

adx.control.models.DatabaseListResult.DatabaseListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DatabasePrincipal

Superclass: adx.control.JSONMapper

DatabasePrincipal A class representing database principal entity.
  
  DatabasePrincipal Properties:
    role - Database principal role. - type: string
    name - Database principal name. - type: string
    type - Database principal type. - type: string
    fqn - Database principal fully qualified name. - type: string
    email - Database principal email if exists. - type: string
    appId - Application id - relevant only for application principal type. - type: string
    tenantName - The tenant name of the principal - type: string

adx.control.models.DatabasePrincipal.DatabasePrincipal

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DatabasePrincipalAssignment

Superclass: adx.control.JSONMapper

DatabasePrincipalAssignment Class representing a database principal assignment.
  
  DatabasePrincipalAssignment Properties:
    xproperties - type: DatabasePrincipalProperties_1
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.DatabasePrincipalAssignment.DatabasePrincipalAssignment

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DatabasePrincipalAssignmentCheckNameRequest

Superclass: adx.control.JSONMapper

DatabasePrincipalAssignmentCheckNameRequest A principal assignment check name availability request.
  
  DatabasePrincipalAssignmentCheckNameRequest Properties:
    name - Principal Assignment resource name. - type: string
    type - The type of resource, Microsoft.Kusto/clusters/databases/principalAssignments. - type: string

adx.control.models.DatabasePrincipalAssignmentCheckNameRequest.DatabasePrincipalAssignmentCheckNameRequest

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DatabasePrincipalAssignmentCheckNameRequestTypeEnum

Superclass: adx.control.JSONEnum

DatabasePrincipalAssignmentCheckNameRequestTypeEnum No description provided

Enumeration values:
  Microsoft_Kusto_clusters_databases_principalAssignments

adx.control.models.DatabasePrincipalAssignmentCheckNameRequestTypeEnum.DatabasePrincipalAssignmentCheckNameRequestTypeEnum

DatabasePrincipalAssignmentCheckNameRequestTypeEnum No description provided

adx.control.models.DatabasePrincipalAssignmentListResult

Superclass: adx.control.JSONMapper

DatabasePrincipalAssignmentListResult The list Kusto database principal assignments operation response.
  
  DatabasePrincipalAssignmentListResult Properties:
    value - The list of Kusto database principal assignments. - type: array of DatabasePrincipalAssignment

adx.control.models.DatabasePrincipalAssignmentListResult.DatabasePrincipalAssignmentListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DatabasePrincipalListRequest

Superclass: adx.control.JSONMapper

DatabasePrincipalListRequest The list Kusto database principals operation request.
  
  DatabasePrincipalListRequest Properties:
    value - The list of Kusto database principals. - type: array of DatabasePrincipal

adx.control.models.DatabasePrincipalListRequest.DatabasePrincipalListRequest

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DatabasePrincipalListResult

Superclass: adx.control.JSONMapper

DatabasePrincipalListResult The list Kusto database principals operation response.
  
  DatabasePrincipalListResult Properties:
    value - The list of Kusto database principals. - type: array of DatabasePrincipal

adx.control.models.DatabasePrincipalListResult.DatabasePrincipalListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DatabasePrincipalProperties

Superclass: adx.control.JSONMapper

DatabasePrincipalProperties A class representing database principal property.
  
  DatabasePrincipalProperties Properties:
    principalId - The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. - type: string
    role - Database principal role. - type: string
    tenantId - The tenant id of the principal - type: string
    principalType - Principal type. - type: string
    tenantName - The tenant name of the principal - type: string
    principalName - The principal name - type: string
    provisioningState - type: ProvisioningState
    aadObjectId - The service principal object id in AAD (Azure active directory) - type: string

adx.control.models.DatabasePrincipalProperties.DatabasePrincipalProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DatabasePrincipalPropertiesPrincipalTypeEnum

Superclass: adx.control.JSONEnum

DatabasePrincipalPropertiesPrincipalTypeEnum No description provided

Enumeration values:
  App
  Group
  User

adx.control.models.DatabasePrincipalPropertiesPrincipalTypeEnum.DatabasePrincipalPropertiesPrincipalTypeEnum

DatabasePrincipalPropertiesPrincipalTypeEnum No description provided

adx.control.models.DatabasePrincipalPropertiesRoleEnum

Superclass: adx.control.JSONEnum

DatabasePrincipalPropertiesRoleEnum No description provided

Enumeration values:
  Admin
  Ingestor
  Monitor
  User
  UnrestrictedViewer
  Viewer

adx.control.models.DatabasePrincipalPropertiesRoleEnum.DatabasePrincipalPropertiesRoleEnum

DatabasePrincipalPropertiesRoleEnum No description provided

adx.control.models.DatabasePrincipalProperties_1

Superclass: adx.control.JSONMapper

DatabasePrincipalProperties_1 A class representing database principal property.
  
  DatabasePrincipalProperties_1 Properties:
    principalId - The principal ID assigned to the database principal. It can be a user email, application ID, or security group name. - type: string
    role - Database principal role. - type: string
    tenantId - The tenant id of the principal - type: string
    principalType - Principal type. - type: string
    tenantName - The tenant name of the principal - type: string
    principalName - The principal name - type: string
    provisioningState - type: ProvisioningState
    aadObjectId - The service principal object id in AAD (Azure active directory) - type: string

adx.control.models.DatabasePrincipalProperties_1.DatabasePrincipalProperties_1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DatabasePrincipalProperties_1PrincipalTypeEnum

Superclass: adx.control.JSONEnum

DatabasePrincipalProperties_1PrincipalTypeEnum No description provided

Enumeration values:
  App
  Group
  User

adx.control.models.DatabasePrincipalProperties_1PrincipalTypeEnum.DatabasePrincipalProperties_1PrincipalTypeEnum

DatabasePrincipalProperties_1PrincipalTypeEnum No description provided

adx.control.models.DatabasePrincipalProperties_1RoleEnum

Superclass: adx.control.JSONEnum

DatabasePrincipalProperties_1RoleEnum No description provided

Enumeration values:
  Admin
  Ingestor
  Monitor
  User
  UnrestrictedViewer
  Viewer

adx.control.models.DatabasePrincipalProperties_1RoleEnum.DatabasePrincipalProperties_1RoleEnum

DatabasePrincipalProperties_1RoleEnum No description provided

adx.control.models.DatabasePrincipalRoleEnum

Superclass: adx.control.JSONEnum

DatabasePrincipalRoleEnum No description provided

Enumeration values:
  Admin
  Ingestor
  Monitor
  User
  UnrestrictedViewer
  Viewer

adx.control.models.DatabasePrincipalRoleEnum.DatabasePrincipalRoleEnum

DatabasePrincipalRoleEnum No description provided

adx.control.models.DatabasePrincipalTypeEnum

Superclass: adx.control.JSONEnum

DatabasePrincipalTypeEnum No description provided

Enumeration values:
  App
  Group
  User

adx.control.models.DatabasePrincipalTypeEnum.DatabasePrincipalTypeEnum

DatabasePrincipalTypeEnum No description provided

adx.control.models.DatabaseShareOrigin

Superclass: adx.control.JSONEnum

DatabaseShareOrigin The origin of the following setup.

Enumeration values:
  Direct
  DataShare
  Other

adx.control.models.DatabaseShareOrigin.DatabaseShareOrigin

DatabaseShareOrigin The origin of the following setup.

adx.control.models.DatabaseStatistics

Superclass: adx.control.JSONMapper

DatabaseStatistics A class that contains database statistics information.
  
  DatabaseStatistics Properties:
    size - The database size - the total size of compressed data and index in bytes. - type: double

adx.control.models.DatabaseStatistics.DatabaseStatistics

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.DiagnoseVirtualNetworkResult

Superclass: adx.control.JSONMapper

DiagnoseVirtualNetworkResult No description provided
  
  DiagnoseVirtualNetworkResult Properties:
    findings - The list of network connectivity diagnostic finding - type: array of string

adx.control.models.DiagnoseVirtualNetworkResult.DiagnoseVirtualNetworkResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.EndpointDependency

Superclass: adx.control.JSONMapper

EndpointDependency A domain name that a service is reached at, including details of the current connection status.
  
  EndpointDependency Properties:
    domainName - The domain name of the dependency. - type: string
    endpointDetails - The ports used when connecting to DomainName. - type: array of EndpointDetail

adx.control.models.EndpointDependency.EndpointDependency

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.EndpointDetail

Superclass: adx.control.JSONMapper

EndpointDetail Current TCP connectivity information from the Kusto cluster to a single endpoint.
  
  EndpointDetail Properties:
    port - The port an endpoint is connected to. - type: int32

adx.control.models.EndpointDetail.EndpointDetail

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ErrorAdditionalInfo

Superclass: adx.control.JSONMapper

ErrorAdditionalInfo The resource management error additional info.
  
  ErrorAdditionalInfo Properties:
    type - The additional info type. - type: string
    info - The additional info. - type: object

adx.control.models.ErrorAdditionalInfo.ErrorAdditionalInfo

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ErrorAdditionalInfo.disp

DISP Display array.
    DISP(X) displays array X without printing the array name or 
    additional description information such as the size and class name.
    In all other ways it is the same as leaving the semicolon off an
    expression except that nothing is shown for empty arrays.
 
    If X is a string or character array, the text is displayed.
 
    See also formattedDisplayText, sprintf, num2str, format, details.

adx.control.models.ErrorDetail

Superclass: adx.control.JSONMapper

ErrorDetail The error detail.
  
  ErrorDetail Properties:
    code - The error code. - type: string
    message - The error message. - type: string
    target - The error target. - type: string
    details - The error details. - type: array of ErrorDetail
    additionalInfo - The error additional info. - type: array of ErrorAdditionalInfo

adx.control.models.ErrorDetail.ErrorDetail

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ErrorDetail.disp

DISP Display array.
    DISP(X) displays array X without printing the array name or 
    additional description information such as the size and class name.
    In all other ways it is the same as leaving the semicolon off an
    expression except that nothing is shown for empty arrays.
 
    If X is a string or character array, the text is displayed.
 
    See also formattedDisplayText, sprintf, num2str, format, details.

adx.control.models.ErrorResponse

Superclass: adx.control.JSONMapper

ErrorResponse Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
  
  ErrorResponse Properties:
    error - type: ErrorDetail

adx.control.models.ErrorResponse.ErrorResponse

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ErrorResponse.disp

DISP Display array.
    DISP(X) displays array X without printing the array name or 
    additional description information such as the size and class name.
    In all other ways it is the same as leaving the semicolon off an
    expression except that nothing is shown for empty arrays.
 
    If X is a string or character array, the text is displayed.
 
    See also formattedDisplayText, sprintf, num2str, format, details.

adx.control.models.EventGridConnectionProperties

Superclass: adx.control.JSONMapper

EventGridConnectionProperties Class representing the Kusto event grid connection properties.
  
  EventGridConnectionProperties Properties:
    storageAccountResourceId - The resource ID of the storage account where the data resides. - type: string
    eventGridResourceId - The resource ID of the event grid that is subscribed to the storage account events. - type: string
    eventHubResourceId - The resource ID where the event grid is configured to send events. - type: string
    consumerGroup - The event hub consumer group. - type: string
    tableName - The table where the data should be ingested. Optionally the table information can be added to each message. - type: string
    mappingRuleName - The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. - type: string
    dataFormat - type: EventGridDataFormat
    ignoreFirstRecord - A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file - type: logical
    blobStorageEventType - type: BlobStorageEventType
    managedIdentityResourceId - The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub and storage account. - type: string
    managedIdentityObjectId - The object ID of managedIdentityResourceId - type: string
    databaseRouting - Indication for database routing information from the data connection, by default only database routing information is allowed - type: string
    provisioningState - type: ProvisioningState

adx.control.models.EventGridConnectionProperties.EventGridConnectionProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.EventGridConnectionPropertiesDatabaseRoutingEnum

Superclass: adx.control.JSONEnum

EventGridConnectionPropertiesDatabaseRoutingEnum No description provided

Enumeration values:
  Single
  Multi

adx.control.models.EventGridConnectionPropertiesDatabaseRoutingEnum.EventGridConnectionPropertiesDatabaseRoutingEnum

EventGridConnectionPropertiesDatabaseRoutingEnum No description provided

adx.control.models.EventGridConnectionProperties_1

Superclass: adx.control.JSONMapper

EventGridConnectionProperties_1 Class representing the Kusto event grid connection properties.
  
  EventGridConnectionProperties_1 Properties:
    storageAccountResourceId - The resource ID of the storage account where the data resides. - type: string
    eventGridResourceId - The resource ID of the event grid that is subscribed to the storage account events. - type: string
    eventHubResourceId - The resource ID where the event grid is configured to send events. - type: string
    consumerGroup - The event hub consumer group. - type: string
    tableName - The table where the data should be ingested. Optionally the table information can be added to each message. - type: string
    mappingRuleName - The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. - type: string
    dataFormat - type: EventGridDataFormat
    ignoreFirstRecord - A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file - type: logical
    blobStorageEventType - type: BlobStorageEventType
    managedIdentityResourceId - The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub and storage account. - type: string
    managedIdentityObjectId - The object ID of managedIdentityResourceId - type: string
    databaseRouting - Indication for database routing information from the data connection, by default only database routing information is allowed - type: string
    provisioningState - type: ProvisioningState

adx.control.models.EventGridConnectionProperties_1.EventGridConnectionProperties_1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.EventGridConnectionProperties_1DatabaseRoutingEnum

Superclass: adx.control.JSONEnum

EventGridConnectionProperties_1DatabaseRoutingEnum No description provided

Enumeration values:
  Single
  Multi

adx.control.models.EventGridConnectionProperties_1DatabaseRoutingEnum.EventGridConnectionProperties_1DatabaseRoutingEnum

EventGridConnectionProperties_1DatabaseRoutingEnum No description provided

adx.control.models.EventGridDataConnection

Superclass: adx.control.JSONMapper

EventGridDataConnection Class representing an Event Grid data connection.
  
  EventGridDataConnection Properties:
    xproperties - type: EventGridConnectionProperties_1
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.EventGridDataConnection.EventGridDataConnection

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.EventGridDataFormat

Superclass: adx.control.JSONEnum

EventGridDataFormat The data format of the message. Optionally the data format can be added to each message.

Enumeration values:
  MULTIJSON
  JSON
  CSV
  TSV
  SCSV
  SOHSV
  PSV
  TXT
  RAW
  SINGLEJSON
  AVRO
  TSVE
  PARQUET
  ORC
  APACHEAVRO
  W3CLOGFILE

adx.control.models.EventGridDataFormat.EventGridDataFormat

EventGridDataFormat The data format of the message. Optionally the data format can be added to each message.

adx.control.models.EventHubConnectionProperties

Superclass: adx.control.JSONMapper

EventHubConnectionProperties Class representing the Kusto event hub connection properties.
  
  EventHubConnectionProperties Properties:
    eventHubResourceId - The resource ID of the event hub to be used to create a data connection. - type: string
    consumerGroup - The event hub consumer group. - type: string
    tableName - The table where the data should be ingested. Optionally the table information can be added to each message. - type: string
    mappingRuleName - The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. - type: string
    dataFormat - type: EventHubDataFormat
    eventSystemProperties - System properties of the event hub - type: array of string
    compression - type: Compression
    provisioningState - type: ProvisioningState
    managedIdentityResourceId - The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub. - type: string
    managedIdentityObjectId - The object ID of the managedIdentityResourceId - type: string
    databaseRouting - Indication for database routing information from the data connection, by default only database routing information is allowed - type: string
    retrievalStartDate - When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period. - type: datetime

adx.control.models.EventHubConnectionProperties.EventHubConnectionProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.EventHubConnectionPropertiesDatabaseRoutingEnum

Superclass: adx.control.JSONEnum

EventHubConnectionPropertiesDatabaseRoutingEnum No description provided

Enumeration values:
  Single
  Multi

adx.control.models.EventHubConnectionPropertiesDatabaseRoutingEnum.EventHubConnectionPropertiesDatabaseRoutingEnum

EventHubConnectionPropertiesDatabaseRoutingEnum No description provided

adx.control.models.EventHubConnectionProperties_1

Superclass: adx.control.JSONMapper

EventHubConnectionProperties_1 Class representing the Kusto event hub connection properties.
  
  EventHubConnectionProperties_1 Properties:
    eventHubResourceId - The resource ID of the event hub to be used to create a data connection. - type: string
    consumerGroup - The event hub consumer group. - type: string
    tableName - The table where the data should be ingested. Optionally the table information can be added to each message. - type: string
    mappingRuleName - The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. - type: string
    dataFormat - type: EventHubDataFormat
    eventSystemProperties - System properties of the event hub - type: array of string
    compression - type: Compression
    provisioningState - type: ProvisioningState
    managedIdentityResourceId - The resource ID of a managed identity (system or user assigned) to be used to authenticate with event hub. - type: string
    managedIdentityObjectId - The object ID of the managedIdentityResourceId - type: string
    databaseRouting - Indication for database routing information from the data connection, by default only database routing information is allowed - type: string
    retrievalStartDate - When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period. - type: datetime

adx.control.models.EventHubConnectionProperties_1.EventHubConnectionProperties_1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.EventHubConnectionProperties_1DatabaseRoutingEnum

Superclass: adx.control.JSONEnum

EventHubConnectionProperties_1DatabaseRoutingEnum No description provided

Enumeration values:
  Single
  Multi

adx.control.models.EventHubConnectionProperties_1DatabaseRoutingEnum.EventHubConnectionProperties_1DatabaseRoutingEnum

EventHubConnectionProperties_1DatabaseRoutingEnum No description provided

adx.control.models.EventHubDataConnection

Superclass: adx.control.JSONMapper

EventHubDataConnection Class representing an event hub data connection.
  
  EventHubDataConnection Properties:
    xproperties - type: EventHubConnectionProperties_1
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.EventHubDataConnection.EventHubDataConnection

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.EventHubDataFormat

Superclass: adx.control.JSONEnum

EventHubDataFormat The data format of the message. Optionally the data format can be added to each message.

Enumeration values:
  MULTIJSON
  JSON
  CSV
  TSV
  SCSV
  SOHSV
  PSV
  TXT
  RAW
  SINGLEJSON
  AVRO
  TSVE
  PARQUET
  ORC
  APACHEAVRO
  W3CLOGFILE

adx.control.models.EventHubDataFormat.EventHubDataFormat

EventHubDataFormat The data format of the message. Optionally the data format can be added to each message.

adx.control.models.FollowerDatabaseDefinition

Superclass: adx.control.JSONMapper

FollowerDatabaseDefinition A class representing follower database request.
  
  FollowerDatabaseDefinition Properties:
    clusterResourceId - Resource id of the cluster that follows a database owned by this cluster. - type: string
    attachedDatabaseConfigurationName - Resource name of the attached database configuration in the follower cluster. - type: string
    databaseName - The database name owned by this cluster that was followed. * in case following all databases. - type: string
    tableLevelSharingProperties - type: TableLevelSharingProperties
    databaseShareOrigin - type: DatabaseShareOrigin

adx.control.models.FollowerDatabaseDefinition.FollowerDatabaseDefinition

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.FollowerDatabaseListResult

Superclass: adx.control.JSONMapper

FollowerDatabaseListResult The list Kusto database principals operation response.
  
  FollowerDatabaseListResult Properties:
    value - The list of follower database result. - type: array of FollowerDatabaseDefinition

adx.control.models.FollowerDatabaseListResult.FollowerDatabaseListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.FreeFormObject

Superclass: dynamicprops

Class methods

adx.control.models.FreeFormObject.FreeFormObject

Class methods

adx.control.models.Identity

Superclass: adx.control.JSONMapper

Identity Identity for the resource.
  
  Identity Properties:
    principalId - The principal ID of resource identity. - type: string
    tenantId - The tenant ID of resource. - type: string
    type - The type of managed identity used. The type ''SystemAssigned, UserAssigned'' includes both an implicitly created identity and a set of user-assigned identities. The type ''None'' will remove all identities. - type: string
    userAssignedIdentities - The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}''. - type: adx.control.JSONMapperMap

adx.control.models.Identity.Identity

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.IdentityTypeEnum

Superclass: adx.control.JSONEnum

IdentityTypeEnum No description provided

Enumeration values:
  None
  SystemAssigned
  UserAssigned
  SystemAssigned_UserAssigned

adx.control.models.IdentityTypeEnum.IdentityTypeEnum

IdentityTypeEnum No description provided

adx.control.models.Identity_userAssignedIdentities_value

Superclass: adx.control.JSONMapper

Identity_userAssignedIdentities_value No description provided
  
  Identity_userAssignedIdentities_value Properties:
    principalId - The principal id of user assigned identity. - type: string
    clientId - The client id of user assigned identity. - type: string

adx.control.models.Identity_userAssignedIdentities_value.Identity_userAssignedIdentities_value

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.IotHubConnectionProperties

Superclass: adx.control.JSONMapper

IotHubConnectionProperties Class representing the Kusto Iot hub connection properties.
  
  IotHubConnectionProperties Properties:
    iotHubResourceId - The resource ID of the Iot hub to be used to create a data connection. - type: string
    consumerGroup - The iot hub consumer group. - type: string
    tableName - The table where the data should be ingested. Optionally the table information can be added to each message. - type: string
    mappingRuleName - The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. - type: string
    dataFormat - type: IotHubDataFormat
    eventSystemProperties - System properties of the iot hub - type: array of string
    sharedAccessPolicyName - The name of the share access policy - type: string
    databaseRouting - Indication for database routing information from the data connection, by default only database routing information is allowed - type: string
    retrievalStartDate - When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period. - type: datetime
    provisioningState - type: ProvisioningState

adx.control.models.IotHubConnectionProperties.IotHubConnectionProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.IotHubConnectionPropertiesDatabaseRoutingEnum

Superclass: adx.control.JSONEnum

IotHubConnectionPropertiesDatabaseRoutingEnum No description provided

Enumeration values:
  Single
  Multi

adx.control.models.IotHubConnectionPropertiesDatabaseRoutingEnum.IotHubConnectionPropertiesDatabaseRoutingEnum

IotHubConnectionPropertiesDatabaseRoutingEnum No description provided

adx.control.models.IotHubConnectionProperties_1

Superclass: adx.control.JSONMapper

IotHubConnectionProperties_1 Class representing the Kusto Iot hub connection properties.
  
  IotHubConnectionProperties_1 Properties:
    iotHubResourceId - The resource ID of the Iot hub to be used to create a data connection. - type: string
    consumerGroup - The iot hub consumer group. - type: string
    tableName - The table where the data should be ingested. Optionally the table information can be added to each message. - type: string
    mappingRuleName - The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. - type: string
    dataFormat - type: IotHubDataFormat
    eventSystemProperties - System properties of the iot hub - type: array of string
    sharedAccessPolicyName - The name of the share access policy - type: string
    databaseRouting - Indication for database routing information from the data connection, by default only database routing information is allowed - type: string
    retrievalStartDate - When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period. - type: datetime
    provisioningState - type: ProvisioningState

adx.control.models.IotHubConnectionProperties_1.IotHubConnectionProperties_1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.IotHubConnectionProperties_1DatabaseRoutingEnum

Superclass: adx.control.JSONEnum

IotHubConnectionProperties_1DatabaseRoutingEnum No description provided

Enumeration values:
  Single
  Multi

adx.control.models.IotHubConnectionProperties_1DatabaseRoutingEnum.IotHubConnectionProperties_1DatabaseRoutingEnum

IotHubConnectionProperties_1DatabaseRoutingEnum No description provided

adx.control.models.IotHubDataConnection

Superclass: adx.control.JSONMapper

IotHubDataConnection Class representing an iot hub data connection.
  
  IotHubDataConnection Properties:
    xproperties - type: IotHubConnectionProperties_1
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.IotHubDataConnection.IotHubDataConnection

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.IotHubDataFormat

Superclass: adx.control.JSONEnum

IotHubDataFormat The data format of the message. Optionally the data format can be added to each message.

Enumeration values:
  MULTIJSON
  JSON
  CSV
  TSV
  SCSV
  SOHSV
  PSV
  TXT
  RAW
  SINGLEJSON
  AVRO
  TSVE
  PARQUET
  ORC
  APACHEAVRO
  W3CLOGFILE

adx.control.models.IotHubDataFormat.IotHubDataFormat

IotHubDataFormat The data format of the message. Optionally the data format can be added to each message.

adx.control.models.KeyVaultProperties

Superclass: adx.control.JSONMapper

KeyVaultProperties Properties of the key vault.
  
  KeyVaultProperties Properties:
    keyName - The name of the key vault key. - type: string
    keyVersion - The version of the key vault key. - type: string
    keyVaultUri - The Uri of the key vault. - type: string
    userIdentity - The user assigned identity (ARM resource id) that has access to the key. - type: string

adx.control.models.KeyVaultProperties.KeyVaultProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.LanguageExtension

Superclass: adx.control.JSONMapper

LanguageExtension The language extension object.
  
  LanguageExtension Properties:
    languageExtensionName - type: LanguageExtensionName
    languageExtensionImageName - type: LanguageExtensionImageName

adx.control.models.LanguageExtension.LanguageExtension

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.LanguageExtensionImageName

Superclass: adx.control.JSONEnum

LanguageExtensionImageName Language extension image name.

Enumeration values:
  R
  Python3_6_5
  Python3_10_8

adx.control.models.LanguageExtensionImageName.LanguageExtensionImageName

LanguageExtensionImageName Language extension image name.

adx.control.models.LanguageExtensionName

Superclass: adx.control.JSONEnum

LanguageExtensionName Language extension that can run within KQL query.

Enumeration values:
  PYTHON
  R

adx.control.models.LanguageExtensionName.LanguageExtensionName

LanguageExtensionName Language extension that can run within KQL query.

adx.control.models.LanguageExtension_1

Superclass: adx.control.JSONMapper

LanguageExtension_1 The language extension object.
  
  LanguageExtension_1 Properties:
    languageExtensionName - type: LanguageExtensionName
    languageExtensionImageName - type: LanguageExtensionImageName

adx.control.models.LanguageExtension_1.LanguageExtension_1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.LanguageExtensionsList

Superclass: adx.control.JSONMapper

LanguageExtensionsList The list of language extension objects.
  
  LanguageExtensionsList Properties:
    value - The list of language extensions. - type: array of LanguageExtension_1

adx.control.models.LanguageExtensionsList.LanguageExtensionsList

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ListResourceSkusResult

Superclass: adx.control.JSONMapper

ListResourceSkusResult List of available SKUs for a Kusto Cluster.
  
  ListResourceSkusResult Properties:
    value - The collection of available SKUs for an existing resource. - type: array of AzureResourceSku_1

adx.control.models.ListResourceSkusResult.ListResourceSkusResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ManagedPrivateEndpoint

Superclass: adx.control.JSONMapper

ManagedPrivateEndpoint Class representing a managed private endpoint.
  
  ManagedPrivateEndpoint Properties:
    xproperties - type: ManagedPrivateEndpointProperties_1
    systemData - type: systemData
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.ManagedPrivateEndpoint.ManagedPrivateEndpoint

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ManagedPrivateEndpointListResult

Superclass: adx.control.JSONMapper

ManagedPrivateEndpointListResult The list managed private endpoints operation response.
  
  ManagedPrivateEndpointListResult Properties:
    value - The list of managed private endpoints. - type: array of ManagedPrivateEndpoint

adx.control.models.ManagedPrivateEndpointListResult.ManagedPrivateEndpointListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ManagedPrivateEndpointProperties

Superclass: adx.control.JSONMapper

ManagedPrivateEndpointProperties A class representing the properties of a managed private endpoint object.
  
  ManagedPrivateEndpointProperties Properties:
    privateLinkResourceId - The ARM resource ID of the resource for which the managed private endpoint is created. - type: string
    privateLinkResourceRegion - The region of the resource to which the managed private endpoint is created. - type: string
    groupId - The groupId in which the managed private endpoint is created. - type: string
    requestMessage - The user request message. - type: string
    provisioningState - type: ProvisioningState

adx.control.models.ManagedPrivateEndpointProperties.ManagedPrivateEndpointProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ManagedPrivateEndpointProperties_1

Superclass: adx.control.JSONMapper

ManagedPrivateEndpointProperties_1 A class representing the properties of a managed private endpoint object.
  
  ManagedPrivateEndpointProperties_1 Properties:
    privateLinkResourceId - The ARM resource ID of the resource for which the managed private endpoint is created. - type: string
    privateLinkResourceRegion - The region of the resource to which the managed private endpoint is created. - type: string
    groupId - The groupId in which the managed private endpoint is created. - type: string
    requestMessage - The user request message. - type: string
    provisioningState - type: ProvisioningState

adx.control.models.ManagedPrivateEndpointProperties_1.ManagedPrivateEndpointProperties_1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ManagedPrivateEndpointsCheckNameRequest

Superclass: adx.control.JSONMapper

ManagedPrivateEndpointsCheckNameRequest The result returned from a managedPrivateEndpoints check name availability request.
  
  ManagedPrivateEndpointsCheckNameRequest Properties:
    name - Managed private endpoint resource name. - type: string
    type - The type of resource, for instance Microsoft.Kusto/clusters/managedPrivateEndpoints. - type: string

adx.control.models.ManagedPrivateEndpointsCheckNameRequest.ManagedPrivateEndpointsCheckNameRequest

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ManagedPrivateEndpointsCheckNameRequestTypeEnum

Superclass: adx.control.JSONEnum

ManagedPrivateEndpointsCheckNameRequestTypeEnum No description provided

Enumeration values:
  Microsoft_Kusto_clusters_managedPrivateEndpoints

adx.control.models.ManagedPrivateEndpointsCheckNameRequestTypeEnum.ManagedPrivateEndpointsCheckNameRequestTypeEnum

ManagedPrivateEndpointsCheckNameRequestTypeEnum No description provided

adx.control.models.MigrationClusterProperties

Superclass: adx.control.JSONMapper

MigrationClusterProperties Represents a properties of a cluster that is part of a migration.
  
  MigrationClusterProperties Properties:
    id - The resource ID of the cluster. - type: string
    uri - The public URL of the cluster. - type: string
    dataIngestionUri - The public data ingestion URL of the cluster. - type: string
    role - The role of the cluster in the migration process. - type: string

adx.control.models.MigrationClusterProperties.MigrationClusterProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.MigrationClusterPropertiesRoleEnum

Superclass: adx.control.JSONEnum

MigrationClusterPropertiesRoleEnum No description provided

Enumeration values:
  Source
  Destination

adx.control.models.MigrationClusterPropertiesRoleEnum.MigrationClusterPropertiesRoleEnum

MigrationClusterPropertiesRoleEnum No description provided

adx.control.models.Operation

Superclass: adx.control.JSONMapper

Operation No description provided
  
  Operation Properties:
    name - This is of the format {provider}/{resource}/{operation}. - type: string
    display - type: The_object_that_describes_the_operation_
    origin - type: string
    xproperties - type: object

adx.control.models.Operation.Operation

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.OperationListResult

Superclass: adx.control.JSONMapper

OperationListResult No description provided
  
  OperationListResult Properties:
    value - type: array of Operation
    nextLink - type: string

adx.control.models.OperationListResult.OperationListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.OperationResult

Superclass: adx.control.JSONMapper

OperationResult Operation Result Entity.
  
  OperationResult Properties:
    id - ID of the resource. - type: string
    name - Name of the resource. - type: string
    status - type: Status
    startTime - The operation start time - type: datetime
    endTime - The operation end time - type: datetime
    percentComplete - Percentage completed. - type: double
    xproperties - type: OperationResultProperties
    error - type: OperationResultErrorProperties

adx.control.models.OperationResult.OperationResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.OperationResultErrorProperties

Superclass: adx.control.JSONMapper

OperationResultErrorProperties Operation result error properties
  
  OperationResultErrorProperties Properties:
    code - The code of the error. - type: string
    message - The error message. - type: string

adx.control.models.OperationResultErrorProperties.OperationResultErrorProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.OperationResultProperties

Superclass: adx.control.JSONMapper

OperationResultProperties Operation result properties
  
  OperationResultProperties Properties:
    operationKind - The kind of the operation. - type: string
    provisioningState - type: ProvisioningState
    operationState - The state of the operation. - type: string

adx.control.models.OperationResultProperties.OperationResultProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.OptimizedAutoscale

Superclass: adx.control.JSONMapper

OptimizedAutoscale A class that contains the optimized auto scale definition.
  
  OptimizedAutoscale Properties:
    version - The version of the template defined, for instance 1. - type: int32
    isEnabled - A boolean value that indicate if the optimized autoscale feature is enabled or not. - type: logical
    minimum - Minimum allowed instances count. - type: int32
    maximum - Maximum allowed instances count. - type: int32

adx.control.models.OptimizedAutoscale.OptimizedAutoscale

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.OutboundNetworkDependenciesEndpoint

Superclass: adx.control.JSONMapper

OutboundNetworkDependenciesEndpoint Endpoints accessed for a common purpose that the Kusto Service Environment requires outbound network access to.
  
  OutboundNetworkDependenciesEndpoint Properties:
    xproperties - type: OutboundNetworkDependenciesEndpointProperties
    etag - A unique read-only string that changes whenever the resource is updated. - type: string
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.OutboundNetworkDependenciesEndpoint.OutboundNetworkDependenciesEndpoint

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.OutboundNetworkDependenciesEndpointListResult

Superclass: adx.control.JSONMapper

OutboundNetworkDependenciesEndpointListResult Collection of Outbound Environment Endpoints
  
  OutboundNetworkDependenciesEndpointListResult Properties:
    value - Collection of resources. - type: array of OutboundNetworkDependenciesEndpoint
    nextLink - Link to next page of resources. - type: string

adx.control.models.OutboundNetworkDependenciesEndpointListResult.OutboundNetworkDependenciesEndpointListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.OutboundNetworkDependenciesEndpointProperties

Superclass: adx.control.JSONMapper

OutboundNetworkDependenciesEndpointProperties Endpoints accessed for a common purpose that the Kusto Service Environment requires outbound network access to.
  
  OutboundNetworkDependenciesEndpointProperties Properties:
    category - The type of service accessed by the Kusto Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory. - type: string
    endpoints - The endpoints that the Kusto Service Environment reaches the service at. - type: array of EndpointDependency
    provisioningState - type: ProvisioningState

adx.control.models.OutboundNetworkDependenciesEndpointProperties.OutboundNetworkDependenciesEndpointProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.PrivateEndpointConnection

Superclass: adx.control.JSONMapper

PrivateEndpointConnection A private endpoint connection
  
  PrivateEndpointConnection Properties:
    xproperties - type: PrivateEndpointConnectionProperties
    systemData - type: systemData
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.PrivateEndpointConnection.PrivateEndpointConnection

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.PrivateEndpointConnectionListResult

Superclass: adx.control.JSONMapper

PrivateEndpointConnectionListResult A list of private endpoint connections
  
  PrivateEndpointConnectionListResult Properties:
    value - Array of private endpoint connections - type: array of PrivateEndpointConnection

adx.control.models.PrivateEndpointConnectionListResult.PrivateEndpointConnectionListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.PrivateEndpointConnectionProperties

Superclass: adx.control.JSONMapper

PrivateEndpointConnectionProperties Properties of a private endpoint connection.
  
  PrivateEndpointConnectionProperties Properties:
    privateEndpoint - type: PrivateEndpointProperty
    privateLinkServiceConnectionState - type: PrivateLinkServiceConnectionStateProperty
    groupId - Group id of the private endpoint. - type: string
    provisioningState - Provisioning state of the private endpoint. - type: string

adx.control.models.PrivateEndpointConnectionProperties.PrivateEndpointConnectionProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.PrivateEndpointProperty

Superclass: adx.control.JSONMapper

PrivateEndpointProperty Private endpoint which the connection belongs to.
  
  PrivateEndpointProperty Properties:
    id - Resource id of the private endpoint. - type: string

adx.control.models.PrivateEndpointProperty.PrivateEndpointProperty

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.PrivateLinkResource

Superclass: adx.control.JSONMapper

PrivateLinkResource A private link resource
  
  PrivateLinkResource Properties:
    xproperties - type: PrivateLinkResourceProperties
    systemData - type: systemData
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.PrivateLinkResource.PrivateLinkResource

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.PrivateLinkResourceListResult

Superclass: adx.control.JSONMapper

PrivateLinkResourceListResult A list of private link resources
  
  PrivateLinkResourceListResult Properties:
    value - Array of private link resources - type: array of PrivateLinkResource

adx.control.models.PrivateLinkResourceListResult.PrivateLinkResourceListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.PrivateLinkResourceProperties

Superclass: adx.control.JSONMapper

PrivateLinkResourceProperties Properties of a private link resource.
  
  PrivateLinkResourceProperties Properties:
    groupId - The private link resource group id. - type: string
    requiredMembers - The private link resource required member names. - type: array of string
    requiredZoneNames - The private link resource required zone names. - type: array of string

adx.control.models.PrivateLinkResourceProperties.PrivateLinkResourceProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.PrivateLinkServiceConnectionStateProperty

Superclass: adx.control.JSONMapper

PrivateLinkServiceConnectionStateProperty Connection State of the Private Endpoint Connection.
  
  PrivateLinkServiceConnectionStateProperty Properties:
    status - The private link service connection status. - type: string
    description - The private link service connection description. - type: string
    actionsRequired - Any action that is required beyond basic workflow (approve/ reject/ disconnect) - type: string

adx.control.models.PrivateLinkServiceConnectionStateProperty.PrivateLinkServiceConnectionStateProperty

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ProvisioningState

Superclass: adx.control.JSONEnum

ProvisioningState The provisioned state of the resource.

Enumeration values:
  Running
  Creating
  Deleting
  Succeeded
  Failed
  Moving
  Canceled

adx.control.models.ProvisioningState.ProvisioningState

ProvisioningState The provisioned state of the resource.

adx.control.models.ProxyResource

Superclass: adx.control.JSONMapper

ProxyResource The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
  
  ProxyResource Properties:
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.ProxyResource.ProxyResource

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ReadOnlyFollowingDatabase

Superclass: adx.control.JSONMapper

ReadOnlyFollowingDatabase Class representing a read only following database.
  
  ReadOnlyFollowingDatabase Properties:
    xproperties - type: ReadOnlyFollowingDatabaseProperties_1
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.ReadOnlyFollowingDatabase.ReadOnlyFollowingDatabase

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ReadOnlyFollowingDatabaseProPrincipalsModificationKindEnum_0000

Superclass: adx.control.JSONEnum

ReadOnlyFollowingDatabaseProPrincipalsModificationKindEnum_0000 No description provided

Enumeration values:
  Union
  Replace
  None

adx.control.models.ReadOnlyFollowingDatabaseProPrincipalsModificationKindEnum_0000.ReadOnlyFollowingDatabaseProPrincipalsModificationKindEnum_0000

ReadOnlyFollowingDatabaseProPrincipalsModificationKindEnum_0000 No description provided

adx.control.models.ReadOnlyFollowingDatabaseProPrincipalsModificationKindEnum_0001

Superclass: adx.control.JSONEnum

ReadOnlyFollowingDatabaseProPrincipalsModificationKindEnum_0001 No description provided

Enumeration values:
  Union
  Replace
  None

adx.control.models.ReadOnlyFollowingDatabaseProPrincipalsModificationKindEnum_0001.ReadOnlyFollowingDatabaseProPrincipalsModificationKindEnum_0001

ReadOnlyFollowingDatabaseProPrincipalsModificationKindEnum_0001 No description provided

adx.control.models.ReadOnlyFollowingDatabaseProperties

Superclass: adx.control.JSONMapper

ReadOnlyFollowingDatabaseProperties Class representing the Kusto database properties.
  
  ReadOnlyFollowingDatabaseProperties Properties:
    provisioningState - type: ProvisioningState
    softDeletePeriod - The time the data should be kept before it stops being accessible to queries in TimeSpan. - type: string
    hotCachePeriod - The time the data should be kept in cache for fast queries in TimeSpan. - type: string
    statistics - type: DatabaseStatistics
    leaderClusterResourceId - The name of the leader cluster - type: string
    attachedDatabaseConfigurationName - The name of the attached database configuration cluster - type: string
    principalsModificationKind - The principals modification kind of the database - type: string
    tableLevelSharingProperties - type: TableLevelSharingProperties
    originalDatabaseName - The original database name, before databaseNameOverride or databaseNamePrefix where applied. - type: string
    databaseShareOrigin - type: DatabaseShareOrigin
    suspensionDetails - type: SuspensionDetails

adx.control.models.ReadOnlyFollowingDatabaseProperties.ReadOnlyFollowingDatabaseProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ReadOnlyFollowingDatabaseProperties_1

Superclass: adx.control.JSONMapper

ReadOnlyFollowingDatabaseProperties_1 Class representing the Kusto database properties.
  
  ReadOnlyFollowingDatabaseProperties_1 Properties:
    provisioningState - type: ProvisioningState
    softDeletePeriod - The time the data should be kept before it stops being accessible to queries in TimeSpan. - type: string
    hotCachePeriod - The time the data should be kept in cache for fast queries in TimeSpan. - type: string
    statistics - type: DatabaseStatistics
    leaderClusterResourceId - The name of the leader cluster - type: string
    attachedDatabaseConfigurationName - The name of the attached database configuration cluster - type: string
    principalsModificationKind - The principals modification kind of the database - type: string
    tableLevelSharingProperties - type: TableLevelSharingProperties
    originalDatabaseName - The original database name, before databaseNameOverride or databaseNamePrefix where applied. - type: string
    databaseShareOrigin - type: DatabaseShareOrigin
    suspensionDetails - type: SuspensionDetails

adx.control.models.ReadOnlyFollowingDatabaseProperties_1.ReadOnlyFollowingDatabaseProperties_1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ReadWriteDatabase

Superclass: adx.control.JSONMapper

ReadWriteDatabase Class representing a read write database.
  
  ReadWriteDatabase Properties:
    xproperties - type: ReadWriteDatabaseProperties_1
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.ReadWriteDatabase.ReadWriteDatabase

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ReadWriteDatabaseProperties

Superclass: adx.control.JSONMapper

ReadWriteDatabaseProperties Class representing the Kusto database properties.
  
  ReadWriteDatabaseProperties Properties:
    provisioningState - type: ProvisioningState
    softDeletePeriod - The time the data should be kept before it stops being accessible to queries in TimeSpan. - type: string
    hotCachePeriod - The time the data should be kept in cache for fast queries in TimeSpan. - type: string
    statistics - type: DatabaseStatistics
    isFollowed - Indicates whether the database is followed. - type: logical
    keyVaultProperties - type: KeyVaultProperties
    suspensionDetails - type: SuspensionDetails

adx.control.models.ReadWriteDatabaseProperties.ReadWriteDatabaseProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ReadWriteDatabaseProperties_1

Superclass: adx.control.JSONMapper

ReadWriteDatabaseProperties_1 Class representing the Kusto database properties.
  
  ReadWriteDatabaseProperties_1 Properties:
    provisioningState - type: ProvisioningState
    softDeletePeriod - The time the data should be kept before it stops being accessible to queries in TimeSpan. - type: string
    hotCachePeriod - The time the data should be kept in cache for fast queries in TimeSpan. - type: string
    statistics - type: DatabaseStatistics
    isFollowed - Indicates whether the database is followed. - type: logical
    keyVaultProperties - type: KeyVaultProperties
    suspensionDetails - type: SuspensionDetails

adx.control.models.ReadWriteDatabaseProperties_1.ReadWriteDatabaseProperties_1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.Resource

Superclass: adx.control.JSONMapper

Resource Common fields that are returned in the response for all Azure Resource Manager resources
  
  Resource Properties:
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.Resource.Resource

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ResourceSkuCapabilities

Superclass: adx.control.JSONMapper

ResourceSkuCapabilities Describes The SKU capabilities object.
  
  ResourceSkuCapabilities Properties:
    name - An invariant to describe the feature. - type: string
    value - An invariant if the feature is measured by quantity. - type: string

adx.control.models.ResourceSkuCapabilities.ResourceSkuCapabilities

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ResourceSkuZoneDetails

Superclass: adx.control.JSONMapper

ResourceSkuZoneDetails Describes The zonal capabilities of a SKU.
  
  ResourceSkuZoneDetails Properties:
    name - The set of zones that the SKU is available in with the specified capabilities. - type: array of string
    capabilities - A list of capabilities that are available for the SKU in the specified list of zones. - type: array of ResourceSkuCapabilities

adx.control.models.ResourceSkuZoneDetails.ResourceSkuZoneDetails

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.Script

Superclass: adx.control.JSONMapper

Script Class representing a database script.
  
  Script Properties:
    xproperties - type: ScriptProperties_1
    systemData - type: systemData
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.Script.Script

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ScriptCheckNameRequest

Superclass: adx.control.JSONMapper

ScriptCheckNameRequest A script name availability request.
  
  ScriptCheckNameRequest Properties:
    name - Script name. - type: string
    type - The type of resource, Microsoft.Kusto/clusters/databases/scripts. - type: string

adx.control.models.ScriptCheckNameRequest.ScriptCheckNameRequest

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ScriptCheckNameRequestTypeEnum

Superclass: adx.control.JSONEnum

ScriptCheckNameRequestTypeEnum No description provided

Enumeration values:
  Microsoft_Kusto_clusters_databases_scripts

adx.control.models.ScriptCheckNameRequestTypeEnum.ScriptCheckNameRequestTypeEnum

ScriptCheckNameRequestTypeEnum No description provided

adx.control.models.ScriptListResult

Superclass: adx.control.JSONMapper

ScriptListResult The list Kusto database script operation response.
  
  ScriptListResult Properties:
    value - The list of Kusto scripts. - type: array of Script

adx.control.models.ScriptListResult.ScriptListResult

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ScriptProperties

Superclass: adx.control.JSONMapper

ScriptProperties A class representing database script property.
  
  ScriptProperties Properties:
    scriptUrl - The url to the KQL script blob file. Must not be used together with scriptContent property - type: string
    scriptUrlSasToken - The SaS token that provide read access to the file which contain the script. Must be provided when using scriptUrl property. - type: string
    scriptContent - The script content. This property should be used when the script is provide inline and not through file in a SA. Must not be used together with scriptUrl and scriptUrlSasToken properties. - type: string
    forceUpdateTag - A unique string. If changed the script will be applied again. - type: string
    continueOnErrors - Flag that indicates whether to continue if one of the command fails. - type: logical
    provisioningState - type: ProvisioningState

adx.control.models.ScriptProperties.ScriptProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.ScriptProperties_1

Superclass: adx.control.JSONMapper

ScriptProperties_1 A class representing database script property.
  
  ScriptProperties_1 Properties:
    scriptUrl - The url to the KQL script blob file. Must not be used together with scriptContent property - type: string
    scriptUrlSasToken - The SaS token that provide read access to the file which contain the script. Must be provided when using scriptUrl property. - type: string
    scriptContent - The script content. This property should be used when the script is provide inline and not through file in a SA. Must not be used together with scriptUrl and scriptUrlSasToken properties. - type: string
    forceUpdateTag - A unique string. If changed the script will be applied again. - type: string
    continueOnErrors - Flag that indicates whether to continue if one of the command fails. - type: logical
    provisioningState - type: ProvisioningState

adx.control.models.ScriptProperties_1.ScriptProperties_1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.SkuDescription

Superclass: adx.control.JSONMapper

SkuDescription The Kusto SKU description of given resource type
  
  SkuDescription Properties:
    resourceType - The resource type - type: string
    name - The name of the SKU - type: string
    tier - The tier of the SKU - type: string
    locations - The set of locations that the SKU is available - type: array of string
    locationInfo - Locations and zones - type: array of SkuLocationInfoItem
    restrictions - The restrictions because of which SKU cannot be used - type: array of object

adx.control.models.SkuDescription.SkuDescription

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.SkuDescriptionList

Superclass: adx.control.JSONMapper

SkuDescriptionList The list of the EngagementFabric SKU descriptions
  
  SkuDescriptionList Properties:
    value - SKU descriptions - type: array of SkuDescription

adx.control.models.SkuDescriptionList.SkuDescriptionList

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.SkuLocationInfoItem

Superclass: adx.control.JSONMapper

SkuLocationInfoItem The locations and zones info for SKU.
  
  SkuLocationInfoItem Properties:
    location - The available location of the SKU. - type: string
    zones - The available zone of the SKU. - type: array of string
    zoneDetails - Gets details of capabilities available to a SKU in specific zones. - type: array of ResourceSkuZoneDetails

adx.control.models.SkuLocationInfoItem.SkuLocationInfoItem

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.Status

Superclass: adx.control.JSONEnum

Status The status of operation.

Enumeration values:
  Succeeded
  Canceled
  Failed
  Running

adx.control.models.Status.Status

Status The status of operation.

adx.control.models.SuspensionDetails

Superclass: adx.control.JSONMapper

SuspensionDetails The database suspension details. If the database is suspended, this object contains information related to the database''s suspension state.
  
  SuspensionDetails Properties:
    suspensionStartDate - The starting date and time of the suspension state. - type: datetime

adx.control.models.SuspensionDetails.SuspensionDetails

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.TableLevelSharingProperties

Superclass: adx.control.JSONMapper

TableLevelSharingProperties Tables that will be included and excluded in the follower database
  
  TableLevelSharingProperties Properties:
    tablesToInclude - List of tables to include in the follower database - type: array of string
    tablesToExclude - List of tables to exclude from the follower database - type: array of string
    externalTablesToInclude - List of external tables to include in the follower database - type: array of string
    externalTablesToExclude - List of external tables to exclude from the follower database - type: array of string
    materializedViewsToInclude - List of materialized views to include in the follower database - type: array of string
    materializedViewsToExclude - List of materialized views to exclude from the follower database - type: array of string
    functionsToInclude - List of functions to include in the follower database - type: array of string
    functionsToExclude - List of functions to exclude from the follower database - type: array of string

adx.control.models.TableLevelSharingProperties.TableLevelSharingProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.The_object_that_describes_the_operation_

Superclass: adx.control.JSONMapper

The_object_that_describes_the_operation_ No description provided
  
  The_object_that_describes_the_operation_ Properties:
    provider - type: string
    operation - For example: read, write, delete. - type: string
    resource - type: string
    description - type: string

adx.control.models.The_object_that_describes_the_operation_.The_object_that_describes_the_operation_

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.TrackedResource

Superclass: adx.control.JSONMapper

TrackedResource The resource model definition for an Azure Resource Manager tracked top level resource which has ''tags'' and a ''location''
  
  TrackedResource Properties:
    tags - Resource tags. - type: adx.control.JSONMapperMap
    location - The geo-location where the resource lives - type: string
    id - Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - type: string
    name - The name of the resource - type: string
    type - The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" - type: string

adx.control.models.TrackedResource.TrackedResource

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.TrustedExternalTenant

Superclass: adx.control.JSONMapper

TrustedExternalTenant Represents a tenant ID that is trusted by the cluster.
  
  TrustedExternalTenant Properties:
    value - GUID representing an external tenant. - type: string

adx.control.models.TrustedExternalTenant.TrustedExternalTenant

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.VirtualNetworkConfiguration

Superclass: adx.control.JSONMapper

VirtualNetworkConfiguration A class that contains virtual network definition.
  
  VirtualNetworkConfiguration Properties:
    subnetId - The subnet resource id. - type: string
    enginePublicIpId - Engine service''s public IP address resource id. - type: string
    dataManagementPublicIpId - Data management''s service public IP address resource id. - type: string

adx.control.models.VirtualNetworkConfiguration.VirtualNetworkConfiguration

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.systemData

Superclass: adx.control.JSONMapper

systemData Metadata pertaining to creation and last modification of the resource.
  
  systemData Properties:
    createdBy - The identity that created the resource. - type: string
    createdByType - The type of identity that created the resource. - type: string
    createdAt - The timestamp of resource creation (UTC). - type: datetime
    lastModifiedBy - The identity that last modified the resource. - type: string
    lastModifiedByType - The type of identity that last modified the resource. - type: string
    lastModifiedAt - The timestamp of resource last modification (UTC) - type: datetime

adx.control.models.systemData.systemData

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.control.models.systemDataCreatedByTypeEnum

Superclass: adx.control.JSONEnum

systemDataCreatedByTypeEnum No description provided

Enumeration values:
  User
  Application
  ManagedIdentity
  Key

adx.control.models.systemDataCreatedByTypeEnum.systemDataCreatedByTypeEnum

systemDataCreatedByTypeEnum No description provided

adx.control.models.systemDataLastModifiedByTypeEnum

Superclass: adx.control.JSONEnum

systemDataLastModifiedByTypeEnum No description provided

Enumeration values:
  User
  Application
  ManagedIdentity
  Key

adx.control.models.systemDataLastModifiedByTypeEnum.systemDataLastModifiedByTypeEnum

systemDataLastModifiedByTypeEnum No description provided

adx.control.BaseClient

Superclasses: handle, matlab.mixin.CustomDisplay

BASECLIENT Base class for RESTful adx services.
  Includes common initialization and authentication code. Authentication
  code may have to be manually updated after code generation.
 
  This class cannot be instantiated directly, work with classes derived
  from it to actually interact with the RESTful service.

adx.control.BaseClient.BaseClient

adx.control.BaseClient constructor to be called from
  derived classes to allow setting properties upon construction

adx.control.BaseClient.applyCookies

adx.control.BaseClient/applyCookies is a function.
    request = applyCookies(obj, request, uri)

adx.control.BaseClient.getOAuthToken

GETOAUTHTOKEN called by requestAuth to obtain OAuth token.
 
  To be customized after code generation.
 
  This template method simply returns the bearerToken of the object
  which is assumed to have been manually set after manually having
  completed the OAuth flow. Typically this method should be
  customized to return a properly cached still valid token, refresh
  an cached expired token just-in-time or perform the entire OAuth
  flow from the start just-in-time and cache the token.
 
  As the exact OAuth flow may vary by OAuth provider, the full
  authentication flow is not automatically generated and the
  template method simply returns the bearerToken property.

adx.control.BaseClient.getPropertyGroups

Redact properties such that tokens, etc. do not show up
  in Command Window output

adx.control.BaseClient.loadConfigFile

Loads client and http properties from a JSON file

adx.control.BaseClient.postSend

POSTSEND is called by every operation right after sending the
  request. This method can for example be customized to add
  customized error handling if the API responds to errors in a
  consistent way.
 
  If the responses of only a few operations need to be customized
  it is recommended to modify the generated operation methods
  in the Api classes themselves rather than modifying postSend.
 
  By default the generated postSend does not do anything, it just
  returns the response as is.

adx.control.BaseClient.preSend

PRESEND is called by every operation right before sending the
  request. This method can for example be customized to add a
  header to all (or most) requests if needed.
 
  If the requests of only a few operations need to be customized
  it is recommended to modify the generated operation methods
  in the Api classes themselves rather than modifying preSend.
 
  By default the generated preSend does not do anything, it just
  returns the inputs as is.

adx.control.BaseClient.requestAuth

REQUESTAUTH will be called by operations which require
  authentication. May have to be extended or modified after code
  generation. For example, authentication methods not present in the
  service OpenAPI spec or methods not directly supported by the
  generator will have to be added. Generated logic may also not be
  100% correct if the OpenAPI spec contained multiple different
  authentication methods of the same type.

adx.control.BaseClient.setCookies

adx.control.BaseClient/setCookies is a function.
    setCookies(obj, history)

adx.control.CookieJar

Superclass: handle

COOKIEJAR helper class in MATLAB Generator for OpenAPI package,
  provides a cookie jar. A cookie jar holds cookies which are typically 
  set by Set-Cookie headers in HTTP(S) requests and it can return the
  cookies which should be included in a request to a given URL.
 
  CookieJar Properties:
    path       - Directory where to save cookies.mat
 
  CookieJar Methods:
    setCookies - Adds cookies to the jar.
    getCookies - Return an array of cookies which match the given URL
 
    persist    - Forces cookie jar to be saved to disk
    load       - Forces cookie jar to be loaded from disk
    purge      - Empties the entire cookie jar and deletes cookies from
                 disk

adx.control.CookieJar.CookieJar

COOKIEJAR helper class in MATLAB Generator for OpenAPI package,
  provides a cookie jar. A cookie jar holds cookies which are typically 
  set by Set-Cookie headers in HTTP(S) requests and it can return the
  cookies which should be included in a request to a given URL.
 
  CookieJar Properties:
    path       - Directory where to save cookies.mat
 
  CookieJar Methods:
    setCookies - Adds cookies to the jar.
    getCookies - Return an array of cookies which match the given URL
 
    persist    - Forces cookie jar to be saved to disk
    load       - Forces cookie jar to be loaded from disk
    purge      - Empties the entire cookie jar and deletes cookies from
                 disk

adx.control.CookieJar.getCookies

GETCOOKIES returns an array of matlab.net.http.Cookie for the
  given URI which must be provided as first input.

adx.control.CookieJar.load

LOAD forces cookie jar to be loaded from disk. This method is
  also called automatically by the constructor. Can be called
  with a alternative directory as input to force saving
  cookies.mat to this alternative location. The CookieJar
  instance is then also reconfigured to continue working with
  this new location.

adx.control.CookieJar.persist

PERSIST forces cookie jar to be saved to disk. This method is
  also called automatically by setCookies if new cookies are
  added. Can be called with a alternative directory as input to
  force saving cookies.mat to this alternative location. The
  CookieJar instance is then also reconfigured to continue 
  working with this new location.

adx.control.CookieJar.purge

PURGE completely empties the cookie jar and also deletes
  cookies.mat from disk.

adx.control.CookieJar.setCookies

SETCOOKIES Adds cookies to the jar. Expects an array of
  matlab.net.http.CookieInfo as input. This can for example be
  obtained using matlab.net.http.CookieInfo.collectFromLog or
  by manually instantiating matlab.net.http.CookieInfo.
 
  See Also: matlab.net.http.CookieInfo.collectFromLog

adx.control.JSONEnum

JSONEnum Base class for enumerations when working with adx.control.JSONMapper
  When adding enumeration properties to adx.control.JSONMapper objects, the custom
  enumeration classes must inherit from this JSONEnum base class. And
  the custom enumeration class must declare string values for each enum
  element, these represent the JSON representation of the enumeration
  values; this is required since not all JSON values are guaranteed to
  be valid MATLAB variable names whereas the actual MATLAB enumeration
  values must be.
 
    Example:
 
      classdef myEnum < JSONEnum
          enumeration
              VAL1 ("VAL.1")
              VAL2 ("VAL.2")
          end
      end
 
  Even if JSON values are valid MATLAB variables, the string value must
  be provided, e.g.:
 
      classdef myEnum < JSONEnum
          enumeration
              VAL1 ("VAL1")
              VAL2 ("VAL2")
          end
      end

adx.control.JSONEnum.JSONEnum

JSONEnum Base class for enumerations when working with adx.control.JSONMapper
  When adding enumeration properties to adx.control.JSONMapper objects, the custom
  enumeration classes must inherit from this JSONEnum base class. And
  the custom enumeration class must declare string values for each enum
  element, these represent the JSON representation of the enumeration
  values; this is required since not all JSON values are guaranteed to
  be valid MATLAB variable names whereas the actual MATLAB enumeration
  values must be.
 
    Example:
 
      classdef myEnum < JSONEnum
          enumeration
              VAL1 ("VAL.1")
              VAL2 ("VAL.2")
          end
      end
 
  Even if JSON values are valid MATLAB variables, the string value must
  be provided, e.g.:
 
      classdef myEnum < JSONEnum
          enumeration
              VAL1 ("VAL1")
              VAL2 ("VAL2")
          end
      end

adx.control.JSONEnum.fromJSON

adx.control.JSONEnum/fromJSON is a function.
    v = fromJSON(obj, json)

adx.control.JSONMapper

Superclass: handle

adx.control.JSONMapper base class - adds JSON serialization and deserialization.
  Derive MATLAB classes from this class to allow them to be
  deserialized from JSON mapping the JSON fields to the class
  properties. To allow proper nesting of object, derived objects must
  call the adx.control.JSONMapper constructor from their constructor:
 
  function obj = myClass(s,inputs)
      arguments
          s {adx.control.JSONMapper.ConstructorArgument} = []
          inputs.?myClass
      end
      obj@adx.control.JSONMapper(s,inputs);
  end
 
  Make sure to update the class name (myClass in the example) in both
  the function name as well as in the arguments block.
 
  During serialization or deserialization the MATLAB object definition
  is leading. JSON data is converted to MATLAB data types based on the
  type declaration in MATLAB. Therefore all properties of the MATLAB
  class *must* have a type declaration. Also, fields are only
  deserialized if they actually exist on the MATLAB class, any
  additional fields in the JSON input are ignored.
 
  Supported property datatypes: double, float, uint8, int8, uint16,
  int16, uint32, int32, uint64, int64, logical, enum, string, char,
  datetime (must be annotated), containers.Map, classes derived from
  adx.control.JSONMapper.
 
  Annotations can be added to properties as "validation functions".
 
  adx.control.JSONMapper Methods:
 
    fieldName      - allows property to be mapped to a JSON field with
                     different name
    JSONArray      - specifies field is a JSON array
    epochDatetime  - for datetime properties specifies in JSON the date
                     time is encoded as epoch. Must be the first
                     attribute if used
    stringDatetime - for datetime properties specifies in JSON the date
                     time is encoded as string with a particular format.
                     Must be the first attribute if used.
    doNotParse     - indicate that a field's JSON should not be parsed.
                     if JSONArray is also applied the field will be
                     parsed at the array level.

adx.control.JSONMapper.ConstructorArgument

CONSTRUCTORARGUMENT to be used in derived constructors to
  allow string or char arrays as input and allows the
  constructor to be used when working with nested adx.control.JSONMapper
  derived classes.

adx.control.JSONMapper.JSONArray

JSONARRAY adx.control.JSONMapper Annotation
  Specified that the JSON field is an array.
 
  Ensures that when serializing a MATLAB scalar it is in fact
  encoded as a JSON array rather than a scalar if the property
  has been annotated with this option.

adx.control.JSONMapper.JSONMapper

adx.control.JSONMapper Constructor. Call this from
  derived classes constructors:
 
  function obj = myClass(s,inputs)
      arguments
          s {adx.control.JSONMapper.ConstructorArgument} = []
          inputs.?myClass
      end
      obj@adx.control.JSONMapper(s,inputs);
  end
 
  Make sure to update the class name (myClass in the example)
  in both the function name as well as in the arguments block.

adx.control.JSONMapper.doNotParse

adx.control.JSONMapper.doNotParse is a function.
    adx.control.JSONMapper.doNotParse(~)

adx.control.JSONMapper.epochDatetime

EPOCHDATETIME adx.control.JSONMapper Annotation
  When working with datetime fields either epochDatetime or
  stringDatetime annotation is required to specify how the
  datetime is encoded in JSON. This must be the first
  annotation.
 
  When called without inputs POSIX time/UNIX timestamp is
  assumed.
 
  Optional Name-Value pairs TimeZone, Epoch and TicksPerSecond
  can be provided (their meaning is the same as when working
  with datetime(d,'ConvertFrom','epochtime', OPTIONS).
 
  Example:
 
    properties
        % start_date is a UNIX timestamp
        start_date {adx.control.JSONMapper.epochDatetime}
        % end_date is UNIX timestamp in milliseconds
        end_date {adx.control.JSONMapper.epochDatetime(end_date,'TicksPerSecond',1000)}
    end

adx.control.JSONMapper.fieldName

FIELDNAME adx.control.JSONMapper Annotation
  This can be added to properties if the MATLAB property name
  and JSON field name differ. For example, when the JSON field
  name is not a valid MATLAB identifier.
 
  Example:
 
    properties
        some_field {adx.control.JSONMapper.fieldName(some_field,"some.field")}
    end

adx.control.JSONMapper.fromJSON

adx.control.JSONMapper/fromJSON is a function.
    obj = fromJSON(obj, json)

adx.control.JSONMapper.getPayload

GETPAYLOAD JSON encodes the object taking into account
  required and optional properties.
 
  Verifies that required properties have indeed been set.
  Includes optional properties in the output. All other
  properties are not included in the output.

adx.control.JSONMapper.jsonencode

JSONENCODE serializes object as JSON
  Can serialize whole hierarchies of objects if all classes
  in the hierarchy derive from adx.control.JSONMapper.
 
  The function should only ever be called with one input: the
  object to be serialized. The second input is only meant to be
  used internally when jsonencode is called recursively.
 
  Example:
 
    json = jsonencode(obj);

adx.control.JSONMapper.stringDatetime

STRINGDATETIME adx.control.JSONMapper Annotation
  When working with datetime fields either epochDatetime or
  stringDatetime annotation is required to specify how the
  datetime is encoded in JSON. This must be the first
  annotation.
 
  stringDatetime requires the string format as input.
 
  Optional Name-Value pair TimeZone can be provided.
 
  Example:
 
    properties
        start_date {adx.control.JSONMapper.stringDatetime(start_date,'yyyy-MM-dd''T''HH:mm:ss')}
    end

adx.control.JSONMapperMap

Superclass: handle

JSONMAPPERMAP Alternative to containers.Map for free-form key-value
  pairs. The advantage of JSONMAPPERMAP over containers.Map is that
  instances are not shared when used as a class property.

adx.control.JSONMapperMap.JSONMapperMap

JSONMAPPERMAP Constructor. Can be called with key value pairs
  as input to initialize the map with those keys and values.

adx.control.JSONMapperMap.disp

DISP Displays keys and corresponding values in the map.

adx.control.JSONMapperMap.jsonencode

JSONENCODE JSON encodes the map.

adx.control.JSONMapperMap.subsasgn

SUBSASGN Assign or update a key-value pair in the map.

adx.control.JSONMapperMap.subsref

SUBSREF retrieve a key value from the map.

adx.control.JSONPropertyInfo

Superclass: handle

JSONPROPERTYINFO class used by adx.control.JSONMapper internally

adx.control.JSONPropertyInfo.JSONPropertyInfo

JSONPROPERTYINFO class used by adx.control.JSONMapper internally

adx.control.JSONPropertyInfo.getPropertyInfo

For all public properties

adx.data

adx.data.api

adx.data.api.Ingest

Superclass: adx.control.BaseClient

Ingest Class to run an ingest command

adx.data.api.Ingest.Ingest

Call base constructor to override any configured settings

adx.data.api.Ingest.ingestRun

ingestRun

adx.data.api.Management

Superclass: adx.control.BaseClient

Management Class to run a management command

adx.data.api.Management.Management

Call base constructor to override any configured settings

adx.data.api.Management.getPropertyGroups

Redact properties such that tokens, etc. do not show up
  in Command Window output

Help for adx.data.api.Management/getPropertyGroups is inherited from superclass adx.control.BaseClient

adx.data.api.Management.managementRun

managementRun

adx.data.api.Query

Superclass: adx.control.BaseClient

Query Class to run a KQL query
 
  Example:
     % Build a request object
     request = adx.data.models.QueryRequest();
     colName = "myColumn";
     message = "Hello World";
     
     % Set the KQL query fields
     request.csl = sprintf('print %s="%s"', colName, message);
     % Don't set the database use the default in .json config file
     % request.db = "myDatabaseName"
     % No adx.data.models.ClientRequestProperties required
     % request.requestProperties
 
     % Create the Query object and run the request
     query = adx.data.api.Query();
     % The default cluster to use is configured using a .json configuration file
     % Run the query:
     [code, result, response, requestId] = query.queryRun(request); %#ok<ASGLU>
 
     if code == matlab.net.http.StatusCode.OK
         % Convert the response to Tables
         hwTable = mathworks.internal.adx.queryV2Response2Tables(result);
         fprintf("Query (%s) result:\n", request.csl);
         disp(hwTable);
     else
         error('Error running query: %s', request.csl);
  end

adx.data.api.Query.Query

Call base constructor to override any configured settings

adx.data.api.Query.queryRun

queryRun Runs a KQL query
 
  Required argument(s)
    queryRequest: A populated adx.data.models.QueryRequest that defines the
                  query, the database and potentially query properties.
 
  Optional named arguments:
    cluster: A cluster URL as a scalar string.
 
    apiVersion: URL path API version field, if not provided and the query starts
                with "." v1 is used otherwise v2 is used.
 
    skipRowsArrayDecode: Returns a adx.data.models.QueryV2ResponseUnparsedRows where
                         the frames are parsed but the array of rows are not parsed
                         into individual values if true. Otherwise a
                         adx.data.models.QueryV2ResponseRaw is returned.
                         Only applied in the case of v2 APIs.
                         Default is false.
 
    skipResponseDecode: Logical flag to determine if the HTTP response should be
                        be parsed at all. If true the result is returned as a
                        adx.data.models.QueryV2ResponseRaw.empty or a 
                        adx.data.models.QueryV1ResponseRaw.empty as appropriate.
                        Default is false.
 
    verbose: Logical to enable additional output. Default is false.
 
  Return values:
    code: HTTP status code, 200 (matlab.net.http.StatusCode.OK) indicates success.
 
    result: Returned data is various forms or an ErrorResponse:
            adx.control.models.ErrorResponse
            adx.data.models.QueryV2ResponseRaw
            adx.data.models.QueryV2ResponseUnparsedRows
            adx.data.models.QueryV1ResponseRaw
 
    response: The original HTTP response to the matlab.net.http.RequestMessage.send
              The response may have been optionally processed by the baseClient
              postSend method.
 
   requestId: A UUID value generated and submitted with the query to
              identify it.

adx.data.models

adx.data.models.ClientRequestProperties

Superclass: adx.control.JSONMapper

ClientRequestProperties Adds ClientRequestPropertiesOptions to a query
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/queryparametersstatement

adx.data.models.ClientRequestProperties.ClientRequestProperties

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.ClientRequestPropertiesOptions

Superclass: adx.control.JSONMapper

ClientRequestPropertiesOptions Request properties control how a query or command executes and returns results
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/netfx/request-properties#clientrequestproperties-options

adx.data.models.ClientRequestPropertiesOptions.ClientRequestPropertiesOptions

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.Column

Superclass: adx.control.JSONMapper

Column Represents a Column in a v2 API response

adx.data.models.Column.Column

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.ColumnV1

Superclass: adx.control.JSONMapper

ColumnV1 Represents a Column in a v1 API response

adx.data.models.ColumnV1.ColumnV1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.DataSetCompletion

Superclass: adx.control.JSONMapper

DataSetCompletion Final field of a v2 response

adx.data.models.DataSetCompletion.DataSetCompletion

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.DataSetHeader

Superclass: adx.control.JSONMapper

DataSetHeader Header field of a v2 response

adx.data.models.DataSetHeader.DataSetHeader

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.DataTable

Superclass: adx.control.JSONMapper

DataTable Represents a v1 API format table

adx.data.models.DataTable.DataTable

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.DataTableV1

Superclass: adx.control.JSONMapper

DataTableV1 Represents a v1 API format table

adx.data.models.DataTableV1.DataTableV1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.DataTables

Superclass: adx.control.JSONMapper

DataTables Represents an array of v2 API tables

adx.data.models.DataTables.DataTables

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.DataTablesV1

Superclass: adx.control.JSONMapper

DataTablesV1 Represents an array of v1 API tables

adx.data.models.DataTablesV1.DataTablesV1

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.IngestionResourcesSnapshot

INGESTIONRESOURCESSNAPSHOT Contains result of .get ingestion resources request
 
  Example:
 
    managementClient = adx.data.api.Management();
    [code, result, response] = managementClient.managementRun(adx.data.models.ManagementRequest('csl', '.get ingestion resources'));
    if code == matlab.net.http.StatusCode.OK
        irs = adx.data.models.IngestionResourcesSnapshot(result);
    end
 
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/netfx/kusto-ingest-client-rest#retrieve-ingestion-resources

adx.data.models.IngestionResourcesSnapshot.IngestionResourcesSnapshot

INGESTIONRESOURCESSNAPSHOT Constructor for IngestionResourcesSnapshot object

adx.data.models.IngestionResourcesSnapshot.table

TABLE Convert a IngestionResourcesSnapshot Data property to a MATLAB table

adx.data.models.ManagementRequest

Superclass: adx.control.JSONMapper

ManagementRequest Defines a Request Object for a management query
  If a database field is defined in the default configuration file
  location its value will be used for the db property.

adx.data.models.ManagementRequest.ManagementRequest

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.QueryParameter

Superclass: adx.control.JSONMapper

QueryParameter Represents Key Value pairs for queries
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/queryparametersstatement

adx.data.models.QueryParameter.QueryParameter

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.QueryRequest

Superclass: adx.control.JSONMapper

QueryRequest Defines a Request Object for a query
  If a database field is defined in the default configuration file
  location its value will be used for the db property.

adx.data.models.QueryRequest.QueryRequest

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.QueryV1ResponseRaw

Superclass: adx.control.JSONMapper

QueryV1ResponseRaw Represents a v1 API response prior to conversion to a table or error

adx.data.models.QueryV1ResponseRaw.QueryV1ResponseRaw

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.QueryV2ResponseRaw

Superclass: adx.control.JSONMapper

QueryV2ResponseRaw Represents a v2 API response prior to conversion to a table or error

adx.data.models.QueryV2ResponseRaw.QueryV2ResponseRaw

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.QueryV2ResponseRaw.getDataSetCompletionFrame

adx.data.models.QueryV2ResponseRaw/getDataSetCompletionFrame is a function.
    dataSetCompletion = getDataSetCompletionFrame(obj)

adx.data.models.QueryV2ResponseRaw.getDataSetHeader

adx.data.models.QueryV2ResponseRaw/getDataSetHeader is a function.
    dataSetHeader = getDataSetHeader(obj)

adx.data.models.QueryV2ResponseUnparsedRows

Superclass: adx.control.JSONMapper

QueryV2ResponseUnparsedRows Represents a v2 API response prior to conversion to a table or error Rows are not parsed

adx.data.models.QueryV2ResponseUnparsedRows.QueryV2ResponseUnparsedRows

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.QueryV2ResponseUnparsedRows.getDataSetCompletionFrame

adx.data.models.QueryV2ResponseUnparsedRows/getDataSetCompletionFrame is a function.
    dataSetCompletion = getDataSetCompletionFrame(obj)

adx.data.models.QueryV2ResponseUnparsedRows.getDataSetHeader

adx.data.models.QueryV2ResponseUnparsedRows/getDataSetHeader is a function.
    dataSetHeader = getDataSetHeader(obj)

adx.data.models.QueueIngestionMessage

Superclass: adx.control.JSONMapper

QueueIngestionMessage The message that the Kusto Data Management service expects to read from the input Azure Queue is a JSON document in the following format

adx.data.models.QueueIngestionMessage.QueueIngestionMessage

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.Row

Superclass: adx.control.JSONMapper

Row Represents a row that is parsed by JSONMapper
  Class not used pending updated JSONMapper capability to handle simple arrays

adx.data.models.Row.Row

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.RowUnparsed

Superclass: adx.control.JSONMapper

RowUnparsed Row data returned which is not to be parsed by JSONMapper
  Value is held an an unparsed string

adx.data.models.RowUnparsed.RowUnparsed

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.RowsUnparsed

Superclass: adx.control.JSONMapper

RowsUnparsed Row data returned which is not to be parsed by JSONMapper
  Value is held an an unparsed string

adx.data.models.RowsUnparsed.RowsUnparsed

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.StreamFormat

STREAMFORMAT Specifies the format of the data in the request body
  The value should be one of: CSV, TSV, SCsv, SOHsv, PSV, JSON, MultiJSON, Avro
  See: https://learn.microsoft.com/en-us/azure/data-explorer/ingestion-supported-formats

Enumeration values:
  CSV
  TSV
  SCsv
  SOHsv
  PSV
  JSON
  MultiJSON
  Avro

adx.data.models.StreamFormat.StreamFormat

STREAMFORMAT Specifies the format of the data in the request body
  The value should be one of: CSV, TSV, SCsv, SOHsv, PSV, JSON, MultiJSON, Avro
  See: https://learn.microsoft.com/en-us/azure/data-explorer/ingestion-supported-formats

adx.data.models.TableCompletion

Superclass: adx.control.JSONMapper

TableCompletion Field to indicate the end of a table

adx.data.models.TableCompletion.TableCompletion

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.TableFragment

Superclass: adx.control.JSONMapper

TableFragment A part of a returned table

adx.data.models.TableFragment.TableFragment

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.TableFragmentType

Superclass: adx.control.JSONEnum

TableFragmentType Describes what the client should do with this fragment
  The value should be one of:
     DataAppend
     DataReplace
 
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/response2

Enumeration values:
  DataAppend
  DataReplace

adx.data.models.TableFragmentType.TableFragmentType

TableFragmentType Describes what the client should do with this fragment
  The value should be one of:
     DataAppend
     DataReplace
 
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/response2

adx.data.models.TableHeader

Superclass: adx.control.JSONMapper

TableHeader Header fields with top-level table properties

adx.data.models.TableHeader.TableHeader

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

adx.data.models.TableKind

Superclass: adx.control.JSONEnum

TableKind Specifies the type of a Table response
  The value should be one of:
    PrimaryResult
    QueryCompletionInformation
    QueryTraceLog
    QueryPerfLog
    TableOfContents
    QueryProperties
    QueryPlan
    Unknown
 
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/response2

Enumeration values:
  PrimaryResult
  QueryCompletionInformation
  QueryTraceLog
  QueryPerfLog
  TableOfContents
  QueryProperties
  QueryPlan
  Unknown

adx.data.models.TableKind.TableKind

TableKind Specifies the type of a Table response
  The value should be one of:
    PrimaryResult
    QueryCompletionInformation
    QueryTraceLog
    QueryPerfLog
    TableOfContents
    QueryProperties
    QueryPlan
    Unknown
 
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/response2

adx.data.models.TableProgress

Superclass: adx.control.JSONMapper

TableProgress Indicates the percentage of a task task that is complete

adx.data.models.TableProgress.TableProgress

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

azure

azure.core

azure.core.credential

azure.core.credential.AccessToken

Superclass: azure.object

ACCESSTOKEN An immutable access token with a token string and an expiration time
  Can be created based on a corresponding Java com.azure.core.credential.AccessToken
  argument or a token string and an expiry datetime (including a timezone).

azure.core.credential.AccessToken.AccessToken

ACCESSTOKEN An immutable access token with a token string and an expiration time
  Can be created based on a corresponding Java com.azure.core.credential.AccessToken
  argument or a token string and an expiry datetime (including a timezone).

azure.core.credential.AccessToken.getToken

GETTOKEN Return token as a character vector.

azure.core.credential.AccessToken.isExpired

ISEXPIRED Returns a logical if the token has expired or not

azure.core.credential.AzureSasCredential

Superclass: azure.object

AZURESASCREDENTIAL A credential that uses a shared access signature to authenticate
 
  See also: https://azuresdkdocs.blob.core.windows.net/$web/java/azure-core/1.20.0/index.html?com/azure/

azure.core.credential.AzureSasCredential.AzureSasCredential

AZURESASCREDENTIAL A credential that uses a shared access signature to authenticate
 
  See also: https://azuresdkdocs.blob.core.windows.net/$web/java/azure-core/1.20.0/index.html?com/azure/

azure.core.credential.AzureSasCredential.AzureSasSignature

azure.core.credential.AzureSasCredential/AzureSasSignature is a function.
    obj = AzureSasSignature(varargin)

azure.core.credential.AzureSasCredential.getSignature

GETSIGNATURE Retrieves the shared access signature associated to this credential
  Returns a character vector.
 
  Copyright 2021 The MathWorks, Inc.

azure.core.credential.AzureSasCredential.update

UPDATE Rotates the shared access signature associated to this credential
  Returns an updated AzureSasCredential object.

azure.core.credential.TokenCredential

Superclass: azure.object

TOKENCREDENTIAL Credential that can provide an access token

azure.core.credential.TokenCredential.TokenCredential

TOKENCREDENTIAL Credential that can provide an access token

azure.core.credential.TokenCredential.getToken

GETTOKEN Asynchronously retrieves an AccessToken
  An azure.core.credential.AccessToken is returned.
  This call is invokes the getTokenSync method rather than
  getToken intentionally.

azure.core.credential.TokenCredential.getTokenSync

GETTOKENSYNC Synchronously retrieves an AccessToken
  An azure.core.credential.AccessToken is returned.

azure.core.credential.TokenRequestContext

Superclass: azure.object

TOKENREQUESTCONTEXT Contains details of a request to get a token
  Can be created based on a corresponding com.azure.core.credential.TokenRequestContext
  Java object argument or without an argument where further configuration is
  required to add scopes.

azure.core.credential.TokenRequestContext.TokenRequestContext

TOKENREQUESTCONTEXT Contains details of a request to get a token
  Can be created based on a corresponding com.azure.core.credential.TokenRequestContext
  Java object argument or without an argument where further configuration is
  required to add scopes.

azure.core.credential.TokenRequestContext.addScopes

ADDSCOPES Adds one or more scopes to the request scopes
  Scopes should be provided as character vector or scalar string arguments.
  The updated TokenRequestContext is returned.

azure.core.credential.TokenRequestContext.getClaims

GETCLAIMS Get the additional claims to be included in the token
  Returns a character vector.

azure.core.credential.TokenRequestContext.getScopes

GETSCOPES Gets the scopes required for the token
  Returns a string array.

azure.core.credential.TokenRequestContext.getTenantId

GETTENANTID Get the tenant id to be used for the authentication request
  Returns a character vector.

azure.core.credential.TokenRequestContext.setClaims

SETCLAIMS Set the additional claims to be included in the token
  The claims should be provided as a character vector or scalar string.
  Returns an updated azure.core.credential.TokenRequestContext.

azure.core.credential.TokenRequestContext.setTenantId

SETTENANTID Set the tenant id to be used for the authentication request
  The tenantId should be provided as a character vector or scalar string.
  Returns an updated azure.core.credential.TokenRequestContext.

azure.core.util

azure.core.util.polling

azure.core.util.polling.LongRunningOperationStatus

Superclass: azure.object

LONGRUNNINGOPERATIONSTATUS Represent states of a long-running operation
  The poll operation is considered complete when the status is one of:
  SUCCESSFULLY_COMPLETED, USER_CANCELLED or FAILED.
 
  Possible values are:
     FAILED
     IN_PROGRESS
     NOT_STARTED
     SUCCESSFULLY_COMPLETED
     USER_CANCELLED

azure.core.util.polling.LongRunningOperationStatus.LongRunningOperationStatus

LONGRUNNINGOPERATIONSTATUS Represent states of a long-running operation
  The poll operation is considered complete when the status is one of:
  SUCCESSFULLY_COMPLETED, USER_CANCELLED or FAILED.
 
  Possible values are:
     FAILED
     IN_PROGRESS
     NOT_STARTED
     SUCCESSFULLY_COMPLETED
     USER_CANCELLED

azure.core.util.polling.LongRunningOperationStatus.fromString

FROMSTRING Creates a LongRunningOperationStatus from its string representation
  A name argument of type character vector or scalar string is required.
  A logical isComplete argument is required.
  A azure.core.util.LongRunningOperationStatus is returned.

azure.core.util.polling.LongRunningOperationStatus.isComplete

ISCOMPLETE Returns a logical to represent if in a completed state or not

azure.core.util.polling.LongRunningOperationStatus.toString

TOSTRING Returns a string representation of LongRunningOperationStatus
  Expected values are:
     FAILED
     IN_PROGRESS
     NOT_STARTED
     SUCCESSFULLY_COMPLETED
     USER_CANCELLED
 
  A character vector is returned.

azure.core.util.polling.PollResponse

Superclass: azure.object

POLLRESPONSE Represents a response from long-running polling operation
  It provides information such as the current status of the long-running
  operation and any value returned in the poll.
 
  Can be created based on a corresponding com.azure.core.util.polling.PollResponse
  Java object argument or a com.azure.core.util.polling.LongRunningOperationStatus
  or azure.core.util.polling.LongRunningOperationStatus status argument and a
  message argument of type character vector or scalar string.

azure.core.util.polling.PollResponse.PollResponse

POLLRESPONSE Represents a response from long-running polling operation
  It provides information such as the current status of the long-running
  operation and any value returned in the poll.
 
  Can be created based on a corresponding com.azure.core.util.polling.PollResponse
  Java object argument or a com.azure.core.util.polling.LongRunningOperationStatus
  or azure.core.util.polling.LongRunningOperationStatus status argument and a
  message argument of type character vector or scalar string.

azure.core.util.polling.PollResponse.getRetryAfter

GETRETRYAFTER Gets requested delay until next polling operation is performed
  If a negative value is returned the poller should determine on its own when
  the next poll operation is to occur.

azure.core.util.polling.PollResponse.getStatus

GETSTATUS Gets status of a long-running operation at last polling operation

azure.core.util.polling.PollResponse.getValue

GETVALUE The value returned as a result of the last successful poll operation
  This can be any custom user defined object, or null if no value was returned
  from the service. The return value will be subject to standard MATLAB to Java
  data type conversion and the following conversions:
     java.lang.String -> character vector

azure.core.util.polling.SyncPoller

Superclass: azure.object

SYNCPOLLER Simplifies executing long-running operations against Azure
  There is no constructor as this is based on a Java interface. A SyncPoller
  must be created based on the underlying SyncPoller Java object.

azure.core.util.polling.SyncPoller.SyncPoller

SYNCPOLLER Simplifies executing long-running operations against Azure
  There is no constructor as this is based on a Java interface. A SyncPoller
  must be created based on the underlying SyncPoller Java object.

azure.core.util.polling.SyncPoller.cancelOperation

CANCELOPERATION Cancels the remote long-running operation
  Requires cancellation to be supported by the service.

azure.core.util.polling.SyncPoller.poll

POLL Poll once and return the poll response received
  A azure.core.util.polling.PollResponse is returned.

azure.core.util.polling.SyncPoller.waitForCompletion

WAITFORCOMPLETION Wait for polling to complete with optional timeout
  A azure.core.util.polling.PollResponse is returned.
  An optional timeout can be provided as a scalar number of seconds to
  wait for polling to complete. The value will be converted to an integer value
  of seconds.

azure.identity

azure.identity.AuthenticationRecord

Superclass: azure.object

Represents the account information relating to an authentication request
  Held as a Java reactor.core.publisher.MonoMap.

azure.identity.AuthenticationRecord.AuthenticationRecord

Represents the account information relating to an authentication request
  Held as a Java reactor.core.publisher.MonoMap.

azure.identity.AzureCliCredential

Superclass: azure.core.credential.TokenCredential

AZURECLICREDENTIAL Provides token credentials based on Azure CLI command
  If the CLI is installed and authenticated there is no need to further
  authenticate within MATLAB.
  A object is created based on a corresponding Java com.azure.identity.AzureCliCredential
  object.

azure.identity.AzureCliCredential.AzureCliCredential

Created using a AzureCliCredential java object from the
  AzureCliCredentialBuilder class only

azure.identity.AzureCliCredentialBuilder

Superclass: azure.identity.CredentialBuilderBase

AZURECLICREDENTIALBUILDER  Credential builder for instantiating a AzureCliCredential

azure.identity.AzureCliCredentialBuilder.AzureCliCredentialBuilder

AZURECLICREDENTIALBUILDER  Credential builder for instantiating a AzureCliCredential

azure.identity.AzureCliCredentialBuilder.build

BUILD Creates new AzureCliCredential with the configured options set

azure.identity.ChainedTokenCredential

Superclass: azure.core.credential.TokenCredential

CHAINEDTOKENCREDENTIAL Provides a credential from a list of providers

azure.identity.ChainedTokenCredential.ChainedTokenCredential

CHAINEDTOKENCREDENTIAL Provides a credential from a list of providers

azure.identity.ChainedTokenCredentialBuilder

Superclass: azure.object

CHAINEDTOKENCREDENTIALBUILDER Builder for instantiating a ChainedTokenCredential

azure.identity.ChainedTokenCredentialBuilder.ChainedTokenCredentialBuilder

CHAINEDTOKENCREDENTIALBUILDER Builder for instantiating a ChainedTokenCredential

azure.identity.ChainedTokenCredentialBuilder.addLast

ADDLAST Adds a credential to try to authenticate at the end of the chain

azure.identity.ChainedTokenCredentialBuilder.build

BUILD Creates new ChainedTokenCredential with the configured options set

azure.identity.ClientCertificateCredential

Superclass: azure.core.credential.TokenCredential

CLIENTCERTIFICATECREDENTIAL AAD credential acquires a token with a client certificate

azure.identity.ClientCertificateCredential.ClientCertificateCredential

Created using a ClientCertificateCredential java object from the
  ClientCertificateCredentialBuilder class only

azure.identity.ClientCertificateCredentialBuilder

Superclass: azure.identity.CredentialBuilderBase

CLIENTCERTIFICATECREDENTIALBUILDER Builder for ClientCertificateCredential

azure.identity.ClientCertificateCredentialBuilder.ClientCertificateCredentialBuilder

CLIENTCERTIFICATECREDENTIALBUILDER Builder for ClientCertificateCredential

azure.identity.ClientCertificateCredentialBuilder.authorityHost

AUTHORITYHOST Specifies the Azure Active Directory endpoint to acquire tokens
  An updated ClientCertificateCredentialBuilder is returned.

azure.identity.ClientCertificateCredentialBuilder.build

BUILD Creates new ClientCertificateCredential with the configured options set

azure.identity.ClientCertificateCredentialBuilder.clientId

CLIENTID Sets client id
  An updated ClientCertificateCredentialBuilder is returned.

azure.identity.ClientCertificateCredentialBuilder.pemCertificate

PEMCERTIFICATE Sets the path of the PEM certificate for authenticating to AAD
  An updated ClientCertificateCredentialBuilder is returned.

azure.identity.ClientCertificateCredentialBuilder.tenantId

TENANTID Sets tenant id to authenticate through ClientCertificateCredential
  An updated ClientCertificateCredentialBuilder is returned.

azure.identity.ClientSecretCredential

Superclass: azure.core.credential.TokenCredential

CLIENTSECRETCREDENTIAL AAD credential acquires a token with a client secret

azure.identity.ClientSecretCredential.ClientSecretCredential

Created using a ClientSecretCredential java object from the
  ClientSecretCredentialBuilder class only

azure.identity.ClientSecretCredentialBuilder

Superclass: azure.identity.CredentialBuilderBase

CLIENTSECRETCREDENTIALBUILDER Builder for ClientSecretCredentialBuilder

azure.identity.ClientSecretCredentialBuilder.ClientSecretCredentialBuilder

CLIENTSECRETCREDENTIALBUILDER Builder for ClientSecretCredentialBuilder

azure.identity.ClientSecretCredentialBuilder.authorityHost

AUTHORITYHOST Specifies the Azure Active Directory endpoint to acquire tokens
  An updated ClientSecretCredentialBuilder is returned.

azure.identity.ClientSecretCredentialBuilder.build

BUILD Creates new ClientSecretCredential with the configured options set

azure.identity.ClientSecretCredentialBuilder.clientId

CLIENTID Sets client id
  An updated ClientSecretCredentialBuilder is returned.

azure.identity.ClientSecretCredentialBuilder.clientSecret

CLIENTID Sets the client secret for the authentication
  An updated ClientSecretCredentialBuilder is returned.

azure.identity.ClientSecretCredentialBuilder.tenantId

TENANTID Sets tenant id to authenticate through ClientSecretCredential
  An updated ClientSecretCredentialBuilder is returned.

azure.identity.CredentialBuilderBase

Superclass: azure.object

azure.identity.CredentialBuilderBase is a class.
    obj = azure.identity.CredentialBuilderBase

azure.identity.CredentialBuilderBase.CredentialBuilderBase

azure.identity.CredentialBuilderBase/CredentialBuilderBase is a constructor.
    obj = azure.identity.CredentialBuilderBase

azure.identity.CredentialBuilderBase.httpClient

HTTPCLIENT Sets the HttpClient to use for sending a receiving requests
  Currently the Netty client is configured by default.
  An updated builder object is returned.

azure.identity.DefaultAzureCredential

Superclass: azure.core.credential.TokenCredential

DEFAULTAZURECREDENTIAL Creates credential from environment or the shared token
  It tries to create a valid credential in the following order:
   EnvironmentCredential
   ManagedIdentityCredential
   SharedTokenCacheCredential
   IntelliJCredential
   VisualStudioCodeCredential
   AzureCliCredential
   Fails if none of the credentials above could be created.

azure.identity.DefaultAzureCredential.DefaultAzureCredential

Created using a DefaultAzureCredential java object from the
  DefaultAzureCredentialBuilder class only

azure.identity.DefaultAzureCredentialBuilder

Superclass: azure.identity.CredentialBuilderBase

DEFAULTAZURECREDENTIALBUILDER Credential builder for DefaultAzureCredential

azure.identity.DefaultAzureCredentialBuilder.DefaultAzureCredentialBuilder

DEFAULTAZURECREDENTIALBUILDER Credential builder for DefaultAzureCredential

azure.identity.DefaultAzureCredentialBuilder.authorityHost

AUTHORITYHOST Specifies the Azure Active Directory endpoint to acquire tokens
  An updated DefaultAzureCredentialBuilder is returned.

azure.identity.DefaultAzureCredentialBuilder.build

BUILD Creates new DefaultAzureCredential with the configured options set

azure.identity.DefaultAzureCredentialBuilder.managedIdentityClientId

MANAGEDIDENTITYCLIENTID Specifies client ID of user or system assigned identity
  This credential can be used when in an environment with managed identities.
  If unset, the value in the AZURE_CLIENT_ID environment variable will be used.
  If neither is set, the default value is null and will only work with system
  assigned managed identities and not user assigned managed identities.
  An updated DefaultAzureCredentialBuilder is returned.

azure.identity.DefaultAzureCredentialBuilder.tenantId

TENANTID Sets tenant id of user to authenticate through DefaultAzureCredential
  An updated DefaultAzureCredentialBuilder is returned.

azure.identity.DeviceCodeCredential

Superclass: azure.core.credential.TokenCredential

DEVICECODECREDENTIAL AAD credential acquires token with device code for AAD application

azure.identity.DeviceCodeCredential.DeviceCodeCredential

DEVICECODECREDENTIAL AAD credential acquires token with device code for AAD application

azure.identity.DeviceCodeCredential.authenticate

AUTHENTICATE  Authenticates a user via the device code flow
  Can take a azure.core.credential.TokenRequestContext as an optional argument.
  Returns a reactor.core.publisher.Mono as a azure.identity.AuthenticationRecord.

azure.identity.DeviceCodeCredentialBuilder

Superclass: azure.identity.CredentialBuilderBase

DEVICECODECREDENTIALBUILDER Builder for DeviceCodeCredential.
 
  The DeviceCodeCredentialBuilder constructor in MATLAB always applies
  disableAutomaticAuthentication to avoid any automatic authentication
  attempts by clients during which MATLAB will not be able to display the
  device code. If a client requires authentication for a certain scope and
  your DeviceCodeCredential has not been authenticated for this (yet), an
  error will be thrown.
  
  See:
    https://docs.microsoft.com/en-us/java/api/com.azure.identity.devicecodecredentialbuilder.disableautomaticauthentication?view=azure-java-stable#com-azure-identity-devicecodecredentialbuilder-disableautomaticauthentication()

azure.identity.DeviceCodeCredentialBuilder.DeviceCodeCredentialBuilder

DEVICECODECREDENTIALBUILDER Builder for DeviceCodeCredential.
 
  The DeviceCodeCredentialBuilder constructor in MATLAB always applies
  disableAutomaticAuthentication to avoid any automatic authentication
  attempts by clients during which MATLAB will not be able to display the
  device code. If a client requires authentication for a certain scope and
  your DeviceCodeCredential has not been authenticated for this (yet), an
  error will be thrown.
  
  See:
    https://docs.microsoft.com/en-us/java/api/com.azure.identity.devicecodecredentialbuilder.disableautomaticauthentication?view=azure-java-stable#com-azure-identity-devicecodecredentialbuilder-disableautomaticauthentication()

azure.identity.DeviceCodeCredentialBuilder.authorityHost

AUTHORITYHOST Specifies the Azure Active Directory endpoint to acquire tokens
  An updated DeviceCodeCredentialBuilder is returned.

azure.identity.DeviceCodeCredentialBuilder.build

BUILD Not Supported in MATLAB
 
  When working with DeviceCodeCredential, MATLAB requires the credential
  object to be pre-authorized before passing it to an Azure client. Please
  build and also immediately authorize the DeviceCodeCredential using the
  'buildAndAuthenticate' method instead.

azure.identity.DeviceCodeCredentialBuilder.buildAndAuthenticate

BUILDANDAUTHENTICATE Creates new DeviceCodeCredential with the configured
  options set and also immediately authenticates it with the requested
  tokenRequestContext.
  
  By default this method will print the device code information:
 
   To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code ILOVEMATLAB to authenticate.
 
  To the MATLAB Command Window. Optionally a function handle
  challengeConsumer can be provided to customize the message or how to
  display it. This function will be called with a DeviceCodeInfo object as
  input.
 
  An authenticated DeviceCodeCredential is returned.

azure.identity.DeviceCodeCredentialBuilder.clientId

CLIENTID Sets client id
  An updated DeviceCodeCredentialBuilder is returned.

azure.identity.DeviceCodeCredentialBuilder.disableAutomaticAuthentication

DISABLEAUTOMATICAUTHENTICATION Disables the automatic authentication and
  prevents the DeviceCodeCredential from automatically prompting the user.
  If automatic authentication is disabled a AuthenticationRequiredException
  will be thrown from getToken(TokenRequestContext request) in the case
  that user interaction is necessary.
 
  An updated DeviceCodeCredentialBuilder is returned.

azure.identity.DeviceCodeCredentialBuilder.maxRetry

MAXRETRY Sets max number of retries when an authentication request fails
  An updated DeviceCodeCredentialBuilder is returned.

azure.identity.DeviceCodeCredentialBuilder.tenantId

TENANTID Sets tenant id to authenticate through DeviceCodeCredential
  An updated DeviceCodeCredentialBuilder is returned.

azure.identity.DeviceCodeCredentialBuilder.tokenCachePersistenceOptions

TOKENCACHEPERSISTENCEOPTIONS Sets tokenCachePersistenceOptions.

azure.identity.DeviceCodeInfo

Superclass: azure.object

DEVICECODEINFO Contains details of a device code request.

azure.identity.DeviceCodeInfo.DeviceCodeInfo

DEVICECODEINFO Contains details of a device code request.

azure.identity.DeviceCodeInfo.getExpiresOn

GETEXPIRESON Gets the expiration time of device code.
  Returns a datetime object.

azure.identity.DeviceCodeInfo.getMessage

GETMESSAGE Gets the message which should be displayed to the user.
  Returns a character vector.

azure.identity.DeviceCodeInfo.getUserCode

GETUSERCODE Gets the code which user needs to provide when authenticating
  at the verification URL. 
  Returns a character vector.

azure.identity.DeviceCodeInfo.getVerificationUrl

GETVERIFICATIONURL Gets the URL where user can authenticate.
  Returns a character vector.

azure.identity.EnvironmentCredential

Superclass: azure.core.credential.TokenCredential

ENVIRONMENTCREDENTIAL Provides token credentials based on environment variables
   The environment variables expected are:
     AZURE_CLIENT_ID
     AZURE_CLIENT_SECRET
     AZURE_TENANT_ID
  or:
     AZURE_CLIENT_ID
     AZURE_CLIENT_CERTIFICATE_PATH
     AZURE_TENANT_ID
  or:
     AZURE_CLIENT_ID
     AZURE_USERNAME
     AZURE_PASSWORD

azure.identity.EnvironmentCredential.EnvironmentCredential

Created using a EnvironmentCredential java object from the
  EnvironmentCredential class only

azure.identity.EnvironmentCredentialBuilder

Superclass: azure.identity.CredentialBuilderBase

ENVIRONMENTCREDENTIALBUILDER Builder for EnvironmentCredentialBuilder

azure.identity.EnvironmentCredentialBuilder.EnvironmentCredentialBuilder

ENVIRONMENTCREDENTIALBUILDER Builder for EnvironmentCredentialBuilder

azure.identity.EnvironmentCredentialBuilder.authorityHost

AUTHORITYHOST Specifies the Azure Active Directory endpoint to acquire tokens
  An updated EnvironmentCredentialBuilder is returned.

azure.identity.EnvironmentCredentialBuilder.build

BUILD Creates new EnvironmentCredential with the configured options set

azure.identity.InteractiveBrowserCredential

Superclass: azure.core.credential.TokenCredential

INTERACTIVEBROWSERCREDENTIAL Prompt the login in the default browser
  An AAD credential that acquires a token for an AAD application by prompting
  the login in the default browser.
  The oauth2 flow will notify the credential of the authentication code through
  the reply URL.
  The application to authenticate to must have delegated user login permissions 
  and have http://localhost:{port} listed as a valid reply URL.

azure.identity.InteractiveBrowserCredential.InteractiveBrowserCredential

Created using a EnvironmentCredential java object from the
  EnvironmentCredential class only

azure.identity.InteractiveBrowserCredentialBuilder

Superclass: azure.identity.CredentialBuilderBase

INTERACTIVEBROWSERCREDENTIALBUILDER builder for InteractiveBrowserCredential

azure.identity.InteractiveBrowserCredentialBuilder.InteractiveBrowserCredentialBuilder

INTERACTIVEBROWSERCREDENTIALBUILDER builder for InteractiveBrowserCredential

azure.identity.InteractiveBrowserCredentialBuilder.authorityHost

AUTHORITYHOST Specifies the Azure Active Directory endpoint to acquire tokens
  An updated InteractiveBrowserCredentialBuilder is returned.

azure.identity.InteractiveBrowserCredentialBuilder.build

BUILD Creates new InteractiveBrowserCredential with the configured options set

azure.identity.InteractiveBrowserCredentialBuilder.clientId

CLIENTID Sets client id
  An updated InteractiveBrowserCredentialBuilder is returned.

azure.identity.InteractiveBrowserCredentialBuilder.redirectUrl

REDIRECTURL Sets Redirect URL for application with the security code callback

azure.identity.InteractiveBrowserCredentialBuilder.tenantId

TENANTID Sets tenant id of user to authenticate through InteractiveBrowserCredential
  An updated InteractiveBrowserCredentialBuilder is returned.

azure.identity.InteractiveBrowserCredentialBuilder.tokenCachePersistenceOptions

tokenCachePersistenceOptions Sets tokenCachePersistenceOptions.

azure.identity.ManagedIdentityCredential

Superclass: azure.core.credential.TokenCredential

MANAGEDIDENTITYCREDENTIAL Managed Service Identity token based credentials

azure.identity.ManagedIdentityCredential.ManagedIdentityCredential

MANAGEDIDENTITYCREDENTIAL Managed Service Identity token based credentials

azure.identity.ManagedIdentityCredential.getClientId

GETCLIENTID Gets the client ID of user assigned or system assigned identity
  The client ID is returned as a character vector.

azure.identity.ManagedIdentityCredentialBuilder

Superclass: azure.identity.CredentialBuilderBase

MANAGEDIDENTITYCREDENTIALBUILDER Builder for ManagedIdentityCredential

azure.identity.ManagedIdentityCredentialBuilder.ManagedIdentityCredentialBuilder

MANAGEDIDENTITYCREDENTIALBUILDER Builder for ManagedIdentityCredential

azure.identity.ManagedIdentityCredentialBuilder.build

BUILD Creates new ManagedIdentityCredential with the configured options set

azure.identity.ManagedIdentityCredentialBuilder.clientId

CLIENTID Sets client id
  An updated ManagedIdentityCredentialBuilder is returned.

azure.identity.ManagedIdentityCredentialBuilder.maxRetry

MAXRETRY Sets max number of retries when an authentication request fails

azure.identity.ManagedIdentityCredentialBuilder.resourceId

RESOURCEID Sets client id
  An updated ManagedIdentityCredentialBuilder is returned.

azure.identity.SharedTokenCacheCredential

Superclass: azure.core.credential.TokenCredential

DEVICECODECREDENTIAL A credential provider that provides token
  credentials from the MSAL shared token cache.

azure.identity.SharedTokenCacheCredential.SharedTokenCacheCredential

DEVICECODECREDENTIAL A credential provider that provides token
  credentials from the MSAL shared token cache.

azure.identity.SharedTokenCacheCredential.restFlow

azure.identity.SharedTokenCacheCredential.restFlow is an undocumented builtin static method or namespace function.

azure.identity.SharedTokenCacheCredential.restGetSas

azure.identity.SharedTokenCacheCredential.restGetSas is an undocumented builtin static method or namespace function.

azure.identity.SharedTokenCacheCredentialBuilder

Superclass: azure.identity.CredentialBuilderBase

SHAREDTOKENCACHECREDENTIALBUILDER Builder for SharedTokenCacheCredential

azure.identity.SharedTokenCacheCredentialBuilder.SharedTokenCacheCredentialBuilder

SHAREDTOKENCACHECREDENTIALBUILDER Builder for SharedTokenCacheCredential

azure.identity.SharedTokenCacheCredentialBuilder.authorityHost

AUTHORITYHOST Specifies the Azure Active Directory endpoint to acquire tokens
  An updated SharedTokenCacheCredentialBuilder is returned.

azure.identity.SharedTokenCacheCredentialBuilder.build

BUILD Creates new SharedTokenCacheCredential with the configured options set

azure.identity.SharedTokenCacheCredentialBuilder.clientId

CLIENTID Sets client id
  An updated SharedTokenCacheCredentialBuilder is returned.

azure.identity.SharedTokenCacheCredentialBuilder.tenantId

TENANTID Sets tenant id to authenticate through SharedTokenCacheCredential
  An updated SharedTokenCacheCredentialBuilder is returned.

azure.identity.SharedTokenCacheCredentialBuilder.tokenCachePersistenceOptions

TOKENCACHEPERSISTENCEOPTIONS Sets tokenCachePersistenceOptions.

azure.identity.TokenCachePersistenceOptions

Superclass: azure.object

TOKENREQUESTCONTEXT Contains details of a request to get a token
  Can be created based on a corresponding com.azure.core.credential.TokenRequestContext
  Java object argument or without an argument where further configuration is
  required to add scopes.

azure.identity.TokenCachePersistenceOptions.TokenCachePersistenceOptions

TOKENREQUESTCONTEXT Contains details of a request to get a token
  Can be created based on a corresponding com.azure.core.credential.TokenRequestContext
  Java object argument or without an argument where further configuration is
  required to add scopes.

azure.identity.TokenCachePersistenceOptions.getName

GETNAME Get the name.
  Returns a character vector.

azure.identity.TokenCachePersistenceOptions.setName

SETNAME Set the name.
  Returns an updated azure.core.identity.TokenCachePersistenceOptions.

azure.mathworks

azure.mathworks.internal

azure.mathworks.internal.compareAuthEnvVars

COMPAREAUTHENVVARS Checks matching Java & MATLAB authentication env. variables
  This is a useful sanity check that variables exist in both contexts.
  The following variables are tested:
    AZURE_CLIENT_ID
    AZURE_CLIENT_SECRET
    AZURE_TENANT_ID
    AZURE_CLIENT_CERTIFICATE_PATH
    AZURE_USERNAME
    AZURE_PASSWORD
 
  A variable no set in either context does not return a false.
  A logical is returned.

azure.mathworks.internal.datetime2OffsetDateTime

DATETIME2OFFSETDATETIME Converts a MATLAB datetime to a Java
  OffsetDateTime in UTC. Ideally the input MATLAB datetime has a specific
  timezone set already. If no timezone is set, local is assumed.

azure.mathworks.internal.int64FnHandler

int64FnHandler Invokes Java method to convert a Java long to a string and then an int64
  An int64 is returned.

azure.security

azure.security.keyvault

azure.security.keyvault.keys

azure.security.keyvault.keys.models

azure.security.keyvault.keys.models.DeletedKey

Superclass: azure.security.keyvault.keys.models.KeyVaultKey

DELETEDKEY Deleted Key is the resource consisting of name, recovery
  id, deleted date, scheduled purge date and its attributes inherited
  from KeyVaultKey. It is managed by Key Service.
 
  DeletedKey follows the Azure KeyVault Java SDK design, meaning that
  DeletedKey inherits from KeyVaultKey, giving DeletedKey methods like
  getKey and getName. It appears however that some of those methods do
  not actually return a value for deleted keys and it even appears to
  depend on how the DeletedKey was obtained. A DeletedKey obtained
  through getDeletedKey *does* appear to return a name when calling
  getName whereas DeletedKey obtained through listDeletedKeys does
  *not*. These are all behaviors of the underlying Azure KeyVault Java
  SDK and not MATLAB specific behaviors.
 
  In that sense, to determine the name of a deleted key, it appears the
  best option is to call getRecoveryId and parse the name from the URI
  this returns.

azure.security.keyvault.keys.models.DeletedKey.DeletedKey

DELETEDKEY Deleted Key is the resource consisting of name, recovery
  id, deleted date, scheduled purge date and its attributes inherited
  from KeyVaultKey. It is managed by Key Service.
 
  DeletedKey follows the Azure KeyVault Java SDK design, meaning that
  DeletedKey inherits from KeyVaultKey, giving DeletedKey methods like
  getKey and getName. It appears however that some of those methods do
  not actually return a value for deleted keys and it even appears to
  depend on how the DeletedKey was obtained. A DeletedKey obtained
  through getDeletedKey *does* appear to return a name when calling
  getName whereas DeletedKey obtained through listDeletedKeys does
  *not*. These are all behaviors of the underlying Azure KeyVault Java
  SDK and not MATLAB specific behaviors.
 
  In that sense, to determine the name of a deleted key, it appears the
  best option is to call getRecoveryId and parse the name from the URI
  this returns.

azure.security.keyvault.keys.models.DeletedKey.getDeletedOn

GETDELETEDON Get the deleted UTC time. 
  A datetime object is returned.

azure.security.keyvault.keys.models.DeletedKey.getRecoveryId

GETRECOVERYID Get the recoveryId identifier.
  The URI is returned as character array.

azure.security.keyvault.keys.models.DeletedKey.getScheduledPurgeDate

GETSCHEDULEDPURGEDATE Get the scheduled purge UTC time.
  A datetime object is returned.

azure.security.keyvault.keys.models.JsonWebKey

Superclass: azure.object

JSONWEBKEY Key as per http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
  This can be used an intermediate format for converting to other key types or
  for extracting elements of a key.
 
  Example:
      key = keyClient.getKey('myKeyName');
      % Return as a jsonWebKey and test if valid
      jsonWebKey = key.getKey();
      tf = jsonWebKey.isValid);
      % Convert to an RSA key
      keyRsa = jsonWebKey.toRsa(false);

azure.security.keyvault.keys.models.JsonWebKey.JsonWebKey

Create a logger object

azure.security.keyvault.keys.models.JsonWebKey.clearMemory

CLEARMEMORY Clears key materials in the underlying Java SDK

azure.security.keyvault.keys.models.JsonWebKey.getId

GETID Get the kid value
  A character vector is returned.

azure.security.keyvault.keys.models.JsonWebKey.getKeyType

GETKEYTYPE Get the kty value
  A azure.security.keyvault.keys.models.KeyType is returned.

azure.security.keyvault.keys.models.JsonWebKey.hasPrivateKey

HASPRIVATEKEY Verifies whether the JsonWebKey has a private key or not
  A logical is returned.

azure.security.keyvault.keys.models.JsonWebKey.isValid

ISVALID Verifies whether the JsonWebKey is valid
  A logical is returned.

azure.security.keyvault.keys.models.JsonWebKey.toAes

TOAES Converts JSON web key to AES key
  A key of type javax.crypto.SecretKey is returned.
 
  Example:
      key = keyClient.getKey('myKeyName');
      jsonWebKey = key.getKey();
      keyAes = jsonWebKey.toAes();

azure.security.keyvault.keys.models.JsonWebKey.toEc

TOEC Converts JSON web key to EC key pair & optionally include the private key
  Include private key if includePrivateParameters set to true
  A key pair of type java.security.KeyPair is returned.

azure.security.keyvault.keys.models.JsonWebKey.toRsa

TORSA Converts JSON web key to RSA key pair
  Include private key if includePrivateParameters set to true
  A key pair of type java.security.KeyPair is returned.
 
  Example:
      key = keyClient.getKey('myKeyName');
      % Return as a jsonWebKey
      jsonWebKey = key.getKey();
      % Convert to an RSA key
      keyRsa = jsonWebKey.toRsa(false);

azure.security.keyvault.keys.models.JsonWebKey.toString

TOSTRING Return as a character vector

azure.security.keyvault.keys.models.KeyProperties

Superclass: azure.object

KEYPROPERTIES Contains the properties of the secret except its value
 
  Example
      keyClient = createKeyVaultClient('Type','Key');
      propList = keyClient.listPropertiesOfKeys();
      % Look at a name in a returned property
      name = propList(1).getName();

azure.security.keyvault.keys.models.KeyProperties.KeyProperties

KEYPROPERTIES Contains the properties of the secret except its value
 
  Example
      keyClient = createKeyVaultClient('Type','Key');
      propList = keyClient.listPropertiesOfKeys();
      % Look at a name in a returned property
      name = propList(1).getName();

azure.security.keyvault.keys.models.KeyProperties.getId

GETID Get the secret identifier
  A character vector is returned.

azure.security.keyvault.keys.models.KeyProperties.getKeyId

GETKEYID Get the keyId identifier
  A character vector is returned.

azure.security.keyvault.keys.models.KeyProperties.getName

GETNAME Get the key name
  A character vector is returned.

azure.security.keyvault.keys.models.KeyProperties.getVersion

GETVERSION Get the key version
  A character vector is returned.

azure.security.keyvault.keys.models.KeyType

KEYTYPE Defines enumeration values for KeyType
  Values are EC, EC_HSM, OCT, OCT_HSM, RSA & RSA_HSM

Enumeration values:
  EC
  EC_HSM
  OCT
  OCT_HSM
  RSA
  RSA_HSM

azure.security.keyvault.keys.models.KeyType.KeyType

KEYTYPE Defines enumeration values for KeyType
  Values are EC, EC_HSM, OCT, OCT_HSM, RSA & RSA_HSM

azure.security.keyvault.keys.models.KeyType.fromString

FROMSTRING Creates or finds a KeyType from its string representation
  A azure.security.keyvault.keys.models.KeyType is returned.
  Input may be a character vector or scalar string.
  Input is not case sensitive.
  Accepted values are: EC, EC_HSM, OCT, OCT_HSM, RSA & RSA_HSM.
  This is a static method.

azure.security.keyvault.keys.models.KeyType.toJava

TOJAVA Converts to a com.azure.security.keyvault.keys.models.KeyType Java object

azure.security.keyvault.keys.models.KeyType.toString

TOSTRING Returns text form of a azure.security.keyvault.keys.models.KeyType
  A character vector is returned.

azure.security.keyvault.keys.models.KeyVaultKey

Superclass: azure.object

KEYVAULTSECRET KeyVaultKey class
  Creates a azure.security.keyvault.keys.models.KeyVaultKey object.
  A com.azure.security.keyvault.keys.models.KeyVaultKey java object is a required
  input argument. A number of methods return KeyVaultKey objects.
 
  Example
      % Get a KeyVaultKey object
      key = keyClient.getKey('myKeyName');
      keyType = key.getKeyType();
      jsonWebKey = key.getKey();

azure.security.keyvault.keys.models.KeyVaultKey.KeyVaultKey

Create a logger object

azure.security.keyvault.keys.models.KeyVaultKey.getId

GETID Returns the ID value of the key
  A character vector is returned.

azure.security.keyvault.keys.models.KeyVaultKey.getKey

GETKEY Get the public part of the latest version of the key
  A azure.security.keyvault.keys.models.JsonWebKey is returned
 
  Example:
      jsonWebKey = key.getKey();

azure.security.keyvault.keys.models.KeyVaultKey.getKeyType

GETKEYTYPE Returns the type of a key
  Returns a azure.security.keyvault.keys.models.KeyType

azure.security.keyvault.keys.models.KeyVaultKey.getName

GETNAME Returns the key name
  A character vector is returned.

azure.security.keyvault.keys.models.KeyVaultKey.getProperties

GETPROPERTIES Get the key properties
  A azure.security.keyvault.keys.models.KeyProperties is returned.

azure.security.keyvault.keys.KeyClient

Superclass: azure.object

KEYCLIENT A KeyClient object for transacting keys with the Key Vault
 
  Example:
      % Create a client using the createKeyVaultClient() function
      % Here an optional non default configuration file path is provided that holds
      % Client Secret style credentials
      keyClient = createKeyVaultClient('Type','Key','ConfigurationFile','C:\myFiles\matlab-azure-key-vault\Software\MATLAB\config\ClientSecret.json')
 
   Or
 
      % If a configuration file path is not provided *createKeyVaultClient()* will search
      % MATLAB path for a configuration file named ```keyvaultsettings.json```:
      keyClient = createKeyVaultClient('Type','Key');
 
   Or
 
      % Alternatively a client can also be created manually to 
      % Configure the logger level and message prefix if not already configured
      initialize('displayLevel', 'debug', 'loggerPrefix', 'Azure:KeyVault');
 
      % Configure a credentials object based on a JSON config file
      credentials = configureCredentials(which('keyvaultsettings.json'));
 
      % Create a client builder object, a KeyClient in this case
      builder = azure.security.keyvault.keys.KeyClientBuilder();
 
      % Configure the builder using its methods
      builder = builder.credential(credentials);
      builder = builder.httpClient();
      settings = loadConfigurationSettings(which('keyvaultsettings.json'));
      builder = builder.vaultUrl(sprintf('https://%s.vault.azure.net/',settings.VaultName));
 
      % Create the client
      keyClient = builder.buildClient();

azure.security.keyvault.keys.KeyClient.KeyClient

KEYCLIENT A KeyClient object for transacting keys with the Key Vault
 
  Example:
      % Create a client using the createKeyVaultClient() function
      % Here an optional non default configuration file path is provided that holds
      % Client Secret style credentials
      keyClient = createKeyVaultClient('Type','Key','ConfigurationFile','C:\myFiles\matlab-azure-key-vault\Software\MATLAB\config\ClientSecret.json')
 
   Or
 
      % If a configuration file path is not provided *createKeyVaultClient()* will search
      % MATLAB path for a configuration file named ```keyvaultsettings.json```:
      keyClient = createKeyVaultClient('Type','Key');
 
   Or
 
      % Alternatively a client can also be created manually to 
      % Configure the logger level and message prefix if not already configured
      initialize('displayLevel', 'debug', 'loggerPrefix', 'Azure:KeyVault');
 
      % Configure a credentials object based on a JSON config file
      credentials = configureCredentials(which('keyvaultsettings.json'));
 
      % Create a client builder object, a KeyClient in this case
      builder = azure.security.keyvault.keys.KeyClientBuilder();
 
      % Configure the builder using its methods
      builder = builder.credential(credentials);
      builder = builder.httpClient();
      settings = loadConfigurationSettings(which('keyvaultsettings.json'));
      builder = builder.vaultUrl(sprintf('https://%s.vault.azure.net/',settings.VaultName));
 
      % Create the client
      keyClient = builder.buildClient();

azure.security.keyvault.keys.KeyClient.beginDeleteKey

BEGINDELETESECRET Deletes a key by name from Key Vault
  A azure.core.util.polling.syncPoller is returned.
  For details see: matlab-azure-common/Software/MATLAB/app/system/+azure/+core/+util/+polling/@SyncPoller
  keyName can be provided as a scalar character vector or string.
 
  Example:
      key = keyClient.getKey('myKeyName');
      syncPoller = keyClient.beginDeleteKey('myKeyName');
      % Block until completion, allow a 10 second timeout
      syncPoller.waitForCompletion(10);
      % Other syncPoller methods are available, e.g. cancelOperation()

azure.security.keyvault.keys.KeyClient.beginRecoverDeletedKey

BEGINRECOVERDELETEDKEY Recovers the deleted key in the key vault to its
  latest version and can only be performed on a soft-delete enabled vault.
  A azure.core.util.polling.syncPoller is returned.
  For details see: matlab-azure-common/Software/MATLAB/app/system/+azure/+core/+util/+polling/@SyncPoller
  keyName can be provided as a scalar character vector or string.
 
  Example:
      syncPoller = keyClient.beginRecoverDeletedKey('myKeyName');
      % Block until completion, allow a 10 second timeout
      syncPoller.waitForCompletion(10);
      % Other syncPoller methods are available, e.g. cancelOperation()

azure.security.keyvault.keys.KeyClient.createKey

CREATEKEY Creates a new key and stores it in the key vault
  A key name argument is provided as a character vector or scalar string.
  A azure.security.keyvault.keys.models.KeyType is provided as an argument
  to indicate which type of key to create.
  An azure.security.keyvault.keys.models.KeyVaultKey is returned.
 
  Example:
      % Create a client
      keyClient = createKeyVaultClient('Type','Key');
      % Create a key type, in this case RSA
      rsaKeyType = azure.security.keyvault.keys.models.KeyType.RSA;
      % Create the key
      key = KeyClient.createKey('myKeyName', rsaKeyType);

azure.security.keyvault.keys.KeyClient.getDeletedKey

GETDELETEDKEY Gets the public part of a deleted key.
  The name argument is provided as a character vector or scalar string.
  A azure.security.keyvault.keys.models.DeletedKey is returned.
 
  Example:
      key = keyClient.getDeletedKey('myKeyName');

azure.security.keyvault.keys.KeyClient.getKey

GETKEY Get the public part of the latest version of the specified key
  The name argument is provided as a character vector or scalar string.
  A azure.security.keyvault.keys.models.KeyVaultKey is returned.
 
  Example:
      key = keyClient.getKey('myKeyName');

azure.security.keyvault.keys.KeyClient.getVaultUrl

GETVAULTURL Gets the vault endpoint url to which service requests are sent to
  A character vector is returned.
  A URL has the form: https://<myKeyVaultName>.vault.azure.net/
  The vaultUrl can optionally be stored in the package's JSON configuration file.

azure.security.keyvault.keys.KeyClient.listDeletedKeys

LISTDELETEDKEYS Lists deleted keys of the key vault.
  Properties are returned as an array of 
  azure.security.keyvault.keys.models.DeletedKey objects.
  If there are no keys an empty array is returned.
 
  Example
      % Get a list the key properties
      deletedKeys = keyClient.listDeletedKeys();

azure.security.keyvault.keys.KeyClient.listPropertiesOfKeys

LISTPROPERTIESOFKEYS Lists keys in the key vault
  Properties are returned as an array of 
  azure.security.keyvault.keys.models.KeyProperties objects.
  If there are no keys an empty array is returned.
 
  Example
      % Get a list the key properties
      keyProperties = keyClient.listPropertiesOfKeys();
      % Look at some of the data returned i.e. the key name
      propList(1).getName();

azure.security.keyvault.keys.KeyClient.purgeDeletedKey

PURGEDELETEDKEY Permanently deletes the specified key without the
  possibility of recovery. The Purge Deleted Key operation is applicable
  for soft-delete enabled vaults. This operation requires the keys/purge
  permission.
  The name argument is provided as a character vector or scalar string.
  The function throws an error if no deleted key can be found. Returns
  nothing upon success.
 
  Example:
      keyClient.purgeDeletedKey('myKeyName');

azure.security.keyvault.keys.KeyClientBuilder

Superclass: azure.object

KEYCLIENTBUILDER Builder for KeyClient object
  Can optionally accept a Java com.azure.security.keyvault.keys.KeyClientBuilder
  object as an argument to create a MATLAB builder from the Java builder.

azure.security.keyvault.keys.KeyClientBuilder.KeyClientBuilder

KEYCLIENTBUILDER Builder for KeyClient object
  Can optionally accept a Java com.azure.security.keyvault.keys.KeyClientBuilder
  object as an argument to create a MATLAB builder from the Java builder.

azure.security.keyvault.keys.KeyClientBuilder.buildClient

BUILDCLIENT Creates a KeyClient based on options configured in the builder

azure.security.keyvault.keys.KeyClientBuilder.credential

CREDENTIAL Sets the credentials used to authorize a client's requests
  An updated builder object is returned.
 
  Example:
      configFilePath = fullfile(AzureCommonRoot, 'config', 'ClientSecret.json');
      credentials = configureCredentials(configFilePath);
      builder = builder.credential(credentials);

azure.security.keyvault.keys.KeyClientBuilder.httpClient

HTTPCLIENT Sets the HttpClient to use for sending a receiving requests
  Currently the Netty client is configured by default. Other options may be added
  in the future. An updated builder object is returned.
  This method will apply http proxy settings if defined in MATLAB Web preferences.

azure.security.keyvault.keys.KeyClientBuilder.vaultUrl

VAULTURL Sets the vault URL to send HTTP requests to
  vaultUrl should be of type character vector or scalar string.
  An updated builder object is returned.
  A URL has the form: https://<myKeyVaultName>.vault.azure.net/
  The vaultUrl can optionally be stored in the package's JSON configuration file.

azure.security.keyvault.secrets

azure.security.keyvault.secrets.models

azure.security.keyvault.secrets.models.DeletedSecret

Superclass: azure.security.keyvault.secrets.models.KeyVaultSecret

DELETEDSECRET Deleted Secret is the resource consisting of name,
  recovery id, deleted date, scheduled purge date and its attributes
  inherited from KeyVaultSecret. It is managed by Secret Service.
 
  DeletedSecret follows the Azure KeyVault Java SDK design, meaning
  that DeletedSecret inherits from KeyVaultSecret, giving DeletedSecret
  methods like getValue. It appears however that this method does not
  actually return a value for deleted secrets. These are all behaviors
  of the underlying Azure KeyVault Java SDK and not MATLAB specific
  behaviors.

azure.security.keyvault.secrets.models.DeletedSecret.DeletedSecret

DELETEDSECRET Deleted Secret is the resource consisting of name,
  recovery id, deleted date, scheduled purge date and its attributes
  inherited from KeyVaultSecret. It is managed by Secret Service.
 
  DeletedSecret follows the Azure KeyVault Java SDK design, meaning
  that DeletedSecret inherits from KeyVaultSecret, giving DeletedSecret
  methods like getValue. It appears however that this method does not
  actually return a value for deleted secrets. These are all behaviors
  of the underlying Azure KeyVault Java SDK and not MATLAB specific
  behaviors.

azure.security.keyvault.secrets.models.DeletedSecret.getDeletedOn

GETDELETEDON Get the deleted UTC time.
  A datetime object is returned.

azure.security.keyvault.secrets.models.DeletedSecret.getRecoveryId

GETRECOVERYID Get the recoveryId identifier.
  The URI is returned as character array.

azure.security.keyvault.secrets.models.DeletedSecret.getScheduledPurgeDate

GETSCHEDULEDPURGEDATE Get the scheduled purge UTC time.
  A datetime object is returned.

azure.security.keyvault.secrets.models.KeyVaultSecret

Superclass: azure.object

KEYVAULTSECRET Class to provide access to the KeyVaultSecret object
  Creates a azure.security.keyvault.secrets.models.KeyVaultSecret object.
  A KeyVaultSecret can be created from a name and value or an equivalent Java
  object. A number of methods return KeyVaultSecret objects.
 
 
  Example
      % Get a KeyVaultSecret object
      secret = secretClient.getSecret('mySecretName');
      value = secret.getValue();
 
  Or
 
      secret = azure.security.keyvault.secrets.models.KeyVaultSecret(secretName, secretValue);
 
  Or
 
      secret = azure.security.keyvault.secrets.models.KeyVaultSecret(javaKeyVaultSecret);

azure.security.keyvault.secrets.models.KeyVaultSecret.KeyVaultSecret

Create a logger object

azure.security.keyvault.secrets.models.KeyVaultSecret.getId

GETID Returns the ID value of the secret
  A character vector is returned.

azure.security.keyvault.secrets.models.KeyVaultSecret.getName

GETNAME Returns the name of the secret
  A character vector is returned.

azure.security.keyvault.secrets.models.KeyVaultSecret.getProperties

GETPROPERTIES Get the secret properties
  A azure.security.keyvault.secrets.models.SecretProperties is returned.

azure.security.keyvault.secrets.models.KeyVaultSecret.getValue

GETVALUE Returns the secret value
  A character vector is returned.
 
  Example:
      sc = createKeyVaultClient('Type','Secret');
      secret = sc.getSecret('mySecretName');
      secretValue = secret.getValue();

azure.security.keyvault.secrets.models.SecretProperties

Superclass: azure.object

SECRETPROPERTIES Contains the properties of the secret but not its value
 
  Example:
      secretClient = createKeyVaultClient('Type','Secret');
      propList = secretClient.listPropertiesOfSecrets();
      % Look at a name in a returned property
      name = propList(1).getName();

azure.security.keyvault.secrets.models.SecretProperties.SecretProperties

SECRETPROPERTIES Contains the properties of the secret but not its value
 
  Example:
      secretClient = createKeyVaultClient('Type','Secret');
      propList = secretClient.listPropertiesOfSecrets();
      % Look at a name in a returned property
      name = propList(1).getName();

azure.security.keyvault.secrets.models.SecretProperties.getId

GETID Get the secret identifier
  A character vector is returned.

azure.security.keyvault.secrets.models.SecretProperties.getKeyId

GETKEYID Get the keyId identifier
  A character vector is returned.

azure.security.keyvault.secrets.models.SecretProperties.getName

GETNAME Get the secret name
  A character vector is returned.

azure.security.keyvault.secrets.models.SecretProperties.getVersion

GETVERSION Get the keyId identifier
  A character vector is returned.

azure.security.keyvault.secrets.SecretClient

Superclass: azure.object

SECRETCLIENT A SecretClient object for transacting secrets with the Key Vault
 
  Example
      % Create a Secret client using the higher-level createKeyVaultClient() function
      % Here an optional non default configuration file path is provided that holds
      % Client Secret style credentials:
      secretClient = createKeyVaultClient('Type','Secret','ConfigurationFile','C:\myFiles\matlab-azure-key-vault\Software\MATLAB\config\ClientSecret.json')
 
   Or
 
      % If a configuration file path is not provided *createKeyVaultClient()* will search
      % MATLAB path for a configuration file named ```keyvaultsettings.json```:
      secretClient = createKeyVaultClient('Type','Secret');
 
   Or
 
      % Alternatively a client can also be created manually using the builder for
      % this class:
      % Create a client builder object, a SecretClient in this case
      builder = azure.security.keyvault.secrets.SecretClientBuilder();
 
      % Configure a credentials object based on a JSON config file
      credentials = configureCredentials(which('keyvaultsettings.json'));
 
      % Configure the builder using its methods
      builder = builder.credential(credentials);
      builder = builder.httpClient();
      settings = loadConfigurationSettings(which('keyvaultsettings.json'));
      builder = builder.vaultUrl(sprintf('https://%s.vault.azure.net/',settings.VaultName));
 
      % Create the client
      secretClient = builder.buildClient();

azure.security.keyvault.secrets.SecretClient.SecretClient

SECRETCLIENT A SecretClient object for transacting secrets with the Key Vault
 
  Example
      % Create a Secret client using the higher-level createKeyVaultClient() function
      % Here an optional non default configuration file path is provided that holds
      % Client Secret style credentials:
      secretClient = createKeyVaultClient('Type','Secret','ConfigurationFile','C:\myFiles\matlab-azure-key-vault\Software\MATLAB\config\ClientSecret.json')
 
   Or
 
      % If a configuration file path is not provided *createKeyVaultClient()* will search
      % MATLAB path for a configuration file named ```keyvaultsettings.json```:
      secretClient = createKeyVaultClient('Type','Secret');
 
   Or
 
      % Alternatively a client can also be created manually using the builder for
      % this class:
      % Create a client builder object, a SecretClient in this case
      builder = azure.security.keyvault.secrets.SecretClientBuilder();
 
      % Configure a credentials object based on a JSON config file
      credentials = configureCredentials(which('keyvaultsettings.json'));
 
      % Configure the builder using its methods
      builder = builder.credential(credentials);
      builder = builder.httpClient();
      settings = loadConfigurationSettings(which('keyvaultsettings.json'));
      builder = builder.vaultUrl(sprintf('https://%s.vault.azure.net/',settings.VaultName));
 
      % Create the client
      secretClient = builder.buildClient();

azure.security.keyvault.secrets.SecretClient.beginDeleteSecret

BEGINDELETESECRET Deletes a secret by name from Key Vault
  A azure.core.util.polling.syncPoller is returned.
  keyName can be provided as a scalar character vector or string.
 
  Example:
      secret = secretClient.getSecret('mySecretName');
      syncPoller = secretClient.beginDeleteSecret('mySecretName');
      % Block until completion, allow a 10 second timeout
      syncPoller.waitForCompletion(10);
      % Other syncPoller methods are available

azure.security.keyvault.secrets.SecretClient.beginRecoverDeletedSecret

BEGINRECOVERDELETEDSECRET Recovers the deleted secret in the key vault to
  its latest version. Can only be performed on a soft-delete enabled vault.
  This operation requires the secrets/recover permission.
  A azure.core.util.polling.syncPoller is returned.
  secretName can be provided as a scalar character vector or string.
 
  Example:
      syncPoller = secretClient.beginRecoverDeletedSecret('myDeletedSecretName');
      % Block until completion, allow a 10 second timeout
      syncPoller.waitForCompletion(10);
      % Other syncPoller methods are available

azure.security.keyvault.secrets.SecretClient.getDeletedSecret

GETDELETEDSECRET Gets a secret that has been deleted for a soft-delete enabled key vault.
  The name can be provided as a scalar character vector or string.
  An exception is thrown is a secret does not exist otherwise a
  azure.security.keyvault.secrets.models.DeletedSecret is returned.
 
  Example
      deletedSecret = secretClient.getDeletedSecret('mySecretName');

azure.security.keyvault.secrets.SecretClient.getSecret

GETSECRETS Returns the secret value of the specific secret by name
  The name can be provided as a scalar character vector or string.
  An exception is thrown is a secret does not exist otherwise a
  azure.security.keyvault.secrets.models.KeyVaultSecret is returned.
 
  Example
      secret = secretClient.getsecret('mySecretName');

azure.security.keyvault.secrets.SecretClient.getVaultUrl

GETVAULTURL Gets the vault endpoint url to which service requests are sent to
  A character vector is returned.
  A URL has the form: https://<myKeyVaultName>.vault.azure.net/
  The vaultUrl can optionally be stored in the package's JSON configuration file.

azure.security.keyvault.secrets.SecretClient.listDeletedSecrets

LISTDELETEDSECRETS Lists deleted secrets of the key vault if it has
  enabled soft-delete. This operation requires the secrets/list permission.
  Properties are returned as an array of 
  azure.security.keyvault.secrets.models.DeletedSecret objects.
  If there are no secrets an empty array is returned.
 
  Example:
      % Get a list of the deleted secrets
      deletedSecrets = secretClient.listDeletedSecrets();
      % Look at some of the data returned i.e. the secret name
      deletedSecrets(1).getName();

azure.security.keyvault.secrets.SecretClient.listPropertiesOfSecrets

LISTPROPERTIESOFSECRETS Lists secrets in the key vault
  Properties are returned as an array of 
  azure.security.keyvault.secrets.models.SecretProperties objects.
  If there are no secrets an empty array is returned.
 
  Example:
      % Get a list the secret properties
      secretProperties = secretClient.listPropertiesOfSecrets();
      % Look at some of the data returned i.e. the secret name
      propList(1).getName();

azure.security.keyvault.secrets.SecretClient.purgeDeletedSecret

PURGEDELETEDSECRET Permanently removes a deleted secret, without the
  possibility of recovery. This operation can only be performed on a
  soft-delete enabled vault. This operation requires the secrets/purge
  permission.
 
  Throws an error on failure, does not return anything at all upon success.
 
  Example
      secretClient.purgeDeletedSecret('mySecretName');

azure.security.keyvault.secrets.SecretClient.setSecret

SETSECRETS Creates a secrets using a name and value
  This method returns an azure.security.keyvault.secrets.KeyVaultSecret
  object. secretName and secretValue can be provided as character vectors or
  scalar strings.
 
  Example:
      % Create a SecretClient object
      sc = createKeyVaultClient('Type','Secret');
      % Set the secret name and its value to Azure KeyVault
      keyVaultSecret = sc.setSecret(secretName, secretValue);

azure.security.keyvault.secrets.SecretClientBuilder

Superclass: azure.object

SECRETCLIENTBUILDER builder for SecretClient
  Can optionally accept a Java com.azure.security.keyvault.secrets.SecretClientBuilder
  object as an argument to build a MATLAB builder from the Java builder.

azure.security.keyvault.secrets.SecretClientBuilder.SecretClientBuilder

SECRETCLIENTBUILDER builder for SecretClient
  Can optionally accept a Java com.azure.security.keyvault.secrets.SecretClientBuilder
  object as an argument to build a MATLAB builder from the Java builder.

azure.security.keyvault.secrets.SecretClientBuilder.buildClient

BUILDCLIENT Creates a SecretClient based on options configured in the builder

azure.security.keyvault.secrets.SecretClientBuilder.credential

CREDENTIAL Sets the credentials used to authorize a client's requests
  An updated builder object is returned.
 
  Example:
      configFilePath = fullfile(AzureCommonRoot, 'config', 'ClientSecret.json');
      credentials = configureCredentials(configFilePath);
      builder = builder.credential(credentials);

azure.security.keyvault.secrets.SecretClientBuilder.httpClient

HTTPCLIENT Sets the HttpClient to use for sending a receiving requests
  Currently the Netty client is configured by default. Other options may be added
  in the future. An updated builder object is returned.
  This method will apply http proxy settings if defined in MATLAB Web preferences.

azure.security.keyvault.secrets.SecretClientBuilder.vaultUrl

VAULTURL Sets the vault URL to send HTTP requests to
  The vaultUrl should be of type character vector or scalar string.
  An updated builder object is returned.
  A URL has the form: https://<myKeyVaultName>.vault.azure.net/
  The vaultUrl can optionally be stored in the package's JSON configuration file.

azure.storage

azure.storage.blob

azure.storage.blob.models

azure.storage.blob.models.BlobContainerItem

Superclass: azure.object

BLOBCONTAINERITEM An Azure Storage container

azure.storage.blob.models.BlobContainerItem.BlobContainerItem

BLOBCONTAINERITEM An Azure Storage container

azure.storage.blob.models.BlobContainerItem.getName

GETNAME Returns the container's name as a character vector

azure.storage.blob.models.BlobItem

Superclass: azure.object

BlobItem

azure.storage.blob.models.BlobItem.BlobItem

BlobItem

azure.storage.blob.models.BlobItem.getMetadata

GETMETADATA Get the metadata property

azure.storage.blob.models.BlobItem.getName

GETNAME Returns the blob's name as a character vector

azure.storage.blob.models.BlobItem.getProperties

GETPROPERTIES Get the properties property

azure.storage.blob.models.BlobItem.getSnapshot

GETSNAPSHOT Returns the blob's snapshot property as a character vector

azure.storage.blob.models.BlobItem.getTags

GETTAGS Get the tags property

azure.storage.blob.models.BlobItem.getVersionId

GETVERSIONID Returns the blob's versionId property as a character vector

azure.storage.blob.models.BlobItem.isDeleted

isDeleted Get the deleted property, returns a logical

azure.storage.blob.models.BlobItem.isPrefix

ISPREFIX Get the isPrefix property: If blobs are named to mimic a directory hierarchy

azure.storage.blob.models.BlobItemProperties

Superclass: azure.object

BlobItemProperties Properties of a blob

azure.storage.blob.models.BlobItemProperties.BlobItemProperties

BlobItemProperties Properties of a blob

azure.storage.blob.models.BlobItemProperties.getCacheControl

GETCACHECONTROL Get the cacheControl property

azure.storage.blob.models.BlobItemProperties.getContentEncoding

GETCONTENTENCODING Get the getContentEncoding property

azure.storage.blob.models.BlobItemProperties.getContentLanguage

GETCONTENTLANGUAGE Get the getContentLanguage property

azure.storage.blob.models.BlobItemProperties.getContentLength

GETCONTENTLENGTH Get the contentType property

azure.storage.blob.models.BlobItemProperties.getContentMd5

GETCONTENTMD5 Get the getContentMd5 property
  Return the base64 value shown in the Azure portal

azure.storage.blob.models.BlobItemProperties.getContentType

GETCONTENTTYPE Get the getContentType property

azure.storage.blob.models.BlobListDetails

Superclass: azure.object

BLOBLISTDETAILS Allows users to specify additional information the service should return with each blob when listing blobs

azure.storage.blob.models.BlobListDetails.BlobListDetails

BLOBLISTDETAILS Allows users to specify additional information the service should return with each blob when listing blobs

azure.storage.blob.models.BlobListDetails.getRetrieveCopy

GETRETRIEVECOPY Whether blob metadata related to any current or previous Copy Blob operation should be included in the response

azure.storage.blob.models.BlobListDetails.getRetrieveDeletedBlobs

GETRETRIEVEDELETEDBLOBS Whether blobs which have been soft deleted should be returned

azure.storage.blob.models.BlobListDetails.getRetrieveDeletedBlobsWithVersions

GETRETRIEVEDELETEDBLOBSWITHVERSIONS Whether blobs which have been deleted with versioning

azure.storage.blob.models.BlobListDetails.getRetrieveImmutabilityPolicy

GETRETRIEVEIMMUTABILITYPOLICY Whether immutability policy for the blob should be returned

azure.storage.blob.models.BlobListDetails.getRetrieveLegalHold

GETRETRIEVELEGALHOLD Whether legal hold for the blob should be returned

azure.storage.blob.models.BlobListDetails.getRetrieveMetadata

GETRETRIEVEMETADATA Whether blob metadata should be returned

azure.storage.blob.models.BlobListDetails.getRetrieveSnapshots

GETRETRIEVESNAPSHOTS Whether snapshots should be returned

azure.storage.blob.models.BlobListDetails.getRetrieveTags

GETRETRIEVETAGS Whether blob tags should be returned

azure.storage.blob.models.BlobListDetails.getRetrieveUncommittedBlobs

GETRETRIEVEUNCOMMITTEDBLOBS Whether blob tags should be returned

azure.storage.blob.models.BlobListDetails.getRetrieveVersions

GETRETRIEVEVERSIONS Whether versions should be returned

azure.storage.blob.models.BlobListDetails.setRetrieveCopy

SETRETRIEVECOPY Whether blob metadata related to any current or previous Copy Blob operation should be included in the response

azure.storage.blob.models.BlobListDetails.setRetrieveDeletedBlobs

SETRETRIEVEDELETEDBLOBS Whether blobs which have been soft deleted should be returned

azure.storage.blob.models.BlobListDetails.setRetrieveDeletedBlobsWithVersions

SETRETRIEVEDELETEDBLOBSWITHVERSIONS Whether blobs which have been deleted with versioning should be returned

azure.storage.blob.models.BlobListDetails.setRetrieveImmutabilityPolicy

SETRETRIEVEIMMUTABILITYPOLICY Whether blobs which have been deleted with versioning should be returned

azure.storage.blob.models.BlobListDetails.setRetrieveLegalHold

SETRETRIEVELEGALHOLD Whether legal hold for the blob should be returned

azure.storage.blob.models.BlobListDetails.setRetrieveMetadata

SETRETRIEVEMETADATA Whether blob metadata should be returned

azure.storage.blob.models.BlobListDetails.setRetrieveSnapshots

setRetrieveSnapshots Whether snapshots should be returned

azure.storage.blob.models.BlobListDetails.setRetrieveTags

setRetrieveTags Whether blob tags should be returned

azure.storage.blob.models.BlobListDetails.setRetrieveUncommittedBlobs

SETRETRIEVEUNCOMMITTEDBLOBS Whether blob metadata should be returned

azure.storage.blob.models.BlobListDetails.setRetrieveVersions

SETRETRIEVEUNCOMMITTEDBLOBS Whether versions should be returned

azure.storage.blob.models.BlobProperties

Superclass: azure.object

BlobProperties Properties of a blob

azure.storage.blob.models.BlobProperties.BlobProperties

BlobProperties Properties of a blob

azure.storage.blob.models.BlobProperties.getBlobSize

GETBLOBSIZE Gets the size of the blob in bytes
  An int64 is returned.

azure.storage.blob.models.BlobProperties.getCacheControl

GETCACHECONTROL Get the the cache control of the blob

azure.storage.blob.models.BlobProperties.getContentEncoding

GETCONTENTENCODING Get the content encoding of the blob

azure.storage.blob.models.BlobProperties.getContentLanguage

GETCONTENTLANGUAGE Get the content language of the blob

azure.storage.blob.models.BlobProperties.getContentMd5

GETCONTENTMD5 Get the MD5 of the blob's content
  Return the base64 value shown in the Azure portal

azure.storage.blob.models.BlobProperties.getContentType

GETCONTENTTYPE Get the content type of the blob

azure.storage.blob.models.ListBlobsOptions

Superclass: azure.object

LISTBLOBSOPTIONS Defines options available to configure the behavior of a call to listBlobs on a BlobContainerClient

azure.storage.blob.models.ListBlobsOptions.ListBlobsOptions

LISTBLOBSOPTIONS Defines options available to configure the behavior of a call to listBlobs on a BlobContainerClient

azure.storage.blob.models.ListBlobsOptions.getDetails

GETDETAILS Returns a BlobListDetails object

azure.storage.blob.models.ListBlobsOptions.getMaxResultsPerPage

GETDETAILS Returns the maximum number of blobs to return, including all BlobPrefix elements
  A double is returned.
  An empty [] is returned if not set.

azure.storage.blob.models.ListBlobsOptions.getPrefix

GETPREFIX Filters the results to return only blobs whose names begin with the specified prefix

azure.storage.blob.models.ListBlobsOptions.setDetails

SETDETAILS Returns a ListBlobsOptions object

azure.storage.blob.models.ListBlobsOptions.setMaxResultsPerPage

SETDETAILS Returns a ListBlobsOptions object

azure.storage.blob.models.ListBlobsOptions.setPrefix

SETPREFIX Filters the results to return only blobs whose names begin with the specified prefix

azure.storage.blob.models.StorageAccountInfo

Superclass: azure.object

STORAGEACCOUNTINFO Holds information related to the storage account
  Currently only constructing an object based on and existing java object of
  type StorageAccountInfo is supported.

azure.storage.blob.models.StorageAccountInfo.StorageAccountInfo

STORAGEACCOUNTINFO Holds information related to the storage account
  Currently only constructing an object based on and existing java object of
  type StorageAccountInfo is supported.

azure.storage.blob.models.StorageAccountInfo.getAccountKind

GETACCOUNTKIND Describes the type of the storage account
  Values: BLOB_STORAGE, BLOCK_BLOB_STORAGE, FILE_STORAGE, STORAGE, STORAGE_V2
  A character vector is returned rather than an enumeration

azure.storage.blob.models.UserDelegationKey

Superclass: azure.object

USERDELEGATIONKEY A user delegation key.

azure.storage.blob.models.UserDelegationKey.UserDelegationKey

USERDELEGATIONKEY A user delegation key.

azure.storage.blob.models.UserDelegationKey.getSignedExpiry

GETSIGNEDEXPIRY Get the signedExpiry property: The date-time
  the key expires.

azure.storage.blob.models.UserDelegationKey.getSignedStart

GETSIGNEDSTART Get the signedStart property: The date-time the
 key is active.

azure.storage.blob.sas

azure.storage.blob.sas.BlobContainerSasPermission

Superclass: azure.object

BLOBCONTAINERSASPERMISSION Constructs a string of permissions granted by Account SAS
  Setting a value to true means that any SAS which uses these permissions will
  grant permissions for that operation.
  Once the required values are set, the object should be serialized with
  toString and set as the permissions field on a BlobSasSignatureValues
  object

azure.storage.blob.sas.BlobContainerSasPermission.BlobContainerSasPermission

BLOBCONTAINERSASPERMISSION Constructs a string of permissions granted by Account SAS
  Setting a value to true means that any SAS which uses these permissions will
  grant permissions for that operation.
  Once the required values are set, the object should be serialized with
  toString and set as the permissions field on a BlobSasSignatureValues
  object

azure.storage.blob.sas.BlobContainerSasPermission.hasAddPermission

HASADDPERMISSION Returns the add permission status
  The result is returned as a logical.

azure.storage.blob.sas.BlobContainerSasPermission.hasCreatePermission

HASCREATEPERMISSION Returns the create permission status
  The result is returned as a logical

azure.storage.blob.sas.BlobContainerSasPermission.hasDeletePermission

HASDELETEPERMISSION Returns the delete permission status
  The result is returned as a logical.

azure.storage.blob.sas.BlobContainerSasPermission.hasListPermission

HASLISTPERMISSION Returns the list permission status
  The result is returned as a logical.

azure.storage.blob.sas.BlobContainerSasPermission.hasReadPermission

HASREADPERMISSION Returns the read permission status
  The result is returned as a logical.

azure.storage.blob.sas.BlobContainerSasPermission.hasWritePermission

HASWRITEPERMISSION Returns the write permission status
  The result is returned as a logical.

azure.storage.blob.sas.BlobContainerSasPermission.parse

PARSE Creates a BlobContainerSasPermission from the specified permissions string
  A azure.storage.blob.sas.BlobContainerSasPermission object is returned.
  permString should be of type scalar string or character vector.
  Throws an IllegalArgumentException if it encounters a character that does
  not correspond to a valid permission.
  This is a static method.
  Expected characters are r, a, c, w, or d.

azure.storage.blob.sas.BlobContainerSasPermission.setAddPermission

SETADDPERMISSION Sets the add permission status
  The permission argument should be of type logical.
  A azure.storage.blob.sas.BlobContainerSasPermission object is returned.

azure.storage.blob.sas.BlobContainerSasPermission.setCreatePermission

SETCREATEPERMISSION Sets the create permission status
  The permission argument should be of type logical.
  A azure.storage.blob.sas.BlobContainerSasPermission object is returned.

azure.storage.blob.sas.BlobContainerSasPermission.setDeletePermission

SETDELETEPERMISSION Sets the delete permission status
  The permission argument should be of type logical.
  A azure.storage.blob.sas.BlobContainerSasPermission object is returned.

azure.storage.blob.sas.BlobContainerSasPermission.setListPermission

SETLISTPERMISSION Sets the list permission status
  The permission argument should be of type logical.
  A azure.storage.blob.sas.BlobContainerSasPermission object is returned.

azure.storage.blob.sas.BlobContainerSasPermission.setReadPermission

SETREADPERMISSION Sets the read permission status
  The permission argument should be of type logical.
  A azure.storage.blob.sas.BlobContainerSasPermission object is returned.

azure.storage.blob.sas.BlobContainerSasPermission.setWritePermission

SETWRITEPERMISSION Sets the write permission status
  The permission argument should be of type logical.
  A azure.storage.blob.sas.BlobContainerSasPermission object is returned.

azure.storage.blob.sas.BlobContainerSasPermission.toString

TOSTRING Converts the given permissions to a String
  A character vector is returned.

azure.storage.blob.sas.BlobSasPermission

Superclass: azure.object

BLOBSASPERMISSION Constructs a string of permissions granted by Account SAS
  Setting a value to true means that any SAS which uses these permissions will
  grant permissions for that operation.
  Once the required values are set, the object should be serialized with
  toString and set as the permissions field on a BlobSasSignatureValues
  object

azure.storage.blob.sas.BlobSasPermission.BlobSasPermission

BLOBSASPERMISSION Constructs a string of permissions granted by Account SAS
  Setting a value to true means that any SAS which uses these permissions will
  grant permissions for that operation.
  Once the required values are set, the object should be serialized with
  toString and set as the permissions field on a BlobSasSignatureValues
  object

azure.storage.blob.sas.BlobSasPermission.hasAddPermission

HASADDPERMISSION Returns the add permission status
  The result is returned as a logical.

azure.storage.blob.sas.BlobSasPermission.hasCreatePermission

HASCREATEPERMISSION Returns the create permission status
  The result is returned as a logical

azure.storage.blob.sas.BlobSasPermission.hasDeletePermission

HASDELETEPERMISSION Returns the delete permission status
  The result is returned as a logical.

azure.storage.blob.sas.BlobSasPermission.hasReadPermission

HASREADPERMISSION Returns the read permission status
  The result is returned as a logical.

azure.storage.blob.sas.BlobSasPermission.hasWritePermission

HASWRITEPERMISSION Returns the write permission status
  The result is returned as a logical.

azure.storage.blob.sas.BlobSasPermission.parse

PARSE Creates a BlobSasPermission from the specified permissions string
  A azure.storage.blob.sas.BlobSasPermission object is returned.
  permString should be of type scalar string or character vector.
  Throws an IllegalArgumentException if it encounters a character that does
  not correspond to a valid permission.
  This is a static method.
  Expected characters are r, a, c, w, or d.

azure.storage.blob.sas.BlobSasPermission.setAddPermission

SETADDPERMISSION Sets the add permission status
  The permission argument should be of type logical.
  A azure.storage.blob.sas.BlobSasPermission object is returned.

azure.storage.blob.sas.BlobSasPermission.setCreatePermission

SETCREATEPERMISSION Sets the create permission status
  The permission argument should be of type logical.
  A azure.storage.blob.sas.BlobSasPermission object is returned.

azure.storage.blob.sas.BlobSasPermission.setDeletePermission

SETDELETEPERMISSION Sets the delete permission status
  The permission argument should be of type logical.
  A azure.storage.blob.sas.BlobSasPermission object is returned.

azure.storage.blob.sas.BlobSasPermission.setReadPermission

SETREADPERMISSION Sets the read permission status
  The permission argument should be of type logical.
  A azure.storage.blob.sas.BlobSasPermission object is returned.

azure.storage.blob.sas.BlobSasPermission.setWritePermission

SETWRITEPERMISSION Sets the write permission status
  The permission argument should be of type logical.
  A azure.storage.blob.sas.BlobSasPermission object is returned.

azure.storage.blob.sas.BlobSasPermission.toString

TOSTRING Converts the given permissions to a String
  A character vector is returned.

azure.storage.blob.sas.BlobServiceSasSignatureValues

Superclass: azure.object

BLOBSERVICESASSIGNATUREVALUES Used to initialize a SAS for a Blob service
  When the values are set, use the generateSas method on the desired service
  client to obtain a representation of the SAS which can then be applied to a
  new client using the .sasToken(String) method on the desired client builder.
 
  Example
    bsssv = azure.storage.blob.sas.BlobServiceSasSignatureValues(expiryTime, permissions);
 
  Argument types:
    expiryTime:  datetime ideally with defined TimeZone to avoid any 
                 confusion, if TimeZone is not set, 'local' is assumed
    permissions: azure.storage.blob.sas.BlobSasPermission or
                 BlobContainerSasPermission

azure.storage.blob.sas.BlobServiceSasSignatureValues.BlobServiceSasSignatureValues

BLOBSERVICESASSIGNATUREVALUES Used to initialize a SAS for a Blob service
  When the values are set, use the generateSas method on the desired service
  client to obtain a representation of the SAS which can then be applied to a
  new client using the .sasToken(String) method on the desired client builder.
 
  Example
    bsssv = azure.storage.blob.sas.BlobServiceSasSignatureValues(expiryTime, permissions);
 
  Argument types:
    expiryTime:  datetime ideally with defined TimeZone to avoid any 
                 confusion, if TimeZone is not set, 'local' is assumed
    permissions: azure.storage.blob.sas.BlobSasPermission or
                 BlobContainerSasPermission

azure.storage.blob.specialized

azure.storage.blob.specialized.BlobLeaseClient

Superclass: azure.object

BLOBLEASECLIENT This class provides a client that contains all the
  leasing operations for BlobContainerClient and BlobClient. This client
  acts as a supplement to those clients and only handles leasing
  operations.

azure.storage.blob.specialized.BlobLeaseClient.BlobLeaseClient

BLOBLEASECLIENT This class provides a client that contains all the
  leasing operations for BlobContainerClient and BlobClient. This client
  acts as a supplement to those clients and only handles leasing
  operations.

azure.storage.blob.specialized.BlobLeaseClient.acquireLease

ACQUIRELEASE Acquires a lease for write and delete
  operations. The lease duration must be between 15 to 60
  seconds or -1 for an infinite duration.
 
  Returns the lease ID.

azure.storage.blob.specialized.BlobLeaseClient.breakLease

BREAKLEASE Breaks the previously acquired lease, if it
  exists.
 
  Returns the remaining time in the broken lease in seconds.

azure.storage.blob.specialized.BlobLeaseClient.changeLease

CHANGELEASE Changes the lease ID.
 
  Returns the new lease ID.

azure.storage.blob.specialized.BlobLeaseClient.getLeaseId

GETLEASEID Get the lease ID for this lease.

azure.storage.blob.specialized.BlobLeaseClient.getResourceUrl

GETRESOURCEURL Gets the URL of the lease client.

azure.storage.blob.specialized.BlobLeaseClient.releaseLease

RELEASELEASE Releases the previously acquired lease.

azure.storage.blob.specialized.BlobLeaseClient.renewLease

RENEWLEASE Renews the previously acquired lease.
 
  Returns the renewed lease ID.

azure.storage.blob.specialized.BlobLeaseClientBuilder

Superclass: azure.object

BLOBCLIENTBUILDER This class provides a fluent builder API to help aid
  the configuration and instantiation of Storage Lease clients.

azure.storage.blob.specialized.BlobLeaseClientBuilder.BlobLeaseClientBuilder

BLOBCLIENTBUILDER This class provides a fluent builder API to help aid
  the configuration and instantiation of Storage Lease clients.

azure.storage.blob.specialized.BlobLeaseClientBuilder.blobClient

BLOBCLIENT Configures the builder based on the passed
  BlobClient. This will set the HttpPipeline and URL that are
  used to interact with the service.
 
  Returns the updated BlobLeaseClientBuilder object

azure.storage.blob.specialized.BlobLeaseClientBuilder.buildClient

BUILDCLIENT Creates a BlobLeaseClient based on the
  configurations set in the builder.
 
  Returns a BlobLeaseClient based on the configurations in this
  builder.

azure.storage.blob.specialized.BlobLeaseClientBuilder.containerClient

CONTAINERCLIENT Configures the builder based on the passed
  BlobContainerClient. This will set the HttpPipeline and URL
  that are used to interact with the service.
 
  Returns the updated BlobLeaseClientBuilder object

azure.storage.blob.specialized.BlobLeaseClientBuilder.leaseId

CONTAINERCLIENT Configures the builder based on the passed
  BlobContainerClient. This will set the HttpPipeline and URL
  that are used to interact with the service.
 
  Returns the updated BlobLeaseClientBuilder object

azure.storage.blob.BlobClient

Superclass: azure.object

BLOBCLIENT Client performs generic blob operations

azure.storage.blob.BlobClient.BlobClient

BLOBCLIENT Client performs generic blob operations

azure.storage.blob.BlobClient.copyFromUrl

COPYFROMURL Copies the data at the source URL to a blob
  The call waits for the copy to complete before returning a response.
  A copyId is returned as a character vector it can apply for certain long
  running operations.
 
  If a lease is active on the blob, parameter 'leaseId' and the
  actual lease id as value can be provided.

azure.storage.blob.BlobClient.delete

DELETE BlobClient destructor - in MATLAB delete is a reserved
  method name for the class destructor. This method does not delete
  Blobs on Azure. To delete the Azure Blob use the deleteBlob
  method in MATLAB.

azure.storage.blob.BlobClient.deleteBlob

DELETEBLOB Deletes the blob - this is the equivalent of the "delete"
  method in the Azure Java API but because "delete" is a reserved
  method name in MATLAB, the method is named deleteBlob.
 
  If a lease is active on the blob, parameter 'leaseId' and the
  actual lease id as value can be provided.
 
  Example:
    client.deleteBlob('leaseId','f6eb8bda-cf33-4da1-8e50-11d1a6dd8797')

azure.storage.blob.BlobClient.downloadToFile

DOWNLOADTOFILE Downloads the entire blob into a file specified by filePath
  To overwrite an existing file use a parameter 'overwrite' and a logical true.
  By default a file is not overwritten.
 
  Example:
    blobClient.downloadToFile('/mydir/myfile.txt', 'overwrite', true);

azure.storage.blob.BlobClient.exists

EXISTS Gets if the blob this client represents exists in Azure
  A logical is returned if the Container exists indicating if the blob
  exists or not. Otherwise an exception is thrown, for example if the
  container does not exist. Consider using a container client to check for
  the existance of the container first.

azure.storage.blob.BlobClient.generateSas

GENERATESAS Generates a SAS for the blob
  The client must be authenticated via StorageSharedKeyCredential
  The SAS is returned as a character vector.

azure.storage.blob.BlobClient.generateUserDelegationSas

GENERATEUSERDELEGATIONSAS Generates a user delegation SAS for the
  blob using the specified BlobServiceSasSignatureValues and
  UserDelegationKey. The UserDelegationKey can be obtained through the
  getUserDelegationKey method of a BlobServiceClient.
 
  The SAS is returned as a character vector.

azure.storage.blob.BlobClient.getAccountName

GETACCOUNTNAME Get associated account name
  A character vector is returned.

azure.storage.blob.BlobClient.getBlobUrl

GETBLOBURL Gets the URL of the blob represented by this client
  The URL is returned as a character vector.

azure.storage.blob.BlobClient.getContainerClient

GETCONTAINERCLIENT Gets a client pointing to the parent container.

azure.storage.blob.BlobClient.getProperties

GETPROPERTIES Returns the blob's metadata and properties

azure.storage.blob.BlobClient.uploadFromFile

UPLOADFROMFILE Creates a or updates a block blob To overwrite an
  existing blob use a parameter 'overwrite' and a logical true. By
  default a blob is not overwritten.
 
  If a lease is active on the blob, parameter 'leaseId' and the
  actual lease id as value can be provided.
 
  Example:
    blobClient.uploadFromFile('/mydir/myfile.txt',...
        'overwrite', true,...
        'leaseId','f6eb8bda-cf33-4da1-8e50-11d1a6dd8797');

azure.storage.blob.BlobClientBuilder

Superclass: azure.object

BLOBCLIENTBUILDER Aids the configuration and instantiation of BlobClients

azure.storage.blob.BlobClientBuilder.BlobClientBuilder

BLOBCLIENTBUILDER Aids the configuration and instantiation of BlobClients

azure.storage.blob.BlobClientBuilder.blobName

BLOBNAME Sets the name of the blob
  blobName should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.blob.BlobClientBuilder.buildClient

BUILDCLIENT Creates a BlobClient based on options set in the builder
  A built BlobClient object is returned.

azure.storage.blob.BlobClientBuilder.connectionString

CONNECTIONSTRING Sets the connection string to connect to the service
  connectionString should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.blob.BlobClientBuilder.containerName

CONTAINERNAME Sets the name of the container that contains the blob
  containerName should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.blob.BlobClientBuilder.credential

CREDENTIAL Sets the credential used to authorize requests
  Credential argument should be of type azure.storage.common.StorageSharedKeyCredential
  or azure.core.credential.TokenCredential.
  An updated builder object is returned.

azure.storage.blob.BlobClientBuilder.endpoint

ENDPOINT Sets the client endpoint
  The endpoint is also parsed for additional information i.e. the SAS token
  endpoint should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.blob.BlobClientBuilder.httpClient

HTTPCLIENT Sets the HttpClient to use for sending a receiving requests
  Currently the Netty client is configured by default.
  An updated builder object is returned.

azure.storage.blob.BlobClientBuilder.sasToken

sasToken Sets the SAS token used to authorize requests
  sasToken should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.blob.BlobClientBuilder.setAnonymousAccess

SETANONYMOUSACCESS Clears the credential used to authorize the request
  An updated builder object is returned.

azure.storage.blob.BlobContainerClient

Superclass: azure.object

BLOBCONTAINERCLIENT Client to a container

azure.storage.blob.BlobContainerClient.BlobContainerClient

BLOBCONTAINERCLIENT Client to a container

azure.storage.blob.BlobContainerClient.create

CREATE Creates a new container within a storage account

azure.storage.blob.BlobContainerClient.delete

DELETE BlobContainerClient destructor - in MATLAB delete is a
  reserved method name for the class destructor. This method
  does not delete Blob Containers on Azure. To delete the Azure
  Blob Container use the deleteContainer method in MATLAB.

azure.storage.blob.BlobContainerClient.deleteContainer

DELETECONTAINER Deletes the container - this is the equivalent of the
  "delete" method in the Azure Java API but because "delete" is a
  reserved method name in MATLAB, the method is named DELETECONTAINER.
 
  If a lease is active on the blob, parameter 'leaseId' and the
  actual lease id as value can be provided.
 
  Example:
    client.deleteContainer('leaseId','f6eb8bda-cf33-4da1-8e50-11d1a6dd8797')

azure.storage.blob.BlobContainerClient.exists

EXISTS Tests if the container this client represents exists in Azure
  A logical is returned.

azure.storage.blob.BlobContainerClient.generateUserDelegationSas

GENERATEUSERDELEGATIONSAS Generates a user delegation SAS for the
  container using the specified BlobServiceSasSignatureValues and
  UserDelegationKey. The UserDelegationKey can be obtained through the
  getUserDelegationKey method of a BlobServiceClient.
 
  The SAS is returned as a character vector.

azure.storage.blob.BlobContainerClient.getAccountName

GETACCOUNTNAME Get associated account name
  A character vector is returned.

azure.storage.blob.BlobContainerClient.getAccountUrl

GETACCOUNTURL Get associated account URL
  A character vector is returned.

azure.storage.blob.BlobContainerClient.getBlobClient

GETBLOBCLIENT Initializes a new BlobClient object 
  blobName should be a scalar string or character vector.
  A BlobClient is returned.

azure.storage.blob.BlobContainerClient.getBlobContainerName

GETCONTAINERNAME Get the container name
  A character vector is returned.

azure.storage.blob.BlobContainerClient.getBlobContainerUrl

GETBLOBCONTAINERURL Get associated container URL
  A character vector is returned.

azure.storage.blob.BlobContainerClient.getServiceClient

GETSERVICECLIENT Get a client pointing to the account.

azure.storage.blob.BlobContainerClient.listBlobs

LISTBLOBS Returns a list of blobs in this container
  Folder structures are flattened.
  An array of BlobItems is returned.

azure.storage.blob.BlobContainerClient.listBlobsByHierarchy

LISTBLOBSBYHIERARCHY Returns the blobs and directories (prefixes) under the given directory (prefix).
  Directories will have BlobItem.isPrefix() set to true. 
  Blob names are returned in lexicographic order.
  An array of BlobItems is returned.

azure.storage.blob.BlobContainerClientBuilder

Superclass: azure.object

BLOBCONTAINERCLIENTBUILDER Aids construction of BlobContinerClients

azure.storage.blob.BlobContainerClientBuilder.BlobContainerClientBuilder

BLOBCONTAINERCLIENTBUILDER Aids construction of BlobContinerClients

azure.storage.blob.BlobContainerClientBuilder.buildClient

BUILDCLIENT Creates a BlobContainerClient based on options set in the builder
  A built BlobContainerClient object is returned.

azure.storage.blob.BlobContainerClientBuilder.connectionString

CONNECTIONSTRING Sets the connection string to connect to the service
  connectionString should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.blob.BlobContainerClientBuilder.containerName

CONTAINERNAME Sets the name of the container
  containerName should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.blob.BlobContainerClientBuilder.credential

CREDENTIAL Sets the credential used to authorize requests
  Credential argument should be of type azure.storage.common.StorageSharedKeyCredential.
  An updated builder object is returned.

azure.storage.blob.BlobContainerClientBuilder.endpoint

ENDPOINT Sets the blob container endpoint
  The endpoint is also parsed for additional information i.e. the SAS token
  endpoint should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.blob.BlobContainerClientBuilder.httpClient

HTTPCLIENT Sets the HttpClient to use for sending a receiving requests
  Currently the Netty client is configured by default.
  An updated builder object is returned.

azure.storage.blob.BlobContainerClientBuilder.sasToken

sasToken Sets the SAS token used to authorize requests
  sasToken should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.blob.BlobServiceClient

Superclass: azure.object

BLOBSERVICECLIENT

azure.storage.blob.BlobServiceClient.BlobServiceClient

BLOBSERVICECLIENT

azure.storage.blob.BlobServiceClient.createBlobContainer

CREATEBLOBCONTAINER Creates a new container within a storage account
  If a container with the same name already exists, the operation fails.
  The name of the container to create should be passed as a character vector or
  scalar string.
  If the container already exists an empty azure.storage.blob.BlobContainerClient
  is returned otherwise a non empty azure.storage.blob.BlobContainerClient is
  returned.
  In verbose logging mode a message is logged.

azure.storage.blob.BlobServiceClient.deleteBlobContainer

DELETEBLOBCONTAINER Deletes the specified container in the storage account
  The name of the container to create should be passed as a character vector or
  scalar string.

azure.storage.blob.BlobServiceClient.generateAccountSas

GENERATEACCOUNTSAS Generates an account SAS for the Azure Storage account
  The client must be authenticated via StorageSharedKeyCredential
  The SAS is returned as a character vector.

azure.storage.blob.BlobServiceClient.getAccountInfo

GETACCOUNTINFO Returns the sku name and account kind for the account
  A StorageAccountInfo object is returned.

azure.storage.blob.BlobServiceClient.getAccountName

GETACCOUNTNAME Get associated account name
  A character vector is returned.

azure.storage.blob.BlobServiceClient.getAccountUrl

GETACCOUNTURL Get associated account URL
  A character vector is returned.

azure.storage.blob.BlobServiceClient.getUserDelegationKey

GETUSERDELEGATIONKEY Gets a user delegation key for use with this
  account's blob storage. 
  
  Note: This method call is only valid when using TokenCredential. I.e. not
  when working with ConnectionString or StorageSharedKey authentication
  approaches.
 
  The function takes two datetime objects as input, the start and expiry
  time of the key's validity.
 
  Returns a UserDelegationKey object.
 
  Example:
 
    key = sc.getUserDelegationKey(datetime('now'),datetime('now')+hours(1))

azure.storage.blob.BlobServiceClient.listBlobContainers

LISTBLOBCONTAINERS

azure.storage.blob.BlobServiceClient.setAnonymousAccess

SETANONYMOUSACCESS Clears the credential used to authorize the request
  An updated builder object is returned.

azure.storage.blob.BlobServiceClientBuilder

Superclass: azure.object

BLOBSERVICECLIENTBUILDER Aids construction of BlobServiceClients

azure.storage.blob.BlobServiceClientBuilder.BlobServiceClientBuilder

BLOBSERVICECLIENTBUILDER Aids construction of BlobServiceClients

azure.storage.blob.BlobServiceClientBuilder.buildClient

BUILDCLIENT Creates a BlobServiceClient based on options set in the builder
  A built BlobServiceClient object is returned.

azure.storage.blob.BlobServiceClientBuilder.connectionString

CONNECTIONSTRING Sets the connection string to connect to the service
  connectionString should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.blob.BlobServiceClientBuilder.credential

CREDENTIAL Sets the credential used to authorize requests
  Credential argument should be of type azure.storage.common.StorageSharedKeyCredential.
  An updated builder object is returned.

azure.storage.blob.BlobServiceClientBuilder.endpoint

ENDPOINT Sets the blob service endpoint
  The endpoint is also parsed for additional information i.e. the SAS token
  endpoint should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.blob.BlobServiceClientBuilder.httpClient

HTTPCLIENT Sets the HttpClient to use for sending a receiving requests
  Currently the Netty client is configured by default.
  An updated builder object is returned.

azure.storage.blob.BlobServiceClientBuilder.retryOptions

RETRYOPTIONS Sets request retry options for all requests made through the client
  retryOptions may be either a com.azure.storage.common.policy.RequestRetryOptions
  or a azure.storage.common.policy.RequestRetryOptions object.
  An updated azure.storage.blob.BlobServiceClientBuilder object is returned.

azure.storage.blob.BlobServiceClientBuilder.sasToken

SASTOKEN Sets the SAS token used to authorize requests
  sasToken should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.common

azure.storage.common.policy

azure.storage.common.policy.RequestRetryOptions

Superclass: azure.object

REQUESTRETRYOPTIONS Options for configuring the RequestRetryFactory
  The default constructor azure.storage.common.policy.RequestRetryOptions() returns an
  object with retry values:
 
      retryPolicyType: Optional azure.storage.common.policy.RetryPolicyType Optional
                       A RetryPolicyType specifying the type of retry pattern
                       to use, default value is EXPONENTIAL
 
             maxTries: Optional int32
                       Maximum number of attempts an operation will be retried
                       default is 4
 
  tryTimeoutInSeconds: Optional int32
                       Specifies the maximum time allowed before a request is
                       cancelled and assumed failed, default is intmax s
 
       retryDelayInMs: Optional int64
                       Specifies the amount of delay to use before retrying an
                       operation, default value is 4ms
 
    maxRetryDelayInMs: Optional int64
                       Specifies the maximum delay allowed before retrying an
                       operation, default value is 120ms
 
        secondaryHost: Optional character vector or scalar string

azure.storage.common.policy.RequestRetryOptions.RequestRetryOptions

REQUESTRETRYOPTIONS Options for configuring the RequestRetryFactory
  The default constructor azure.storage.common.policy.RequestRetryOptions() returns an
  object with retry values:
 
      retryPolicyType: Optional azure.storage.common.policy.RetryPolicyType Optional
                       A RetryPolicyType specifying the type of retry pattern
                       to use, default value is EXPONENTIAL
 
             maxTries: Optional int32
                       Maximum number of attempts an operation will be retried
                       default is 4
 
  tryTimeoutInSeconds: Optional int32
                       Specifies the maximum time allowed before a request is
                       cancelled and assumed failed, default is intmax s
 
       retryDelayInMs: Optional int64
                       Specifies the amount of delay to use before retrying an
                       operation, default value is 4ms
 
    maxRetryDelayInMs: Optional int64
                       Specifies the maximum delay allowed before retrying an
                       operation, default value is 120ms
 
        secondaryHost: Optional character vector or scalar string

azure.storage.common.policy.RetryPolicyType

RetryPolicyType Defines holds possible options for retry backoff algorithms
  They may be used with RequestRetryOptions.
  Values are EXPONENTIAL & FIXED

Enumeration values:
  EXPONENTIAL
  FIXED

azure.storage.common.policy.RetryPolicyType.RetryPolicyType

RetryPolicyType Defines holds possible options for retry backoff algorithms
  They may be used with RequestRetryOptions.
  Values are EXPONENTIAL & FIXED

azure.storage.common.policy.RetryPolicyType.toJava

TOJAVA Converts to a com.azure.storage.common.policy.RetryPolicyType Java object

azure.storage.common.policy.RetryPolicyType.toString

TOSTRING Returns text form of a RetryPolicyType
  A character vector is returned.

azure.storage.common.policy.RetryPolicyType.valueOf

VALUEOF Returns the enum constant of this type with the specified name

azure.storage.common.sas

azure.storage.common.sas.AccountSasPermission

Superclass: azure.object

ACCOUNTSASPERMISSION Constructs a string of permissions granted by Account SAS
  Setting a value to true means that any SAS which uses these permissions will
  grant permissions for that operation.
  Once the required values are set, the object should be serialized with
  toString and set as the permissions field on an AccountSasSignatureValues
  object

azure.storage.common.sas.AccountSasPermission.AccountSasPermission

ACCOUNTSASPERMISSION Constructs a string of permissions granted by Account SAS
  Setting a value to true means that any SAS which uses these permissions will
  grant permissions for that operation.
  Once the required values are set, the object should be serialized with
  toString and set as the permissions field on an AccountSasSignatureValues
  object

azure.storage.common.sas.AccountSasPermission.hasAddPermission

HASADDPERMISSION Returns the add permission status
  The result is returned as a logical.

azure.storage.common.sas.AccountSasPermission.hasCreatePermission

HASCREATEPERMISSION Returns the create permission status
  The result is returned as a logical

azure.storage.common.sas.AccountSasPermission.hasDeletePermission

HASDELETEPERMISSION Returns the delete permission status
  The result is returned as a logical.

azure.storage.common.sas.AccountSasPermission.hasListPermission

HASLISTPERMISSION Returns the list permission status
  The result is returned as a logical.

azure.storage.common.sas.AccountSasPermission.hasProcessMessages

HASPROCESSMESSAGES Returns the process messages permission
  This allows the retrieval and deletion of queue messages.
  The result is returned as a logical.

azure.storage.common.sas.AccountSasPermission.hasReadPermission

HASREADPERMISSION Returns the read permission status
  The result is returned as a logical.

azure.storage.common.sas.AccountSasPermission.hasUpdatePermission

HASUPDATEPERMISSION Returns the update permission status
  It allows the update of queue message and tables.
  This allows the retrieval and deletion of queue messages.
  The result is returned as a logical.

azure.storage.common.sas.AccountSasPermission.hasWritePermission

HASWRITEPERMISSION Returns the write permission status
  The result is returned as a logical.

azure.storage.common.sas.AccountSasPermission.parse

PARSE Creates an AccountSasPermission from the specified permissions string
  A azure.storage.common.sas.AccountSasPermission object is returned.
  permString should be of type scalar string or character vector.
  Throws an IllegalArgumentException if it encounters a character that does
  not correspond to a valid permission.
  This is a static method.
  Expected characters are r, w, d, l, a, c, u, or p.

azure.storage.common.sas.AccountSasPermission.setAddPermission

SETADDPERMISSION Sets the add permission status
  The permission argument should be of type logical.
  A azure.storage.common.sas.AccountSasPermission object is returned.

azure.storage.common.sas.AccountSasPermission.setCreatePermission

SETCREATEPERMISSION Sets the create permission status
  The permission argument should be of type logical.
  A azure.storage.common.sas.AccountSasPermission object is returned.

azure.storage.common.sas.AccountSasPermission.setDeletePermission

SETDELETEPERMISSION Sets the delete permission status
  The permission argument should be of type logical.
  A azure.storage.common.sas.AccountSasPermission object is returned.

azure.storage.common.sas.AccountSasPermission.setListPermission

SETLISTPERMISSION Sets the list permission status
  The permission argument should be of type logical.
  A azure.storage.common.sas.AccountSasPermission object is returned.

azure.storage.common.sas.AccountSasPermission.setProcessMessages

SETPROCESSMESSAGES Sets the process messages permission
  This allows the retrieval and deletion of queue messages.
  The permission argument should be of type logical.
  A azure.storage.common.sas.AccountSasPermission object is returned.

azure.storage.common.sas.AccountSasPermission.setReadPermission

SETREADPERMISSION Sets the read permission status
  The permission argument should be of type logical.
  A azure.storage.common.sas.AccountSasPermission object is returned.

azure.storage.common.sas.AccountSasPermission.setUpdatePermission

SETUPDATEPERMISSION Sets the update permission status
  This allows the update of queue messages and tables.
  The permission argument should be of type logical.
  A azure.storage.common.sas.AccountSasPermission object is returned.

azure.storage.common.sas.AccountSasPermission.setWritePermission

SETWRITEPERMISSION Sets the write permission status
  The permission argument should be of type logical.
  A azure.storage.common.sas.AccountSasPermission object is returned.

azure.storage.common.sas.AccountSasPermission.toString

TOSTRING Converts the given permissions to a String
  A character vector is returned.

azure.storage.common.sas.AccountSasResourceType

Superclass: azure.object

ACCOUNTSASRESOURCETYPE Construct string representing the Account SAS services
  Setting a value to true means that any SAS which uses these permissions will
  grant access to that resource type.
  Once the required values are set serialize the object with toString for use
  as the resources field on an AccountSasSignatureValues object.

azure.storage.common.sas.AccountSasResourceType.AccountSasResourceType

ACCOUNTSASRESOURCETYPE Construct string representing the Account SAS services
  Setting a value to true means that any SAS which uses these permissions will
  grant access to that resource type.
  Once the required values are set serialize the object with toString for use
  as the resources field on an AccountSasSignatureValues object.

azure.storage.common.sas.AccountSasResourceType.isContainer

ISCONTAINER Returns true if the resource is a Container otherwise false

azure.storage.common.sas.AccountSasResourceType.isObject

ISOBJECT Returns true if the resource is an object otherwise false

azure.storage.common.sas.AccountSasResourceType.isService

ISSERVICE Returns true if the resource is a Service otherwise false

azure.storage.common.sas.AccountSasResourceType.parse

PARSE Creates an AccountSasResourceType from the specified permissions string
  Creates an AccountSasResourceType from the specified resource types string.
  Throws an IllegalArgumentException if passed a character that does not
  correspond to a valid resource type.
  Expected characters are s, c, or o.
  A azure.storage.common.sas.AccountSasResourceType object is returned.
  resourceTypesString should be of type scalar string or character vector.
  This is a static method.

azure.storage.common.sas.AccountSasResourceType.setContainer

SETCONTAINER Sets the access status for container level APIs
  Grants access to Blob Containers, Tables, Queues, and File Shares.
  The container argument should be of type logical.
  A azure.storage.common.sas.AccountSasResourceType object is returned.

azure.storage.common.sas.AccountSasResourceType.setObject

SETOBJECT Sets the access status for object level APIs
  Grants access to Blobs, Table Entities, Queue Messages, Files.
  The object argument should be of type logical.
  A azure.storage.common.sas.AccountSasResourceType object is returned.

azure.storage.common.sas.AccountSasResourceType.setService

SETSERVICE Sets the access status for service level APIs
  The service argument should be of type logical.
  A azure.storage.common.sas.AccountSasResourceType service is returned.

azure.storage.common.sas.AccountSasResourceType.toString

TOSTRING Converts the given permissions to a String
  This method is used to serialize an AccountSasResourceType 
  A character vector is returned.

azure.storage.common.sas.AccountSasService

Superclass: azure.object

ACCOUNTSASSERVICE Construct a string representing the Account SAS services
  Setting a value to true means that any SAS which uses these permissions will
  grant access to that service. Once required values are set the object should
  be serialized with toString and set as the services field on an
  AccountSasSignatureValues object.

azure.storage.common.sas.AccountSasService.AccountSasService

ACCOUNTSASSERVICE Construct a string representing the Account SAS services
  Setting a value to true means that any SAS which uses these permissions will
  grant access to that service. Once required values are set the object should
  be serialized with toString and set as the services field on an
  AccountSasSignatureValues object.

azure.storage.common.sas.AccountSasService.hasBlobAccess

HASBLOBACCESS Returns the access status for blob resources
  The result is returned as a logical

azure.storage.common.sas.AccountSasService.hasFileAccess

HASFILEACCESS Returns the access status for file resources
  The result is returned as a logical

azure.storage.common.sas.AccountSasService.hasQueueAccess

HASQUEUEACCESS Returns the access status for queue resources
  The result is returned as a logical

azure.storage.common.sas.AccountSasService.hasTableAccess

HASTABLEACCESS Returns the access status for table resources
  The result is returned as a logical

azure.storage.common.sas.AccountSasService.parse

PARSE Creates an AccountSasService from the specified permissions string
  A azure.storage.common.sas.AccountSasService object is returned.
  servicesString should be of type scalar string or character vector.
  Throws an IllegalArgumentException if it encounters a character that does
  not correspond to a valid service.
  Expected characters are b, f, q, or t.
  This is a static method.

azure.storage.common.sas.AccountSasService.setBlobAccess

SETBLOBACCESS Sets the access status for blob resources
  The blob argument should be of type logical.
  A azure.storage.common.sas.AccountSasService object is returned.

azure.storage.common.sas.AccountSasService.setFileAccess

SETFILEACCESS Sets the access status for file resources
  The file argument should be of type logical.
  A azure.storage.common.sas.AccountSasService object is returned.

azure.storage.common.sas.AccountSasService.setQueueAccess

SETQUEUEACCESS Sets the access status for queue resources
  The queue argument should be of type logical.
  A azure.storage.common.sas.AccountSasService object is returned.

azure.storage.common.sas.AccountSasService.setTableAccess

SETTABLEACCESS Sets the access status for table resources
  The table argument should be of type logical.
  A azure.storage.common.sas.AccountSasService object is returned.

azure.storage.common.sas.AccountSasService.toString

TOSTRING Converts the given permissions to a String
  A character vector is returned.

azure.storage.common.sas.AccountSasSignatureValues

Superclass: azure.object

ACCOUNTSASSIGNATUREVALUES Used to initialize a SAS for a storage account
  When the values are set, use the generateSas method on the desired service
  client to obtain a representation of the SAS which can then be applied to a
  new client using the .sasToken(String) method on the desired client builder.
 
  Example
    assv = azure.storage.common.sas.AccountSasSignatureValues( ...
               expiryTime, permissions, services, resourceTypes);
 
  Argument types:
    expiryTime: datetime
    permissions: azure.storage.common.sas.AccountSasPermission
    services: azure.storage.common.sas.AccountSasService
    resourceTypes: azure.storage.common.sas.AccountSasResourceType

azure.storage.common.sas.AccountSasSignatureValues.AccountSasSignatureValues

ACCOUNTSASSIGNATUREVALUES Used to initialize a SAS for a storage account
  When the values are set, use the generateSas method on the desired service
  client to obtain a representation of the SAS which can then be applied to a
  new client using the .sasToken(String) method on the desired client builder.
 
  Example
    assv = azure.storage.common.sas.AccountSasSignatureValues( ...
               expiryTime, permissions, services, resourceTypes);
 
  Argument types:
    expiryTime: datetime
    permissions: azure.storage.common.sas.AccountSasPermission
    services: azure.storage.common.sas.AccountSasService
    resourceTypes: azure.storage.common.sas.AccountSasResourceType

azure.storage.common.StorageSharedKeyCredential

Superclass: azure.object

STORAGESHAREDKEYCREDENTIAL SharedKey credential policy 
  Used to put into a header to authorize requests.

azure.storage.common.StorageSharedKeyCredential.StorageSharedKeyCredential

STORAGESHAREDKEYCREDENTIAL SharedKey credential policy 
  Used to put into a header to authorize requests.

azure.storage.common.StorageSharedKeyCredential.getAccountName

GETACCOUNTNAME Gets the account name associated with the request
  The accountName is returned as a character vector.

azure.storage.file

azure.storage.file.datalake

azure.storage.file.datalake.models

azure.storage.file.datalake.models.PathItem

Superclass: azure.object

Copyright 2022 The MathWorks, Inc.

azure.storage.file.datalake.models.PathItem.PathItem

Copyright 2022 The MathWorks, Inc.

azure.storage.file.datalake.models.PathItem.getName

GETNAME Get the name property
  A character vector is returned.

azure.storage.file.datalake.models.PathItem.isDirectory

ISDIRECTORY Get the isDirectory property
  A logical is returned.

azure.storage.file.datalake.models.PathProperties

Superclass: azure.object

Copyright 2022 The MathWorks, Inc.

azure.storage.file.datalake.models.PathProperties.PathProperties

Copyright 2022 The MathWorks, Inc.

azure.storage.file.datalake.sas

azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues

Superclass: azure.object

DATALAKESERVICESASSIGNATUREVALUES Used to initialize a SAS for Data Lake Storage
  When the values are set, use the generateSas method on the desired service
  client to obtain a representation of the SAS which can then be applied to a
  new client using the .sasToken(String) method on the desired client builder.
 
  Example
    dlsssv = azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues(expiryTime, permissions);
 
  Argument types:
    expiryTime:  datetime ideally with defined TimeZone to avoid any 
                 confusion, if TimeZone is not set, 'local' is assumed
    permissions: azure.storage.file.datalake.sas.PathSasPermission or
                 FileSystemSasPermission
  Or
 
    dlsssv = azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues(identifier);
 
  Argument types:
    identifier:  Creates an object with the specified identifier.
                 NOTE: Identifier can not be used for a UserDelegationKey SAS.
                 Type character vector or scalar string.

azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues.DataLakeServiceSasSignatureValues

DATALAKESERVICESASSIGNATUREVALUES Used to initialize a SAS for Data Lake Storage
  When the values are set, use the generateSas method on the desired service
  client to obtain a representation of the SAS which can then be applied to a
  new client using the .sasToken(String) method on the desired client builder.
 
  Example
    dlsssv = azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues(expiryTime, permissions);
 
  Argument types:
    expiryTime:  datetime ideally with defined TimeZone to avoid any 
                 confusion, if TimeZone is not set, 'local' is assumed
    permissions: azure.storage.file.datalake.sas.PathSasPermission or
                 FileSystemSasPermission
  Or
 
    dlsssv = azure.storage.file.datalake.sas.DataLakeServiceSasSignatureValues(identifier);
 
  Argument types:
    identifier:  Creates an object with the specified identifier.
                 NOTE: Identifier can not be used for a UserDelegationKey SAS.
                 Type character vector or scalar string.

azure.storage.file.datalake.sas.FileSystemSasPermission

Superclass: azure.object

FILESYSTEMSASPERMISSION Constructs a string of permissions granted by ServiceSAS
  Setting a value to true means that any SAS which uses these permissions will
  grant permissions for that operation.

azure.storage.file.datalake.sas.FileSystemSasPermission.FileSystemSasPermission

FILESYSTEMSASPERMISSION Constructs a string of permissions granted by ServiceSAS
  Setting a value to true means that any SAS which uses these permissions will
  grant permissions for that operation.

azure.storage.file.datalake.sas.FileSystemSasPermission.hasAddPermission

HASADDPERMISSION Returns the add permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.FileSystemSasPermission.hasCreatePermission

HASCREATEPERMISSION Returns the create permission status
  The result is returned as a logical

azure.storage.file.datalake.sas.FileSystemSasPermission.hasDeletePermission

HASDELETEPERMISSION Returns the delete permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.FileSystemSasPermission.hasExecutePermission

HASEXECUTEPERMISSION Returns the execute permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.FileSystemSasPermission.hasListPermission

HASLISTPERMISSION Returns the list permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.FileSystemSasPermission.hasManageAccessControlPermission

HASMANAGEACCESSCONTROLPERMISSION Returns the manage access control permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.FileSystemSasPermission.hasManageOwnershipPermission

HASMANAGEOWNERSHIPPERMISSION Returns the manage ownership permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.FileSystemSasPermission.hasMovePermission

HASMOVEPERMISSION Returns the move permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.FileSystemSasPermission.hasReadPermission

HASREADPERMISSION Returns the read permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.FileSystemSasPermission.hasWritePermission

HASWRITEPERMISSION Returns the write permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.FileSystemSasPermission.parse

PARSE Creates a FileSystemSasPermission from the specified permissions string
  A azure.storage.file.datalake.sas.FileSystemPermission object is returned.
  permString should be of type scalar string or character vector.
  Throws an IllegalArgumentException if it encounters a character that does
  not correspond to a valid permission.
  This is a static method.

azure.storage.file.datalake.sas.FileSystemSasPermission.setAddPermission

SETADDPERMISSION Sets the add permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.FileSystemSasPermission object is returned.

azure.storage.file.datalake.sas.FileSystemSasPermission.setCreatePermission

SETCREATEPERMISSION Sets the create permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.FileSystemSasPermission object is returned.

azure.storage.file.datalake.sas.FileSystemSasPermission.setDeletePermission

SETDELETEPERMISSION Sets the delete permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.FileSystemSasPermission object is returned.

azure.storage.file.datalake.sas.FileSystemSasPermission.setExecutePermission

SETEXECUTEPERMISSION Sets the execute permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.FileSystemSasPermission object is returned.

azure.storage.file.datalake.sas.FileSystemSasPermission.setListPermission

SETADDPERMISSION Sets the list permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.FileSystemSasPermission object is returned.

azure.storage.file.datalake.sas.FileSystemSasPermission.setManageAccessControlPermission

SETMANAGEACCESSCONTROLPERMISSION Sets the manage access control permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.FileSystemSasPermission object is returned.

azure.storage.file.datalake.sas.FileSystemSasPermission.setManageOwnershipPermission

SETMANAGEOWNERSHIPPERMISSION Sets the manage ownership permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.FileSystemSasPermission object is returned.

azure.storage.file.datalake.sas.FileSystemSasPermission.setMovePermission

SETMOVEPERMISSION Sets the move permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.FileSystemSasPermission object is returned.

azure.storage.file.datalake.sas.FileSystemSasPermission.setReadPermission

SETCREATEPERMISSION Sets the read permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.FileSystemSasPermission object is returned.

azure.storage.file.datalake.sas.FileSystemSasPermission.setWritePermission

SETWRITEPERMISSION Sets the write permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.FileSystemSasPermission object is returned.

azure.storage.file.datalake.sas.FileSystemSasPermission.toString

TOSTRING Converts the given permissions to a String
  A character vector is returned.

azure.storage.file.datalake.sas.PathSasPermission

Superclass: azure.object

PATHSASPERMISSION Constructs a string of permissions granted by ServiceSAS
  Setting a value to true means that any SAS which uses these permissions will
  grant permissions for that operation.

azure.storage.file.datalake.sas.PathSasPermission.PathSasPermission

PATHSASPERMISSION Constructs a string of permissions granted by ServiceSAS
  Setting a value to true means that any SAS which uses these permissions will
  grant permissions for that operation.

azure.storage.file.datalake.sas.PathSasPermission.hasAddPermission

HASADDPERMISSION Returns the add permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.PathSasPermission.hasCreatePermission

HASCREATEPERMISSION Returns the create permission status
  The result is returned as a logical

azure.storage.file.datalake.sas.PathSasPermission.hasDeletePermission

HASDELETEPERMISSION Returns the delete permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.PathSasPermission.hasExecutePermission

HASEXECUTEPERMISSION Returns the execute permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.PathSasPermission.hasListPermission

HASLISTPERMISSION Returns the list permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.PathSasPermission.hasManageAccessControlPermission

HASMANAGEACCESSCONTROLPERMISSION Returns the manage access control permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.PathSasPermission.hasManageOwnershipPermission

HASMANAGEOWNERSHIPPERMISSION Returns the manage ownership permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.PathSasPermission.hasMovePermission

HASMOVEPERMISSION Returns the move permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.PathSasPermission.hasReadPermission

HASREADPERMISSION Returns the read permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.PathSasPermission.hasWritePermission

HASWRITEPERMISSION Returns the write permission status
  The result is returned as a logical.

azure.storage.file.datalake.sas.PathSasPermission.parse

PARSE Creates a PathSasPermission from the specified permissions string
  A azure.storage.file.datalake.sas.PathSasPermission object is returned.
  permString should be of type scalar string or character vector.
  Throws an IllegalArgumentException if it encounters a character that does
  not correspond to a valid permission.
  This is a static method.

azure.storage.file.datalake.sas.PathSasPermission.setAddPermission

SETADDPERMISSION Sets the add permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.PathSasPermission object is returned.

azure.storage.file.datalake.sas.PathSasPermission.setCreatePermission

SETCREATEPERMISSION Sets the create permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.PathSasPermission object is returned.

azure.storage.file.datalake.sas.PathSasPermission.setDeletePermission

SETDELETEPERMISSION Sets the delete permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.PathSasPermission object is returned.

azure.storage.file.datalake.sas.PathSasPermission.setExecutePermission

SETEXECUTEPERMISSION Sets the execute permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.PathSasPermission object is returned.

azure.storage.file.datalake.sas.PathSasPermission.setListPermission

SETADDPERMISSION Sets the list permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.PathSasPermission object is returned.

azure.storage.file.datalake.sas.PathSasPermission.setManageAccessControlPermission

SETMANAGEACCESSCONTROLPERMISSION Sets the manage access control permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.PathSasPermission object is returned.

azure.storage.file.datalake.sas.PathSasPermission.setManageOwnershipPermission

SETMANAGEOWNERSHIPPERMISSION Sets the manage ownership permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.PathSasPermission object is returned.

azure.storage.file.datalake.sas.PathSasPermission.setMovePermission

SETMOVEPERMISSION Sets the move permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.PathSasPermission object is returned.

azure.storage.file.datalake.sas.PathSasPermission.setReadPermission

SETREADPERMISSION Sets the add permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.PathSasPermission object is returned.

azure.storage.file.datalake.sas.PathSasPermission.setWritePermission

SETWRITEPERMISSION Sets the write permission status
  The permission argument should be of type logical.
  A azure.storage.file.datalake.sas.PathSasPermission object is returned.

azure.storage.file.datalake.sas.PathSasPermission.toString

TOSTRING Converts the given permissions to a String
  A character vector is returned.

azure.storage.file.datalake.DataLakeDirectoryClient

Superclass: azure.object

DATALAKEDIRECTORYCLIENT Client that contains directory operations for Azure Storage Data Lake
  This client is instantiated through DataLakePathClientBuilder

azure.storage.file.datalake.DataLakeDirectoryClient.DataLakeDirectoryClient

DATALAKEDIRECTORYCLIENT Client that contains directory operations for Azure Storage Data Lake
  This client is instantiated through DataLakePathClientBuilder

azure.storage.file.datalake.DataLakeDirectoryClient.createFile

CREATEFILE Creates a new file within a directory
  By default, this method will not overwrite an existing file.
  To enable overwrite set an overwrite argument to true.
  A azure.storage.file.datalake.DataLakeDirectoryClient is returned.

azure.storage.file.datalake.DataLakeDirectoryClient.delete

DELETE DataLakeDirectoryClient destructor - in MATLAB delete is a reserved
  method name for the class destructor. This method does not delete
  files on Azure. To delete the Azure files use the deleteDirectory
  method in MATLAB.

azure.storage.file.datalake.DataLakeDirectoryClient.deleteDirectory

DELETEDIRECTORY Deletes the directory - this is the equivalent of the "delete"
  method in the Azure Java API but because "delete" is a reserved
  method name in MATLAB, the method is named deleteDirectory.
 
  Example:
    client.deleteDirectory()

azure.storage.file.datalake.DataLakeDirectoryClient.deleteFile

DELETEFILE Deletes the file - this is the equivalent of the "delete"
  method in the Azure Java API but because "delete" is a reserved
  method name in MATLAB, the method is named deleteFile.
 
  Example:
    client.deleteFile('myfile.txt')

azure.storage.file.datalake.DataLakeDirectoryClient.deleteSubdirectory

DELETESUBDIRECTORY Deletes the specified sub-directory in the directory
  If the sub-directory doesn't exist or is not empty the operation fails.
  subdirectoryName is provided as a character vector or scalar string.

azure.storage.file.datalake.DataLakeDirectoryClient.exists

EXISTS Gets if the path this client represents exists in Azure
  This does not guarantee that the path type (file/directory) matches expectations.
  E.g. a DataLakeFileClient representing a path to a datalake directory will
  return true, and vice versa.
  A logical is returned.

azure.storage.file.datalake.DataLakeDirectoryClient.getDirectoryPath

GETDIRECTORYPATH Gets the path of this file, not including the name of the resource itself
  A character vector is returned.

azure.storage.file.datalake.DataLakeDirectoryClient.getDirectoryUrl

GETDIRECTORYURL Gets the URL of the directory represented by this client
  A matlab.net.URI is returned.

azure.storage.file.datalake.DataLakeDirectoryClient.getFileClient

GETFILECLIENT Create a DataLakeFileClient concatenating fileName to the DataLakeDirectoryClient

azure.storage.file.datalake.DataLakeDirectoryClient.listPaths

LISTPATHS Returns a list of files/directories in this account
  Paths are returned as an array of 
  azure.storage.file.datalake.models.PathItem objects.
  If there are no keys an empty array is returned.

azure.storage.file.datalake.DataLakeDirectoryClient.rename

RENAME Moves the directory to another location within the file system
  Arguments must be scalar strings or character vectors.
 
  destinationFileSystem is the file system of the destination within the account.
  Use an empty array [] to use the current file system.
 
  destinationPath Relative path from the file system to rename the directory to.
  This excludes the file system name, e.g. to move a directory with:
     fileSystem = "myfilesystem", path = "mydir/mysubdir"
  to another path in myfilesystem e.g.: newdir then set the destinationPath to "newdir"
 
  A DataLakeDirectoryClient used to interact with the newly created directory is returned.

azure.storage.file.datalake.DataLakeFileClient

Superclass: azure.object

DATALAKEFILECLIENT Client that contains file operations for Azure Storage Data Lake
  This client is instantiated through DataLakePathClientBuilder or retrieved via
  getFileClient().

azure.storage.file.datalake.DataLakeFileClient.DataLakeFileClient

DATALAKEFILECLIENT Client that contains file operations for Azure Storage Data Lake
  This client is instantiated through DataLakePathClientBuilder or retrieved via
  getFileClient().

azure.storage.file.datalake.DataLakeFileClient.delete

DELETE DataLakeFileClient destructor - in MATLAB delete is a reserved
  method name for the class destructor. This method does not delete
  files on Azure. To delete the Azure files use the deleteFile
  method in MATLAB.

azure.storage.file.datalake.DataLakeFileClient.deleteFile

DELETEFILE Deletes the file - this is the equivalent of the "delete"
  method in the Azure Java API but because "delete" is a reserved
  method name in MATLAB, the method is named deleteFile.
 
  Example:
    client.deleteFile()

azure.storage.file.datalake.DataLakeFileClient.exists

EXISTS Gets if the path this client represents exists in Azure
  This does not guarantee that the path type (file/directory) matches expectations.
  E.g. a DataLakeFileClient representing a path to a datalake directory will
  return true, and vice versa.

azure.storage.file.datalake.DataLakeFileClient.getFilePath

GETFILEPATH Gets the path of this file, not including the name of the resource itself
  A character vector is returned.

azure.storage.file.datalake.DataLakeFileClient.getFileUrl

GETFILEURL Gets the URL of the file represented by this client
  A matlab.net.URI is returned.

azure.storage.file.datalake.DataLakeFileClient.readToFile

READTOFILE Reads the entire file into a file specified by the path
  By default a file will not be overwritten and if the file already exists a 
  FileAlreadyExistsException Java will be thrown. A logical overwrite flag
  can be optionally provided.
  An azure.storage.file.datalake.models.PathProperties is returned.

azure.storage.file.datalake.DataLakeFileClient.rename

RENAME Moves the file to another location within the file system
  Arguments must be scalar strings or character vectors.
 
  destinationFileSystem is the file system of the destination within the account.
  Use a string or character vector of zero length for the current file system.
 
  destinationPath is the relative path from the file system to rename the file to.
  This excludes the file system name, e.g. to move a file with:
     fileSystem = "myfilesystem", path = "mydir/hello.txt"
  to another path in myfilesystem e.g.: newdir/hi.txt
  then set the destinationPath = "newdir/hi.txt"
 
  A DataLakeFileClient used to interact with the newly created file is returned.

azure.storage.file.datalake.DataLakeFileClient.uploadFromFile

UPLOADFROMFILE Creates a file with the content of the specified file
  By default, this method will not overwrite an existing file.
  filePath is provided as a character vector or scalar string.

azure.storage.file.datalake.DataLakeFileSystemClient

Superclass: azure.object

DATALAKEFILEFILESYSTEMCLIENT Client that contains file system operations
  This client is instantiated through DataLakeFileSystemClientBuilder

azure.storage.file.datalake.DataLakeFileSystemClient.DataLakeFileSystemClient

DATALAKEFILEFILESYSTEMCLIENT Client that contains file system operations
  This client is instantiated through DataLakeFileSystemClientBuilder

azure.storage.file.datalake.DataLakeFileSystemClient.createDirectory

CREATEDIRECTORY Creates a new directory within a file system
  By default, this method will not overwrite an existing directory.
  To enable overwrite set an overwrite argument to true.
  A azure.storage.file.datalake.DataLakeDirectoryClient is returned.

azure.storage.file.datalake.DataLakeFileSystemClient.delete

DELETE DataLakeFileSystemClient destructor - in MATLAB delete is a reserved
  method name for the class destructor. This method does not delete
  files on Azure. To delete the Azure files use the deleteFileSystem
  method in MATLAB.

azure.storage.file.datalake.DataLakeFileSystemClient.deleteDirectory

DELETEDIRECTORY Deletes the specified directory
 
  Example:
    client.deleteDirectory('myDirectory')

azure.storage.file.datalake.DataLakeFileSystemClient.deleteFile

DELETEFILE Deletes the file - this is the equivalent of the "delete"
  method in the Azure Java API but because "delete" is a reserved
  method name in MATLAB, the method is named deleteFile.
 
  Example:
    client.deleteFile('myfile.txt')

azure.storage.file.datalake.DataLakeFileSystemClient.generateSas

GENERATESAS Generates a SAS for the blob
  The client must be authenticated via StorageSharedKeyCredential
  The SAS is returned as a character vector.

azure.storage.file.datalake.DataLakeFileSystemClient.listPaths

LISTPATHS Returns a list of files/directories in this account
  Paths are returned as an array of 
  azure.storage.file.datalake.models.PathItem objects.
  If there are no keys an empty array is returned.

azure.storage.file.datalake.DataLakeFileSystemClientBuilder

Superclass: azure.object

DATALAKEFILESYSTEMCLIENTBUILDER Aids the configuration and instantiation of DataLakeFileSystemClient

azure.storage.file.datalake.DataLakeFileSystemClientBuilder.DataLakeFileSystemClientBuilder

DATALAKEFILESYSTEMCLIENTBUILDER Aids the configuration and instantiation of DataLakeFileSystemClient

azure.storage.file.datalake.DataLakeFileSystemClientBuilder.buildClient

BUILDFILESYSTEMCLIENT Creates a DataLakeFileSystemClient based on the builder
  Returns a DataLakeFileSystemClient created from the configurations in this builder.

azure.storage.file.datalake.DataLakeFileSystemClientBuilder.credential

CREDENTIAL Sets the credential used to authorize requests
  Credential argument should be of type azure.storage.common.StorageSharedKeyCredential
  or azure.core.credential.TokenCredential.
  An updated builder object is returned.

azure.storage.file.datalake.DataLakeFileSystemClientBuilder.endpoint

ENDPOINT Sets the client endpoint
  The endpoint is also parsed for additional information i.e. the SAS token
  endpoint should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.file.datalake.DataLakeFileSystemClientBuilder.fileSystemName

FILESYSTEMNAME Sets the name of the file/directory
  If the path name contains special characters, pass in the url encoded version
  of the path name.
  A azure.storage.file.datalake.DataLakeFileSystemClientBuilder is returned.

azure.storage.file.datalake.DataLakeFileSystemClientBuilder.httpClient

HTTPCLIENT Sets the HttpClient to use for sending a receiving requests
  Currently the Netty client is configured by default.
  An updated builder object is returned.

azure.storage.file.datalake.DataLakeFileSystemClientBuilder.sasToken

SASTOKEN Sets the SAS token used to authorize requests sent to the service
  This string should only be the query parameters (with or without a leading
  '?') and not a full url.
  An updated builder is returned.

azure.storage.file.datalake.DataLakePathClientBuilder

Superclass: azure.object

DATALAKEPATHCLIENTBUILDER Aids the configuration and instantiation of DataLakeFileClient

azure.storage.file.datalake.DataLakePathClientBuilder.DataLakePathClientBuilder

DATALAKEPATHCLIENTBUILDER Aids the configuration and instantiation of DataLakeFileClient

azure.storage.file.datalake.DataLakePathClientBuilder.buildDirectoryClient

BUILDDIRECTORYCLIENT Creates a DataLakeDirectoryClient based on the builder
  Returns a buildDirectoryClient created from the configurations in this builder.

azure.storage.file.datalake.DataLakePathClientBuilder.buildFileClient

BUILDFILECLIENT Creates a DataLakeFileClient based on options set in the builder
  Returns a DataLakeFileClient created from the configurations in this builder.

azure.storage.file.datalake.DataLakePathClientBuilder.credential

CREDENTIAL Sets the credential used to authorize requests
  Credential argument should be of type azure.storage.common.StorageSharedKeyCredential
  or azure.core.credential.TokenCredential.
  An updated builder object is returned.

azure.storage.file.datalake.DataLakePathClientBuilder.endpoint

ENDPOINT Sets the client endpoint
  The endpoint is also parsed for additional information i.e. the SAS token
  endpoint should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.file.datalake.DataLakePathClientBuilder.fileSystemName

fileSystemName Sets the name of the file system that contains the path
  If the value null or empty the root file system, $root, will be used.
  An updated builder object is returned.

azure.storage.file.datalake.DataLakePathClientBuilder.httpClient

HTTPCLIENT Sets the HttpClient to use for sending a receiving requests
  Currently the Netty client is configured by default.
  An updated builder object is returned.

azure.storage.file.datalake.DataLakePathClientBuilder.pathName

PATHNAME Sets the name of the file/directory
  If the path name contains special characters, pass in the url encoded version
  of the path name.
  An updated builder object is returned.

azure.storage.file.datalake.DataLakePathClientBuilder.sasToken

SASTOKEN Sets the SAS token used to authorize requests sent to the service
  This string should only be the query parameters (with or without a leading
  '?') and not a full url.
  A azure.storage.file.datalake.DataLakePathClientBuilder is returned.

azure.storage.queue

azure.storage.queue.models

azure.storage.queue.models.PeekedMessageItem

Superclass: azure.object

PEEKEDMESSAGEITEM Returned when calling Peek Messages on a queue

azure.storage.queue.models.PeekedMessageItem.PeekedMessageItem

PEEKEDMESSAGEITEM Returned when calling Peek Messages on a queue

azure.storage.queue.models.PeekedMessageItem.getDequeueCount

GETDEQUEUECOUNT Get the number of times the message has been dequeued
  An int64 is returned.

azure.storage.queue.models.PeekedMessageItem.getExpirationTime

GETEXPIRATIONTIME Get the time the Message was inserted into the queue
  A datetime value is returned, with time zone configured for UTC.

azure.storage.queue.models.PeekedMessageItem.getInsertionTime

GETINSERTIONTIME Get the time the Message was inserted into the queue
  A datetime value is returned, with time zone configured for UTC.

azure.storage.queue.models.PeekedMessageItem.getMessageId

GETMESSAGEID Get the Id of the Message
  A character vector is returned.

azure.storage.queue.models.PeekedMessageItem.getMessageText

GETMESSAGETEXT Get the content of the Message
  A character vector is returned.

azure.storage.queue.models.PeekedMessageItem.setDequeueCount

SETDEQUEUECOUNT Set the DequeueCount property
  The DequeueCount may be of type integer
  A PeekedMessageItem is returned.

azure.storage.queue.models.PeekedMessageItem.setExpirationTime

SETEXPIRATIONTIME  The time the Message was inserted into the Queue
  Expiration time should be of type datetime with a time zone set.
  A PeekedMessageItem is returned.

azure.storage.queue.models.PeekedMessageItem.setInsertionTime

SETINSERTIONTIME  The time the Message was inserted into the Queue
  Insertion time should be of type datetime with a time zone set.
  A PeekedMessageItem is returned.

azure.storage.queue.models.PeekedMessageItem.setMessageId

SETMESSAGEID Set the messageId property
  The messageId may be of type character vector or scalar string
  A PeekedMessageItem is returned.

azure.storage.queue.models.PeekedMessageItem.setMessageText

SETMESSAGETEXT Set the messageId property
  The messageText may be of type character vector or scalar string
  A PeekedMessageItem is returned.

azure.storage.queue.models.QueueItem

Superclass: azure.object

QUEUEITEM Azure Storage Queue

azure.storage.queue.models.QueueItem.QueueItem

QUEUEITEM Azure Storage Queue

azure.storage.queue.models.QueueItem.getName

GETNAME Returns the queue's name as a character vector

azure.storage.queue.models.QueueMessageItem

Superclass: azure.object

QUEUEMESSAGEITEM Returned when calling Get Messages on a queue

azure.storage.queue.models.QueueMessageItem.QueueMessageItem

QUEUEMESSAGEITEM Returned when calling Get Messages on a queue

azure.storage.queue.models.QueueMessageItem.getDequeueCount

GETDEQUEUECOUNT Get the number of times the message has been dequeued
  An int64 is returned.

azure.storage.queue.models.QueueMessageItem.getExpirationTime

GETEXPIRATIONTIME Get the time the Message was inserted into the queue
  A datetime value is returned, with time zone configured for UTC.

azure.storage.queue.models.QueueMessageItem.getInsertionTime

GETINSERTIONTIME Get the time the Message was inserted into the queue
  A datetime value is returned, with time zone configured for UTC.

azure.storage.queue.models.QueueMessageItem.getMessageId

GETMESSAGEID Get the Id of the Message
  A character vector is returned.

azure.storage.queue.models.QueueMessageItem.getMessageText

GETMESSAGETEXT Get the content of the Message
  A character vector is returned.

azure.storage.queue.models.QueueMessageItem.getPopReceipt

GETPOPRECEIPT Get the popReceipt, this value is required to delete the Message
  A character vector is returned.

azure.storage.queue.models.QueueMessageItem.getTimeNextVisible

GETTIMENEXTVISIBLE Get the timeNextVisible property
  The time that the message will again become visible in the Queue.
  A datetime value is returned, with time zone configured for UTC.

azure.storage.queue.models.QueueMessageItem.setDequeueCount

SETDEQUEUECOUNT Set the DequeueCount property
  The DequeueCount may be of type integer
  A QueueMessageItem is returned.

azure.storage.queue.models.QueueMessageItem.setExpirationTime

SETEXPIRATIONTIME  The time the Message was inserted into the Queue
  Expiration time should be of type datetime with a time zone set.
  A QueueMessageItem is returned.

azure.storage.queue.models.QueueMessageItem.setInsertionTime

SETINSERTIONTIME  The time the Message was inserted into the Queue
  Insertion time should be of type datetime with a time zone set.
  A QueueMessageItem is returned.

azure.storage.queue.models.QueueMessageItem.setMessageId

SETMESSAGEID Set the messageId property
  The messageId may be of type character vector or scalar string
  A QueueMessageItem is returned.

azure.storage.queue.models.QueueMessageItem.setMessageText

SETMESSAGETEXT Set the messageId property
  The messageText may be of type character vector or scalar string
  A QueueMessageItem is returned.

azure.storage.queue.models.QueueMessageItem.setPopReceipt

SETPOPRECEIPT Set the messageId property
  The popReceipt may be of type character vector or scalar string
  A QueueMessageItem is returned.

azure.storage.queue.models.QueueMessageItem.setTimeNextVisible

SETTIMENEXTVISIBLE Set the timeNextVisible property
  The time that the message will again become visible in the Queue.
  The time should be of type datetime with a time zone set.
  A QueueMessageItem is returned.

azure.storage.queue.models.QueueProperties

Superclass: azure.object

QUEUEPROPERTIES Class containing properties of a specific queue

azure.storage.queue.models.QueueProperties.QueueProperties

QUEUEPROPERTIES Class containing properties of a specific queue

azure.storage.queue.models.QueueProperties.getApproximateMessageCount

GETAPPROXIMATEMESSAGECOUNT Gets the approximate number of messages  in the queue
  Applies at the time of properties retrieval.
  An int64 is returned.

azure.storage.queue.models.SendMessageResult

Superclass: azure.object

SENDMESSAGERESULT Returned in the QueueMessageList array when calling Put Message on a Queue

azure.storage.queue.models.SendMessageResult.SendMessageResult

SENDMESSAGERESULT Returned in the QueueMessageList array when calling Put Message on a Queue

azure.storage.queue.models.SendMessageResult.getExpirationTime

GETEXPIRATIONTIME Time the Message will expire and be automatically deleted
  A datetime value is returned, with time zone configured for UTC.

azure.storage.queue.models.SendMessageResult.getInsertionTime

GETINSERTIONTIME Get the time the Message was inserted into the queue
  A datetime value is returned, with time zone configured for UTC.

azure.storage.queue.models.SendMessageResult.getPopReceipt

GETPOPRECEIPT Get the popReceipt, this value is required to delete the Message
  A character vector is returned.

azure.storage.queue.models.SendMessageResult.getTimeNextVisible

GETTIMENEXTVISIBLE Get the timeNextVisible property
  The time that the message will again become visible in the Queue.
  A datetime value is returned, with time zone configured for UTC.

azure.storage.queue.sas

azure.storage.queue.sas.QueueSasPermission

Superclass: azure.object

QUEUESASPERMISSION Constructs a string of permissions granted by Account SAS
  Setting a value to true means that any SAS which uses these permissions will
  grant permissions for that operation.
  Once the required values are set, the object should be serialized with
  toString and set as the permissions field on a QueueSasSignatureValues
  object

azure.storage.queue.sas.QueueSasPermission.QueueSasPermission

QUEUESASPERMISSION Constructs a string of permissions granted by Account SAS
  Setting a value to true means that any SAS which uses these permissions will
  grant permissions for that operation.
  Once the required values are set, the object should be serialized with
  toString and set as the permissions field on a QueueSasSignatureValues
  object

azure.storage.queue.sas.QueueSasPermission.hasAddPermission

HASADDPERMISSION Returns the add permission status
  The result is returned as a logical.

azure.storage.queue.sas.QueueSasPermission.hasProcessPermission

HASPROCESSPERMISSION Returns the process permission status
  The result is returned as a logical.

azure.storage.queue.sas.QueueSasPermission.hasReadPermission

HASREADPERMISSION Returns the read permission status
  The result is returned as a logical.

azure.storage.queue.sas.QueueSasPermission.hasUpdatePermission

HASUPDATEPERMISSION Returns the update permission status
  The result is returned as a logical

azure.storage.queue.sas.QueueSasPermission.parse

PARSE Creates a QueueSasPermission from the specified permissions string
  A azure.storage.queue.sas.QueueSasPermission object is returned.
  permString should be of type scalar string or character vector.
  Throws an IllegalArgumentException if it encounters a character that does
  not correspond to a valid permission.
  This is a static method.
  Expected characters are r, a, u, or p.

azure.storage.queue.sas.QueueSasPermission.setAddPermission

SETADDPERMISSION Sets the add permission status
  The permission argument should be of type logical.
  A azure.storage.queue.sas.QueueSasPermission object is returned.

azure.storage.queue.sas.QueueSasPermission.setProcessPermission

SETPROCESSPERMISSION Sets the read permission status
  The permission argument should be of type logical.
  A azure.storage.queue.sas.QueueSasPermission object is returned.

azure.storage.queue.sas.QueueSasPermission.setReadPermission

SETREADPERMISSION Sets the read permission status
  The permission argument should be of type logical.
  A azure.storage.queue.sas.QueueSasPermission object is returned.

azure.storage.queue.sas.QueueSasPermission.setUpdatePermission

SETUPDATEPERMISSION Sets the read permission status
  The permission argument should be of type logical.
  A azure.storage.queue.sas.QueueSasPermission object is returned.

azure.storage.queue.sas.QueueSasPermission.toString

TOSTRING Converts the given permissions to a String
  A character vector is returned.

azure.storage.queue.sas.QueueServiceSasSignatureValues

Superclass: azure.object

QUEUESERVICESASSIGNATUREVALUES Used to initialize a SAS for a Queue service
  When the values are set, use the generateSas method on the desired service
  client to obtain a representation of the SAS which can then be applied to a
  new client using the .sasToken(String) method on the desired client builder.
 
  Example
    qsssv = azure.storage.queue.sas.QueueServiceSasSignatureValues(expiryTime, permissions);
 
  Argument types:
    expiryTime: datetime
    permissions: azure.storage.queue.sas.QueueSasPermission

azure.storage.queue.sas.QueueServiceSasSignatureValues.QueueServiceSasSignatureValues

QUEUESERVICESASSIGNATUREVALUES Used to initialize a SAS for a Queue service
  When the values are set, use the generateSas method on the desired service
  client to obtain a representation of the SAS which can then be applied to a
  new client using the .sasToken(String) method on the desired client builder.
 
  Example
    qsssv = azure.storage.queue.sas.QueueServiceSasSignatureValues(expiryTime, permissions);
 
  Argument types:
    expiryTime: datetime
    permissions: azure.storage.queue.sas.QueueSasPermission

azure.storage.queue.QueueClient

Superclass: azure.object

QUEUECLIENT Client performs generic queue operations

azure.storage.queue.QueueClient.QueueClient

QUEUECLIENT Client performs generic queue operations

azure.storage.queue.QueueClient.clearMessages

CLEARMESSAGES Deletes all messages in the queue

azure.storage.queue.QueueClient.create

CREATE Creates a new queue

azure.storage.queue.QueueClient.delete

DELETE QueueClient destructor - in MATLAB delete is a
  reserved method name for the class destructor. This method
  does not delete Queues on Azure. To delete the Azure
  Queue use the deleteQueue method in MATLAB.

azure.storage.queue.QueueClient.deleteMessage

DELETEMESSAGE Deletes the specified message from the queue
  The messageId and popReceipt arguments should be of type character vector or
  scalar string

azure.storage.queue.QueueClient.deleteQueue

DELETEQUEUE Deletes the queue

azure.storage.queue.QueueClient.generateSas

GENERATESAS Generates a SAS for the queue
  The client must be authenticated via StorageSharedKeyCredential
  The SAS is returned as a character vector.

azure.storage.queue.QueueClient.getAccountName

GETACCOUNTNAME Get associated account name
  A character vector is returned.

azure.storage.queue.QueueClient.getQueueName

GETQUEUENAME Get associated account name
  A character vector is returned.

azure.storage.queue.QueueClient.getQueueUrl

GETQUEUEURL Get associated URL
  A character vector is returned.

azure.storage.queue.QueueClient.peekMessage

PEEKMESSAGE Peeks the first message in the queue
  A peek request retrieves a message from the front of the queue without
  changing its visibility. If no message is found an empty double is
  returned.

azure.storage.queue.QueueClient.receiveMessage

RECEIVEMESSAGE Retrieves the first message in the queue
  The message is hidden from other operations for 30 seconds.
  If no message is found an empty double is returned.

azure.storage.queue.QueueClient.receiveMessages

RECEIVEMESSAGES Retrieves up to the maximum number of messages from the queue
  Messages are hidden from other operations for the timeout period.
 
  maxMessages
    Maximum number of messages to get.
    If there are less messages exist in the queue than requested
    all the messages will be returned. If left empty only 1 message
    will be retrieved, the allowed range is 1 to 32 messages.
 
  visibilityTimeout - Optional.
    The timeout period for how long the message is invisible in
    the queue. If left empty the received messages will be
    invisible for 30 seconds. The timeout must be between 1
    second and 7 days.
 
  timeout - Optional.
    Timeout applied to the operation.
    If a response is not returned before the timeout concludes
    a RuntimeException will be thrown.
 
  context - TODO
 
  If a any of visibilityTimeout, timeout or context are provided all must be
  provided.
 
  An array of QueueMessageItem is returned.

azure.storage.queue.QueueClient.sendMessage

SENDMESSAGE Sends a message that has a time-to-live of 7 days
  The message is instantly visible.
  A SendMessageResult is returned.

azure.storage.queue.QueueClientBuilder

Superclass: azure.object

QUEUECLIENTBUILDER Aids the configuration and instantiation of QueueClients

azure.storage.queue.QueueClientBuilder.QueueClientBuilder

QUEUECLIENTBUILDER Aids the configuration and instantiation of QueueClients

azure.storage.queue.QueueClientBuilder.buildClient

BUILDCLIENT Creates a QueueClient based on options set in the builder
  A built QueueClient object is returned.

azure.storage.queue.QueueClientBuilder.connectionString

CONNECTIONSTRING Sets the connection string to connect to the service
  connectionString should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.queue.QueueClientBuilder.credential

CREDENTIAL Sets the credential used to authorize requests
  Credential argument should be of type azure.storage.common.StorageSharedKeyCredential.
  An updated builder object is returned.

azure.storage.queue.QueueClientBuilder.endpoint

ENDPOINT Sets the client endpoint
  The endpoint is also parsed for additional information i.e. the SAS token
  endpoint should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.queue.QueueClientBuilder.httpClient

HTTPCLIENT Sets the HttpClient to use for sending a receiving requests
  Currently the Netty client is configured by default.
  An updated builder object is returned.

azure.storage.queue.QueueClientBuilder.queueName

QUEUENAME Sets the name of the container that contains the queue
  containerName should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.queue.QueueClientBuilder.sasToken

sasToken Sets the SAS token used to authorize requests
  sasToken should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.queue.QueueServiceClient

Superclass: azure.object

QUEUESERVICECLIENT Service client performs generic queue operations

azure.storage.queue.QueueServiceClient.QueueServiceClient

QUEUESERVICECLIENT Service client performs generic queue operations

azure.storage.queue.QueueServiceClient.createQueue

CREATEQUEUE Creates a queue in with the specified name
  A QueueClient is returned.

azure.storage.queue.QueueServiceClient.deleteQueue

DELETEQUEUE Deletes a queue in with the specified name

azure.storage.queue.QueueServiceClient.generateAccountSas

GENERATEACCOUNTSAS Generates an account SAS for the Azure Storage account
  The client must be authenticated via StorageSharedKeyCredential
  The SAS is returned as a character vector.

azure.storage.queue.QueueServiceClient.getAccountName

GETACCOUNTNAME Get associated account name
  A character vector is returned.

azure.storage.queue.QueueServiceClient.getQueueClient

GETQUEUECLIENT Constructs a QueueClient that interacts with the specified queue
  A QueueClient is returned.

azure.storage.queue.QueueServiceClient.getQueueServiceUrl

GETQUEUESERVICEURL Gets the URL of the storage queue

azure.storage.queue.QueueServiceClient.listQueues

Lists all queues in the storage account without their metadata
  TODO listQueues probably SDK bug - Only the fist page of queues is 
  currently listed.

azure.storage.queue.QueueServiceClientBuilder

Superclass: azure.object

QUEUESERVICECLIENTBUILDER Aids configuration & instantiation of QueueServiceClients

azure.storage.queue.QueueServiceClientBuilder.QueueServiceClientBuilder

QUEUESERVICECLIENTBUILDER Aids configuration & instantiation of QueueServiceClients

azure.storage.queue.QueueServiceClientBuilder.buildClient

BUILDCLIENT Creates a QueueServiceClient based on options set in the builder
  A built QueueServiceClient object is returned.

azure.storage.queue.QueueServiceClientBuilder.connectionString

CONNECTIONSTRING Sets the connection string to connect to the service
  connectionString should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.queue.QueueServiceClientBuilder.credential

CREDENTIAL Sets the credential used to authorize requests
  Credential argument should be of type azure.storage.common.StorageSharedKeyCredential.
  An updated builder object is returned.

azure.storage.queue.QueueServiceClientBuilder.endpoint

ENDPOINT Sets the client endpoint
  The endpoint is also parsed for additional information i.e. the SAS token
  endpoint should be of type character vector or scalar string.
  An updated builder object is returned.

azure.storage.queue.QueueServiceClientBuilder.httpClient

HTTPCLIENT Sets the HttpClient to use for sending a receiving requests
  Currently the Netty client is configured by default.
  An updated builder object is returned.

azure.storage.queue.QueueServiceClientBuilder.sasToken

sasToken Sets the SAS token used to authorize requests
  sasToken should be of type character vector or scalar string.
  An updated builder object is returned.

azure.object

Superclass: dynamicprops

OBJECT Root Class for all Azure wrapper objects

azure.object.object

logObj = Logger.getLogger();
  write(logObj,'debug','Creating root object');

azure.object.setSystemProperties

azure.object.setSystemProperties is a function.
    v = azure.object.setSystemProperties

mathworks

mathworks.adx

mathworks.adx.NullPolicy

NullPolicy Enumeration used to determine how null values ard handled in MATLAB
 
  Values:
                 ErrorAny: Error if any null values are detected
   ErrorLogicalInt32Int64: Error if null values are detected for logicals,
                           int32s or int64s that do not support missing or NaN
                 AllowAll: All null types to map to missing, NaN or NaT for
                           all data types
           Convert2Double: Convert logicals, int32s, & int64s  to doubles

Enumeration values:
  ErrorAny
  ErrorLogicalInt32Int64
  AllowAll
  Convert2Double

mathworks.adx.NullPolicy.NullPolicy

NullPolicy Enumeration used to determine how null values ard handled in MATLAB
 
  Values:
                 ErrorAny: Error if any null values are detected
   ErrorLogicalInt32Int64: Error if null values are detected for logicals,
                           int32s or int64s that do not support missing or NaN
                 AllowAll: All null types to map to missing, NaN or NaT for
                           all data types
           Convert2Double: Convert logicals, int32s, & int64s  to doubles

mathworks.adx.KQLQuery

KQLQuery Runs a KQL query
 
  Required argument
    query: query to be run as a string or character vector
 
  Optional arguments
   database: Name of the the database to be used, by default a value will be
             taken from the settings JSON file.
 
   propertyNames: Property names to be applies to the query, specified as a 
                  string array.
 
   propertyValues: Property values that correspond the propertyNames, specified
                   as a cell array.
 
   type: Force the type of the query, options are "query" or "command" by default
         the query will be examined to determine the type.
 
   cluster: A non default cluster can be specified as a string or character vector.
 
   bearerToken: Token used to authenticate KQL queries only, overrides JSON
                settings file based authentication. Provided as a text scalar.
 
   convertDynamics: Logical to determine if dynamic fields are decoded or not.
 
   nullPolicy: A mathworks.adx.NullPolicy enumeration to determine how
               null values are handled in returned results.
 
   useParallel: A logical to enable the use of Parallel Computing Toolbox if
                available to improve performance on large queries.
                Default is false.  Applies to KQL queries only.
                See: Documentation/Performance.md for more details.
 
   parallelThreshold: The number of rows above which a parpool will be started
                      rather than just working serially, if making a large
                      query or repeated queries then the overhead caused by 
                      the creation of a parpool should be amortized.
                      The default is 1000 rows.
 
   verbose: A logical to enable additional output. Default is false.
 
 
  Return values
   result: Table containing the primary result of the query or command. If the
           request failed the result will be a adx.control.models.ErrorResponse
           rather than a table.
 
   success: A logical to indicate if the query succeed or not.
 
   requestId: The request's ID string in ADX.
 
   resultTables: Returned tables including metadata, values have not been processed
                 into MATLAB Tables.
 
   dataSetHeader: For calls that use the V2 REST API the value contains version
                  information and whether the call is progressive or not.
                  See https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/response-v2#datasetheader
 
   dataSetCompletion: For calls that use the V2 REST API the value indicates
                      if the request was cancelled or has an error and if so
                      error information, in general the success value and result
                      (adx.control.models.ErrorResponse) is simpler to work with.
                      See https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/response-v2#datasetcompletion

mathworks.adx.adxRoot

adxRoot Function to return the root folder for the ADX interface
 
  ADXRoot alone will return the root for the MATLAB code in the
  project.
 
  ADXRoot with additional arguments will add these to the path
  
   funDir = mathworks.adx.adxRoot('app', 'functions')
 
   The special argument of a negative number will move up folders, e.g.
   the following call will move up two folders, and then into
   Documentation.
 
   docDir = mathworks.adx.adxRoot(-2, 'Documentation')

mathworks.adx.clustersGet

clustersGet Returns a Cluster object for a given or default Cluster URL
  In the case of error a adx.control.models.ErrorResponse is returned
  or an error is thrown.
 
  Example:
    % Get a cluster Object for the current default cluster
    result = mathworks.adx.clustersGet();

mathworks.adx.createTable

createTable Creates a table in a given database
  The contents of the table are not ingested, only the schema
 
  Require arguments:
    matlabTable : The matlabTable to base Kusto table upon. Type table.
                  The table need not have content only columns of the
                  correct types.
      tableName : The name of the table to create. Type string.
 
  Optional arguments:
   tableProperties : Key value properties for the table, Type containers.Map.
          database : Non default database name. Type string.
           cluster : Non default cluster name. Type string.
       bearerToken : Non default token value. Type string.
 
  Returns a logical true and a table describing the created table or a
  logical false and a adx.control.models.ErrorResponse or an empty MATLAB Table.
 
  Example:
 
    % Create a sample table T
    LastName = ["Sanchez";"Johnson";"Li"];
    Age = [int32(38); int32(43); int32(38)];
    Height = [int64(71); int64(69); int64(64)];
    Weight = [176; 163; 131];
    T = table(LastName,Age,Height,Weight);
    [tf, result] = mathworks.adx.createTable(T, "health")
 
    tf =
     logical
      1
    result =
      1x5 table
 
    TableName                                                                                                                                       Schema                                                                                                                                       DatabaseName     Folder      DocString
    _________    ____________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________    ____________    _________    _________
    "health"     "{"Name":"health","OrderedColumns":[{"Name":"LastName","Type":"System.String","CslType":"string"},{"Name":"Age","Type":"System.Int32","CslType":"int"},{"Name":"Height","Type":"System.Int64","CslType":"long"},{"Name":"Weight","Type":"System.Double","CslType":"real"}]}"     "testdb1"      <missing>    <missing>
 
  See also: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/management/create-table-command

mathworks.adx.dropTable

dropTable Drops a table from a given database
 
  The .drop table command only soft deletes the data.
  Data can't be queried, but is still recoverable from persistent storage.
  The underlying storage artifacts are hard-deleted according to the
  recoverability property in the retention policy that was in effect at
  the time the data was ingested into the table.
 
  Require argument:
      tableName : The name of the table to drop. Type string.
 
  Optional arguments:
       ifExists : If specified and if true the command won't fail if the table
                  doesn't exist. Type logical.
       database : Non default database name. Type string.
        cluster : Non default cluster name. Type string.
    bearerToken : Non default token value. Type string.
 
  Returns a table of remaining tables and some properties or an
  adx.control.models.ErrorResponse.
 
  Example:
 
      result = mathworks.adx.dropTable("TestTable")
  result =
    5x4 table
          TableName        DatabaseName     Folder      DocString
      _________________    ____________    _________    _________
      "airlinesmall"        "testdb1"      <missing>    <missing>
      "airlinesmallcsv"     "testdb1"      <missing>    <missing>
      "itable"              "testdb1"      <missing>    <missing>
      "myparquet"           "testdb1"      <missing>    <missing>
      "outagesTable"        "testdb1"      <missing>    <missing>
 
  See also: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/management/drop-table-command

mathworks.adx.exportToBlob

exportToBlob Exports data to an Azure blob
 
  Required arguments
   storageConnectionString: SAS URL for the destination blob
 
   query: The result of the query is written to a blob.
 
  Optional arguments
   compressed: Logical to indicate if the results should be compressed, default is true
 
   outputDataFormat: String to indicate the output file format the default is parquet
                     Supported values are: csv, tsv, json, and parquet.
 
   database: Database name string, the default is taken from the JSON settings file.
 
   cluster: Cluster name string, the default is taken from the JSON settings file.
 
   bearerToken: String containing a specific bearerToken
 
  Return values
   tf: Logical to indicate if the command succeeded.
 
   Result: On success contains the result of the query on failure contains a
           adx.control.models.ErrorResponse
 
  Example:
   exportURL = "https://<mystorageaccount>.blob.core.windows.net/<REDACTED>";
   exportURI = matlab.net.URI(exportURL);
   SAS = exportURI.EncodedQuery;
   query = "table('" + "mytablename" + "', 'all')";
   [tf, result] = mathworks.adx.exportToBlob(exportURI.EncodedURI, query);
   % Assuming tf == true
   downloadURL = result.Path(1) + "?" + SAS;
   downloadURI = matlab.net.URI(downloadURL);
   % The default export format is parquet
   localFile = websave("exportedTable.gz.parquet", downloadURI);
   T = parquetread(localFile);
  
  See also: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/management/data-export/export-data-to-storage

mathworks.adx.ingestFile

ingestTableQueue Ingests a local file to Azure Data Explorer using Azure blob
 
  Arguments:
       localFile: Path to file to be ingested.
  
       tableName: Table to ingest the data to.
 
  Optional arguments:
        database: database name, if not specified the database configured in
                  the json settings file will be used.
  
          format: Format of the file to be ingested, if not specified the file
                  extension will be used.
  
        blobName: Name of the blob to upload to, if not specified a name will be
                  generated based on the local file.
 
          cluster: Cluster name, if not specified the database configured in
                  the json settings file will be used.
 
      bearerToken: Bearer Token, if not specified the database configured in
                  the json settings file will be used.
 
            mode: "drop" drop the existing table if it exists before ingesting
                  "create" create the table if it does not exist
                  "add" (Default) ingest into an existing table
 
  Return values:
     success: A logical true is returned if a success message is returned.
 
      result: Tabular output of the command if successful otherwise a
              adx.control.models.ErrorResponse
 
  Example:
     % Get filename & path for the outages.parquet file
     info = parquetinfo('outages.parquet');
     success = mathworks.adx.ingestFile(info.Filename, 'outagesTable');
 
 
                                    Table Exists
   -----------------------------------------------------
                 |       True           |     False
   -----------------------------------------------------
   Mode          |                      |
   create        |   add                |    create, add
   drop          |   drop, create, add  |    create add
   add (default) |   add                |    error

mathworks.adx.ingestFileQueue

INGESTSINGLEFILE Ingests a local file to Azure Data Explorer using Azure blob & queue
  
  Arguments:
       localFile: Path to file to be ingested.
 
  Optional named arguments:
        database: database name, if not specified the database configured in
                  the JSON settings file will be used.
          format: Format of the file to be ingested, if not specified the file
                  extension will be used.
        blobName: Name of the blob to upload to, if not specified a name will be
                  generated based on the local file.
         cluster: Cluster name, if not specified the database configured in
                  the JSON settings file will be used.
     bearerToken: Bearer Token, if not specified the database configured in
                  the JSON settings file will be used.
       tableName: Table to ingest the data to, default is ingestedTable-<timeDateStamp>
 
  Return values
         success: A logical true is returned if a success message is returned.
 
  Example:
     % Get filename & path for the outages.parquet file
     info = parquetinfo('outages.parquet');
     success = mathworks.adx.ingestFileQueue(info.Filename, 'tableName', 'outagesTable')

mathworks.adx.ingestFromQuery

ingestFromQuery Ingest data using the result of a command or query
 
  This ingestion method is intended for exploration and prototyping.
  Do not use it in production or high-volume scenarios.
 
    Command           If table exists                 If table doesn't exist
    -------------------------------------------------------------------------------------------
    set              The command fails               The table is created and data is ingested
    append           Data is appended to the table   The command fails
    set-or-append    Data is appended to the table   The table is created and data is ingested
    set-or-replace   Data replaces the data          The table is created and data is ingested
                     in the table
 
  Arguments
          command   One of: set, append, set-or-append or set-or-replace.
                    Type scalar text.
 
        tableName   Name of the table to ingest into. Type scalar text.
 
   queryOrCommand   Command or query to append to produce the dta to ingest.
                    Type scalar text.
 
  Optional named arguments
            async   Logical to indicate if async mode should be used or not.
                    Default is false.
 
         database   Non default database name. Type scalar text.
 
          cluster   Non default cluster name. Type scalar text.
 
    propertyNames   One or more supported ingestion properties used
                    to control the ingestion process.
 
   propertyValues   Property values that correspond the propertyNames, specified
                    as a cell array.
 
           scopes   Non default scopes value. Type scalar text.
 
  convertDynamics   Logical to determine if dynamic fields are decoded or not.
                    Default is true.
 
       nullPolicy   A mathworks.adx.NullPolicy enumeration to determine how
                    null values are handled in returned results.
 
  allowNullStrings  Logical to allow null strings in input. Kusto does not
                    store null strings but control command may return them.
                    Default is true.
 
          verbose   A logical to enable additional output. Default is true.
 
  Return values
          success   A logical to indicate if the query succeed or not.
 
           result   Table containing the primary result or first table of the
                    command response. If the request failed the result will
                    be a adx.control.models.ErrorResponse rather than a table.
 
        requestId   The request's ID string in ADX. Type scalar string.
 
         extentId   The unique identifier for the data shard that was generated
                    by the command. Type scalar string.
 
  See also:
    https://learn.microsoft.com/en-us/azure/data-explorer/ingestion-properties
    https://learn.microsoft.com/en-us/azure/data-explorer/kusto/management/data-ingestion/ingest-from-query

mathworks.adx.ingestInline

ingestInline Ingests limited amounts of data into Kusto directly from MATLAB
 
  This ingestion method is intended for exploration and prototyping.
  Do not use it in production or high-volume scenarios.
 
  The destination table should exist before calling this function.
 
  You must have at least Table Ingestor permissions to run this command.
 
  Arguments
        tableName   Name of the table to ingest into. Type scalar text.
 
       ingestData   Data to be ingested, must be of formats that are convertible
                    to Kusto literals and compatible with the destination table
                    schema. Type cell array, table, primitive variable/array.
 
  Optional named arguments
   tableExistsCheck Check if the table exists before proceeding. Type logical,
                    default true.
 
      checkSchema   Check that the destination schema is compatible with the
                    ingest data. Type logical, default true.
 
         database   Non default database name. Type scalar text.
 
          cluster   Non default cluster name. Type scalar text.
 
    propertyNames   One or more supported ingestion properties used
                    to control the ingestion process.
 
   propertyValues   Property values that correspond the propertyNames, specified
                    as a cell array.
 
           scopes   Non default scopes value. Type scalar text.
 
  convertDynamics   Logical to determine if dynamic fields are decoded or not.
                    Default is true.
 
       nullPolicy   A mathworks.adx.NullPolicy enumeration to determine how
                    null values are handled in returned results.
 
  allowNullStrings  Logical to allow null strings in input. Kusto does not
                    store null strings but control command may return them.
                    Default is true.
 
          verbose   A logical to enable additional output. Default is true.
 
  Return values
          success   A logical to indicate if the query succeed or not.
 
           result   Table containing the primary result or first table of the
                    command response. If the request failed the result will
                    be a adx.control.models.ErrorResponse rather than a table.
 
        requestId   The request's ID string in ADX. Type scalar string.
 
         extentId   The unique identifier for the data shard that was generated
                    by the command. Type scalar string.
  
  If table existence check and the schema compatibility check fail empty
  result, requestId & extentId values are returned along with a logical false
  success.
 
  While not intended for performance sensitive applications disabling the 
  table existence check and the schema compatibility check where appropriate
  using tableExistsCheck and checkSchema respectively.
 
  Example:
   localPath = fullfile(matlabroot, "toolbox", "matlab", "demos", "outages.parquet");
   tableName = "outages";
   ingestData = praquetTable(1,:);
   
   [success, result, requestId, extentId] = mathworks.adx.ingestInline(tableName, ingestData)
   
   success =
     logical
      1
   result =
     1x5 table
                      ExtentId                                    ItemLoaded                      Duration    HasErrors                 OperationId              
       ______________________________________    _____________________________________________    ________    _________    ______________________________________
       "8de6b799-6e12-4994-b57b-ed75e15db0a8"    "inproc:a607e293-dbdd-4f79-a1a2-a61982585adf"    00:00:00      false      "cd4184ca-0d31-4c42-a273-5f2953f76ddf"
   requestId = 
       "63bb1cea-b589-45ac-82ad-00d68ca96aeb"
   extentId = 
       "8de6b799-6e12-4994-b57b-ed75e15db0a8"
 
  See also:
    https://learn.microsoft.com/en-us/azure/data-explorer/ingestion-properties
    https://learn.microsoft.com/en-us/azure/data-explorer/kusto/management/data-ingestion/ingest-inline

mathworks.adx.ingestTable

ingestTable Ingests a MATLAB table to an Azure Data Explorer Table
  The table is converted to a temporary local parquet file to facilitate
  ingestion.
 
  Example:
    inputTable = parquetread("myfile.parquet");
    [success, result] =  mathworks.adx.ingestTable(inputTable, tableName="mytablename")
 
  Arguments:
               T: A MATLAB table
 
  Options:
       tableName: A name for the table, if not specified the tabled will
                  be named ingestedTable-<UTC timestamp>
        database: database name, if not specified the database configured in
                  the json settings file will be used.
         cluster: Cluster name, if not specified the database configured in
                  the json settings file will be used.
     bearerToken: Bearer Token, if not specified the database configured in
                  the json settings file will be used.
            mode: "drop" drop an existing table with the tableName before ingesting
                  "create" create the table if it does not exist
                  "add" (Default) ingest into an existing table
         verbose: Logical to enable additional feedback, default is true

mathworks.adx.ingestTableQueue

ingestTableQueue Ingests a MATLAB table to an Azure Data Explorer Table
  The table is converted to a temporary local parquet file to facilitate
  ingestion.
 
  Arguments:
               T: A MATLAB table.
 
  Optional named arguments:
       tableName: A name for the table, if not specified the tabled will
                  be named ingestedTable-<UTC timestamp>
        database: database name, if not specified the database configured in
                  the json settings file will be used.
         cluster: Cluster name, if not specified the database configured in
                  the json settings file will be used.
     bearerToken: Bearer Token, if not specified the database configured in
                  the json settings file will be used.

mathworks.adx.isClusterRunning

isClusterRunning Returns a logical true if the cluster is running
  If the cluster is not running a false is returned. The state is optionally 
  displayed. An optional adx.control.models.Cluster object is returned with
  full cluster metadata information.
 
  Example:
    tf = mathworks.adx.isClusterRunning();

mathworks.adx.listTables

listTables Returns a list of tables and their properties
  
  contains the specified table or all tables in the
  database with a detailed summary of each table's properties.
  You must have at least Database User, Database Viewer, or Database
  Monitor permissions to run this command.
  
  Optional arguments
   database: Database name string, the default is taken from the JSON settings file.
 
   cluster: Cluster name string, the default is taken from the JSON settings file.
 
  Returns
   tableNames: A string array of the table names.
 
   Success: Logical true if the query successfully completes, otherwise false.
 
   tableDetails: A table containing metadata about the tables.

mathworks.adx.mgtCommand

mgtCommand Runs a management command
 
  Required argument
    query: query to be run as a string or character vector
 
  Optional arguments
   database: Name of the the database to be used, by default a value will be
             taken from the settings JSON file.
 
   propertyNames: Property names to be applies to the query, specified as a 
                  string array.
 
   propertyValues: Property values that correspond the propertyNames, specified
                   as a cell array.
 
   type: Force the type of the query, options are "query" or "command" by default
         the query will be examined to determine the type.
 
   scopes: For commands scopes can be specified as a string array.
 
   cluster: A non default cluster can be specified as a string or character vector.
 
   convertDynamics: Logical to determine if dynamic fields are decoded or not.
 
   nullPolicy: A mathworks.adx.NullPolicy enumeration to determine how
               null values are handled in returned results.
 
   verbose: A logical to enable additional output.
 
  Return values
   result: Table containing the primary result of the query or command. If the
           request failed the result will be a adx.control.models.ErrorResponse
           rather than a table.
 
   success: A logical to indicate if the query succeed or not.
 
   requestId: The request's ID string in ADX
 
   resultTables: Returned tables including metadata, values have not been processed
                 into MATLAB Tables.
 
   dataSetHeader: For calls that use the V2 REST API the value contains version
                  information and whether the call is progressive or not.
                  See https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/response-v2#datasetheader
 
   dataSetCompletion: For calls that use the V2 REST API the value indicates
                      if the request was canceled or has an error and if so
                      error information, in general the success value and result
                      (adx.control.models.ErrorResponse) is simpler to work with.
                      See https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/response-v2#datasetcompletion

mathworks.adx.run

run Runs a KQL query or management command
  This ia a high-level interface to simplify running most queries.
 
  Required argument
    query: query to be run as a string or character vector
 
  Optional arguments
   database: Name of the the database to be used, by default a value will be
             taken from the settings JSON file.
 
   propertyNames: Property names to be applies to the query, specified as a 
                  string array.
 
   propertyValues: Property values that correspond the propertyNames, specified
                   as a cell array.
 
   type: Force the type of the query, options are "query" or "command" by default
         the query will be examined to determine the type.
 
   scopes: For commands scopes can be specified as a string array.
 
   cluster: A non default cluster can be specified as a string or character vector.
 
   bearerToken: Token used to authenticate KQL queries only, overrides JSON
                settings file based authentication. Provided as a text scalar.
 
   convertDynamics: Logical to determine if dynamic fields are decoded or not.
 
   nullPolicy: A mathworks.adx.NullPolicy enumeration to determine how
               null values are handled in returned results.
 
   customRowDecoder: A function handle to a function that will be called to decode
                     Primary Result table JSON rows instead of the default decoder.
                     See: Documentation/Performance.md for more details.
 
   useParallel: A logical to enable the use of Parallel Computing Toolbox if
                available to improve performance on large queries.
                Default is false.  Applies to KQL queries only.
                See: Documentation/Performance.md for more details.
 
   parallelThreshold: The number of rows above which a parpool will be started
                      rather than just working serially, if making a large
                      query or repeated queries then the overhead caused by 
                      the creation of a parpool should be amortized.
                      The default is 1000 rows.
 
  verbose: A logical to enable additional output.
 
 
  Return values
   result: Table containing the primary result of the query or command. If the
           request failed the result will be a adx.control.models.ErrorResponse
           rather than a table.
 
   success: A boolean to indicate if the query succeed or not.
 
   requestId: The request's ID string in ADX
 
   resultTables: Returned tables including metadata, values have not been processed
                 into MATLAB Tables.
 
   dataSetHeader: For calls that use the V2 REST API the value contains version
                  information and whether the call is progressive or not.
                  See https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/response-v2#datasetheader
 
   dataSetCompletion: For calls that use the V2 REST API the value indicates
                      if the request was cancelled or has an error and if so
                      error information, in general the success value and result
                      (adx.control.models.ErrorResponse) is simpler to work with.
                      See https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/response-v2#datasetcompletion
 
  Example:
     [result, success] = mathworks.adx.run('print mycol="Hello World"')

mathworks.adx.tSQLQuery

tSQLQuery Runs a T-SQL query
  This is a higher-level wrapper function for KQLQuery which sets the
  query propertyName and propertyValue to enable the tSQL syntax.
  Input arguments and return values are as per KQLQuery.
 
  It assumes the query_language property is not already set, if so it will
  be overwritten.
 
  See: https://learn.microsoft.com/en-us/azure/data-explorer/t-sql

mathworks.adx.tableExists

TABLEEXISTS Returns true is a given table exists
 
  Example:
    tableExists = mathworks.adx.tableExists(tableName, database=database, cluster=cluster);

mathworks.internal

mathworks.internal.adx

mathworks.internal.adx.buildSettingsFile

buildSettingsFile Gets user input for JSON settings file fields
  Template files can be found in <package directory>/Software/MATLAB/config
 
  Optional argument
    filename: Filename to store settings, default is <package directory>/Software/MATLAB/config/adx.Client.Settings.json>

mathworks.internal.adx.charOrString2Guid

charOrString2Guid Converts a scalar MATLAB string or char to a Kusto guid
  Example: guid(74be27de-1e4e-49d9-b579-fe0b331d3642)
  A scalar or empty input value must be provided.
  If an empty value is provided guid(null) is returned.
 
  See also: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/guid

mathworks.internal.adx.charOrString2String

charOrString2String Converts a MATLAB char or string to a Kusto string
  A string is returned.
  Input must be a empty, missing, scalar string or character vector.
 
  If the optional logical named argument verbatim (default: false) a @ sign is
  prepended to the string. The backslash character (\) stands for itself and
  isn't an escape character. Prepending the @ character to string literals
  serves as a verbatim identifier. In verbatim string literals, double quotes
  are escaped with double quotes and single quotes are escaped with single quotes.
 
  An obfuscated string is created by setting the optional named argument
  obfuscated (default: false). It prepends a H character to a verbatim
  or string literal. The obfuscated argument is not applied to multi-lines.
 
  Multi-line string literals support newline (\n) and return (\r) characters.
  Multi-line string literals do not support escaped characters, similar to verbatim
  string literals. Multi-line string literals don't support obfuscation.
 
  Kusto does not support null strings hence empty or missing MATLAB string
  values are treated as follows:
 
            |  Literal     Verbatim    Multi-line
   -----------------------------------------------
   missing  |    ""           @""        ``````
     empty  |    ""           @""        ``````
 
  If an empty string is provided "", `````` or @"" is returned.
 
  Optional named arguments
    verbatim    Logical, default: false
    multiline    Logical, default: false
 
  Verbatim and multiline cannot be enabled at the same time.
 
  See also: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/string

mathworks.internal.adx.datetime2datetime

datetime2datetime Converts a scalar MATLAB datetime to a Kusto datetime
  A scalar or empty input value must be provided.
 
  See also: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/datetime

mathworks.internal.adx.dispErrorAdditionalInfo

Displays a adx.control.models.ErrorAdditionalInfo

mathworks.internal.adx.dispErrorDetails

dispErrorDetails Display a adx.control.models.ErrorDetail

mathworks.internal.adx.dispErrorResponse

dispErrorResponse Display a adx.control.models.ErrorResponse

mathworks.internal.adx.doubleOrSingle2Decimal

doubleOrSingle2Decimal Converts a MATLAB double or single to a Kusto decimal
  A string is returned.
  If empty decimal(null) is returned.
  Otherwise decimal(<value>) is returned.
  A scalar or empty input value must be provided.
 
  Note Arithmetic operations involving decimal values are significantly slower
  than operations on real data type. As MATLAB does not support floating point
  precision beyond double using doubleOrSingle2Real() instead is recommended
  if a real value can be used.
 
  See also: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/decimal

mathworks.internal.adx.doubleOrSingle2Real

doubleOrSingle2Real Converts a MATLAB double or single to a Kusto real
  A string is returned.
  If empty real(null) is returned.
  If nan real(nan) is returned.
  If +inf real(+inf) is returned.
  If -inf real(-inf) is returned.
  A scalar or empty input value must be provided.
 
  See also: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/real

mathworks.internal.adx.duration2Timespan

duration2Timespan Converts a MATLAB duration to a Kusto timespan
  Input must be a scalar duration, duration.empty or duration NaN.
  A timespan literal is returned as a scalar string.
  At most millisecond precision is supported.
  A duration.empty or duration NaN are returned as "timespan(null)"
  Other values are returned in the format: "timespan(days.hours:minutes:seconds.milliseconds)"
 
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/timespan

mathworks.internal.adx.exampleCustomRowDecoder

exampleCustomRowDecoder Example of a custom JSON parser function
  Sample decoder that handles an array of rows of the form:
   [128030544,1.0,"myStringValue-1"]
  with fields of types int64, double and string.
 
  It will not process other data and is intended for speed rather than
  strict correctness or robustness.
 
  The custom decoder is applied to the PrimaryResult rows field only.
 
  It is required to return a cell array of size number of rows by the
  number of columns that can be converted to a MATLAB table with the
  given schema.
 
  It is not required to respect input arguments flags if foreknowledge of
  returned data permits it.
 
  Custom decoders are applied to nonprogressive KQL API v2 mode queries only.
  If support for other query types is required contact MathWorks.
 
  Example:
   query = sprintf('table("%s", "all")', tableName);
   crd = @mathworks.internal.adx.exampleCustomRowDecoder;
   [result, success] = mathworks.adx.run(query, customRowDecoder=crd);
 
  For a generic decoder see: getRowsWithSchema.

mathworks.internal.adx.getDataBearerToken

getDataBearerToken Gets a bearer token by forcing a query

mathworks.internal.adx.getDefaultConfigValue

getDefaultConfigValue Reads a field from the config file
  A string is returned.

mathworks.internal.adx.getIngestionResources

getIngestionResources Get queues and other values to do ingestion
  Returns a adx.data.models.IngestionResourcesSnapshot

mathworks.internal.adx.getKustoIdentityToken

getKustoIdentityToken Management query to request a Kusto Identity Token
  Query used is: .get kusto identity token

mathworks.internal.adx.getRowWithSchema

GETROWWITHSCHEMA Extract a row of data as a cell array from a JSON string using schemas
  For detail on dynamic values see:
    https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/dynamic

mathworks.internal.adx.getRowsWithSchema

GETROWSWITHSCHEMA Extract rows of data as a cell array from a JSON string using schemas
  For detail on dynamic values see:
    https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/dynamic

mathworks.internal.adx.getTableAndSchemas

getTableAndSchemas Returns a MATLAB table to store a returned Kusto table
 
  The table is not populated.
  Column names are mapped to valid MATLAB column names using matlab.lang.makeValidName
  Datatype schemas are also returned.
  MATLAB types mapped from the Kusto types using mathworks.internal.adx.mapTypesKustoToMATLAB
 
  Required Arguments
   columns: 1d array of adx.data.models.Column
 
   numRows: Number of rows in the table
 
  Optional Arguments
   name: Name for the table, the default is: "". matlab.lang.makeValidName is applied.
 
   nullPolicy: A mathworks.adx.NullPolicy to determine how nulls are handled
               Default is mathworks.adx.NullPolicy.ErrorLogicalInt32Int64
 
   verbose: Logical to enable additional output, default is false.
 
  Return Values:
   mTable: Unpopulated MATLAB table.
 
   matlabSchema: String array of the underlying MATLAB types for columns which
                 may be stored in a cell to enable representation of nulls
 
   tableSchema: String array of the actual MATLAB column types used to create the table
 
   kustoSchema: String array of the Kusto type fields for the columns also
                stored in the table descriptions fields

mathworks.internal.adx.getTableSchema

getTableSchema
 
  See also: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/management/show-table-schema-command

mathworks.internal.adx.int2IntOrLong

int2IntOrLong Converts a MATLAB int to a Kusto int or long
  A scalar or empty input value must be provided.
  A scalar string is returned.
  If empty an int(null) or long(null) is returned.
 
  See also:
    https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/int
    https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/long

mathworks.internal.adx.isMappableMATLABToKusto

isMappableMATLABToKusto Returns true if a MATLAB type can be converted to a given Kusto type
 
  The following mappings are supported:
 
   Kusto Type   MATLAB Types
   ----------------------------------------------------
   int          int8, uint8, int16, uint16, int32
   long         int8, uint8, int16, uint16, int32, uint32, int64
   string       string char
   guid         string char
   real         double single
   decimal      double single
   datetime     datetime
   bool         logical
   timespan     duration
   dynamic      See optional allowDynamic flag
 
  As dynamic datatype are "dynamic" the contents must be parsed to determine
  if the can be converted the optional named argument allowDynamic if true
  makes the assumption that a dynamic type will be convertible.
  The default value is true. False is a more conservative value.

mathworks.internal.adx.kustoSchemaToNamesAndTypes

kustoSchemaToNamesAndTypes Splits a Kusto schema into string arrays of column names and types

mathworks.internal.adx.loadConfig

LOADCONFIG Reads a config file if it exists
 
  Optional argument
    configFile: Path to JSON settings

mathworks.internal.adx.logical2Bool

logical2Bool Converts a MATLAB logical to a Kusto bool
  A string is returned.
  If empty bool(null) is returned, otherwise bool(true)
  or bool false.
  A scalar or empty input value must be provided.

mathworks.internal.adx.mapTypesKustoToMATLAB

MAPTYPESKUSTOTOMATLAB Map Kusto datatypes to corresponding MATLAB type
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/
  for .net mapping

mathworks.internal.adx.mapTypesMATLABToKusto

mapTypesMATLABToKusto Map MATLAB datatypes to corresponding Kusto type
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/
  for .net mapping

mathworks.internal.adx.queryV1Response2Tables

queryV1Response2Tables Convert a v1 API response to MATLAB tables
 
  Required argument
   response: A adx.data.models.QueryV1ResponseRaw as returned by queryRun().
 
  Optional arguments
   nullPolicy: Enumeration to determine how null values should be handled.
               Default is mathworks.adx.NullPolicy.ErrorLogicalInt32Int64
 
   convertDynamics: Logical to determine if dynamic fields should be decoded
                    from JSON. Default is true.
 
   allowNullStrings: Logical to allow null strings in input. Kusto does not
                     store null strings but control command may return them.
                     Default is false.
 
   useParallel: Logical to enable the use of Parallel Computing Toolbox if available
 
   parallelThreshold: Threshold for row number above which Parallel Computing
                      Toolbox will be used, default is 1000.
 
   customRowDecoder: Function handle to a non default row conversion function
                     Function is applied to the Primary Result table only.
                     In certain unexpected states it is not applied.
 
   verbose: Logical to enable additional output, default is false.
 
  Return values
   primaryResult: The primary result as a MATLAB table.
 
   resultTables: The other returned tables as MATLAB tables.

mathworks.internal.adx.queryV2Response2Tables

queryV2Response2Tables Converts a v2 API response to MATLAB tables
 
  Required Argument:
   v2Response: A adx.data.models.QueryV2ResponseRaw which been processed by JSONMapper
 
  Optional Arguments:
   convertDynamics: Logical to determine if Dynamic fields are decoded or not
                    Default is true
 
   nullPolicy: A mathworks.adx.NullPolicy to determine how nulls are handled
               Default is mathworks.adx.NullPolicy.ErrorLogicalInt32Int64
 
   allowNullStrings: Logical to allow null strings in input. Kusto does not
                     store null strings but control command may return them.
                     Default is false.
   customRowDecoder: Function handle to a non default row conversion function
                     Function is applied to the Primary Result table only.
                     In certain unexpected states it is not applied.
 
   useParallel: Logical to enable the use of Parallel Computing Toolbox if available
 
   parallelThreshold: Threshold for row number above which Parallel Computing
                      Toolbox will be used, default is 1000.
 
   verbose: Logical to enable additional output, default is false
 
  Return Values:
   primaryResult: The primary result as a MATLAB table
 
   resultTables: The other returned tables as MATLAB tables.
 
   dataSetHeader: A adx.data.models.DataSetHeader describes the high-level properties
                  of the returned data
 
   dataSetCompletion: A adx.data.models.DataSetCompletion indicates success and other
                      properties of the query
 
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/response2

mathworks.internal.adx.setCustomQueryHeaders

setCustomHeaders Sets custom header fields Query calls
 
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/request#request-headers

mathworks.internal.adx.setDefaultConfigValue

setDefaultConfigValue Sets a field in the config file

mathworks.internal.adx.timespanLiteral2duration

timespanLiteral2duration Converts a Kusto timespan value to a MATLAB duration
 
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/timespan

mathworks.internal.adx.timespanValue2duration

timespanValue2duration Converts a timespan value to a MATALB duration
 
  See: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/timespan

mathworks.internal.adx.toDynamic

toDynamic Creates a Kusto dynamic literal value
 
  See also: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types/dynamic

mathworks.internal.adx.toKustoLiteral

toKustoLiteral Converts a MATLAB value to a Kusto Literal
  Supports duration, logical, int, double, single, string, char, and 
  datetime MATLAB input types.
 
  See also: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/scalar-data-types

mathworks.internal.adx.validateConfig

VALIDATECONFIG Sanity checks configuration settings

mathworks.internal.blob

mathworks.internal.blob.clientCopyToBlobContainer

clientCopyToBlobContainer Copies a file to a blob for ingestion
  Uses MATLAB's built in copy file function.

mathworks.internal.blob.clientUploadToBlobContainer

clientUploadToBlobContainer Uploads a file to a blob for ingestion
  Uses Azure Services support package

mathworks.internal.blob.sanitizeBlobName

sanitizeBlobName Checks that a name complies with Blob name limits

mathworks.internal.curl

mathworks.internal.curl.adxCurlWrite

adxCurlWrite adx caller for mathworks.internal.curlWrite
  Inserts custom headers required by ADX.
 
  This function may be changed or removed in a future release without
  notice. currently only windows is supported.
  It is a Proof of Concept testing mechanism to enable TCP keep-alive
  Packets only, it should be avoided in production use.
 
  Arguments:
    clusterUrl: A cluster URL including https:// as scalar text if not provided
                an attempt will be made to read the value from adx.Client.Settings.json
 
    urlPath: Query URL path as scalar text, default: "/v1/rest/query"
 
    query: KQL query to execute as scalar text, default (for PoC purposes):
           "print mycol=""Hello World"""
           Alternatively a a file containing the complete Query body can be
           provided byt prefixing the file name with a "@" symbol as
           normal in curl command syntax.
           When the JSON body for the query is constructed only the csl
           and db fields are populated, if further properties are
           required then the JSON body should be provided in its
           entirety as described above
 
    bearerToken: A bearerToken as scalar text if not provided an attempt will
                 be made to read the value from adx.Client.Settings.json
 
    id: Request id header value as scalar text, if not provided a UUID is created
 
 
    skipJSONDecode: A logical to determine if JSON is decode using MATLAB's
                    jsondecode or not, default is true
 
    propertyNames: Property names to be applies to the query, specified as a
                   string array
 
    propertyValues: Property values that correspond the propertyNames, specified
                    as a cell array
 
    verbose: A logical to enable additional feedback, default is true
             WARNING: verbose output will display the bearer token
 
 
  Returned values:
    tf: Logical that indicates if a HTTP status 200 was returned
 
    result: Result of the query as a string or a decoded JSON struct
            In certain error cases an empty struct is returned
 
    id: Request Id
 
 
  Examples:
 
    If called with no arguments with a adx.Client.Settings.json file
    present containing a valid bearer token the query: print mycol='Hello World'
    should run, returning a logical true, populated result struct and
    request UUID:
 
    [tf, result, id] = mathworks.internal.curl.adxCurlWrite()
 
 
    Provide key arguments:
 
    clusterUrl = "https://mycluster.westeurope.kusto.windows.net";
    query = 'print mycol="Hello World"';
    bearerToken = "eyJ0e<REDACTED>c1RuQ";
    [tf, result, id] = mathworks.internal.adxCurlWrite(clusterUrl=clusterUrl, bearerToken=bearerToken, query=query, verbose=true)
 
 
    Convert the primary result to a MATLAB table
    Assumes the url path is specifying a v1 API, as per default:
 
    [tf, result, id] = mathworks.internal.curl.adxCurlWrite(skipJSONDecode=true);
    [primaryResult, resultTables] = mathworks.internal.adx.queryV1Response2Tables(result);
 
 
    Set sample request properties & convert to a MATLAB table:
 
    propertyNames = {"notruncation", "query_datetimescope_column", "servertimeout"};
    tenMinDuration = minutes(10);
    propertyValues = {true, "mycol", tenMinDuration};
    [tf,result,id] = mathworks.internal.curl.adxCurlWrite(verbose=true, propertyNames=propertyNames, propertyValues=propertyValues, skipJSONDecode=true)
    [primaryResult, ~] = mathworks.internal.adx.queryV1Response2Tables(result)

mathworks.internal.curl.curlWrite

curlWrite webwrite like functionality via curl PoC implementation
  This function may be changed or removed in a future release without
  notice. Currently only windows is supported.
  Currently only the HTTP POST method is supported.
  This function is provided as a testing mechanism for TCP keep-alive
  Packets.
 
  Required Arguments
 
    url: A MATLAB.net.URI containing the host to connect to an any
         required path elements e.g.:
         matlab.net.URI("https://myhost.example.com:1234/path1/path2")
 
    dataFilename: A scalar text value for a filename containing the JSON
                  request body payload to send to the endpoint.
 
    webOpts: A weboptions object. Used to configure curl arguments.
             NB: This value is currently required but NOT yet used.
 
  Optional Positional Argument
 
    verbose: A logical in enable or disable increased logging
             Default is true
 
  Optional Named Arguments
 
    keepaliveTime: An integer number of seconds after which to send a
                   keep-alive packet. Default is 60.
 
    additionalArguments: A string array of extra arguments to be appended to
                         the generated curl command. Prefix and postfix padding
                         will be added.
 
    skipJSONDecode: A logical to skip decoding returned JSON and just
                    return a scalar character vector. Default is false.
 
  Return Value:
 
    Response: Decoded JSON or a character vector containing the returned JSON
              See: skipJSONDecode.
 
  Example:
 
    result = mathworks.internal.curl.curlWrite(matlab.net.URI("https://httpbin.org/post"), "", weboptions, true)
 
  See also: mathworks.internal.curl.adxCurlWrite

mathworks.internal.countDown

countDown displays a countDown of wait seconds

mathworks.utils

mathworks.utils.jwt

mathworks.utils.jwt.ClaimsJM

Superclass: adx.control.JSONMapper

ClaimsJM JWT Claims that use JSON Mapper

mathworks.utils.jwt.ClaimsJM.ClaimsJM

To allow proper nesting of object, derived objects must
  call the JSONMapper constructor from their constructor. This 
  also allows objects to be instantiated with Name-Value pairs
  as inputs to set properties to specified values.

mathworks.utils.jwt.JWT

JWT Represent a Java Web Token
  All times as assumed to be UTC
 
  This is not a generic JWT interface and is intended for use with
  Azure Data Explorer only at this point.

mathworks.utils.jwt.JWT.JWT

JWT Create a JWT object from a token string

mathworks.utils.jwt.JWT.expiryTime

mathworks.utils.jwt.JWT/expiryTime is a function.
    exp = expiryTime(obj)

mathworks.utils.jwt.JWT.isExpired

mathworks.utils.jwt.JWT/isExpired is a function.
    tf = isExpired(obj)

mathworks.utils.jwt.JWT.isTimeValid

mathworks.utils.jwt.JWT/isTimeValid is a function.
    tf = isTimeValid(obj)

mathworks.utils.jwt.JWT.notBeforeTime

mathworks.utils.jwt.JWT/notBeforeTime is a function.
    nbf = notBeforeTime(obj)

mathworks.utils.msOAuth2Client

Superclass: handle

msOAuth2Client obtains and caches tokens for the Microsoft
  Identity Platform.
 
  OAuth2Client Methods:
    OAuth2Client    - Constructor
    getToken        - Obtain an access token for a requested scope
    getFullToken    - Obtain the full token for a requested scope
 
  Note: the access tokens and refresh tokens are stored inside a
  MAT-file in plain-text and are not encrypted. The MAT-file is saved
  as .mlMsTokenCache in your home directory. This file should be kept
  confidential.

mathworks.utils.msOAuth2Client.acquireClientCredentialToken

mathworks.utils.msOAuth2Client/acquireClientCredentialToken is a function.
    token = acquireClientCredentialToken(obj, scopes)

mathworks.utils.msOAuth2Client.acquireDeviceCodeToken

Initiate Device Code Authentication

mathworks.utils.msOAuth2Client.acquireInteractiveBrowserToken

mathworks.utils.msOAuth2Client/acquireInteractiveBrowserToken is a function.
    token = acquireInteractiveBrowserToken(obj, scopes, serviceMetadataURI)

mathworks.utils.msOAuth2Client.acquireManagedIdentityToken

mathworks.utils.msOAuth2Client/acquireManagedIdentityToken is a function.
    token = acquireManagedIdentityToken(obj, scopes)

mathworks.utils.msOAuth2Client.acquireToken

mathworks.utils.msOAuth2Client/acquireToken is a function.
    token = acquireToken(obj, scopes)

mathworks.utils.msOAuth2Client.addTokenToCache

Check whether any tokens have been cached for the given
  tenant at all

mathworks.utils.msOAuth2Client.findTokenInCache

Return an empty token if returning early

mathworks.utils.msOAuth2Client.getFullToken

GETFULLTOKEN Obtains a token in the same way as getToken,
  only instead of only returning the access token itself, a
  struct is returned which contains the accessToken, an
  expiresAt field, and if available also a refreshToken. Then
  syntax for this method is the same as for getToken.
 
  See Also: GETTOKEN

mathworks.utils.msOAuth2Client.getToken

GETTOKEN Obtain and return an access token for the configured
  Tenant, ClientID and Scopes.
 
    If a token for configured Tenant, ClientID and Scopes:
        - IS found in the cache and it
            - Has NOT expired, it is returned
            - HAS expired and a refresh token IS available, it
              is refreshed and then returned, if refresh fails
              a new token is requested and returned
            - HAS expired and there is NO refresh token, a new
              token is requested and returned
        - Is NOT found in the cache, a new token is requested 
          and returned upon success 
 
    Note: to obtain a refresh token, explicitly include 
    "offline_access" in the requested scopes.
 
    Examples:
 
        Obtain an access token for Azure Key Vault Scope with
        refresh token:
 
            access_token = GETTOKEN(["https://vault.azure.net/.default","offline_access"])
 
        Obtain an access token for Azure Storage without
        refresh token:
 
            access_token = GETTOKEN(["https://storage.azure.com/.default"])

mathworks.utils.msOAuth2Client.initializeCache

Load cache from disk if it exists or start a new one

mathworks.utils.msOAuth2Client.msOAuth2Client

msOAuth2Client Constructor
 
    Create a client for user principals through Device Code 
    authentication:
 
      client = msOAuth2Client(tenantId,clientId);
 
    When working with Device Code authentication, user
    interaction is needed if a new token has to be requested.
    If the requested token already exists in the cache (and can
    be refreshed if needed) no further user interaction should
    be required.
 
    Create a client for service principals through Client
    Secret authentication:
 
        client = msOAuth2Client(tenantId,clientId,clientSecret);
 
    When working with Client Secret authentication, no user
    interaction is required.

mathworks.utils.msOAuth2Client.refreshToken

Perform the refresh

mathworks.utils.msOAuth2Client.saveCache

Save the cache to disk

mathworks.utils.UUID

UUID Returns a UUID string as created by java.util.UUID.randomUUID

mathworks.utils.addArgs

addArg Builds and named argument cell array
 
  Example:
    args = mathworks.utils.addArgs(options, ["authMethod", "profileName"]);
    x = myFunc(args{:});

Logger

Superclass: handle

Logger - Object definition for Logger
  ---------------------------------------------------------------------
  Abstract: A logger object to encapsulate logging and debugging
            messages for a MATLAB application.
 
  Syntax:
            logObj = Logger.getLogger();
 
  Logger Properties:
 
      LogFileLevel - The level of log messages that will be saved to the
      log file
 
      DisplayLevel - The level of log messages that will be displayed
      in the command window
 
      LogFile - The file name or path to the log file. If empty,
      nothing will be logged to file.
 
      Messages - Structure array containing log messages
 
  Logger Methods:
 
      clearMessages(obj) - Clears the log messages currently stored in
      the Logger object
 
      clearLogFile(obj) - Clears the log messages currently stored in
      the log file
 
      write(obj,Level,MessageText) - Writes a message to the log
 
  Examples:
      logObj = Logger.getLogger();
      write(logObj,'warning','My warning message')

Logger.Logger

Logger - Object definition for Logger
  ---------------------------------------------------------------------
  Abstract: A logger object to encapsulate logging and debugging
            messages for a MATLAB application.
 
  Syntax:
            logObj = Logger.getLogger();
 
  Logger Properties:
 
      LogFileLevel - The level of log messages that will be saved to the
      log file
 
      DisplayLevel - The level of log messages that will be displayed
      in the command window
 
      LogFile - The file name or path to the log file. If empty,
      nothing will be logged to file.
 
      Messages - Structure array containing log messages
 
  Logger Methods:
 
      clearMessages(obj) - Clears the log messages currently stored in
      the Logger object
 
      clearLogFile(obj) - Clears the log messages currently stored in
      the log file
 
      write(obj,Level,MessageText) - Writes a message to the log
 
  Examples:
      logObj = Logger.getLogger();
      write(logObj,'warning','My warning message')

Logger.clearLogFile

clearLogFile - Method to clear messages in the log file
  -------------------------------------------------------------------------
  Abstract: Clears the log messages currently stored in the log
  file
 
  Syntax:
        logObj.clearLogFile(Level)
        clearLogFile(logObj)
 
  Inputs:
        logObj - Logger object
 
  Outputs:
        none

Logger.clearMessages

clearMessages - Method to clear messages in the Logger
  -------------------------------------------------------------------------
  Abstract: Clears the log messages currently stored in the
  Logger object
 
  Syntax:
        logObj.clearMessages(Level)
        clearMessages(logObj)
 
  Inputs:
        logObj - Logger object
 
  Outputs:
        none

Logger.closeLogFile

If a log file was open, close it

Logger.debug

DEBUG List MATLAB debugging functions
 
    dbstop     - Set breakpoint.
    dbclear    - Remove breakpoint.
    dbcont     - Resume execution.
    dbdown     - Change local workspace context.
    dbmex      - Enable MEX-file debugging.
    dbstack    - List who called whom.
    dbstatus   - List all breakpoints.
    dbstep     - Execute one or more lines.
    dbtype     - List file with line numbers.
    dbup       - Change local workspace context.
    dbquit     - Quit debug mode.
 
    When a breakpoint is hit, MATLAB goes into debug mode, the debugger
    window becomes active, and the prompt changes to a K>>.  Any MATLAB
    command is allowed at the prompt.  
 
    To resume program execution, use DBCONT or DBSTEP.  
    To exit from the debugger use DBQUIT.

Logger.delete

If a log file was open, close it

Logger.error

Expect an MException to be returned if so catch it and throw as the
  caller to keep logger entries out of the console output

Logger.getLogger

This method returns the singleton logger object. Only one
  logger is allowed in a MATLAB session, and this method will
  retrieve it.

Logger.log

LOG    Natural logarithm.
    LOG(X) is the natural logarithm of the elements of X.
    Complex results are produced if X is not positive.
 
    See also LOG1P, LOG2, LOG10, EXP, LOGM, REALLOG.

Logger.openLogFile

Was a file name passed in?

Logger.processMessage

Called from write()
  Handle the file logging first as if an error throwing the error
  will halt execution and the file logging (if enabled) will not
  happen
  Should the message be written to the log file?

Logger.verbose

Logger.verbose is a function.
    Logger.verbose(varargin)

Logger.warning

Logger.warning is a function.
    Logger.warning(varargin)

Logger.write

write - Method to write messages to the Logger
  -------------------------------------------------------------------------
  Abstract: Adds a new message to the Logger, with the
  specified message level and text
 
  Syntax:
        logObj.write(Level,MessageText)
        write(logObj,Level,MessageText)
        write(logObj,Level,MessageText,myException)
 
  Inputs:
        logObj - Logger object
        Level - Message level string ('debug','warning',etc)
        MessageText - Message text string
        myException - A previously caught or created exception
 
  Outputs:
        none
 
  Examples:
        logObj = Logger.getLogger;
        write(logObj,'warning','My warning message')

AzureCommonRoot

AZURECOMMONROOT Return Azure Services root location
  Locate the installation of the Azure interface package to allow easier construction
 
  The special argument of a negative number will move up folders, e.g.
  the following call will move up two folders, and then into
  Documentation.
 
   docDir = AzureCommonRoot(-2, 'Documentation')

AzureShell

AZURESHELL Invokes the Azure Web Browser based shell
  Cloud Shell enables access to a browser-based command-line experience with
  Azure. It is an interactive, browser-accessible shell for managing Azure
  resources. The shell can be Bash or PowerShell. The system configured browser
  is used. Authentication will be requested if not already in place within the
  browser.

AzureStorageExplorer

AZURESTORAGEEXPLORER Invokes the Azure Storage Explorer
  Brings up the Azure Storage Explorer. It is possible to specify the local
  installation of the storage explorer in the configuration file.
 
  By default the MATLAB path will be searched for a configuration file called
  storagesettings.json, however an alternative filename can be provided as
  an argument to this function.

Logger

Logger - Object definition for Logger
  ---------------------------------------------------------------------
  Abstract: A logger object to encapsulate logging and debugging
            messages for a MATLAB application.
 
  Syntax:
            logObj = Logger.getLogger();
 
  Logger Properties:
 
      LogFileLevel - The level of log messages that will be saved to the
      log file
 
      DisplayLevel - The level of log messages that will be displayed
      in the command window
 
      LogFile - The file name or path to the log file. If empty,
      nothing will be logged to file.
 
      Messages - Structure array containing log messages
 
  Logger Methods:
 
      clearMessages(obj) - Clears the log messages currently stored in
      the Logger object
 
      clearLogFile(obj) - Clears the log messages currently stored in
      the log file
 
      write(obj,Level,MessageText) - Writes a message to the log
 
  Examples:
      logObj = Logger.getLogger();
      write(logObj,'warning','My warning message')

configureCredentials

CONFIGURECREDENTIALS Reads JSON configuration file and returns credentials object
  A configuration file path must be passed as a string or character vector.
  Authentication method to use is determined using the AuthMethod field of the
  JSON configuration file.
 
  Supported authentication methods are:
    storageSharedKey (Azure Data Lake Storage Gen2 only)
    connectionString (Azure Data Lake Storage Gen2 only)
    environment
    defaultAzure
    clientSecret
    interactiveBrowser
    deviceCode
    sharedTokenCache
    managedIdentity
    azurecli
 
  The resulting credential object can then be used by the corresponding client
  builder.
 
  The function has one optional Name-Value input pair:
 
    'DeviceCodeCallback', @myFunctionHandle
 
  This option is only valid when working with the DeviceCode method and it
  allows specifying a custom function for displaying the Device Code login
  instructions.

configureProxyOptions

CONFIGUREPROXYOPTIONS Configured Java proxy options object
  A com.azure.core.http.ProxyOptions Java object is returned if a proxy is
  configured otherwise an empty double is returned corresponding to a null.

createKeyVaultClient

CREATEKEYVAULTCLIENT Convenience function for creating KeyClient and
  SecretClient
 
    client = createKeyVaultClient('Type','Key') creates a KeyClient with
    default options.
 
    client = createKeyVaultClient('Type','Secret') creates SecretClient with
    default options.
 
  By default createKeyVaultClient reads Credential information and the
  Vault Name from a configuration file named 'keyvaultsettings.json'. The
  function automatically searches for this file on the MATLABPATH. It is
  possible to specify a different filename using 'ConfigurationFile'. It is
  also possible to provide 'Credentials' and 'VaultName' as inputs to the
  function directly in case which no configuration file may be needed. See
  the Name, Value pairs below for more details.
 
  Additional Name, Value pairs can be supplied to configure non-default
  options:
 
    'ConfigurationFile', explicitly specify which configuration file to
        use. This file is used for configuring Credentials (when not
        supplied as input) and/or Account Name (when not supplied as input).
 
        Default Value: 'keyvaultsettings.json'
 
    'Credentials', explicitly specify credentials to use. This for example
        allows building multiple clients based on the same credentials
        without having to go through (interactive) authentication again. If
        not specified, createKeyVaultClient uses configureCredentials with
        'ConfigurationFile' as input to first configure credentials before
        building the client.
 
        Hint: configureCredentials can be used to build valid Credentials.
 
        Example:
            credentials = configureCredentials('myCredentials.json');
            client1 = createKeyVaultClient('Credentials',credentials,'Type','Key')
            client2 = createKeyVaultClient('Credentials',credentials,'Type','Secret')
 
    'VaultName', explicitly specify the Vault name for the client. If not
        specified createKeyVaultClient uses loadConfigurationSettings to
        load configuration options from 'ConfigurationFile'. This file must
        then contain a "VaultName" setting.
 
    See also CONFIGURECREDENTIALS, LOADCONFIGURATIONSETTINGS

createStorageClient

CREATESTORAGECLIENT Convenience function for creating BlobServiceClient,
  BlobContainerClient, BlobClient, QueueServiceClient, QueueClient,
  DataLakeFileSystemClient, DataLakeDirectoryClient and DataLakeFileClient.
 
    client = createStorageClient() creates a BlobServiceClient with default
    options.
 
    client = createStorageClient('ContainerName','myContainer')
    creates BlobContainerClient with default options.
 
    client = createStorageClient('ContainerName','myContainer',...
                'BlobName','myBlob') creates a BlobClient with default options.
 
    client = createStorageClient('Type','QueueService') creates a
    QueueServiceClient with default options.
 
    client = createStorageClient('QueueName','myQueue') creates a
    QueueClient with default options.
 
    client = createStorageClient('FileSystemName','myFileSystem') creates a
    DataLakeFileSystemClient with default options.
 
    client = createStorageClient('FileSystemName','myFileSystem',...
                'DirectoryName','my/dir') creates a DataLakeDirectoryClient
    with default options.
 
    client = createStorageClient('FileSystemName','myFileSystem',...
                'FileName','my/dir/file') creates a DataLakeFileClient with 
    default options.
 
  By default createStorageClient reads Credential information and the
  Account Name (used to build the Client endpoint) from a configuration
  file named 'storagesettings.json'. The function automatically searches for
  this file on the MATLABPATH. It is possible to specify a different
  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. 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:
 
    'Type', explicitly specify the type of client to create. Required for
        creating QueueServiceClient. In all other cases the type of client
        is derived from whether 'ContainerName', 'BlobName', 'QueueName', 
        'FileSystemName', 'DirectoryName', and/or 'FileName' are provided. 
        With none of these configured a BlobServiceClient is created. If 
        only BlobContainer is specified a BlobContainerClient is created,
        if both BlobContainer and BlobName are specified a BlobClient is
        created. If QueueName is specified a QueueClient is created. If 
        only FileSystemName is specified a DataLakeFileSystemClient is
        created, if DirectoryName is specified as well, a 
        DataLakeDirectoryClient is created, or if FileName is specified a 
        DataLakeFileClient is created.
            
        Possible Values: 'BlobService', 'BlobContainer', 'Blob',
            'QueueService', 'QueueClient', 'DataLakeDirectory',
            'DataLakeFile', or 'DataLakeFileSystem'.
 
    'ConfigurationFile', explicitly specify which configuration file to
        use. This file is used for configuring Credentials (when not 
        supplied as input) and/or Account Name (when not supplied as input).
 
        Default Value: 'storagesettings.json'
 
    'Credentials', explicitly specify credentials to use. This for example
        allows building multiple clients based on the same credentials
        without having to go through (interactive) authentication again. If
        neither this option nor 'SASToken' is specified, 
        createStorageClient uses configureCredentials with 
        'ConfigurationFile' as input to first configure credentials before
        building the client. 
  
        Hint: configureCredentials can be used to build valid Credentials.
 
        Example:
            credentials = configureCredentials('myCredentials.json');
            client1 = createStorageClient('Credentials',credentials,'ContainerName','container1')
            client2 = createStorageClient('Credentials',credentials,'ContainerName','container2')
 
    'SASToken', explicitly specify a SAS Token to use for authentication
        rather than reading authentication details from a configuration
        file or a credentials object passed in through the 'Credentials`
        option. If neither this option nor 'Credentials' are specified,
        createStorageClient uses configureCredentials with
        'ConfigurationFile' as input to first configure credentials before
        building the client. 
    
    'AccountName', explicitly specify the AccountName used to configure the
        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

initialize

INITIALIZE Configure logger and version test at Client builder entry points
  This function need only be invoked once per session when using the package.
  It configures logging and proxy settings.
  Note the logger is a singleton so prefixes may not correspond if multiple
  packages are using it simultaneously. In this scenario a generic subprefix
  may be helpful.
 
  Example
     % Taken from createClient in the Key Vault interface
     initialize('displayLevel', 'debug', 'loggerPrefix', 'Azure:KeyVault');
 
  See: MATLAB/app/functions/Logger.m for more details.

    Other uses of initialize

       matlab.net.http.io.ContentConsumer/initialize
       matlab.net.http.io.ImageConsumer/initialize
       matlab.net.http.io.JSONConsumer/initialize
       matlab.net.http.io.MultipartConsumer/initialize
       matlab.net.http.io.StringConsumer/initialize
       myDeployedModule/initialize
       SimTimeseries/initialize
       simulink.Simulation/initialize

loadConfigurationSettings

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.

Microsoft Azure Data Explorer, Azure Data Lake Storage & Azure Key Vault are trademarks of the Microsoft group of companies.