client#

Helper functions for setting up valid Azure clients.

Functions#

`get_batch_management_client`(...)	Get an Azure Batch management client using
`get_compute_management_client`(...)	Get an Azure compute management client using
`get_batch_service_client`(→ azure.batch.BatchServiceClient)	Get an Azure batch service client using
`get_blob_service_client`(...)	Get an Azure blob service client using

Module Contents#

get_batch_management_client(credential_handler: azuretools.auth.CredentialHandler = None, **kwargs) → azure.mgmt.batch.BatchManagementClient#

Get an Azure Batch management client using credentials obtained via a CredentialHandler, either a user-provided one or a default based on environment variables.

Parameters#

credential_handler: Credential handler for connecting and authenticating to Azure resources. If None, create a blank EnvCredentialHandler, which attempts to obtain needed credentials using information available in local environment variables (see its documentation for details).
**kwargs: Additional keyword arguments passed to the BatchManagementClient constructor.

Returns#

BatchManagementClient: A client instaniated according to the specified configuration.

get_compute_management_client(credential_handler: azuretools.auth.CredentialHandler = None, **kwargs) → azure.mgmt.compute.ComputeManagementClient#

Get an Azure compute management client using credentials obtained via a CredentialHandler, either a user-provided one or a default based on environment variables.

Parameters#

credential_handler: Credential handler for connecting and authenticating to Azure resources. If None, create a blank EnvCredentialHandler, which attempts to obtain needed credentials using information available in local environment variables (see its documentation for details).
**kwargs: Additional keyword arguments passed to the ComputeManagementClient constructor.

Returns#

ComputeManagementClient: A client instaniated according to the specified configuration.

get_batch_service_client(credential_handler: azuretools.auth.CredentialHandler = None, **kwargs) → azure.batch.BatchServiceClient#

Get an Azure batch service client using credentials obtained via a CredentialHandler, either a user-provided one or a default based on environment variables.

Parameters#

credential_handler: Credential handler for connecting and authenticating to Azure resources. If None, create a blank EnvCredentialHandler, which attempts to obtain needed credentials using information available in local environment variables (see its documentation for details).
**kwargs: Additional keyword arguments passed to the BatchServiceClient constructor.

Returns#

BatchServiceClient: A client instaniated according to the specified configuration.

get_blob_service_client(credential_handler: azuretools.auth.CredentialHandler = None, **kwargs) → azure.storage.blob.BlobServiceClient#

Get an Azure blob service client using credentials obtained via a CredentialHandler, either a user-provided one or a default based on environment variables.

Parameters#

credential_handler: Credential handler for connecting and authenticating to Azure resources. If None, create a blank EnvCredentialHandler, which attempts to obtain needed credentials using information available in local environment variables (see its documentation for details).
**kwargs: Additional keyword arguments passed to the BlobServiceClient constructor.

Returns#

BlobServiceClient: A client instaniated according to the specified configuration.