ShareClient.CreateDirectoryAsync Method

Reference

Definition

Namespace:: Azure.Storage.Files.Shares

Assembly:: Azure.Storage.Files.Shares.dll

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

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

Source:: ShareClient.cs

Source:: ShareClient.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 CreateDirectoryAsync(String, IDictionary<String,String>, FileSmbProperties, String, CancellationToken) operation creates a new directory in this share.

For more information, see Create Directory.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.ShareDirectoryClient>> CreateDirectoryAsync (string directoryName, System.Collections.Generic.IDictionary<string,string> metadata = default, Azure.Storage.Files.Shares.Models.FileSmbProperties smbProperties = default, string filePermission = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateDirectoryAsync : string * System.Collections.Generic.IDictionary<string, string> * Azure.Storage.Files.Shares.Models.FileSmbProperties * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.ShareDirectoryClient>>
override this.CreateDirectoryAsync : string * System.Collections.Generic.IDictionary<string, string> * Azure.Storage.Files.Shares.Models.FileSmbProperties * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.Shares.ShareDirectoryClient>>

Public Overridable Function CreateDirectoryAsync (directoryName As String, Optional metadata As IDictionary(Of String, String) = Nothing, Optional smbProperties As FileSmbProperties = Nothing, Optional filePermission As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ShareDirectoryClient))

Parameters

directoryName: String

T The name of the directory to create.

metadata: IDictionary<String,String>

Optional custom metadata to set for the directory.

smbProperties: FileSmbProperties

Optional SMB properties to set for the directory.

filePermission: String

Optional file permission to set on the directory.

cancellationToken: CancellationToken

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

Returns

Task<Response<ShareDirectoryClient>>

A Response<T> referencing the newly created directory.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to