BatchServiceClientConfiguration Class

Configuration for BatchServiceClient Note that all parameters used to create this instance are saved as instance attributes.

Inheritance

msrestazure.azure_configuration.AzureConfiguration

BatchServiceClientConfiguration

Constructor

BatchServiceClientConfiguration(credentials, batch_url)

Parameters

Name	Description
credentials Required	<xref:msrestazure.azure_active_directory> Credentials needed for the client to connect to Azure.
batch_url Required	str The base URL for all Azure Batch service requests.

Methods

add_user_agent	Add value to current user agent with a space.
load	Load configuration from existing file.
save	Save current configuration to file.

add_user_agent

Add value to current user agent with a space.

add_user_agent(value: str) -> None

Parameters

Name	Description
value Required	str value to add to user agent.

load

Load configuration from existing file.

load(filepath)

Parameters

Name	Description
filepath Required	str Path to existing config file.

Exceptions

Type	Description
ValueError if supplied config file is invalid.

save

Save current configuration to file.

save(filepath)

Parameters

Name	Description
filepath Required	str Path to save file to.

Exceptions

Type	Description
ValueError if supplied filepath cannot be written to.

Attributes

enable_http_logger

user_agent

The current user agent value.