azure.mgmt.batch.models.ResourceFile.yml

### YamlMime:PythonClass
uid: azure.mgmt.batch.models.ResourceFile
name: ResourceFile
fullName: azure.mgmt.batch.models.ResourceFile
module: azure.mgmt.batch.models
inheritances:
- azure.mgmt.batch._serialization.Model
summary: A single file or multiple files to be downloaded to a compute node.
constructor:
  syntax: 'ResourceFile(*, auto_storage_container_name: str | None = None, storage_container_url:
    str | None = None, http_url: str | None = None, blob_prefix: str | None = None,
    file_path: str | None = None, file_mode: str | None = None, identity_reference:
    _models.ComputeNodeIdentityReference | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: auto_storage_container_name
    description: 'The autoStorageContainerName, storageContainerUrl and

      httpUrl properties are mutually exclusive and one of them must be specified.'
    types:
    - <xref:str>
  - name: storage_container_url
    description: 'The autoStorageContainerName, storageContainerUrl and httpUrl

      properties are mutually exclusive and one of them must be specified. This URL
      must be readable

      and listable from compute nodes. There are three ways to get such a URL for
      a container in

      Azure storage: include a Shared Access Signature (SAS) granting read and list
      permissions on

      the container, use a managed identity with read and list permissions, or set
      the ACL for the

      container to allow public access.'
    types:
    - <xref:str>
  - name: http_url
    description: 'The autoStorageContainerName, storageContainerUrl and httpUrl properties
      are

      mutually exclusive and one of them must be specified. If the URL points to Azure
      Blob Storage,

      it must be readable from compute nodes. There are three ways to get such a URL
      for a blob in

      Azure storage: include a Shared Access Signature (SAS) granting read permissions
      on the blob,

      use a managed identity with read permission, or set the ACL for the blob or
      its container to

      allow public access.'
    types:
    - <xref:str>
  - name: blob_prefix
    description: 'The property is valid only when autoStorageContainerName or

      storageContainerUrl is used. This prefix can be a partial filename or a subdirectory.
      If a

      prefix is not specified, all the files in the container will be downloaded.'
    types:
    - <xref:str>
  - name: file_path
    description: 'If the httpUrl property is specified, the filePath is required and

      describes the path which the file will be downloaded to, including the filename.
      Otherwise, if

      the autoStorageContainerName or storageContainerUrl property is specified, filePath
      is optional

      and is the directory to download the files to. In the case where filePath is
      used as a

      directory, any directory structure already associated with the input data will
      be retained in

      full and appended to the specified filePath directory. The specified relative
      path cannot break

      out of the task''s working directory (for example by using ''..'').'
    types:
    - <xref:str>
  - name: file_mode
    description: 'This property applies only to files being downloaded to Linux compute

      nodes. It will be ignored if it is specified for a resourceFile which will be
      downloaded to a

      Windows node. If this property is not specified for a Linux node, then a default
      value of 0770

      is applied to the file.'
    types:
    - <xref:str>
  - name: identity_reference
    description: 'The reference to a user assigned identity associated with the

      Batch pool which a compute node will use.'
    types:
    - <xref:azure.mgmt.batch.models.ComputeNodeIdentityReference>
variables:
- description: 'The autoStorageContainerName, storageContainerUrl and

    httpUrl properties are mutually exclusive and one of them must be specified.'
  name: auto_storage_container_name
  types:
  - <xref:str>
- description: 'The autoStorageContainerName, storageContainerUrl and httpUrl

    properties are mutually exclusive and one of them must be specified. This URL
    must be readable

    and listable from compute nodes. There are three ways to get such a URL for a
    container in

    Azure storage: include a Shared Access Signature (SAS) granting read and list
    permissions on

    the container, use a managed identity with read and list permissions, or set the
    ACL for the

    container to allow public access.'
  name: storage_container_url
  types:
  - <xref:str>
- description: 'The autoStorageContainerName, storageContainerUrl and httpUrl properties
    are

    mutually exclusive and one of them must be specified. If the URL points to Azure
    Blob Storage,

    it must be readable from compute nodes. There are three ways to get such a URL
    for a blob in

    Azure storage: include a Shared Access Signature (SAS) granting read permissions
    on the blob,

    use a managed identity with read permission, or set the ACL for the blob or its
    container to

    allow public access.'
  name: http_url
  types:
  - <xref:str>
- description: 'The property is valid only when autoStorageContainerName or

    storageContainerUrl is used. This prefix can be a partial filename or a subdirectory.
    If a

    prefix is not specified, all the files in the container will be downloaded.'
  name: blob_prefix
  types:
  - <xref:str>
- description: 'If the httpUrl property is specified, the filePath is required and
    describes

    the path which the file will be downloaded to, including the filename. Otherwise,
    if the

    autoStorageContainerName or storageContainerUrl property is specified, filePath
    is optional and

    is the directory to download the files to. In the case where filePath is used
    as a directory,

    any directory structure already associated with the input data will be retained
    in full and

    appended to the specified filePath directory. The specified relative path cannot
    break out of

    the task''s working directory (for example by using ''..'').'
  name: file_path
  types:
  - <xref:str>
- description: 'This property applies only to files being downloaded to Linux compute
    nodes.

    It will be ignored if it is specified for a resourceFile which will be downloaded
    to a Windows

    node. If this property is not specified for a Linux node, then a default value
    of 0770 is

    applied to the file.'
  name: file_mode
  types:
  - <xref:str>
- description: 'The reference to a user assigned identity associated with the Batch

    pool which a compute node will use.'
  name: identity_reference
  types:
  - <xref:azure.mgmt.batch.models.ComputeNodeIdentityReference>