@azure/arm-storagecache 5.0.0 → 5.1.0

package/src/operations/ascUsages.ts

@@ -0,0 +1,158 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { AscUsages } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
+import * as Parameters from "../models/parameters";
+import { StorageCacheManagementClient } from "../storageCacheManagementClient";
+import {
+  ResourceUsage,
+  AscUsagesListNextOptionalParams,
+  AscUsagesListOptionalParams,
+  AscUsagesListResponse,
+  AscUsagesListNextResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Class containing AscUsages operations. */
+export class AscUsagesImpl implements AscUsages {
+  private readonly client: StorageCacheManagementClient;
+
+  /**
+   * Initialize a new instance of the class AscUsages class.
+   * @param client Reference to the service client
+   */
+  constructor(client: StorageCacheManagementClient) {
+    this.client = client;
+  }
+
+  /**
+   * Gets the quantity used and quota limit for resources
+   * @param location The name of the region to query for usage information.
+   * @param options The options parameters.
+   */
+  public list(
+    location: string,
+    options?: AscUsagesListOptionalParams
+  ): PagedAsyncIterableIterator<ResourceUsage> {
+    const iter = this.listPagingAll(location, options);
+    return {
+      next() {
+        return iter.next();
+      },
+      [Symbol.asyncIterator]() {
+        return this;
+      },
+      byPage: () => {
+        return this.listPagingPage(location, options);
+      }
+    };
+  }
+
+  private async *listPagingPage(
+    location: string,
+    options?: AscUsagesListOptionalParams
+  ): AsyncIterableIterator<ResourceUsage[]> {
+    let result = await this._list(location, options);
+    yield result.value || [];
+    let continuationToken = result.nextLink;
+    while (continuationToken) {
+      result = await this._listNext(location, continuationToken, options);
+      continuationToken = result.nextLink;
+      yield result.value || [];
+    }
+  }
+
+  private async *listPagingAll(
+    location: string,
+    options?: AscUsagesListOptionalParams
+  ): AsyncIterableIterator<ResourceUsage> {
+    for await (const page of this.listPagingPage(location, options)) {
+      yield* page;
+    }
+  }
+
+  /**
+   * Gets the quantity used and quota limit for resources
+   * @param location The name of the region to query for usage information.
+   * @param options The options parameters.
+   */
+  private _list(
+    location: string,
+    options?: AscUsagesListOptionalParams
+  ): Promise<AscUsagesListResponse> {
+    return this.client.sendOperationRequest(
+      { location, options },
+      listOperationSpec
+    );
+  }
+
+  /**
+   * ListNext
+   * @param location The name of the region to query for usage information.
+   * @param nextLink The nextLink from the previous successful call to the List method.
+   * @param options The options parameters.
+   */
+  private _listNext(
+    location: string,
+    nextLink: string,
+    options?: AscUsagesListNextOptionalParams
+  ): Promise<AscUsagesListNextResponse> {
+    return this.client.sendOperationRequest(
+      { location, nextLink, options },
+      listNextOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const listOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/usages",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.ResourceUsagesListResult
+    },
+    default: {
+      bodyMapper: Mappers.CloudError
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.location
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const listNextOperationSpec: coreClient.OperationSpec = {
+  path: "{nextLink}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.ResourceUsagesListResult
+    },
+    default: {
+      bodyMapper: Mappers.CloudError
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.nextLink,
+    Parameters.subscriptionId,
+    Parameters.location
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};

package/src/operations/index.ts

@@ -10,6 +10,7 @@ export * from "./operations";
 export * from "./skus";
 export * from "./usageModels";
 export * from "./ascOperations";
+export * from "./ascUsages";
 export * from "./caches";
 export * from "./storageTargets";
 export * from "./storageTargetOperations";

package/src/operations/storageTargetOperations.ts

@@ -16,7 +16,8 @@ import { LroImpl } from "../lroImpl";
 import {
   StorageTargetFlushOptionalParams,
   StorageTargetSuspendOptionalParams,
-  StorageTargetResumeOptionalParams
+  StorageTargetResumeOptionalParams,
+  StorageTargetInvalidateOptionalParams
 } from "../models";
 
 /** Class containing StorageTargetOperations operations. */
@@ -296,6 +297,96 @@ export class StorageTargetOperationsImpl implements StorageTargetOperations {
     );
     return poller.pollUntilDone();
   }
+
+  /**
+   * Invalidate all cached data for a storage target. Cached files are discarded and fetched from the
+   * back end on the next request.
+   * @param resourceGroupName Target resource group.
+   * @param cacheName Name of Cache. Length of name must not be greater than 80 and chars must be from
+   *                  the [-0-9a-zA-Z_] char class.
+   * @param storageTargetName Name of Storage Target.
+   * @param options The options parameters.
+   */
+  async beginInvalidate(
+    resourceGroupName: string,
+    cacheName: string,
+    storageTargetName: string,
+    options?: StorageTargetInvalidateOptionalParams
+  ): Promise<PollerLike<PollOperationState<void>, void>> {
+    const directSendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ): Promise<void> => {
+      return this.client.sendOperationRequest(args, spec);
+    };
+    const sendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ) => {
+      let currentRawResponse:
+        | coreClient.FullOperationResponse
+        | undefined = undefined;
+      const providedCallback = args.options?.onResponse;
+      const callback: coreClient.RawResponseCallback = (
+        rawResponse: coreClient.FullOperationResponse,
+        flatResponse: unknown
+      ) => {
+        currentRawResponse = rawResponse;
+        providedCallback?.(rawResponse, flatResponse);
+      };
+      const updatedArgs = {
+        ...args,
+        options: {
+          ...args.options,
+          onResponse: callback
+        }
+      };
+      const flatResponse = await directSendOperation(updatedArgs, spec);
+      return {
+        flatResponse,
+        rawResponse: {
+          statusCode: currentRawResponse!.status,
+          body: currentRawResponse!.parsedBody,
+          headers: currentRawResponse!.headers.toJSON()
+        }
+      };
+    };
+
+    const lro = new LroImpl(
+      sendOperation,
+      { resourceGroupName, cacheName, storageTargetName, options },
+      invalidateOperationSpec
+    );
+    return new LroEngine(lro, {
+      resumeFrom: options?.resumeFrom,
+      intervalInMs: options?.updateIntervalInMs,
+      lroResourceLocationConfig: "azure-async-operation"
+    });
+  }
+
+  /**
+   * Invalidate all cached data for a storage target. Cached files are discarded and fetched from the
+   * back end on the next request.
+   * @param resourceGroupName Target resource group.
+   * @param cacheName Name of Cache. Length of name must not be greater than 80 and chars must be from
+   *                  the [-0-9a-zA-Z_] char class.
+   * @param storageTargetName Name of Storage Target.
+   * @param options The options parameters.
+   */
+  async beginInvalidateAndWait(
+    resourceGroupName: string,
+    cacheName: string,
+    storageTargetName: string,
+    options?: StorageTargetInvalidateOptionalParams
+  ): Promise<void> {
+    const poller = await this.beginInvalidate(
+      resourceGroupName,
+      cacheName,
+      storageTargetName,
+      options
+    );
+    return poller.pollUntilDone();
+  }
 }
 // Operation Specifications
 const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
@@ -372,3 +463,27 @@ const resumeOperationSpec: coreClient.OperationSpec = {
   headerParameters: [Parameters.accept],
   serializer
 };
+const invalidateOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/invalidate",
+  httpMethod: "POST",
+  responses: {
+    200: {},
+    201: {},
+    202: {},
+    204: {},
+    default: {
+      bodyMapper: Mappers.CloudError
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.cacheName,
+    Parameters.storageTargetName
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};

package/src/operationsInterfaces/ascUsages.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { ResourceUsage, AscUsagesListOptionalParams } from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a AscUsages. */
+export interface AscUsages {
+  /**
+   * Gets the quantity used and quota limit for resources
+   * @param location The name of the region to query for usage information.
+   * @param options The options parameters.
+   */
+  list(
+    location: string,
+    options?: AscUsagesListOptionalParams
+  ): PagedAsyncIterableIterator<ResourceUsage>;
+}

package/src/operationsInterfaces/index.ts

@@ -10,6 +10,7 @@ export * from "./operations";
 export * from "./skus";
 export * from "./usageModels";
 export * from "./ascOperations";
+export * from "./ascUsages";
 export * from "./caches";
 export * from "./storageTargets";
 export * from "./storageTargetOperations";

package/src/operationsInterfaces/storageTargetOperations.ts

@@ -10,7 +10,8 @@ import { PollerLike, PollOperationState } from "@azure/core-lro";
 import {
   StorageTargetFlushOptionalParams,
   StorageTargetSuspendOptionalParams,
-  StorageTargetResumeOptionalParams
+  StorageTargetResumeOptionalParams,
+  StorageTargetInvalidateOptionalParams
 } from "../models";
 
 /** Interface representing a StorageTargetOperations. */
@@ -101,4 +102,34 @@ export interface StorageTargetOperations {
     storageTargetName: string,
     options?: StorageTargetResumeOptionalParams
   ): Promise<void>;
+  /**
+   * Invalidate all cached data for a storage target. Cached files are discarded and fetched from the
+   * back end on the next request.
+   * @param resourceGroupName Target resource group.
+   * @param cacheName Name of Cache. Length of name must not be greater than 80 and chars must be from
+   *                  the [-0-9a-zA-Z_] char class.
+   * @param storageTargetName Name of Storage Target.
+   * @param options The options parameters.
+   */
+  beginInvalidate(
+    resourceGroupName: string,
+    cacheName: string,
+    storageTargetName: string,
+    options?: StorageTargetInvalidateOptionalParams
+  ): Promise<PollerLike<PollOperationState<void>, void>>;
+  /**
+   * Invalidate all cached data for a storage target. Cached files are discarded and fetched from the
+   * back end on the next request.
+   * @param resourceGroupName Target resource group.
+   * @param cacheName Name of Cache. Length of name must not be greater than 80 and chars must be from
+   *                  the [-0-9a-zA-Z_] char class.
+   * @param storageTargetName Name of Storage Target.
+   * @param options The options parameters.
+   */
+  beginInvalidateAndWait(
+    resourceGroupName: string,
+    cacheName: string,
+    storageTargetName: string,
+    options?: StorageTargetInvalidateOptionalParams
+  ): Promise<void>;
 }

package/src/storageCacheManagementClient.ts

@@ -13,6 +13,7 @@ import {
   SkusImpl,
   UsageModelsImpl,
   AscOperationsImpl,
+  AscUsagesImpl,
   CachesImpl,
   StorageTargetsImpl,
   StorageTargetOperationsImpl
@@ -22,6 +23,7 @@ import {
   Skus,
   UsageModels,
   AscOperations,
+  AscUsages,
   Caches,
   StorageTargets,
   StorageTargetOperations
@@ -61,7 +63,7 @@ export class StorageCacheManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-storagecache/5.0.0`;
+    const packageDetails = `azsdk-js-arm-storagecache/5.1.0`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -84,11 +86,12 @@ export class StorageCacheManagementClient extends coreClient.ServiceClient {
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2021-09-01";
+    this.apiVersion = options.apiVersion || "2022-01-01";
     this.operations = new OperationsImpl(this);
     this.skus = new SkusImpl(this);
     this.usageModels = new UsageModelsImpl(this);
     this.ascOperations = new AscOperationsImpl(this);
+    this.ascUsages = new AscUsagesImpl(this);
     this.caches = new CachesImpl(this);
     this.storageTargets = new StorageTargetsImpl(this);
     this.storageTargetOperations = new StorageTargetOperationsImpl(this);
@@ -98,6 +101,7 @@ export class StorageCacheManagementClient extends coreClient.ServiceClient {
   skus: Skus;
   usageModels: UsageModels;
   ascOperations: AscOperations;
+  ascUsages: AscUsages;
   caches: Caches;
   storageTargets: StorageTargets;
   storageTargetOperations: StorageTargetOperations;

package/tsconfig.json

@@ -9,12 +9,25 @@
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
     "forceConsistentCasingInFileNames": true,
-    "lib": ["es6", "dom"],
+    "lib": [
+      "es6",
+      "dom"
+    ],
     "declaration": true,
     "outDir": "./dist-esm",
     "importHelpers": true,
-    "paths": { "@azure/arm-storagecache": ["./src/index"] }
+    "paths": {
+      "@azure/arm-storagecache": [
+        "./src/index"
+      ]
+    }
   },
-  "include": ["./src/**/*.ts", "./test/**/*.ts", "samples-dev/**/*.ts"],
-  "exclude": ["node_modules"]
-}
+  "include": [
+    "./src/**/*.ts",
+    "./test/**/*.ts",
+    "samples-dev/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

package/types/arm-storagecache.d.ts

@@ -82,6 +82,30 @@ export declare interface AscOperationsGetOptionalParams extends coreClient.Opera
 /** Contains response data for the get operation. */
 export declare type AscOperationsGetResponse = AscOperation;
 
+/** Interface representing a AscUsages. */
+export declare interface AscUsages {
+    /**
+     * Gets the quantity used and quota limit for resources
+     * @param location The name of the region to query for usage information.
+     * @param options The options parameters.
+     */
+    list(location: string, options?: AscUsagesListOptionalParams): PagedAsyncIterableIterator<ResourceUsage>;
+}
+
+/** Optional parameters. */
+export declare interface AscUsagesListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type AscUsagesListNextResponse = ResourceUsagesListResult;
+
+/** Optional parameters. */
+export declare interface AscUsagesListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type AscUsagesListResponse = ResourceUsagesListResult;
+
 /** Properties pertaining to the BlobNfsTarget. */
 export declare interface BlobNfsTarget {
     /** Resource ID of the storage container. */
@@ -154,6 +178,8 @@ declare interface Cache_2 {
     securitySettings?: CacheSecuritySettings;
     /** Specifies Directory Services settings of the cache. */
     directoryServicesSettings?: CacheDirectorySettings;
+    /** Availability zones for resources. This field should only contain a single element in the array. */
+    zones?: string[];
 }
 export { Cache_2 as Cache }
 
@@ -1034,6 +1060,52 @@ export declare interface ResourceSkusResult {
     readonly value?: ResourceSku[];
 }
 
+/** The usage and limit (quota) for a resource. */
+export declare interface ResourceUsage {
+    /**
+     * The limit (quota) for this resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly limit?: number;
+    /**
+     * Unit that the limit and usages are expressed in, such as 'Count'.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly unit?: string;
+    /**
+     * The current usage of this resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly currentValue?: number;
+    /**
+     * Naming information for this resource type.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: ResourceUsageName;
+}
+
+/** Naming information for this resource type. */
+export declare interface ResourceUsageName {
+    /** Canonical name for this resource type. */
+    value?: string;
+    /** Localized name for this resource type. */
+    localizedValue?: string;
+}
+
+/** Result of the request to list resource usages. It contains a list of resource usages & limits and a URL link to get the next set of results. */
+export declare interface ResourceUsagesListResult {
+    /**
+     * URL to get the next set of resource usage list results if there are any.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
+    /**
+     * List of usages and limits for resources controlled by the Microsoft.StorageCache resource provider.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly value?: ResourceUsage[];
+}
+
 /** The restrictions preventing this SKU from being used. */
 export declare interface Restriction {
     /**
@@ -1089,6 +1161,7 @@ export declare class StorageCacheManagementClient extends coreClient.ServiceClie
     skus: Skus;
     usageModels: UsageModels;
     ascOperations: AscOperations;
+    ascUsages: AscUsages;
     caches: Caches;
     storageTargets: StorageTargets;
     storageTargetOperations: StorageTargetOperations;
@@ -1135,6 +1208,14 @@ export declare interface StorageTargetFlushOptionalParams extends coreClient.Ope
     resumeFrom?: string;
 }
 
+/** Optional parameters. */
+export declare interface StorageTargetInvalidateOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
 /** Interface representing a StorageTargetOperations. */
 export declare interface StorageTargetOperations {
     /**
@@ -1193,6 +1274,26 @@ export declare interface StorageTargetOperations {
      * @param options The options parameters.
      */
     beginResumeAndWait(resourceGroupName: string, cacheName: string, storageTargetName: string, options?: StorageTargetResumeOptionalParams): Promise<void>;
+    /**
+     * Invalidate all cached data for a storage target. Cached files are discarded and fetched from the
+     * back end on the next request.
+     * @param resourceGroupName Target resource group.
+     * @param cacheName Name of Cache. Length of name must not be greater than 80 and chars must be from
+     *                  the [-0-9a-zA-Z_] char class.
+     * @param storageTargetName Name of Storage Target.
+     * @param options The options parameters.
+     */
+    beginInvalidate(resourceGroupName: string, cacheName: string, storageTargetName: string, options?: StorageTargetInvalidateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    /**
+     * Invalidate all cached data for a storage target. Cached files are discarded and fetched from the
+     * back end on the next request.
+     * @param resourceGroupName Target resource group.
+     * @param cacheName Name of Cache. Length of name must not be greater than 80 and chars must be from
+     *                  the [-0-9a-zA-Z_] char class.
+     * @param storageTargetName Name of Storage Target.
+     * @param options The options parameters.
+     */
+    beginInvalidateAndWait(resourceGroupName: string, cacheName: string, storageTargetName: string, options?: StorageTargetInvalidateOptionalParams): Promise<void>;
 }
 
 /** Resource used by a Cache. */