API Reference
API Reference
Documentation generation settings:
Including class level help text
Omitting constructor help text
Excluding inherited methods
Excluding default MATLAB classes
Package azure
Classes
Subpackage azure.identity
Classes
Subpackage azure.storage.common
Classes
Subpackage azure.storage.common.sas
Classes
Subpackage azure.storage.common.policy
Classes
Subpackage azure.storage.queue
Classes
Subpackage azure.storage.queue.models
Classes
Subpackage azure.storage.queue.sas
Classes
Subpackage azure.storage.file.datalake
Classes
Subpackage azure.storage.file.datalake.models
Classes
Subpackage azure.storage.file.datalake.sas
Classes
Subpackage azure.storage.blob
Classes
Subpackage azure.storage.blob.models
Classes
Subpackage azure.storage.blob.sas
Classes
Subpackage azure.storage.blob.specialized
Classes
Subpackage azure.core.credential
Classes
Subpackage azure.core.util.polling
Classes
Subpackage azure.security.keyvault.secrets
Classes
Subpackage azure.security.keyvault.secrets.models
Classes
Subpackage azure.security.keyvault.keys
Classes
Subpackage azure.security.keyvault.keys.models
Classes
Standalone Classes
Standalone Functions
API Help
azure.object
OBJECT Root Class for all Azure wrapper objects
azure.identity.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.CredentialBuilderBase
azure.identity.CredentialBuilderBase is a class.
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.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.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.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.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.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.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.ClientCertificateCredential
CLIENTCERTIFICATECREDENTIAL AAD credential acquires a token with a client certificate
azure.identity.InteractiveBrowserCredential
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.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.EnvironmentCredential
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.DefaultAzureCredential
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.AzureCliCredentialBuilder
AZURECLICREDENTIALBUILDER Credential builder for instantiating a AzureCliCredential
azure.identity.AzureCliCredentialBuilder.build
BUILD Creates new AzureCliCredential with the configured options set
azure.identity.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.ClientSecretCredential
CLIENTSECRETCREDENTIAL AAD credential acquires a token with a client secret
azure.identity.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.ChainedTokenCredential
CHAINEDTOKENCREDENTIAL Provides a credential from a list of providers
azure.identity.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.AzureCliCredential
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.AuthenticationRecord
Represents the account information relating to an authentication request
Held as a Java reactor.core.publisher.MonoMap.
azure.identity.AuthenticationRecord.subscribe
SUBSCRIBE Subscribe to this Mono and request unbounded demand
Used to trigger the device code challenge flow.
Returns a Java reactor.core.publisher.LambdaMonoSubscriber object.
The return value is not normally required.
azure.identity.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.storage.common.sas.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.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.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.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
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.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.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.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
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.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.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.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.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.policy.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:
EXPONENTIAL
FIXED
azure.storage.common.policy.RetryPolicyType.valueOf
VALUEOF Returns the enum constant of this type with the specified name
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.queue.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.storage.queue.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.QueueClient
QUEUECLIENT Client performs generic queue operations
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.clearMessages
CLEARMESSAGES Deletes all messages in the queue
azure.storage.queue.QueueClient.create
CREATE Creates a new queue
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.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
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.models.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.models.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.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
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.QueueItem
QUEUEITEM Azure Storage Queue
azure.storage.queue.models.QueueItem.getName
GETNAME Returns the queue's name as a character vector
azure.storage.queue.sas.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.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.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.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
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.file.datalake.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.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.DataLakeFileSystemClient
DATALAKEFILEFILESYSTEMCLIENT Client that contains file system operations
This client is instantiated through DataLakeFileSystemClientBuilder
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.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.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.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.file.datalake.DataLakeDirectoryClient
DATALAKEDIRECTORYCLIENT Client that contains directory operations for Azure Storage Data Lake
This client is instantiated through DataLakePathClientBuilder
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.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.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.models.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
Copyright 2022 The MathWorks, Inc.
azure.storage.file.datalake.sas.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.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.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.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.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.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.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.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.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.blob.BlobClient
BLOBCLIENT Client performs generic blob operations
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.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.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.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.BlobContainerClient
BLOBCONTAINERCLIENT Client to a container
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.create
CREATE Creates a new container within a storage account
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
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.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.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
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.blob.models.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.UserDelegationKey
USERDELEGATIONKEY A user delegation key.
azure.storage.blob.models.UserDelegationKey.getSignedStart
GETSIGNEDSTART Get the signedStart property: The date-time the
key is active.
azure.storage.blob.models.UserDelegationKey.getSignedExpiry
GETSIGNEDEXPIRY Get the signedExpiry property: The date-time
the key expires.
azure.storage.blob.models.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.BlobItemProperties
BlobItemProperties Properties of a blob
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.getContentLength
GETCONTENTLENGTH Get the contentType property
azure.storage.blob.models.BlobItemProperties.getContentType
GETCONTENTTYPE Get the getContentType property
azure.storage.blob.models.BlobItemProperties.getContentLanguage
GETCONTENTLANGUAGE Get the getContentLanguage property
azure.storage.blob.models.BlobItemProperties.getContentEncoding
GETCONTENTENCODING Get the getContentEncoding property
azure.storage.blob.models.BlobItemProperties.getCacheControl
GETCACHECONTROL Get the cacheControl property
azure.storage.blob.models.BlobListDetails
BLOBLISTDETAILS Allows users to specify additional information the service should return with each blob when listing blobs
azure.storage.blob.models.BlobListDetails.getRetrieveVersions
GETRETRIEVEVERSIONS Whether versions should be returned
azure.storage.blob.models.BlobListDetails.getRetrieveUncommittedBlobs
GETRETRIEVEUNCOMMITTEDBLOBS Whether blob tags should be returned
azure.storage.blob.models.BlobListDetails.getRetrieveTags
GETRETRIEVETAGS Whether blob tags should be returned
azure.storage.blob.models.BlobListDetails.getRetrieveSnapshots
GETRETRIEVESNAPSHOTS Whether snapshots should be returned
azure.storage.blob.models.BlobListDetails.getRetrieveMetadata
GETRETRIEVEMETADATA Whether blob metadata should be returned
azure.storage.blob.models.BlobListDetails.getRetrieveLegalHold
GETRETRIEVELEGALHOLD Whether legal hold for the blob should be returned
azure.storage.blob.models.BlobListDetails.getRetrieveImmutabilityPolicy
GETRETRIEVEIMMUTABILITYPOLICY Whether immutability policy for the blob should be returned
azure.storage.blob.models.BlobListDetails.getRetrieveDeletedBlobsWithVersions
GETRETRIEVEDELETEDBLOBSWITHVERSIONS Whether blobs which have been deleted with versioning
azure.storage.blob.models.BlobListDetails.getRetrieveDeletedBlobs
GETRETRIEVEDELETEDBLOBS Whether blobs which have been soft deleted should be returned
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.setRetrieveVersions
SETRETRIEVEUNCOMMITTEDBLOBS Whether versions should be returned
azure.storage.blob.models.BlobListDetails.setRetrieveUncommittedBlobs
SETRETRIEVEUNCOMMITTEDBLOBS Whether blob metadata should be returned
azure.storage.blob.models.BlobListDetails.setRetrieveTags
setRetrieveTags Whether blob tags should be returned
azure.storage.blob.models.BlobListDetails.setRetrieveSnapshots
setRetrieveSnapshots Whether snapshots should be returned
azure.storage.blob.models.BlobListDetails.setRetrieveMetadata
SETRETRIEVEMETADATA Whether blob metadata should be returned
azure.storage.blob.models.BlobListDetails.setRetrieveLegalHold
SETRETRIEVELEGALHOLD Whether legal hold for the blob 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.setRetrieveDeletedBlobsWithVersions
SETRETRIEVEDELETEDBLOBSWITHVERSIONS Whether blobs which have been deleted with versioning should be returned
azure.storage.blob.models.BlobListDetails.setRetrieveDeletedBlobs
SETRETRIEVEDELETEDBLOBS Whether blobs which have been soft deleted 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.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.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.sas.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.sas.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.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.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.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
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.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.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.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.specialized.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.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.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.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.getResourceUrl
GETRESOURCEURL Gets the URL of the lease client.
azure.storage.blob.specialized.BlobLeaseClient.getLeaseId
GETLEASEID Get the lease ID for this lease.
azure.storage.blob.specialized.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.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.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.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.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.core.credential.TokenCredential
TOKENCREDENTIAL Credential that can provide an access token
azure.core.credential.TokenCredential.getToken
GETTOKEN Retrieves an AccessToken
An azure.core.credential.AccessToken is returned.
azure.core.credential.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.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.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.polling.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.core.util.polling.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.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.security.keyvault.secrets.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.security.keyvault.secrets.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.models.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.getScheduledPurgeDate
GETSCHEDULEDPURGEDATE Get the scheduled purge 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.getDeletedOn
GETDELETEDON Get the deleted UTC time.
A datetime object is returned.
azure.security.keyvault.secrets.models.KeyVaultSecret
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.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
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.keys.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
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.keys.models.JsonWebKey
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.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.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.getScheduledPurgeDate
GETSCHEDULEDPURGEDATE Get the scheduled purge 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.getDeletedOn
GETDELETEDON Get the deleted UTC time.
A datetime object is returned.
azure.security.keyvault.keys.models.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.KeyVaultKey
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.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.models.KeyType
KEYTYPE Defines enumeration values for KeyType
Values are EC, EC_HSM, OCT, OCT_HSM, RSA & RSA_HSM
Enumeration:
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.
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.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.verbose
Logger.verbose is a function.
Logger.verbose(varargin)
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.warning
Logger.warning is a function.
Logger.warning(varargin)
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.getLogger
This method returns the singleton logger object. Only one
logger is allowed in a MATLAB session, and this method will
retrieve it.
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')
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.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?
AzureCommonRoot
AZURECOMMONROOT Helper function to locate the Azure Common location
Locate the installation of the Azure interface package to allow easier construction
of absolute paths to the required dependencies.
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')
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.
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
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.
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
dlnetwork/initialize
idnlfun/initialize
lidar.labeler.AutomationAlgorithm/initialize
matlab.internal.cef.webwindow/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
particleFilter/initialize
PointTracker/initialize
SimTimeseries/initialize
slTunable/initialize
socIPCore/initialize
stateEstimatorPF/initialize
trackingEKF/initialize
vision.labeler.AutomationAlgorithm/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.