azure.batch.models.AzureFileShareConfiguration.yml

### YamlMime:PythonClass
uid: azure.batch.models.AzureFileShareConfiguration
name: AzureFileShareConfiguration
fullName: azure.batch.models.AzureFileShareConfiguration
module: azure.batch.models
summary: 'Information used to connect to an Azure Fileshare.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'AzureFileShareConfiguration(*args: Any, **kwargs: Any)'
variables:
- description: The Azure Storage account name. Required.
  name: account_name
  types:
  - <xref:str>
- description: 'The Azure Files URL. This is of the form

    ''[https:/](https:/)/{account}.file.core.windows.net/''. Required.'
  name: azure_file_url
  types:
  - <xref:str>
- description: The Azure Storage account key. Required.
  name: account_key
  types:
  - <xref:str>
- description: 'The relative path on the compute node where the file system will be

    mounted. All file systems are mounted relative to the Batch mounts directory,
    accessible via

    the AZ_BATCH_NODE_MOUNTS_DIR environment variable. Required.'
  name: relative_mount_path
  types:
  - <xref:str>
- description: 'Additional command line options to pass to the mount command. These
    are

    ''net use'' options in Windows and ''mount'' options in Linux.'
  name: mount_options
  types:
  - <xref:str>
methods:
- uid: azure.batch.models.AzureFileShareConfiguration.as_dict
  name: as_dict
  summary: Return a dict that can be JSONify using json.dump.
  signature: 'as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]'
  keywordOnlyParameters:
  - name: exclude_readonly
    description: Whether to remove the readonly properties.
    types:
    - <xref:bool>
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.batch.models.AzureFileShareConfiguration.clear
  name: clear
  signature: clear() -> None
- uid: azure.batch.models.AzureFileShareConfiguration.copy
  name: copy
  signature: copy() -> Model
- uid: azure.batch.models.AzureFileShareConfiguration.get
  name: get
  signature: 'get(key: str, default: Any = None) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
    defaultValue: None
- uid: azure.batch.models.AzureFileShareConfiguration.items
  name: items
  signature: items() -> ItemsView[str, Any]
- uid: azure.batch.models.AzureFileShareConfiguration.keys
  name: keys
  signature: keys() -> KeysView[str]
- uid: azure.batch.models.AzureFileShareConfiguration.pop
  name: pop
  signature: 'pop(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.AzureFileShareConfiguration.popitem
  name: popitem
  signature: popitem() -> Tuple[str, Any]
- uid: azure.batch.models.AzureFileShareConfiguration.setdefault
  name: setdefault
  signature: 'setdefault(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.AzureFileShareConfiguration.update
  name: update
  signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.batch.models.AzureFileShareConfiguration.values
  name: values
  signature: values() -> ValuesView[Any]
attributes:
- uid: azure.batch.models.AzureFileShareConfiguration.account_key
  name: account_key
  summary: The Azure Storage account key. Required.
  signature: 'account_key: str'
- uid: azure.batch.models.AzureFileShareConfiguration.account_name
  name: account_name
  summary: The Azure Storage account name. Required.
  signature: 'account_name: str'
- uid: azure.batch.models.AzureFileShareConfiguration.azure_file_url
  name: azure_file_url
  summary: //{account}.file.core.windows.net/'. Required.
  signature: 'azure_file_url: str'
- uid: azure.batch.models.AzureFileShareConfiguration.mount_options
  name: mount_options
  summary: 'Additional command line options to pass to the mount command. These are
    ''net use'' options in

    Windows and ''mount'' options in Linux.'
  signature: 'mount_options: str | None'
- uid: azure.batch.models.AzureFileShareConfiguration.relative_mount_path
  name: relative_mount_path
  summary: 'The relative path on the compute node where the file system will be mounted.
    All file systems

    are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR

    environment variable. Required.'
  signature: 'relative_mount_path: str'