ResourceFile Class

Definition

Namespace:

Azure.Compute.Batch

Assembly:

Azure.Compute.Batch.dll

Package:

Azure.Compute.Batch v1.0.0-beta.1

Source:

ResourceFile.cs

A single file or multiple files to be downloaded to a Compute Node.

public class ResourceFile : System.ClientModel.Primitives.IJsonModel<Azure.Compute.Batch.ResourceFile>, System.ClientModel.Primitives.IPersistableModel<Azure.Compute.Batch.ResourceFile>

type ResourceFile = class
    interface IJsonModel<ResourceFile>
    interface IPersistableModel<ResourceFile>

Public Class ResourceFile
Implements IJsonModel(Of ResourceFile), IPersistableModel(Of ResourceFile)

Inheritance

Object

ResourceFile

Implements

IJsonModel<ResourceFile> IPersistableModel<ResourceFile> IPersistableModel<T>

Constructors

ResourceFile()

Initializes a new instance of ResourceFile.

Properties

AutoStorageContainerName	The storage container name in the auto storage Account. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
BlobPrefix	The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. 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.
FileMode	The file permission mode attribute in octal format. 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 Compute Node. If this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file.
FilePath	The location on the Compute Node to which to download the file(s), relative to the Task's working directory. 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 '..').
HttpUrl	The URL of the file to download. 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.
IdentityReference	The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl.
StorageContainerUrl	The URL of the blob container within Azure Blob Storage. 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.

Explicit Interface Implementations

IJsonModel<ResourceFile>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ResourceFile>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ResourceFile>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ResourceFile>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ResourceFile>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.