@azure/arm-containerregistry 10.1.1-alpha.20230918.1 → 11.0.0-alpha.20230920.2

package/src/operations/cacheRules.ts

@@ -0,0 +1,661 @@
+/*
+ * 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, PageSettings } from "@azure/core-paging";
+import { setContinuationToken } from "../pagingHelper";
+import { CacheRules } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
+import * as Parameters from "../models/parameters";
+import { ContainerRegistryManagementClient } from "../containerRegistryManagementClient";
+import {
+  SimplePollerLike,
+  OperationState,
+  createHttpPoller
+} from "@azure/core-lro";
+import { createLroSpec } from "../lroImpl";
+import {
+  CacheRule,
+  CacheRulesListNextOptionalParams,
+  CacheRulesListOptionalParams,
+  CacheRulesListResponse,
+  CacheRulesGetOptionalParams,
+  CacheRulesGetResponse,
+  CacheRulesCreateOptionalParams,
+  CacheRulesCreateResponse,
+  CacheRulesDeleteOptionalParams,
+  CacheRulesDeleteResponse,
+  CacheRuleUpdateParameters,
+  CacheRulesUpdateOptionalParams,
+  CacheRulesUpdateResponse,
+  CacheRulesListNextResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Class containing CacheRules operations. */
+export class CacheRulesImpl implements CacheRules {
+  private readonly client: ContainerRegistryManagementClient;
+
+  /**
+   * Initialize a new instance of the class CacheRules class.
+   * @param client Reference to the service client
+   */
+  constructor(client: ContainerRegistryManagementClient) {
+    this.client = client;
+  }
+
+  /**
+   * Lists all cache rule resources for the specified container registry.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param registryName The name of the container registry.
+   * @param options The options parameters.
+   */
+  public list(
+    resourceGroupName: string,
+    registryName: string,
+    options?: CacheRulesListOptionalParams
+  ): PagedAsyncIterableIterator<CacheRule> {
+    const iter = this.listPagingAll(resourceGroupName, registryName, options);
+    return {
+      next() {
+        return iter.next();
+      },
+      [Symbol.asyncIterator]() {
+        return this;
+      },
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listPagingPage(
+          resourceGroupName,
+          registryName,
+          options,
+          settings
+        );
+      }
+    };
+  }
+
+  private async *listPagingPage(
+    resourceGroupName: string,
+    registryName: string,
+    options?: CacheRulesListOptionalParams,
+    settings?: PageSettings
+  ): AsyncIterableIterator<CacheRule[]> {
+    let result: CacheRulesListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(resourceGroupName, registryName, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
+    while (continuationToken) {
+      result = await this._listNext(
+        resourceGroupName,
+        registryName,
+        continuationToken,
+        options
+      );
+      continuationToken = result.nextLink;
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
+  }
+
+  private async *listPagingAll(
+    resourceGroupName: string,
+    registryName: string,
+    options?: CacheRulesListOptionalParams
+  ): AsyncIterableIterator<CacheRule> {
+    for await (const page of this.listPagingPage(
+      resourceGroupName,
+      registryName,
+      options
+    )) {
+      yield* page;
+    }
+  }
+
+  /**
+   * Lists all cache rule resources for the specified container registry.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param registryName The name of the container registry.
+   * @param options The options parameters.
+   */
+  private _list(
+    resourceGroupName: string,
+    registryName: string,
+    options?: CacheRulesListOptionalParams
+  ): Promise<CacheRulesListResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, registryName, options },
+      listOperationSpec
+    );
+  }
+
+  /**
+   * Gets the properties of the specified cache rule resource.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param registryName The name of the container registry.
+   * @param cacheRuleName The name of the cache rule.
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    registryName: string,
+    cacheRuleName: string,
+    options?: CacheRulesGetOptionalParams
+  ): Promise<CacheRulesGetResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, registryName, cacheRuleName, options },
+      getOperationSpec
+    );
+  }
+
+  /**
+   * Creates a cache rule for a container registry with the specified parameters.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param registryName The name of the container registry.
+   * @param cacheRuleName The name of the cache rule.
+   * @param cacheRuleCreateParameters The parameters for creating a cache rule.
+   * @param options The options parameters.
+   */
+  async beginCreate(
+    resourceGroupName: string,
+    registryName: string,
+    cacheRuleName: string,
+    cacheRuleCreateParameters: CacheRule,
+    options?: CacheRulesCreateOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<CacheRulesCreateResponse>,
+      CacheRulesCreateResponse
+    >
+  > {
+    const directSendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ): Promise<CacheRulesCreateResponse> => {
+      return this.client.sendOperationRequest(args, spec);
+    };
+    const sendOperationFn = 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 = createLroSpec({
+      sendOperationFn,
+      args: {
+        resourceGroupName,
+        registryName,
+        cacheRuleName,
+        cacheRuleCreateParameters,
+        options
+      },
+      spec: createOperationSpec
+    });
+    const poller = await createHttpPoller<
+      CacheRulesCreateResponse,
+      OperationState<CacheRulesCreateResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
+      intervalInMs: options?.updateIntervalInMs,
+      resourceLocationConfig: "azure-async-operation"
+    });
+    await poller.poll();
+    return poller;
+  }
+
+  /**
+   * Creates a cache rule for a container registry with the specified parameters.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param registryName The name of the container registry.
+   * @param cacheRuleName The name of the cache rule.
+   * @param cacheRuleCreateParameters The parameters for creating a cache rule.
+   * @param options The options parameters.
+   */
+  async beginCreateAndWait(
+    resourceGroupName: string,
+    registryName: string,
+    cacheRuleName: string,
+    cacheRuleCreateParameters: CacheRule,
+    options?: CacheRulesCreateOptionalParams
+  ): Promise<CacheRulesCreateResponse> {
+    const poller = await this.beginCreate(
+      resourceGroupName,
+      registryName,
+      cacheRuleName,
+      cacheRuleCreateParameters,
+      options
+    );
+    return poller.pollUntilDone();
+  }
+
+  /**
+   * Deletes a cache rule resource from a container registry.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param registryName The name of the container registry.
+   * @param cacheRuleName The name of the cache rule.
+   * @param options The options parameters.
+   */
+  async beginDelete(
+    resourceGroupName: string,
+    registryName: string,
+    cacheRuleName: string,
+    options?: CacheRulesDeleteOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<CacheRulesDeleteResponse>,
+      CacheRulesDeleteResponse
+    >
+  > {
+    const directSendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ): Promise<CacheRulesDeleteResponse> => {
+      return this.client.sendOperationRequest(args, spec);
+    };
+    const sendOperationFn = 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 = createLroSpec({
+      sendOperationFn,
+      args: { resourceGroupName, registryName, cacheRuleName, options },
+      spec: deleteOperationSpec
+    });
+    const poller = await createHttpPoller<
+      CacheRulesDeleteResponse,
+      OperationState<CacheRulesDeleteResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
+      intervalInMs: options?.updateIntervalInMs,
+      resourceLocationConfig: "location"
+    });
+    await poller.poll();
+    return poller;
+  }
+
+  /**
+   * Deletes a cache rule resource from a container registry.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param registryName The name of the container registry.
+   * @param cacheRuleName The name of the cache rule.
+   * @param options The options parameters.
+   */
+  async beginDeleteAndWait(
+    resourceGroupName: string,
+    registryName: string,
+    cacheRuleName: string,
+    options?: CacheRulesDeleteOptionalParams
+  ): Promise<CacheRulesDeleteResponse> {
+    const poller = await this.beginDelete(
+      resourceGroupName,
+      registryName,
+      cacheRuleName,
+      options
+    );
+    return poller.pollUntilDone();
+  }
+
+  /**
+   * Updates a cache rule for a container registry with the specified parameters.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param registryName The name of the container registry.
+   * @param cacheRuleName The name of the cache rule.
+   * @param cacheRuleUpdateParameters The parameters for updating a cache rule.
+   * @param options The options parameters.
+   */
+  async beginUpdate(
+    resourceGroupName: string,
+    registryName: string,
+    cacheRuleName: string,
+    cacheRuleUpdateParameters: CacheRuleUpdateParameters,
+    options?: CacheRulesUpdateOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<CacheRulesUpdateResponse>,
+      CacheRulesUpdateResponse
+    >
+  > {
+    const directSendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ): Promise<CacheRulesUpdateResponse> => {
+      return this.client.sendOperationRequest(args, spec);
+    };
+    const sendOperationFn = 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 = createLroSpec({
+      sendOperationFn,
+      args: {
+        resourceGroupName,
+        registryName,
+        cacheRuleName,
+        cacheRuleUpdateParameters,
+        options
+      },
+      spec: updateOperationSpec
+    });
+    const poller = await createHttpPoller<
+      CacheRulesUpdateResponse,
+      OperationState<CacheRulesUpdateResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
+      intervalInMs: options?.updateIntervalInMs,
+      resourceLocationConfig: "azure-async-operation"
+    });
+    await poller.poll();
+    return poller;
+  }
+
+  /**
+   * Updates a cache rule for a container registry with the specified parameters.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param registryName The name of the container registry.
+   * @param cacheRuleName The name of the cache rule.
+   * @param cacheRuleUpdateParameters The parameters for updating a cache rule.
+   * @param options The options parameters.
+   */
+  async beginUpdateAndWait(
+    resourceGroupName: string,
+    registryName: string,
+    cacheRuleName: string,
+    cacheRuleUpdateParameters: CacheRuleUpdateParameters,
+    options?: CacheRulesUpdateOptionalParams
+  ): Promise<CacheRulesUpdateResponse> {
+    const poller = await this.beginUpdate(
+      resourceGroupName,
+      registryName,
+      cacheRuleName,
+      cacheRuleUpdateParameters,
+      options
+    );
+    return poller.pollUntilDone();
+  }
+
+  /**
+   * ListNext
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param registryName The name of the container registry.
+   * @param nextLink The nextLink from the previous successful call to the List method.
+   * @param options The options parameters.
+   */
+  private _listNext(
+    resourceGroupName: string,
+    registryName: string,
+    nextLink: string,
+    options?: CacheRulesListNextOptionalParams
+  ): Promise<CacheRulesListNextResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, registryName, nextLink, options },
+      listNextOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const listOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.CacheRulesListResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.registryName
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const getOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules/{cacheRuleName}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.CacheRule
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.registryName,
+    Parameters.cacheRuleName
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const createOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules/{cacheRuleName}",
+  httpMethod: "PUT",
+  responses: {
+    200: {
+      bodyMapper: Mappers.CacheRule
+    },
+    201: {
+      bodyMapper: Mappers.CacheRule
+    },
+    202: {
+      bodyMapper: Mappers.CacheRule
+    },
+    204: {
+      bodyMapper: Mappers.CacheRule
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  requestBody: Parameters.cacheRuleCreateParameters,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.registryName,
+    Parameters.cacheRuleName
+  ],
+  headerParameters: [Parameters.accept, Parameters.contentType],
+  mediaType: "json",
+  serializer
+};
+const deleteOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules/{cacheRuleName}",
+  httpMethod: "DELETE",
+  responses: {
+    200: {
+      headersMapper: Mappers.CacheRulesDeleteHeaders
+    },
+    201: {
+      headersMapper: Mappers.CacheRulesDeleteHeaders
+    },
+    202: {
+      headersMapper: Mappers.CacheRulesDeleteHeaders
+    },
+    204: {
+      headersMapper: Mappers.CacheRulesDeleteHeaders
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.registryName,
+    Parameters.cacheRuleName
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const updateOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules/{cacheRuleName}",
+  httpMethod: "PATCH",
+  responses: {
+    200: {
+      bodyMapper: Mappers.CacheRule
+    },
+    201: {
+      bodyMapper: Mappers.CacheRule
+    },
+    202: {
+      bodyMapper: Mappers.CacheRule
+    },
+    204: {
+      bodyMapper: Mappers.CacheRule
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  requestBody: Parameters.cacheRuleUpdateParameters,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.registryName,
+    Parameters.cacheRuleName
+  ],
+  headerParameters: [Parameters.accept, Parameters.contentType],
+  mediaType: "json",
+  serializer
+};
+const listNextOperationSpec: coreClient.OperationSpec = {
+  path: "{nextLink}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.CacheRulesListResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.registryName,
+    Parameters.nextLink
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};