Skip to content

Files

Latest commit

3d8e362 · Aug 6, 2018

History

History
57 lines (40 loc) · 3.05 KB

cli_parameters.md

File metadata and controls

57 lines (40 loc) · 3.05 KB

CLI Parameters

Required parameters for all cli commands

parameter type description
subscription-id str Sign up to get an Azure subscription id
resource-group str Azure resource group name. An Azure resource group is a logical grouping of Azure resources.
location str Azure region to create resources. eastus is recommended as this region supports Azure NC-Series (or GPU-enabled) machines.
aad-app-id str AAD Application Id.
aad-key str AAD Secret Key.
aad-directory-id str AAD Directory Id.

NOTE: The application MUST be assigned a Contributor role.

Azure Active Directory (AAD)

To use pybatchai, you must obtain Azure Active Directory (AAD) Credentials (aad_app_id, aad_key, aad_directory_id) in the Azure Portal.

AAD manages application permissions. As pybatchai will create and manages resources, this application will need to be assigned a Contributor role, otherwise you will not be able to use this cli.

To obtain AAD credentials refer either this brief guide or detailed guide.

storage

parameter type description
name str Storage account names must be between 3 and 24 characters in length and may contain numbers and lowercase letters only.

fileshare

parameter type description
name str See fileshare names for more details on its stricter naming policy.

blob storage

parameter type description
container str See container names for more details on its stricter naming policy.

upload or download to fileshare or blob

parameter type description
local-path str Path on local machine to upload files from or download files to.

cluster

parameter type description
name str Batch AI cluster name.
workspace str Workspace name.