ShareServiceClient.yml

### YamlMime:TSType
name: ShareServiceClient
uid: '@azure/storage-file-share.ShareServiceClient'
package: '@azure/storage-file-share'
summary: >-
  A ShareServiceClient represents a URL to the Azure Storage File service
  allowing you

  to manipulate file shares.
fullName: ShareServiceClient
remarks: ''
isDeprecated: false
type: class
constructors:
  - name: >-
      ShareServiceClient(string, Credential_2 | TokenCredential,
      ShareClientOptions)
    uid: '@azure/storage-file-share.ShareServiceClient.constructor'
    package: '@azure/storage-file-share'
    summary: Creates an instance of ShareServiceClient.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        new ShareServiceClient(url: string, credential?: Credential_2 |
        TokenCredential, options?: ShareClientOptions)
      parameters:
        - id: url
          type: string
          description: |-
            A URL string pointing to Azure Storage file service, such as
                                "https://myaccount.file.core.windows.net". You can Append a SAS
                                if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
        - id: credential
          type: >-
            <xref uid="@azure/storage-file-share.Credential" /> | <xref
            uid="@azure/core-auth.TokenCredential" />
          description: >-
            Such as AnonymousCredential, StorageSharedKeyCredential or
            TokenCredential.
                                             If not specified, AnonymousCredential is used.
        - id: options
          type: <xref uid="@azure/storage-file-share.ShareClientOptions" />
          description: Optional. Options to configure the HTTP pipeline.
  - name: ShareServiceClient(string, Pipeline, ShareClientConfig)
    uid: '@azure/storage-file-share.ShareServiceClient.constructor_1'
    package: '@azure/storage-file-share'
    summary: Creates an instance of ShareServiceClient.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        new ShareServiceClient(url: string, pipeline: Pipeline, options?:
        ShareClientConfig)
      parameters:
        - id: url
          type: string
          description: |-
            A URL string pointing to Azure Storage file service, such as
                                "https://myaccount.file.core.windows.net". You can Append a SAS
                                if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
        - id: pipeline
          type: <xref uid="@azure/storage-file-share.Pipeline" />
          description: |-
            Call newPipeline() to create a default
                                       pipeline, or provide a customized pipeline.
        - id: options
          type: <xref uid="@azure/storage-file-share.ShareClientConfig" />
          description: Optional. Options to configure the HTTP pipeline.
inheritedProperties:
  - name: accountName
    uid: '@azure/storage-file-share.ShareServiceClient.accountName'
    package: '@azure/storage-file-share'
    summary: ''
    fullName: accountName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'accountName: string'
      return:
        description: ''
        type: string
    inheritanceDescription: <b>Inherited From</b> StorageClient.accountName
  - name: url
    uid: '@azure/storage-file-share.ShareServiceClient.url'
    package: '@azure/storage-file-share'
    summary: URL string value.
    fullName: url
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'url: string'
      return:
        description: ''
        type: string
    inheritanceDescription: <b>Inherited From</b> StorageClient.url
methods:
  - name: createShare(string, ShareCreateOptions)
    uid: '@azure/storage-file-share.ShareServiceClient.createShare'
    package: '@azure/storage-file-share'
    summary: Creates a Share.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function createShare(shareName: string, options?: ShareCreateOptions):
        Promise<{ shareClient: ShareClient, shareCreateResponse:
        ShareCreateResponse }>
      parameters:
        - id: shareName
          type: string
          description: ''
        - id: options
          type: <xref uid="@azure/storage-file-share.ShareCreateOptions" />
          description: ''
      return:
        description: Share creation response and the corresponding share client.
        type: >-
          Promise&lt;{ shareClient: ShareClient, shareCreateResponse:
          ShareCreateResponse }&gt;
  - name: deleteShare(string, ShareDeleteMethodOptions)
    uid: '@azure/storage-file-share.ShareServiceClient.deleteShare'
    package: '@azure/storage-file-share'
    summary: Deletes a Share.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function deleteShare(shareName: string, options?:
        ShareDeleteMethodOptions): Promise<ShareDeleteResponse>
      parameters:
        - id: shareName
          type: string
          description: ''
        - id: options
          type: <xref uid="@azure/storage-file-share.ShareDeleteMethodOptions" />
          description: ''
      return:
        description: Share deletion response and the corresponding share client.
        type: >-
          Promise&lt;<xref uid="@azure/storage-file-share.ShareDeleteResponse"
          />&gt;
  - name: fromConnectionString(string, ShareClientOptions)
    uid: '@azure/storage-file-share.ShareServiceClient.fromConnectionString'
    package: '@azure/storage-file-share'
    summary: Creates an instance of ShareServiceClient from connection string.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        static function fromConnectionString(connectionString: string, options?:
        ShareClientOptions): ShareServiceClient
      parameters:
        - id: connectionString
          type: string
          description: >-
            Account connection string or a SAS connection string of an Azure
            storage account.
                                             [ Note - Account connection string can only be used in NODE.JS runtime. ]
                                             Account connection string example -
                                             `DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`
                                             SAS connection string example -
                                             `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString`
        - id: options
          type: <xref uid="@azure/storage-file-share.ShareClientOptions" />
          description: Options to configure the HTTP pipeline.
      return:
        description: A new ShareServiceClient from the given connection string.
        type: <xref uid="@azure/storage-file-share.ShareServiceClient" />
  - name: >-
      generateAccountSasUrl(Date, AccountSASPermissions, string,
      ServiceGenerateAccountSasUrlOptions)
    uid: '@azure/storage-file-share.ShareServiceClient.generateAccountSasUrl'
    package: '@azure/storage-file-share'
    summary: >-
      Only available for ShareServiceClient constructed with a shared key
      credential.


      Generates an account Shared Access Signature (SAS) URI based on the client
      properties

      and parameters passed in. The SAS is signed by the shared key credential
      of the client.


      See
      https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function generateAccountSasUrl(expiresOn?: Date, permissions?:
        AccountSASPermissions, resourceTypes?: string, options?:
        ServiceGenerateAccountSasUrlOptions): string
      parameters:
        - id: expiresOn
          type: Date
          description: >-
            Optional. The time at which the shared access signature becomes
            invalid. Default to an hour later if not specified.
        - id: permissions
          type: <xref uid="@azure/storage-file-share.AccountSASPermissions" />
          description: Specifies the list of permissions to be associated with the SAS.
        - id: resourceTypes
          type: string
          description: >-
            Specifies the resource types associated with the shared access
            signature.
        - id: options
          type: >-
            <xref
            uid="@azure/storage-file-share.ServiceGenerateAccountSasUrlOptions"
            />
          description: Optional parameters.
      return:
        description: >-
          An account SAS URI consisting of the URI to the resource represented
          by this client, followed by the generated SAS token.
        type: string
  - name: getProperties(ServiceGetPropertiesOptions)
    uid: '@azure/storage-file-share.ShareServiceClient.getProperties'
    package: '@azure/storage-file-share'
    summary: >-
      Gets the properties of a storage account’s file service, including
      properties

      for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.


      See
      https://docs.microsoft.com/en-us/rest/api/storageservices/get-file-service-properties
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getProperties(options?: ServiceGetPropertiesOptions):
        Promise<ServiceGetPropertiesResponse>
      parameters:
        - id: options
          type: <xref uid="@azure/storage-file-share.ServiceGetPropertiesOptions" />
          description: Options to Get Properties operation.
      return:
        description: Response data for the Get Properties operation.
        type: >-
          Promise&lt;<xref
          uid="@azure/storage-file-share.ServiceGetPropertiesResponse" />&gt;
  - name: getShareClient(string)
    uid: '@azure/storage-file-share.ShareServiceClient.getShareClient'
    package: '@azure/storage-file-share'
    summary: Creates a ShareClient object.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function getShareClient(shareName: string): ShareClient'
      parameters:
        - id: shareName
          type: string
          description: Name of a share.
      return:
        description: |-
          The ShareClient object for the given share name.

          Example usage:

          ```js
          const shareClient = serviceClient.getShareClient("<share name>");
          await shareClient.create();
          console.log("Created share successfully!");
          ```
        type: <xref uid="@azure/storage-file-share.ShareClient" />
  - name: listShares(ServiceListSharesOptions)
    uid: '@azure/storage-file-share.ShareServiceClient.listShares'
    package: '@azure/storage-file-share'
    summary: >-
      Returns an async iterable iterator to list all the shares

      under the specified account.


      .byPage() returns an async iterable iterator to list the shares in pages.


      Example using `for await` syntax:


      ```js

      let i = 1;

      for await (const share of serviceClient.listShares()) {
        console.log(`Share ${i++}: ${share.name}`);
      }

      ```


      Example using `iter.next()`:


      ```js

      let i = 1;

      let iter = serviceClient.listShares();

      let shareItem = await iter.next();

      while (!shareItem.done) {
        console.log(`Share ${i++}: ${shareItem.value.name}`);
        shareItem = await iter.next();
      }

      ```


      Example using `byPage()`:


      ```js

      // passing optional maxPageSize in the page settings

      let i = 1;

      for await (const response of serviceClient.listShares().byPage({
      maxPageSize: 20 })) {
        if (response.shareItems) {
         for (const share of response.shareItems) {
             console.log(`Share ${i++}: ${share.name}`);
          }
        }
      }

      ```


      Example using paging with a marker:


      ```js

      let i = 1;

      let iterator = serviceClient.listShares().byPage({ maxPageSize: 2 });

      let response = (await iterator.next()).value;


      // Prints 2 share names

      if (response.shareItems) {
        for (const share of response.shareItems) {
          console.log(`Share ${i++}: ${share.name}`);
        }
      }


      // Gets next marker

      let marker = response.continuationToken;


      // Passing next marker as continuationToken

      iterator = serviceClient.listShares().byPage({ continuationToken: marker,
      maxPageSize: 10 });

      response = (await iterator.next()).value;


      // Prints 10 share names

      if (response.shareItems) {
        for (const share of response.shareItems) {
          console.log(`Share ${i++}: ${share.name}`);
        }
      }

      ```
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listShares(options?: ServiceListSharesOptions):
        PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse,
        PageSettings>
      parameters:
        - id: options
          type: <xref uid="@azure/storage-file-share.ServiceListSharesOptions" />
          description: |-
            Options to list shares operation.

            An asyncIterableIterator that supports paging.
      return:
        description: ''
        type: >-
          <xref uid="@azure/core-paging.PagedAsyncIterableIterator" />&lt;<xref
          uid="@azure/storage-file-share.ShareItem" />, <xref
          uid="@azure/storage-file-share.ServiceListSharesSegmentResponse" />,
          <xref uid="@azure/core-paging.PageSettings" />&gt;
  - name: setProperties(FileServiceProperties, ServiceSetPropertiesOptions)
    uid: '@azure/storage-file-share.ShareServiceClient.setProperties'
    package: '@azure/storage-file-share'
    summary: >-
      Sets properties for a storage account’s file service endpoint, including
      properties

      for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft
      delete settings.


      See
      https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-service-properties
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function setProperties(properties: FileServiceProperties, options?:
        ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>
      parameters:
        - id: properties
          type: <xref uid="@azure/storage-file-share.FileServiceProperties" />
          description: ''
        - id: options
          type: <xref uid="@azure/storage-file-share.ServiceSetPropertiesOptions" />
          description: Options to Set Properties operation.
      return:
        description: Response data for the Set Properties operation.
        type: >-
          Promise&lt;<xref
          uid="@azure/storage-file-share.ServiceSetPropertiesResponse" />&gt;
  - name: undeleteShare(string, string, ServiceUndeleteShareOptions)
    uid: '@azure/storage-file-share.ShareServiceClient.undeleteShare'
    package: '@azure/storage-file-share'
    summary: |-
      Restores a previously deleted share.
      This API is only functional if Share Soft Delete is enabled
      for the storage account associated with the share.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function undeleteShare(deletedShareName: string, deletedShareVersion:
        string, options?: ServiceUndeleteShareOptions): Promise<ShareClient>
      parameters:
        - id: deletedShareName
          type: string
          description: The name of the previously deleted share.
        - id: deletedShareVersion
          type: string
          description: The version of the previously deleted share.
        - id: options
          type: <xref uid="@azure/storage-file-share.ServiceUndeleteShareOptions" />
          description: Options to Share undelete operation.
      return:
        description: Restored share.
        type: Promise&lt;<xref uid="@azure/storage-file-share.ShareClient" />&gt;
extends: StorageClient