FileShareCollection.CreateOrUpdate Method

Definition

Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
  • Operation Id: FileShares_Create
  • Default Api Version: 2023-05-01
  • Resource: FileShareResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Storage.FileShareResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string shareName, Azure.ResourceManager.Storage.FileShareData data, string expand = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.Storage.FileShareData * string * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Storage.FileShareResource>
override this.CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.Storage.FileShareData * string * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Storage.FileShareResource>
Public Overridable Function CreateOrUpdate (waitUntil As WaitUntil, shareName As String, data As FileShareData, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of FileShareResource)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

shareName
String

The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.

data
FileShareData

Properties of the file share to create.

expand
String

Optional, used to expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

shareName is an empty string, and was expected to be non-empty.

shareName or data is null.

Applies to