Share via

az batchai file-server

  • Deprecated
  • Reference

This command group is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

Commands to manage file servers.

Commands

Name Description Type Status
az batchai file-server create

Create a file server.

 Core Deprecated
az batchai file-server list

List file servers.

 Core Deprecated

az batchai file-server create

Edit
Deprecated

This command is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

Create a file server.

az batchai file-server create --name
                              --resource-group
                              --workspace
                              [--caching-type {none, readonly, readwrite}]
                              [--config-file]
                              [--disk-count]
                              [--disk-size]
                              [--generate-ssh-keys]
                              [--no-wait]
                              [--password]
                              [--ssh-key]
                              [--storage-sku {Premium_LRS, Standard_LRS}]
                              [--subnet]
                              [--user-name]
                              [--vm-size]

Examples

Create a NFS file server using a configuration file.

az batchai file-server create -g MyResourceGroup -w MyWorkspace -n MyNFS -f nfs.json

Create a NFS manually providing parameters.

az batchai file-server create -g MyResourceGroup -w MyWorkspace -n MyNFS \
    -s Standard_D14 --disk-count 4 --disk-size 512 \
    --storage-sku Premium_LRS --caching-type readonly \
    -u $USER -k ~/.ssh/id_rsa.pub

Required Parameters

--name -n

Name of file server.

--resource-group -g

Name of resource group. You can configure a default value by setting up default workspace using az batchai workspace set-default.

--workspace -w

Name or ARM ID of the workspace. You can configure default workspace using az batchai workspace set-default.

Optional Parameters

--caching-type

Caching type for premium disks. If not provided via command line or in configuration file, no caching will be used.

Accepted values: none, readonly, readwrite
--config-file -f

A path to a json file containing file server create parameters (json representation of azure.mgmt.batchai.models.FileServerCreateParameters). Note, parameters given via command line will overwrite parameters specified in the configuration file.

--disk-count

Number of disks.

--disk-size

Disk size in Gb.

--generate-ssh-keys

Generate SSH public and private key files in ~/.ssh directory (if missing).

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--password -p

Optional password for the admin user created on the NFS node.

--ssh-key -k

Optional SSH public key value or path. If ommited and no password specified, default SSH key (~/.ssh/id_rsa.pub) will be used.

--storage-sku

The sku of storage account to persist VM.

Accepted values: Premium_LRS, Standard_LRS
--subnet

ARM ID of a virtual network subnet to put the file server in. If not provided via command line or in the configuration file, Batch AI will create a new virtual network and subnet under your subscription.

--user-name -u

Name of admin user account to be created on NFS node. If the value is not provided and no user configuration is provided in the config file, current user's name will be used.

--vm-size -s

VM size.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az batchai file-server list

Edit
Deprecated

This command is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

List file servers.

az batchai file-server list --resource-group
                            --workspace

Examples

List all file servers in the given workspace.

az batchai file-server list -g MyResourceGroup -w MyWorkspace -o table

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace -w

Name of workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.