azure-batch-apps 0.5.2

应用程序配置

为了与Batch Apps账户中设置的服务交互，您需要配置Python客户端。

第一次实例化Configuration对象时，配置文件将默认创建为

$HOME/BatchAppsData/batch_apps.ini

单个配置对象代表Batch Apps账户中的单个服务。这意味着每个配置都需要一个端点和客户端ID。

要设置新的作业类型引用，您可以将其添加到配置文件中，并附带您希望与之关联的任何自定义参数。

您可以直接编辑该文件，或者通过Configuration类编辑

from batchapps import Configuration

# These can be retrieved when creating an unattended account in the Batch Apps portal.
# See the authentication section below for more details.
endpoint = 'myservice.batchapps.core.windows.net'
account_details = 'ClientID=xxxxxxxx;TenantID=abcdefg'
account_key = '12345'

cfg = Configuration(log_level='debug', default=True)
cfg.aad_config(account=account_details, key=account_key,
        endpoint=endpoint, unattended=True)

cfg.add_jobtype('my_job_type')

# Set this job type as the current job type
cfg.current_jobtype('my_job_type')

# Set the current job type as the default job type for future jobs
cfg.set_default_jobtype()

# Set up some default parameter values for the current job type
cfg.set('quality', 10)
cfg.set('timeout', 500)

# Save updated configuration to file
cfg.save_config()

身份验证

该模块通过Azure Active Directory（OAuth2的一种实现）进行身份验证。Batchapps模块提供了一个辅助类，用于使用Requests-OAuthlib检索AAD令牌。但是，如果您有首选的OAuth实现，也可以使用此模块进行身份验证。

您可以在您的Batch Apps账户中创建一组“无人值守账户”凭据。这些凭据的格式为

Account Id = ClientId=abc;TenantId=xyz
Account Key = ***********************

获取这些凭据后，您可以通过将它们添加到batch_apps.ini配置文件中（使用Python，如上所述，或直接编辑文件）来通过Python客户端进行身份验证

[Authentication]
endpoint = myservice.batchapps.core.windows.net
unattended_account = ClientID=abc;TenantID=xyz
unattended_key = ***********************

然后您可以使用这些凭据进行身份验证

from batchapps import AzureOAuth

creds = AzureOAuth.get_unattended_session()

或者，如果您使用不同的AAD实现来获取令牌

from batchapps import Credentials, Configuration
import my_oauth

client_id = "abc"
cfg = Configuration()

aad_token = my_oauth.get_token(client_id)
creds = Credentials(cfg, client_id, token=aad_token)

将通过Web UI登录进行身份验证的功能将很快支持。

作业管理

作业管理，包括提交、监控和访问输出，是通过JobManager类完成的

from batchapps import AzureOAuth, JobManager
import time

creds = AzureOAuth.get_unattended_session()
mgr = JobManager(creds)

my_job = mgr.create_job("First Job")

# Apply any custom parameters and source files here
my_job.example_parameter = "test123"

# Then submit the job
new_job = my_job.submit()

job_progress = mgr.get_job(url=new_job['link'])

# Let's allow up to 30 minutes for the job to complete
timeout = time.time() + 1800

while time.time() < timeout:

        if job_progress.status is 'Complete':
                job_progress.get_output('c:\\my_download_dir')
                break

        if job_progress.status is 'Error':
                break

        time.sleep(30)
        job_progress.update()

else:
        job_progress.cancel()

文件管理

文件管理，包括同步作业源文件和依赖项到云端，可以使用FileManager类完成

from batchapps import AzureOAuth, FileManager

creds = AzureOAuth.get_unattended_session()
mgr = FileManager(creds)

file_collection = mgr.files_from_dir('c:\\my_job_assets')
job_source = mgr.file_from_path('C:\\start_job.bat')
file_collection.add(job_source)

file_collection.upload()

# Check files previously uploaded matching a certain name
mgr.find_files('start_job.bat')

# Retrieve a list of all uploaded files
mgr.list_files()

池管理

池管理，包括创建、调整大小和删除池，可以使用PoolManager类完成。

一旦创建了池，就可以向其提交作业。默认情况下，当作业提交时没有引用现有池，它将使用为作业运行而创建的自动池，并在完成时删除。

from batchapps import AzureOAuth, PoolManager

creds = AzureOAuth.get_unattended_session()
mgr = PoolManager(creds)

new_pool = mgr.create_pool(target_size=5)

# Create new job submission, then submit to pool
my_job.pool = new_pool
my_job.submit()

# After job has completed, and we no longer need the pool
pool.delete()