Follow up rename: ServiceClient to BlobServiceClient

sdk/storage/storage-blob/samples/typescript/advanced.ts

@@ -12,7 +12,7 @@ import {
   BlobClient,
   BlockBlobClient,
   ContainerClient,
-  ServiceClient,
+  BlobServiceClient,
   StorageClient
 } from "../.."; // Change to "@azure/storage-blob" in your package
 
@@ -29,14 +29,14 @@ async function main() {
     telemetry: { value: "HighLevelSample V1.0.0" } // Customized telemetry string
   });
 
-  const serviceClient = new ServiceClient(
+  const blobServiceClient = new BlobServiceClient(
     `https://${account}.blob.core.windows.net${accountSas}`,
     pipeline
   );
 
   // Create a container
   const containerName = `newcontainer${new Date().getTime()}`;
-  const containerClient = ContainerClient.fromServiceClient(serviceClient, containerName);
+  const containerClient = ContainerClient.fromBlobServiceClient(blobServiceClient, containerName);
   await containerClient.create(Aborter.none);
 
   // Create a blob

sdk/storage/storage-blob/samples/typescript/basic.ts

@@ -7,7 +7,7 @@ import {
   BlobClient,
   BlockBlobClient,
   ContainerClient,
-  ServiceClient,
+  BlobServiceClient,
   StorageClient,
   SharedKeyCredential,
   TokenCredential,
@@ -33,15 +33,15 @@ async function main() {
   const pipeline = StorageClient.newPipeline(sharedKeyCredential);
 
   // List containers
-  const serviceClient = new ServiceClient(
+  const blobServiceClient = new BlobServiceClient(
     // When using AnonymousCredential, following url should include a valid SAS or support public access
     `https://${account}.blob.core.windows.net`,
     pipeline
   );
 
   let marker;
   do {
-    const listContainersResponse: Models.ServiceListContainersSegmentResponse = await serviceClient.listContainersSegment(
+    const listContainersResponse: Models.ServiceListContainersSegmentResponse = await blobServiceClient.listContainersSegment(
       Aborter.none,
       marker
     );
@@ -54,7 +54,7 @@ async function main() {
 
   // Create a container
   const containerName = `newcontainer${new Date().getTime()}`;
-  const containerClient = ContainerClient.fromServiceClient(serviceClient, containerName);
+  const containerClient = ContainerClient.fromBlobServiceClient(blobServiceClient, containerName);
 
   const createContainerResponse = await containerClient.create(Aborter.none);
   console.log(

sdk/storage/storage-blob/src/ServiceClient.ts → sdk/storage/storage-blob/src/BlobServiceClient.ts

@@ -30,48 +30,48 @@ export interface IServiceListContainersSegmentOptions {
 }
 
 /**
- * A ServiceClient represents a Client to the Azure Storage Blob service allowing you
+ * A BlobServiceClient represents a Client to the Azure Storage Blob service allowing you
  * to manipulate blob containers.
  *
  * @export
- * @class ServiceClient
+ * @class BlobServiceClient
  * @extends {StorageClient}
  */
-export class ServiceClient extends StorageClient {
+export class BlobServiceClient extends StorageClient {
   /**
    * serviceContext provided by protocol layer.
    *
    * @private
    * @type {Service}
-   * @memberof ServiceClient
+   * @memberof BlobServiceClient
    */
   private serviceContext: Service;
 
   /**
-   * Creates an instance of ServiceClient.
+   * Creates an instance of BlobServiceClient.
    *
    * @param {string} url A Client string pointing to Azure Storage blob service, such as
    *                     "https://myaccount.blob.core.windows.net". You can append a SAS
    *                     if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
    * @param {Pipeline} pipeline Call StorageClient.newPipeline() to create a default
    *                            pipeline, or provide a customized pipeline.
-   * @memberof ServiceClient
+   * @memberof BlobServiceClient
    */
   constructor(url: string, pipeline: Pipeline) {
     super(url, pipeline);
     this.serviceContext = new Service(this.storageClientContext);
   }
 
   /**
-   * Creates a new ServiceClient object identical to the source but with the
+   * Creates a new BlobServiceClient object identical to the source but with the
    * specified request policy pipeline.
    *
    * @param {Pipeline} pipeline
-   * @returns {ServiceClient}
-   * @memberof ServiceClient
+   * @returns {BlobServiceClient}
+   * @memberof BlobServiceClient
    */
-  public withPipeline(pipeline: Pipeline): ServiceClient {
-    return new ServiceClient(this.url, pipeline);
+  public withPipeline(pipeline: Pipeline): BlobServiceClient {
+    return new BlobServiceClient(this.url, pipeline);
   }
 
   /**
@@ -82,7 +82,7 @@ export class ServiceClient extends StorageClient {
    * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(),
    *                          goto documents of Aborter for more examples about request cancellation
    * @returns {Promise<Models.ServiceGetPropertiesResponse>}
-   * @memberof ServiceClient
+   * @memberof BlobServiceClient
    */
   public async getProperties(aborter: Aborter): Promise<Models.ServiceGetPropertiesResponse> {
     return this.serviceContext.getProperties({
@@ -99,7 +99,7 @@ export class ServiceClient extends StorageClient {
    *                          goto documents of Aborter for more examples about request cancellation
    * @param {Models.StorageServiceProperties} properties
    * @returns {Promise<Models.ServiceSetPropertiesResponse>}
-   * @memberof ServiceClient
+   * @memberof BlobServiceClient
    */
   public async setProperties(
     aborter: Aborter,
@@ -119,7 +119,7 @@ export class ServiceClient extends StorageClient {
    *  @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(),
    *                          goto documents of Aborter for more examples about request cancellation
    * @returns {Promise<Models.ServiceGetStatisticsResponse>}
-   * @memberof ServiceClient
+   * @memberof BlobServiceClient
    */
   public async getStatistics(aborter: Aborter): Promise<Models.ServiceGetStatisticsResponse> {
     return this.serviceContext.getStatistics({
@@ -137,7 +137,7 @@ export class ServiceClient extends StorageClient {
    * @param {Aborter} aborter Create a new Aborter instance with Aborter.none or Aborter.timeout(),
    *                          goto documents of Aborter for more examples about request cancellation
    * @returns {Promise<Models.ServiceGetAccountInfoResponse>}
-   * @memberof ServiceClient
+   * @memberof BlobServiceClient
    */
   public async getAccountInfo(aborter: Aborter): Promise<Models.ServiceGetAccountInfoResponse> {
     return this.serviceContext.getAccountInfo({
@@ -160,7 +160,7 @@ export class ServiceClient extends StorageClient {
    *                          items. The marker value is opaque to the client.
    * @param {IServiceListContainersSegmentOptions} [options]
    * @returns {Promise<Models.ServiceListContainersSegmentResponse>}
-   * @memberof ServiceClient
+   * @memberof BlobServiceClient
    */
   public async listContainersSegment(
     aborter: Aborter,

sdk/storage/storage-blob/src/ContainerClient.ts

@@ -4,7 +4,7 @@ import { Aborter } from "./Aborter";
 import { Container } from "./generated/lib/operations";
 import { IContainerAccessConditions, IMetadata } from "./models";
 import { Pipeline } from "./Pipeline";
-import { ServiceClient } from "./ServiceClient";
+import { BlobServiceClient } from "./BlobServiceClient";
 import { StorageClient } from "./StorageClient";
 import { ETagNone } from "./utils/constants";
 import { appendToURLPath, truncatedISO8061Date } from "./utils/utils.common";
@@ -133,18 +133,18 @@ export interface IContainerListBlobsSegmentOptions {
  */
 export class ContainerClient extends StorageClient {
   /**
-   * Creates a ContainerClient object from ServiceClient
+   * Creates a ContainerClient object from BlobServiceClient
    *
-   * @param serviceClient A ServiceClient object
+   * @param blobServiceClient A BlobServiceClient object
    * @param containerName A container name
    */
-  public static fromServiceClient(
-    serviceClient: ServiceClient,
+  public static fromBlobServiceClient(
+    blobServiceClient: BlobServiceClient,
     containerName: string
   ): ContainerClient {
     return new ContainerClient(
-      appendToURLPath(serviceClient.url, encodeURIComponent(containerName)),
-      serviceClient.pipeline
+      appendToURLPath(blobServiceClient.url, encodeURIComponent(containerName)),
+      blobServiceClient.pipeline
     );
   }
 

sdk/storage/storage-blob/src/StorageClient.ts

@@ -33,7 +33,7 @@ export interface INewPipelineOptions {
 }
 
 /**
- * A ServiceClient represents a based URL class for ServiceClient, ContainerClient and etc.
+ * A StorageClient represents a based URL class for BlobServiceClient, ContainerClient and etc.
  *
  * @export
  * @class StorageClient

sdk/storage/storage-blob/src/credentials/TokenCredential.ts

@@ -12,7 +12,7 @@ import { TokenCredentialPolicy } from "../policies/TokenCredentialPolicy";
  *  const pipeline = StorageClient.newPipeline(tokenCredential);
  *
  *  // List containers
- *  const serviceClient = new ServiceClient("https://mystorageaccount.blob.core.windows.net", pipeline);
+ *  const blobServiceClient = new BlobServiceClient("https://mystorageaccount.blob.core.windows.net", pipeline);
  *
  *  // Set up a timer to refresh the token
  *  const timerID = setInterval(() => {

sdk/storage/storage-blob/src/index.browser.ts

@@ -24,6 +24,6 @@ export * from "./LoggingPolicyFactory";
 export * from "./TelemetryPolicyFactory";
 export * from "./policies/TokenCredentialPolicy";
 export * from "./UniqueRequestIDPolicyFactory";
-export * from "./ServiceClient";
+export * from "./BlobServiceClient";
 export * from "./StorageClient";
 export { Models, RestError };

sdk/storage/storage-blob/src/index.ts

@@ -34,7 +34,7 @@ export * from "./policies/SharedKeyCredentialPolicy";
 export * from "./TelemetryPolicyFactory";
 export * from "./policies/TokenCredentialPolicy";
 export * from "./UniqueRequestIDPolicyFactory";
-export * from "./ServiceClient";
+export * from "./BlobServiceClient";
 export * from "./StorageClient";
 export * from "./SASQueryParameters";
 export { Models, RestError };

sdk/storage/storage-blob/test/aborter.spec.ts

@@ -8,13 +8,13 @@ dotenv.config({ path: "../.env" });
 
 // tslint:disable:no-empty
 describe("Aborter", () => {
-  const serviceClient = getBSU();
+  const blobServiceClient = getBSU();
   let containerName: string = getUniqueName("container");
-  let containerClient = ContainerClient.fromServiceClient(serviceClient, containerName);
+  let containerClient = ContainerClient.fromBlobServiceClient(blobServiceClient, containerName);
 
   beforeEach(async () => {
     containerName = getUniqueName("container");
-    containerClient = ContainerClient.fromServiceClient(serviceClient, containerName);
+    containerClient = ContainerClient.fromBlobServiceClient(blobServiceClient, containerName);
   });
 
   it("should set value and get value successfully", async () => {

sdk/storage/storage-blob/test/appendblobclient.spec.ts

@@ -8,15 +8,15 @@ import * as dotenv from "dotenv";
 dotenv.config({ path: "../.env" });
 
 describe("AppendBlobClient", () => {
-  const serviceClient = getBSU();
+  const blobServiceClient = getBSU();
   let containerName: string = getUniqueName("container");
-  let containerClient = ContainerClient.fromServiceClient(serviceClient, containerName);
+  let containerClient = ContainerClient.fromBlobServiceClient(blobServiceClient, containerName);
   let blobName: string = getUniqueName("blob");
   let appendBlobClient = AppendBlobClient.fromContainerClient(containerClient, blobName);
 
   beforeEach(async () => {
     containerName = getUniqueName("container");
-    containerClient = ContainerClient.fromServiceClient(serviceClient, containerName);
+    containerClient = ContainerClient.fromBlobServiceClient(blobServiceClient, containerName);
     await containerClient.create(Aborter.none);
     blobName = getUniqueName("blob");
     appendBlobClient = AppendBlobClient.fromContainerClient(containerClient, blobName);

sdk/storage/storage-blob/test/blobclient.spec.ts

@@ -9,17 +9,17 @@ import { bodyToString, getBSU, getUniqueName, sleep } from "./utils";
 import * as dotenv from "dotenv";
 dotenv.config({ path: "../.env" });
 describe("BlobClient", () => {
-  const serviceClient = getBSU();
+  const blobServiceClient = getBSU();
   let containerName: string = getUniqueName("container");
-  let containerClient = ContainerClient.fromServiceClient(serviceClient, containerName);
+  let containerClient = ContainerClient.fromBlobServiceClient(blobServiceClient, containerName);
   let blobName: string = getUniqueName("blob");
   let blobClient = BlobClient.fromContainerClient(containerClient, blobName);
   let blockBlobClient = BlockBlobClient.fromBlobClient(blobClient);
   const content = "Hello World";
 
   beforeEach(async () => {
     containerName = getUniqueName("container");
-    containerClient = ContainerClient.fromServiceClient(serviceClient, containerName);
+    containerClient = ContainerClient.fromBlobServiceClient(blobServiceClient, containerName);
     await containerClient.create(Aborter.none);
     blobName = getUniqueName("blob");
     blobClient = BlobClient.fromContainerClient(containerClient, blobName);
@@ -252,9 +252,9 @@ describe("BlobClient", () => {
   });
 
   it("undelete", async () => {
-    const properties = await serviceClient.getProperties(Aborter.none);
+    const properties = await blobServiceClient.getProperties(Aborter.none);
     if (!properties.deleteRetentionPolicy!.enabled) {
-      await serviceClient.setProperties(Aborter.none, {
+      await blobServiceClient.setProperties(Aborter.none, {
         deleteRetentionPolicy: {
           days: 7,
           enabled: true