Share via


FileShareCollection Class

Definition

A class representing a collection of FileShareResource and their operations. Each FileShareResource in the collection will belong to the same instance of FileServiceResource. To get a FileShareCollection instance call the GetFileShares method from an instance of FileServiceResource.

public class FileShareCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.Storage.FileShareResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Storage.FileShareResource>
type FileShareCollection = class
    inherit ArmCollection
    interface seq<FileShareResource>
    interface IEnumerable
    interface IAsyncEnumerable<FileShareResource>
Public Class FileShareCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of FileShareResource), IEnumerable(Of FileShareResource)
Inheritance
FileShareCollection
Implements

Constructors

FileShareCollection()

Initializes a new instance of the FileShareCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, FileShareData, String, CancellationToken)

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
CreateOrUpdateAsync(WaitUntil, String, FileShareData, String, CancellationToken)

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
Exists(String, String, String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
  • Operation Id: FileShares_Get
  • Default Api Version: 2023-05-01
  • Resource: FileShareResource
ExistsAsync(String, String, String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
  • Operation Id: FileShares_Get
  • Default Api Version: 2023-05-01
  • Resource: FileShareResource
Get(String, String, String, CancellationToken)

Gets properties of a specified share.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
  • Operation Id: FileShares_Get
  • Default Api Version: 2023-05-01
  • Resource: FileShareResource
GetAll(Nullable<Int32>, String, String, CancellationToken)

Lists all shares.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares
  • Operation Id: FileShares_List
  • Default Api Version: 2023-05-01
  • Resource: FileShareResource
GetAll(String, String, String, CancellationToken)

Lists all shares.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares
  • Operation Id: FileShares_List
  • Default Api Version: 2022-09-01
  • Resource: FileShareResource
GetAllAsync(Nullable<Int32>, String, String, CancellationToken)

Lists all shares.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares
  • Operation Id: FileShares_List
  • Default Api Version: 2023-05-01
  • Resource: FileShareResource
GetAllAsync(String, String, String, CancellationToken)

Lists all shares.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares
  • Operation Id: FileShares_List
  • Default Api Version: 2022-09-01
  • Resource: FileShareResource
GetAsync(String, String, String, CancellationToken)

Gets properties of a specified share.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
  • Operation Id: FileShares_Get
  • Default Api Version: 2023-05-01
  • Resource: FileShareResource
GetIfExists(String, String, String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
  • Operation Id: FileShares_Get
  • Default Api Version: 2023-05-01
  • Resource: FileShareResource
GetIfExistsAsync(String, String, String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
  • Operation Id: FileShares_Get
  • Default Api Version: 2023-05-01
  • Resource: FileShareResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<FileShareResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<FileShareResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to