DataLakeDirectoryClient.CreateFileAsync Method

Definition

Namespace:

Azure.Storage.Files.DataLake

Assembly:

Azure.Storage.Files.DataLake.dll

Package:

Azure.Storage.Files.DataLake v12.20.1

Source:

DataLakeDirectoryClient.cs

The CreateFileAsync(String, DataLakePathCreateOptions, CancellationToken) operation creates a new file in this directory. If the file already exists, it will be overwritten. If you don't intent to overwrite an existing file, consider using the CreateIfNotExistsAsync(DataLakePathCreateOptions, CancellationToken) API.

For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.DataLakeFileClient>> CreateFileAsync (string fileName, Azure.Storage.Files.DataLake.Models.DataLakePathCreateOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateFileAsync : string * Azure.Storage.Files.DataLake.Models.DataLakePathCreateOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.DataLakeFileClient>>
override this.CreateFileAsync : string * Azure.Storage.Files.DataLake.Models.DataLakePathCreateOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.DataLakeFileClient>>

Public Overridable Function CreateFileAsync (fileName As String, Optional options As DataLakePathCreateOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DataLakeFileClient))

Parameters

fileName

String

Name of the file to create.

options

DataLakePathCreateOptions

Optional parameters.

cancellationToken

CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Task<Response<DataLakeFileClient>>

A Response<T> for the newly created file.

Remarks

A RequestFailedException will be thrown if a failure occurs.