Package com.azure.resourcemanager.storage.fluent

Interface FileSharesClient

public interface FileSharesClient
An instance of this class provides access to all the operations defined in FileSharesClient.

  • Method Details

    • listAsync

      com.azure.core.http.rest.PagedFlux<FileShareItemInner> listAsync(String resourceGroupName, String accountName, String maxpagesize, String filter, String expand)
      Lists all shares.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      maxpagesize - Optional. Specified maximum number of shares that can be included in the list.
      filter - Optional. When specified, only share names starting with the filter will be listed.
      expand - Optional, used to expand the properties within share's properties. Valid values are: deleted, snapshots. Should be passed as a string with delimiter ','.
      Returns:
      response schema as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listAsync

      com.azure.core.http.rest.PagedFlux<FileShareItemInner> listAsync(String resourceGroupName, String accountName)
      Lists all shares.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      Returns:
      response schema as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<FileShareItemInner> list(String resourceGroupName, String accountName)
      Lists all shares.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      Returns:
      response schema as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<FileShareItemInner> list(String resourceGroupName, String accountName, String maxpagesize, String filter, String expand, com.azure.core.util.Context context)
      Lists all shares.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      maxpagesize - Optional. Specified maximum number of shares that can be included in the list.
      filter - Optional. When specified, only share names starting with the filter will be listed.
      expand - Optional, used to expand the properties within share's properties. Valid values are: deleted, snapshots. Should be passed as a string with delimiter ','.
      context - The context to associate with this operation.
      Returns:
      response schema as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createWithResponseAsync

      Mono<com.azure.core.http.rest.Response<FileShareInner>> createWithResponseAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, String expand)
      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.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      fileShare - Properties of the file share to create.
      expand - Optional, used to expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','.
      Returns:
      properties of the file share, including Id, resource name, resource type, Etag along with Response on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createAsync

      Mono<FileShareInner> createAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, String expand)
      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.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      fileShare - Properties of the file share to create.
      expand - Optional, used to expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','.
      Returns:
      properties of the file share, including Id, resource name, resource type, Etag on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createAsync

      Mono<FileShareInner> createAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)
      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.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      fileShare - Properties of the file share to create.
      Returns:
      properties of the file share, including Id, resource name, resource type, Etag on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • create

      FileShareInner create(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)
      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.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      fileShare - Properties of the file share to create.
      Returns:
      properties of the file share, including Id, resource name, resource type, Etag.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createWithResponse

      com.azure.core.http.rest.Response<FileShareInner> createWithResponse(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, String expand, com.azure.core.util.Context context)
      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.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      fileShare - Properties of the file share to create.
      expand - Optional, used to expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','.
      context - The context to associate with this operation.
      Returns:
      properties of the file share, including Id, resource name, resource type, Etag along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • updateWithResponseAsync

      Mono<com.azure.core.http.rest.Response<FileShareInner>> updateWithResponseAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)
      Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      fileShare - Properties to update for the file share.
      Returns:
      properties of the file share, including Id, resource name, resource type, Etag along with Response on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • updateAsync

      Mono<FileShareInner> updateAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)
      Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      fileShare - Properties to update for the file share.
      Returns:
      properties of the file share, including Id, resource name, resource type, Etag on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • update

      FileShareInner update(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)
      Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      fileShare - Properties to update for the file share.
      Returns:
      properties of the file share, including Id, resource name, resource type, Etag.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • updateWithResponse

      com.azure.core.http.rest.Response<FileShareInner> updateWithResponse(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, com.azure.core.util.Context context)
      Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      fileShare - Properties to update for the file share.
      context - The context to associate with this operation.
      Returns:
      properties of the file share, including Id, resource name, resource type, Etag along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponseAsync

      Mono<com.azure.core.http.rest.Response<FileShareInner>> getWithResponseAsync(String resourceGroupName, String accountName, String shareName, String expand, String xMsSnapshot)
      Gets properties of a specified share.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      expand - Optional, used to expand the properties within share's properties. Valid values are: stats. Should be passed as a string with delimiter ','.
      xMsSnapshot - Optional, used to retrieve properties of a snapshot.
      Returns:
      properties of a specified share along with Response on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getAsync

      Mono<FileShareInner> getAsync(String resourceGroupName, String accountName, String shareName, String expand, String xMsSnapshot)
      Gets properties of a specified share.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      expand - Optional, used to expand the properties within share's properties. Valid values are: stats. Should be passed as a string with delimiter ','.
      xMsSnapshot - Optional, used to retrieve properties of a snapshot.
      Returns:
      properties of a specified share on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getAsync

      Mono<FileShareInner> getAsync(String resourceGroupName, String accountName, String shareName)
      Gets properties of a specified share.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      Returns:
      properties of a specified share on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      FileShareInner get(String resourceGroupName, String accountName, String shareName)
      Gets properties of a specified share.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      Returns:
      properties of a specified share.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<FileShareInner> getWithResponse(String resourceGroupName, String accountName, String shareName, String expand, String xMsSnapshot, com.azure.core.util.Context context)
      Gets properties of a specified share.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      expand - Optional, used to expand the properties within share's properties. Valid values are: stats. Should be passed as a string with delimiter ','.
      xMsSnapshot - Optional, used to retrieve properties of a snapshot.
      context - The context to associate with this operation.
      Returns:
      properties of a specified share along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteWithResponseAsync

      Mono<com.azure.core.http.rest.Response<Void>> deleteWithResponseAsync(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, String include)
      Deletes specified share under its account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      xMsSnapshot - Optional, used to delete a snapshot.
      include - Optional. Valid values are: snapshots, leased-snapshots, none. The default value is snapshots. For 'snapshots', the file share is deleted including all of its file share snapshots. If the file share contains leased-snapshots, the deletion fails. For 'leased-snapshots', the file share is deleted included all of its file share snapshots (leased/unleased). For 'none', the file share is deleted if it has no share snapshots. If the file share contains any snapshots (leased or unleased), the deletion fails.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteAsync

      Mono<Void> deleteAsync(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, String include)
      Deletes specified share under its account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      xMsSnapshot - Optional, used to delete a snapshot.
      include - Optional. Valid values are: snapshots, leased-snapshots, none. The default value is snapshots. For 'snapshots', the file share is deleted including all of its file share snapshots. If the file share contains leased-snapshots, the deletion fails. For 'leased-snapshots', the file share is deleted included all of its file share snapshots (leased/unleased). For 'none', the file share is deleted if it has no share snapshots. If the file share contains any snapshots (leased or unleased), the deletion fails.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteAsync

      Mono<Void> deleteAsync(String resourceGroupName, String accountName, String shareName)
      Deletes specified share under its account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String accountName, String shareName)
      Deletes specified share under its account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, String include, com.azure.core.util.Context context)
      Deletes specified share under its account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      xMsSnapshot - Optional, used to delete a snapshot.
      include - Optional. Valid values are: snapshots, leased-snapshots, none. The default value is snapshots. For 'snapshots', the file share is deleted including all of its file share snapshots. If the file share contains leased-snapshots, the deletion fails. For 'leased-snapshots', the file share is deleted included all of its file share snapshots (leased/unleased). For 'none', the file share is deleted if it has no share snapshots. If the file share contains any snapshots (leased or unleased), the deletion fails.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • restoreWithResponseAsync

      Mono<com.azure.core.http.rest.Response<Void>> restoreWithResponseAsync(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)
      Restore a file share within a valid retention days if share soft delete is enabled.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      deletedShare - The deleted share to be restored.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • restoreAsync

      Mono<Void> restoreAsync(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)
      Restore a file share within a valid retention days if share soft delete is enabled.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      deletedShare - The deleted share to be restored.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • restore

      void restore(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)
      Restore a file share within a valid retention days if share soft delete is enabled.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      deletedShare - The deleted share to be restored.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • restoreWithResponse

      com.azure.core.http.rest.Response<Void> restoreWithResponse(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare, com.azure.core.util.Context context)
      Restore a file share within a valid retention days if share soft delete is enabled.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      deletedShare - The deleted share to be restored.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • leaseWithResponseAsync

      Mono<FileSharesLeaseResponse> leaseWithResponseAsync(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, LeaseShareRequest parameters)
      The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      xMsSnapshot - Optional. Specify the snapshot time to lease a snapshot.
      parameters - Lease Share request body.
      Returns:
      lease Share response schema on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • leaseAsync

      Mono<LeaseShareResponseInner> leaseAsync(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, LeaseShareRequest parameters)
      The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      xMsSnapshot - Optional. Specify the snapshot time to lease a snapshot.
      parameters - Lease Share request body.
      Returns:
      lease Share response schema on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • leaseAsync

      Mono<LeaseShareResponseInner> leaseAsync(String resourceGroupName, String accountName, String shareName)
      The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      Returns:
      lease Share response schema on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • lease

      LeaseShareResponseInner lease(String resourceGroupName, String accountName, String shareName)
      The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      Returns:
      lease Share response schema.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • leaseWithResponse

      FileSharesLeaseResponse leaseWithResponse(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, LeaseShareRequest parameters, com.azure.core.util.Context context)
      The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      accountName - The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
      shareName - 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.
      xMsSnapshot - Optional. Specify the snapshot time to lease a snapshot.
      parameters - Lease Share request body.
      context - The context to associate with this operation.
      Returns:
      lease Share response schema.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.