DataLakeFileSystemClient.CreateFileAsync Method

Reference

Definition

Namespace:: Azure.Storage.Files.DataLake

Assembly:: Azure.Storage.Files.DataLake.dll

Package:: Azure.Storage.Files.DataLake v12.17.1

Package:: Azure.Storage.Files.DataLake v12.18.0-beta.2

Source:: DataLakeFileSystemClient.cs

Source:: DataLakeFileSystemClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The CreateFileAsync(String, DataLakePathCreateOptions, CancellationToken) creates a file in this file system. 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 path, 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 (path As String, Optional options As DataLakePathCreateOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DataLakeFileClient))

Parameters

path: String

The path to 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> describing the newly created directory.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to