@azure/arm-resourcegraph 5.0.0-beta.3 → 5.0.0-beta.5

package/dist/esm/models/resourceHistory/index.d.ts

@@ -0,0 +1,2 @@
+export type { ResourcesHistoryRequest, ResourcesHistoryRequestOptions } from "./models.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/models/resourceHistory/index.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};
+//# sourceMappingURL=index.js.map

package/dist/esm/models/resourceHistory/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/resourceHistory/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport type { ResourcesHistoryRequest, ResourcesHistoryRequestOptions } from \"./models.js\";\n"]}

package/dist/esm/models/resourceHistory/models.d.ts

@@ -0,0 +1,32 @@
+import type { DateTimeInterval, ResultFormat } from "../resourceGraphCommon/models.js";
+/**
+ * This file contains only generated model types and their (de)serializers.
+ * Disable the following rules for internal models with '_' prefix and deserializers which require 'any' for raw JSON input.
+ */
+/** Describes a history request to be executed. */
+export interface ResourcesHistoryRequest {
+    /** Azure subscriptions against which to execute the query. */
+    subscriptions?: string[];
+    /** The resources query. */
+    query?: string;
+    /** The history request evaluation options */
+    options?: ResourcesHistoryRequestOptions;
+    /** Azure management groups against which to execute the query. Example: [ 'mg1', 'mg2' ] */
+    managementGroups?: string[];
+}
+export declare function resourcesHistoryRequestSerializer(item: ResourcesHistoryRequest): any;
+/** The options for history request evaluation */
+export interface ResourcesHistoryRequestOptions {
+    /** The time interval used to fetch history. */
+    interval?: DateTimeInterval;
+    /** The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present. */
+    top?: number;
+    /** The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present. */
+    skip?: number;
+    /** Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. */
+    skipToken?: string;
+    /** Defines in which format query result returned. */
+    resultFormat?: ResultFormat;
+}
+export declare function resourcesHistoryRequestOptionsSerializer(item: ResourcesHistoryRequestOptions): any;
+//# sourceMappingURL=models.d.ts.map

package/dist/esm/models/resourceHistory/models.js

@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { dateTimeIntervalSerializer } from "../resourceGraphCommon/models.js";
+export function resourcesHistoryRequestSerializer(item) {
+    return {
+        subscriptions: !item["subscriptions"]
+            ? item["subscriptions"]
+            : item["subscriptions"].map((p) => {
+                return p;
+            }),
+        query: item["query"],
+        options: !item["options"]
+            ? item["options"]
+            : resourcesHistoryRequestOptionsSerializer(item["options"]),
+        managementGroups: !item["managementGroups"]
+            ? item["managementGroups"]
+            : item["managementGroups"].map((p) => {
+                return p;
+            }),
+    };
+}
+export function resourcesHistoryRequestOptionsSerializer(item) {
+    return {
+        interval: !item["interval"] ? item["interval"] : dateTimeIntervalSerializer(item["interval"]),
+        $top: item["top"],
+        $skip: item["skip"],
+        $skipToken: item["skipToken"],
+        resultFormat: item["resultFormat"],
+    };
+}
+//# sourceMappingURL=models.js.map

package/dist/esm/models/resourceHistory/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../../src/models/resourceHistory/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAoB9E,MAAM,UAAU,iCAAiC,CAAC,IAA6B;IAC7E,OAAO;QACL,aAAa,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC;YACnC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;YACvB,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE;gBACnC,OAAO,CAAC,CAAC;YACX,CAAC,CAAC;QACN,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;QACpB,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC;YACvB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;YACjB,CAAC,CAAC,wCAAwC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,gBAAgB,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC;YACzC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;YAC1B,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE;gBACtC,OAAO,CAAC,CAAC;YACX,CAAC,CAAC;KACP,CAAC;AACJ,CAAC;AAgBD,MAAM,UAAU,wCAAwC,CACtD,IAAoC;IAEpC,OAAO;QACL,QAAQ,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7F,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC;QACjB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC;QACnB,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC;QAC7B,YAAY,EAAE,IAAI,CAAC,cAAc,CAAC;KACnC,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { DateTimeInterval, ResultFormat } from \"../resourceGraphCommon/models.js\";\nimport { dateTimeIntervalSerializer } from \"../resourceGraphCommon/models.js\";\n\n/**\n * This file contains only generated model types and their (de)serializers.\n * Disable the following rules for internal models with '_' prefix and deserializers which require 'any' for raw JSON input.\n */\n/* eslint-disable @typescript-eslint/naming-convention */\n/* eslint-disable @typescript-eslint/explicit-module-boundary-types */\n/** Describes a history request to be executed. */\nexport interface ResourcesHistoryRequest {\n  /** Azure subscriptions against which to execute the query. */\n  subscriptions?: string[];\n  /** The resources query. */\n  query?: string;\n  /** The history request evaluation options */\n  options?: ResourcesHistoryRequestOptions;\n  /** Azure management groups against which to execute the query. Example: [ 'mg1', 'mg2' ] */\n  managementGroups?: string[];\n}\n\nexport function resourcesHistoryRequestSerializer(item: ResourcesHistoryRequest): any {\n  return {\n    subscriptions: !item[\"subscriptions\"]\n      ? item[\"subscriptions\"]\n      : item[\"subscriptions\"].map((p: any) => {\n          return p;\n        }),\n    query: item[\"query\"],\n    options: !item[\"options\"]\n      ? item[\"options\"]\n      : resourcesHistoryRequestOptionsSerializer(item[\"options\"]),\n    managementGroups: !item[\"managementGroups\"]\n      ? item[\"managementGroups\"]\n      : item[\"managementGroups\"].map((p: any) => {\n          return p;\n        }),\n  };\n}\n\n/** The options for history request evaluation */\nexport interface ResourcesHistoryRequestOptions {\n  /** The time interval used to fetch history. */\n  interval?: DateTimeInterval;\n  /** The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present. */\n  top?: number;\n  /** The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present. */\n  skip?: number;\n  /** Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. */\n  skipToken?: string;\n  /** Defines in which format query result returned. */\n  resultFormat?: ResultFormat;\n}\n\nexport function resourcesHistoryRequestOptionsSerializer(\n  item: ResourcesHistoryRequestOptions,\n): any {\n  return {\n    interval: !item[\"interval\"] ? item[\"interval\"] : dateTimeIntervalSerializer(item[\"interval\"]),\n    $top: item[\"top\"],\n    $skip: item[\"skip\"],\n    $skipToken: item[\"skipToken\"],\n    resultFormat: item[\"resultFormat\"],\n  };\n}\n"]}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/esm/resourceGraphClient.d.ts

@@ -0,0 +1,31 @@
+import type { ResourceGraphClientOptionalParams } from "./api/index.js";
+import type { ResourcesHistoryOptionalParams, ResourcesOptionalParams, ResourceChangeDetailsOptionalParams, ResourceChangesOptionalParams } from "./api/options.js";
+import type { GraphQueryOperations } from "./classic/graphQuery/index.js";
+import type { OperationsOperations } from "./classic/operations/index.js";
+import type { ResourcesHistoryResponse } from "./models/models.js";
+import type { ResourceChangesRequestParameters, ResourceChangeList, ResourceChangeData, ResourceChangeDetailsRequestParameters } from "./models/resourceChanges/models.js";
+import type { QueryRequest, QueryResponse } from "./models/resourceGraphApi/models.js";
+import type { ResourcesHistoryRequest } from "./models/resourceHistory/models.js";
+import type { TokenCredential } from "@azure/core-auth";
+import type { Pipeline } from "@azure/core-rest-pipeline";
+export type { ResourceGraphClientOptionalParams } from "./api/resourceGraphContext.js";
+export declare class ResourceGraphClient {
+    private _client;
+    /** The pipeline used by this client to make requests */
+    readonly pipeline: Pipeline;
+    constructor(credential: TokenCredential, options?: ResourceGraphClientOptionalParams);
+    constructor(credential: TokenCredential, subscriptionId: string, options?: ResourceGraphClientOptionalParams);
+    /** List all snapshots of a resource for a given time interval. */
+    resourcesHistory(request: ResourcesHistoryRequest, options?: ResourcesHistoryOptionalParams): Promise<ResourcesHistoryResponse>;
+    /** Queries the resources managed by Azure Resource Manager for scopes specified in the request. */
+    resources(query: QueryRequest, options?: ResourcesOptionalParams): Promise<QueryResponse>;
+    /** Get resource change details. */
+    resourceChangeDetails(parameters: ResourceChangeDetailsRequestParameters, options?: ResourceChangeDetailsOptionalParams): Promise<ResourceChangeData[]>;
+    /** List changes to a resource for a given time interval. */
+    resourceChanges(parameters: ResourceChangesRequestParameters, options?: ResourceChangesOptionalParams): Promise<ResourceChangeList>;
+    /** The operation groups for graphQuery */
+    readonly graphQuery: GraphQueryOperations;
+    /** The operation groups for operations */
+    readonly operations: OperationsOperations;
+}
+//# sourceMappingURL=resourceGraphClient.d.ts.map

package/dist/esm/resourceGraphClient.js

@@ -0,0 +1,53 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { createResourceGraph } from "./api/index.js";
+import { resourcesHistory, resources, resourceChangeDetails, resourceChanges, } from "./api/operations.js";
+import { _getGraphQueryOperations } from "./classic/graphQuery/index.js";
+import { _getOperationsOperations } from "./classic/operations/index.js";
+export class ResourceGraphClient {
+    _client;
+    /** The pipeline used by this client to make requests */
+    pipeline;
+    constructor(credential, subscriptionIdOrOptions, options) {
+        let subscriptionId;
+        if (typeof subscriptionIdOrOptions === "string") {
+            subscriptionId = subscriptionIdOrOptions;
+        }
+        else if (typeof subscriptionIdOrOptions === "object") {
+            options = subscriptionIdOrOptions;
+        }
+        options = options ?? {};
+        const prefixFromOptions = options?.userAgentOptions?.userAgentPrefix;
+        const userAgentPrefix = prefixFromOptions
+            ? `${prefixFromOptions} azsdk-js-client`
+            : `azsdk-js-client`;
+        this._client = createResourceGraph(credential, subscriptionId ?? "", {
+            ...options,
+            userAgentOptions: { userAgentPrefix },
+        });
+        this.pipeline = this._client.pipeline;
+        this.graphQuery = _getGraphQueryOperations(this._client);
+        this.operations = _getOperationsOperations(this._client);
+    }
+    /** List all snapshots of a resource for a given time interval. */
+    resourcesHistory(request, options = { requestOptions: {} }) {
+        return resourcesHistory(this._client, request, options);
+    }
+    /** Queries the resources managed by Azure Resource Manager for scopes specified in the request. */
+    resources(query, options = { requestOptions: {} }) {
+        return resources(this._client, query, options);
+    }
+    /** Get resource change details. */
+    resourceChangeDetails(parameters, options = { requestOptions: {} }) {
+        return resourceChangeDetails(this._client, parameters, options);
+    }
+    /** List changes to a resource for a given time interval. */
+    resourceChanges(parameters, options = { requestOptions: {} }) {
+        return resourceChanges(this._client, parameters, options);
+    }
+    /** The operation groups for graphQuery */
+    graphQuery;
+    /** The operation groups for operations */
+    operations;
+}
+//# sourceMappingURL=resourceGraphClient.js.map

package/dist/esm/resourceGraphClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourceGraphClient.js","sourceRoot":"","sources":["../../src/resourceGraphClient.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EACL,gBAAgB,EAChB,SAAS,EACT,qBAAqB,EACrB,eAAe,GAChB,MAAM,qBAAqB,CAAC;AAQ7B,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAezE,MAAM,OAAO,mBAAmB;IACtB,OAAO,CAAuB;IACtC,wDAAwD;IACxC,QAAQ,CAAW;IAQnC,YACE,UAA2B,EAC3B,uBAAoE,EACpE,OAA2C;QAE3C,IAAI,cAAkC,CAAC;QAEvC,IAAI,OAAO,uBAAuB,KAAK,QAAQ,EAAE,CAAC;YAChD,cAAc,GAAG,uBAAuB,CAAC;QAC3C,CAAC;aAAM,IAAI,OAAO,uBAAuB,KAAK,QAAQ,EAAE,CAAC;YACvD,OAAO,GAAG,uBAAuB,CAAC;QACpC,CAAC;QAED,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,MAAM,iBAAiB,GAAG,OAAO,EAAE,gBAAgB,EAAE,eAAe,CAAC;QACrE,MAAM,eAAe,GAAG,iBAAiB;YACvC,CAAC,CAAC,GAAG,iBAAiB,kBAAkB;YACxC,CAAC,CAAC,iBAAiB,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,mBAAmB,CAAC,UAAU,EAAE,cAAc,IAAI,EAAE,EAAE;YACnE,GAAG,OAAO;YACV,gBAAgB,EAAE,EAAE,eAAe,EAAE;SACtC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACtC,IAAI,CAAC,UAAU,GAAG,wBAAwB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,IAAI,CAAC,UAAU,GAAG,wBAAwB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED,kEAAkE;IAClE,gBAAgB,CACd,OAAgC,EAChC,UAA0C,EAAE,cAAc,EAAE,EAAE,EAAE;QAEhE,OAAO,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,mGAAmG;IACnG,SAAS,CACP,KAAmB,EACnB,UAAmC,EAAE,cAAc,EAAE,EAAE,EAAE;QAEzD,OAAO,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED,mCAAmC;IACnC,qBAAqB,CACnB,UAAkD,EAClD,UAA+C,EAAE,cAAc,EAAE,EAAE,EAAE;QAErE,OAAO,qBAAqB,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED,4DAA4D;IAC5D,eAAe,CACb,UAA4C,EAC5C,UAAyC,EAAE,cAAc,EAAE,EAAE,EAAE;QAE/D,OAAO,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED,0CAA0C;IAC1B,UAAU,CAAuB;IACjD,0CAA0C;IAC1B,UAAU,CAAuB;CAClD","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ResourceGraphContext, ResourceGraphClientOptionalParams } from \"./api/index.js\";\nimport { createResourceGraph } from \"./api/index.js\";\nimport {\n  resourcesHistory,\n  resources,\n  resourceChangeDetails,\n  resourceChanges,\n} from \"./api/operations.js\";\nimport type {\n  ResourcesHistoryOptionalParams,\n  ResourcesOptionalParams,\n  ResourceChangeDetailsOptionalParams,\n  ResourceChangesOptionalParams,\n} from \"./api/options.js\";\nimport type { GraphQueryOperations } from \"./classic/graphQuery/index.js\";\nimport { _getGraphQueryOperations } from \"./classic/graphQuery/index.js\";\nimport type { OperationsOperations } from \"./classic/operations/index.js\";\nimport { _getOperationsOperations } from \"./classic/operations/index.js\";\nimport type { ResourcesHistoryResponse } from \"./models/models.js\";\nimport type {\n  ResourceChangesRequestParameters,\n  ResourceChangeList,\n  ResourceChangeData,\n  ResourceChangeDetailsRequestParameters,\n} from \"./models/resourceChanges/models.js\";\nimport type { QueryRequest, QueryResponse } from \"./models/resourceGraphApi/models.js\";\nimport type { ResourcesHistoryRequest } from \"./models/resourceHistory/models.js\";\nimport type { TokenCredential } from \"@azure/core-auth\";\nimport type { Pipeline } from \"@azure/core-rest-pipeline\";\n\nexport type { ResourceGraphClientOptionalParams } from \"./api/resourceGraphContext.js\";\n\nexport class ResourceGraphClient {\n  private _client: ResourceGraphContext;\n  /** The pipeline used by this client to make requests */\n  public readonly pipeline: Pipeline;\n\n  constructor(credential: TokenCredential, options?: ResourceGraphClientOptionalParams);\n  constructor(\n    credential: TokenCredential,\n    subscriptionId: string,\n    options?: ResourceGraphClientOptionalParams,\n  );\n  constructor(\n    credential: TokenCredential,\n    subscriptionIdOrOptions?: string | ResourceGraphClientOptionalParams,\n    options?: ResourceGraphClientOptionalParams,\n  ) {\n    let subscriptionId: string | undefined;\n\n    if (typeof subscriptionIdOrOptions === \"string\") {\n      subscriptionId = subscriptionIdOrOptions;\n    } else if (typeof subscriptionIdOrOptions === \"object\") {\n      options = subscriptionIdOrOptions;\n    }\n\n    options = options ?? {};\n    const prefixFromOptions = options?.userAgentOptions?.userAgentPrefix;\n    const userAgentPrefix = prefixFromOptions\n      ? `${prefixFromOptions} azsdk-js-client`\n      : `azsdk-js-client`;\n    this._client = createResourceGraph(credential, subscriptionId ?? \"\", {\n      ...options,\n      userAgentOptions: { userAgentPrefix },\n    });\n    this.pipeline = this._client.pipeline;\n    this.graphQuery = _getGraphQueryOperations(this._client);\n    this.operations = _getOperationsOperations(this._client);\n  }\n\n  /** List all snapshots of a resource for a given time interval. */\n  resourcesHistory(\n    request: ResourcesHistoryRequest,\n    options: ResourcesHistoryOptionalParams = { requestOptions: {} },\n  ): Promise<ResourcesHistoryResponse> {\n    return resourcesHistory(this._client, request, options);\n  }\n\n  /** Queries the resources managed by Azure Resource Manager for scopes specified in the request. */\n  resources(\n    query: QueryRequest,\n    options: ResourcesOptionalParams = { requestOptions: {} },\n  ): Promise<QueryResponse> {\n    return resources(this._client, query, options);\n  }\n\n  /** Get resource change details. */\n  resourceChangeDetails(\n    parameters: ResourceChangeDetailsRequestParameters,\n    options: ResourceChangeDetailsOptionalParams = { requestOptions: {} },\n  ): Promise<ResourceChangeData[]> {\n    return resourceChangeDetails(this._client, parameters, options);\n  }\n\n  /** List changes to a resource for a given time interval. */\n  resourceChanges(\n    parameters: ResourceChangesRequestParameters,\n    options: ResourceChangesOptionalParams = { requestOptions: {} },\n  ): Promise<ResourceChangeList> {\n    return resourceChanges(this._client, parameters, options);\n  }\n\n  /** The operation groups for graphQuery */\n  public readonly graphQuery: GraphQueryOperations;\n  /** The operation groups for operations */\n  public readonly operations: OperationsOperations;\n}\n"]}

package/dist/esm/static-helpers/cloudSettingHelpers.d.ts

@@ -0,0 +1,22 @@
+/**
+ * An enum to describe Azure Cloud environments.
+ * @enum {string}
+ */
+export declare enum AzureClouds {
+    /** Azure public cloud, which is the default cloud for Azure SDKs. */
+    AZURE_PUBLIC_CLOUD = "AZURE_PUBLIC_CLOUD",
+    /** Azure China cloud */
+    AZURE_CHINA_CLOUD = "AZURE_CHINA_CLOUD",
+    /** Azure US government cloud */
+    AZURE_US_GOVERNMENT = "AZURE_US_GOVERNMENT"
+}
+/** The supported values for cloud setting as a string literal type */
+export type AzureSupportedClouds = `${AzureClouds}`;
+/**
+ * Gets the Azure Resource Manager endpoint URL for the specified cloud setting.
+ * @param cloudSetting - The Azure cloud environment setting. Use one of the AzureClouds enum values.
+ * @returns The ARM endpoint URL for the specified cloud, or undefined if cloudSetting is undefined.
+ * @throws {Error} Throws an error if an unknown cloud setting is provided.
+ */
+export declare function getArmEndpoint(cloudSetting?: AzureSupportedClouds): string | undefined;
+//# sourceMappingURL=cloudSettingHelpers.d.ts.map

package/dist/esm/static-helpers/cloudSettingHelpers.js

@@ -0,0 +1,38 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * An enum to describe Azure Cloud environments.
+ * @enum {string}
+ */
+export var AzureClouds;
+(function (AzureClouds) {
+    /** Azure public cloud, which is the default cloud for Azure SDKs. */
+    AzureClouds["AZURE_PUBLIC_CLOUD"] = "AZURE_PUBLIC_CLOUD";
+    /** Azure China cloud */
+    AzureClouds["AZURE_CHINA_CLOUD"] = "AZURE_CHINA_CLOUD";
+    /** Azure US government cloud */
+    AzureClouds["AZURE_US_GOVERNMENT"] = "AZURE_US_GOVERNMENT";
+})(AzureClouds || (AzureClouds = {}));
+/**
+ * Gets the Azure Resource Manager endpoint URL for the specified cloud setting.
+ * @param cloudSetting - The Azure cloud environment setting. Use one of the AzureClouds enum values.
+ * @returns The ARM endpoint URL for the specified cloud, or undefined if cloudSetting is undefined.
+ * @throws {Error} Throws an error if an unknown cloud setting is provided.
+ */
+export function getArmEndpoint(cloudSetting) {
+    if (cloudSetting === undefined) {
+        return undefined;
+    }
+    const cloudEndpoints = {
+        AZURE_CHINA_CLOUD: "https://management.chinacloudapi.cn/",
+        AZURE_US_GOVERNMENT: "https://management.usgovcloudapi.net/",
+        AZURE_PUBLIC_CLOUD: "https://management.azure.com/",
+    };
+    if (cloudSetting in cloudEndpoints) {
+        return cloudEndpoints[cloudSetting];
+    }
+    else {
+        throw new Error(`Unknown cloud setting: ${cloudSetting}. Please refer to the enum AzureClouds for possible values.`);
+    }
+}
+//# sourceMappingURL=cloudSettingHelpers.js.map

package/dist/esm/static-helpers/cloudSettingHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudSettingHelpers.js","sourceRoot":"","sources":["../../../src/static-helpers/cloudSettingHelpers.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;GAGG;AACH,MAAM,CAAN,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,qEAAqE;IACrE,wDAAyC,CAAA;IACzC,wBAAwB;IACxB,sDAAuC,CAAA;IACvC,gCAAgC;IAChC,0DAA2C,CAAA;AAC7C,CAAC,EAPW,WAAW,KAAX,WAAW,QAOtB;AAKD;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,YAAmC;IAChE,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,cAAc,GAA6C;QAC/D,iBAAiB,EAAE,sCAAsC;QACzD,mBAAmB,EAAE,uCAAuC;QAC5D,kBAAkB,EAAE,+BAA+B;KACpD,CAAC;IACF,IAAI,YAAY,IAAI,cAAc,EAAE,CAAC;QACnC,OAAO,cAAc,CAAC,YAAY,CAAC,CAAC;IACtC,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CACb,0BAA0B,YAAY,6DAA6D,CACpG,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * An enum to describe Azure Cloud environments.\n * @enum {string}\n */\nexport enum AzureClouds {\n  /** Azure public cloud, which is the default cloud for Azure SDKs. */\n  AZURE_PUBLIC_CLOUD = \"AZURE_PUBLIC_CLOUD\",\n  /** Azure China cloud */\n  AZURE_CHINA_CLOUD = \"AZURE_CHINA_CLOUD\",\n  /** Azure US government cloud */\n  AZURE_US_GOVERNMENT = \"AZURE_US_GOVERNMENT\",\n}\n\n/** The supported values for cloud setting as a string literal type */\nexport type AzureSupportedClouds = `${AzureClouds}`;\n\n/**\n * Gets the Azure Resource Manager endpoint URL for the specified cloud setting.\n * @param cloudSetting - The Azure cloud environment setting. Use one of the AzureClouds enum values.\n * @returns The ARM endpoint URL for the specified cloud, or undefined if cloudSetting is undefined.\n * @throws {Error} Throws an error if an unknown cloud setting is provided.\n */\nexport function getArmEndpoint(cloudSetting?: AzureSupportedClouds): string | undefined {\n  if (cloudSetting === undefined) {\n    return undefined;\n  }\n  const cloudEndpoints: Record<keyof typeof AzureClouds, string> = {\n    AZURE_CHINA_CLOUD: \"https://management.chinacloudapi.cn/\",\n    AZURE_US_GOVERNMENT: \"https://management.usgovcloudapi.net/\",\n    AZURE_PUBLIC_CLOUD: \"https://management.azure.com/\",\n  };\n  if (cloudSetting in cloudEndpoints) {\n    return cloudEndpoints[cloudSetting];\n  } else {\n    throw new Error(\n      `Unknown cloud setting: ${cloudSetting}. Please refer to the enum AzureClouds for possible values.`,\n    );\n  }\n}\n"]}

package/dist/esm/static-helpers/pagingHelpers.d.ts

@@ -0,0 +1,74 @@
+import type { Client, PathUncheckedResponse } from "@azure-rest/core-client";
+/**
+ * Options for the byPage method
+ */
+export interface PageSettings {
+    /**
+     * A reference to a specific page to start iterating from.
+     */
+    continuationToken?: string;
+}
+/**
+ * An interface that describes a page of results.
+ */
+export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
+    /**
+     * The token that keeps track of where to continue the iterator
+     */
+    continuationToken?: string;
+};
+/**
+ * An interface that allows async iterable iteration both to completion and by page.
+ */
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
+    /**
+     * The next method, part of the iteration protocol
+     */
+    next(): Promise<IteratorResult<TElement>>;
+    /**
+     * The connection to the async iterator, part of the iteration protocol
+     */
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    /**
+     * Return an AsyncIterableIterator that works a page at a time
+     */
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
+}
+/**
+ * An interface that describes how to communicate with the service.
+ */
+export interface PagedResult<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
+    /**
+     * Link to the first page of results.
+     */
+    firstPageLink?: string;
+    /**
+     * A method that returns a page of results.
+     */
+    getPage: (pageLink?: string) => Promise<{
+        page: TPage;
+        nextPageLink?: string;
+    } | undefined>;
+    /**
+     * a function to implement the `byPage` method on the paged async iterator.
+     */
+    byPage?: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
+    /**
+     * A function to extract elements from a page.
+     */
+    toElements?: (page: TPage) => TElement[];
+}
+/**
+ * Options for the paging helper
+ */
+export interface BuildPagedAsyncIteratorOptions {
+    itemName?: string;
+    nextLinkName?: string;
+    nextLinkMethod?: "GET" | "POST";
+    apiVersion?: string;
+}
+/**
+ * Helper to paginate results in a generic way and return a PagedAsyncIterableIterator
+ */
+export declare function buildPagedAsyncIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings, TResponse extends PathUncheckedResponse = PathUncheckedResponse>(client: Client, getInitialResponse: () => PromiseLike<TResponse>, processResponseBody: (result: TResponse) => PromiseLike<unknown>, expectedStatuses: string[], options?: BuildPagedAsyncIteratorOptions): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+//# sourceMappingURL=pagingHelpers.d.ts.map

package/dist/esm/static-helpers/pagingHelpers.js

@@ -0,0 +1,143 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { createRestError } from "@azure-rest/core-client";
+import { RestError } from "@azure/core-rest-pipeline";
+/**
+ * Helper to paginate results in a generic way and return a PagedAsyncIterableIterator
+ */
+export function buildPagedAsyncIterator(client, getInitialResponse, processResponseBody, expectedStatuses, options = {}) {
+    const itemName = options.itemName ?? "value";
+    const nextLinkName = options.nextLinkName ?? "nextLink";
+    const nextLinkMethod = options.nextLinkMethod ?? "GET";
+    const apiVersion = options.apiVersion;
+    const pagedResult = {
+        getPage: async (pageLink) => {
+            let result;
+            if (pageLink === undefined) {
+                result = await getInitialResponse();
+            }
+            else {
+                const resolvedPageLink = apiVersion ? addApiVersionToUrl(pageLink, apiVersion) : pageLink;
+                result =
+                    nextLinkMethod === "POST"
+                        ? await client.pathUnchecked(resolvedPageLink).post()
+                        : await client.pathUnchecked(resolvedPageLink).get();
+            }
+            checkPagingRequest(result, expectedStatuses);
+            const results = await processResponseBody(result);
+            const nextLink = getNextLink(results, nextLinkName);
+            const values = getElements(results, itemName);
+            return {
+                page: values,
+                nextPageLink: nextLink,
+            };
+        },
+        byPage: (settings) => {
+            const { continuationToken } = settings ?? {};
+            return getPageAsyncIterator(pagedResult, {
+                pageLink: continuationToken,
+            });
+        },
+    };
+    return getPagedAsyncIterator(pagedResult);
+}
+/**
+ * returns an async iterator that iterates over results. It also has a `byPage`
+ * method that returns pages of items at once.
+ *
+ * @param pagedResult - an object that specifies how to get pages.
+ * @returns a paged async iterator that iterates over results.
+ */
+function getPagedAsyncIterator(pagedResult) {
+    const iter = getItemAsyncIterator(pagedResult);
+    return {
+        next() {
+            return iter.next();
+        },
+        [Symbol.asyncIterator]() {
+            return this;
+        },
+        byPage: pagedResult?.byPage ??
+            ((settings) => {
+                const { continuationToken } = settings ?? {};
+                return getPageAsyncIterator(pagedResult, {
+                    pageLink: continuationToken,
+                });
+            }),
+    };
+}
+async function* getItemAsyncIterator(pagedResult) {
+    const pages = getPageAsyncIterator(pagedResult);
+    for await (const page of pages) {
+        yield* page;
+    }
+}
+async function* getPageAsyncIterator(pagedResult, options = {}) {
+    const { pageLink } = options;
+    let response = await pagedResult.getPage(pageLink ?? pagedResult.firstPageLink);
+    if (!response) {
+        return;
+    }
+    let result = response.page;
+    result.continuationToken = response.nextPageLink;
+    yield result;
+    while (response.nextPageLink) {
+        response = await pagedResult.getPage(response.nextPageLink);
+        if (!response) {
+            return;
+        }
+        result = response.page;
+        result.continuationToken = response.nextPageLink;
+        yield result;
+    }
+}
+/**
+ * Gets for the value of nextLink in the body
+ */
+function getNextLink(body, nextLinkName) {
+    if (!nextLinkName) {
+        return undefined;
+    }
+    const nextLink = body[nextLinkName];
+    if (typeof nextLink !== "string" && typeof nextLink !== "undefined" && nextLink !== null) {
+        throw new RestError(`Body Property ${nextLinkName} should be a string or undefined or null but got ${typeof nextLink}`);
+    }
+    if (nextLink === null) {
+        return undefined;
+    }
+    return nextLink;
+}
+/**
+ * Gets the elements of the current request in the body.
+ */
+function getElements(body, itemName) {
+    const value = body[itemName];
+    if (!Array.isArray(value)) {
+        throw new RestError(`Couldn't paginate response\n Body doesn't contain an array property with name: ${itemName}`);
+    }
+    return value ?? [];
+}
+/**
+ * Checks if a request failed
+ */
+function checkPagingRequest(response, expectedStatuses) {
+    if (!expectedStatuses.includes(response.status)) {
+        throw createRestError(`Pagination failed with unexpected statusCode ${response.status}`, response);
+    }
+}
+/**
+ * Adds the api-version query parameter on a URL if it's not present.
+ * @param url - the URL to modify
+ * @param apiVersion - the API version to set
+ * @returns - the URL with the api-version query parameter set
+ */
+function addApiVersionToUrl(url, apiVersion) {
+    // The base URL is only used for parsing and won't appear in the returned URL
+    const urlObj = new URL(url, "https://microsoft.com");
+    if (!urlObj.searchParams.get("api-version")) {
+        // Append one if there is no apiVersion
+        return `${url}${urlObj.search ? "&" : "?"}api-version=${apiVersion}`;
+    }
+    return url;
+}
+//# sourceMappingURL=pagingHelpers.js.map

package/dist/esm/static-helpers/pagingHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagingHelpers.js","sourceRoot":"","sources":["../../../src/static-helpers/pagingHelpers.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAiFtD;;GAEG;AACH,MAAM,UAAU,uBAAuB,CAMrC,MAAc,EACd,kBAAgD,EAChD,mBAAgE,EAChE,gBAA0B,EAC1B,UAA0C,EAAE;IAE5C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC;IAC7C,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,UAAU,CAAC;IACxD,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,KAAK,CAAC;IACvD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACtC,MAAM,WAAW,GAAgD;QAC/D,OAAO,EAAE,KAAK,EAAE,QAAiB,EAAE,EAAE;YACnC,IAAI,MAAM,CAAC;YACX,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,MAAM,GAAG,MAAM,kBAAkB,EAAE,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACN,MAAM,gBAAgB,GAAG,UAAU,CAAC,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAC1F,MAAM;oBACJ,cAAc,KAAK,MAAM;wBACvB,CAAC,CAAC,MAAM,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,IAAI,EAAE;wBACrD,CAAC,CAAC,MAAM,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,GAAG,EAAE,CAAC;YAC3D,CAAC;YACD,kBAAkB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;YAC7C,MAAM,OAAO,GAAG,MAAM,mBAAmB,CAAC,MAAmB,CAAC,CAAC;YAC/D,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;YACpD,MAAM,MAAM,GAAG,WAAW,CAAW,OAAO,EAAE,QAAQ,CAAU,CAAC;YACjE,OAAO;gBACL,IAAI,EAAE,MAAM;gBACZ,YAAY,EAAE,QAAQ;aACvB,CAAC;QACJ,CAAC;QACD,MAAM,EAAE,CAAC,QAAwB,EAAE,EAAE;YACnC,MAAM,EAAE,iBAAiB,EAAE,GAAG,QAAQ,IAAI,EAAE,CAAC;YAC7C,OAAO,oBAAoB,CAAC,WAAW,EAAE;gBACvC,QAAQ,EAAE,iBAAiB;aAC5B,CAAC,CAAC;QACL,CAAC;KACF,CAAC;IACF,OAAO,qBAAqB,CAAC,WAAW,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;;GAMG;AAEH,SAAS,qBAAqB,CAK5B,WAAwD;IAExD,MAAM,IAAI,GAAG,oBAAoB,CAAiC,WAAW,CAAC,CAAC;IAC/E,OAAO;QACL,IAAI;YACF,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;QACrB,CAAC;QACD,CAAC,MAAM,CAAC,aAAa,CAAC;YACpB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,EACJ,WAAW,EAAE,MAAM;YACnB,CAAC,CAAC,QAAwB,EAAE,EAAE;gBAC5B,MAAM,EAAE,iBAAiB,EAAE,GAAG,QAAQ,IAAI,EAAE,CAAC;gBAC7C,OAAO,oBAAoB,CAAC,WAAW,EAAE;oBACvC,QAAQ,EAAE,iBAAiB;iBAC5B,CAAC,CAAC;YACL,CAAC,CAAC;KACL,CAAC;AACJ,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,oBAAoB,CAClC,WAAwD;IAExD,MAAM,KAAK,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;IAChD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC/B,KAAK,CAAC,CAAC,IAA6B,CAAC;IACvC,CAAC;AACH,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,oBAAoB,CAClC,WAAwD,EACxD,UAEI,EAAE;IAEN,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAC7B,IAAI,QAAQ,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,QAAQ,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC;IAChF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO;IACT,CAAC;IACD,IAAI,MAAM,GAAG,QAAQ,CAAC,IAAwC,CAAC;IAC/D,MAAM,CAAC,iBAAiB,GAAG,QAAQ,CAAC,YAAY,CAAC;IACjD,MAAM,MAAM,CAAC;IACb,OAAO,QAAQ,CAAC,YAAY,EAAE,CAAC;QAC7B,QAAQ,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAC5D,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO;QACT,CAAC;QACD,MAAM,GAAG,QAAQ,CAAC,IAAwC,CAAC;QAC3D,MAAM,CAAC,iBAAiB,GAAG,QAAQ,CAAC,YAAY,CAAC;QACjD,MAAM,MAAM,CAAC;IACf,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAC,IAAa,EAAE,YAAqB;IACvD,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAI,IAAgC,CAAC,YAAY,CAAC,CAAC;IAEjE,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,OAAO,QAAQ,KAAK,WAAW,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACzF,MAAM,IAAI,SAAS,CACjB,iBAAiB,YAAY,oDAAoD,OAAO,QAAQ,EAAE,CACnG,CAAC;IACJ,CAAC;IAED,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAc,IAAa,EAAE,QAAgB;IAC/D,MAAM,KAAK,GAAI,IAAgC,CAAC,QAAQ,CAAQ,CAAC;IACjE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,SAAS,CACjB,kFAAkF,QAAQ,EAAE,CAC7F,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,IAAI,EAAE,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAC,QAA+B,EAAE,gBAA0B;IACrF,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,MAAM,eAAe,CACnB,gDAAgD,QAAQ,CAAC,MAAM,EAAE,EACjE,QAAQ,CACT,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,GAAW,EAAE,UAAkB;IACzD,6EAA6E;IAC7E,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC;QAC5C,uCAAuC;QACvC,OAAO,GAAG,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,eAAe,UAAU,EAAE,CAAC;IACvE,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { Client, PathUncheckedResponse } from \"@azure-rest/core-client\";\nimport { createRestError } from \"@azure-rest/core-client\";\nimport { RestError } from \"@azure/core-rest-pipeline\";\n\n/**\n * Options for the byPage method\n */\nexport interface PageSettings {\n  /**\n   * A reference to a specific page to start iterating from.\n   */\n  continuationToken?: string;\n}\n\n/**\n * An interface that describes a page of results.\n */\nexport type ContinuablePage<TElement, TPage = TElement[]> = TPage & {\n  /**\n   * The token that keeps track of where to continue the iterator\n   */\n  continuationToken?: string;\n};\n\n/**\n * An interface that allows async iterable iteration both to completion and by page.\n */\nexport interface PagedAsyncIterableIterator<\n  TElement,\n  TPage = TElement[],\n  TPageSettings extends PageSettings = PageSettings,\n> {\n  /**\n   * The next method, part of the iteration protocol\n   */\n  next(): Promise<IteratorResult<TElement>>;\n  /**\n   * The connection to the async iterator, part of the iteration protocol\n   */\n  [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;\n  /**\n   * Return an AsyncIterableIterator that works a page at a time\n   */\n  byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;\n}\n\n/**\n * An interface that describes how to communicate with the service.\n */\nexport interface PagedResult<\n  TElement,\n  TPage = TElement[],\n  TPageSettings extends PageSettings = PageSettings,\n> {\n  /**\n   * Link to the first page of results.\n   */\n  firstPageLink?: string;\n  /**\n   * A method that returns a page of results.\n   */\n  getPage: (pageLink?: string) => Promise<{ page: TPage; nextPageLink?: string } | undefined>;\n  /**\n   * a function to implement the `byPage` method on the paged async iterator.\n   */\n  byPage?: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;\n\n  /**\n   * A function to extract elements from a page.\n   */\n  toElements?: (page: TPage) => TElement[];\n}\n\n/**\n * Options for the paging helper\n */\nexport interface BuildPagedAsyncIteratorOptions {\n  itemName?: string;\n  nextLinkName?: string;\n  nextLinkMethod?: \"GET\" | \"POST\";\n  apiVersion?: string;\n}\n\n/**\n * Helper to paginate results in a generic way and return a PagedAsyncIterableIterator\n */\nexport function buildPagedAsyncIterator<\n  TElement,\n  TPage = TElement[],\n  TPageSettings extends PageSettings = PageSettings,\n  TResponse extends PathUncheckedResponse = PathUncheckedResponse,\n>(\n  client: Client,\n  getInitialResponse: () => PromiseLike<TResponse>,\n  processResponseBody: (result: TResponse) => PromiseLike<unknown>,\n  expectedStatuses: string[],\n  options: BuildPagedAsyncIteratorOptions = {},\n): PagedAsyncIterableIterator<TElement, TPage, TPageSettings> {\n  const itemName = options.itemName ?? \"value\";\n  const nextLinkName = options.nextLinkName ?? \"nextLink\";\n  const nextLinkMethod = options.nextLinkMethod ?? \"GET\";\n  const apiVersion = options.apiVersion;\n  const pagedResult: PagedResult<TElement, TPage, TPageSettings> = {\n    getPage: async (pageLink?: string) => {\n      let result;\n      if (pageLink === undefined) {\n        result = await getInitialResponse();\n      } else {\n        const resolvedPageLink = apiVersion ? addApiVersionToUrl(pageLink, apiVersion) : pageLink;\n        result =\n          nextLinkMethod === \"POST\"\n            ? await client.pathUnchecked(resolvedPageLink).post()\n            : await client.pathUnchecked(resolvedPageLink).get();\n      }\n      checkPagingRequest(result, expectedStatuses);\n      const results = await processResponseBody(result as TResponse);\n      const nextLink = getNextLink(results, nextLinkName);\n      const values = getElements<TElement>(results, itemName) as TPage;\n      return {\n        page: values,\n        nextPageLink: nextLink,\n      };\n    },\n    byPage: (settings?: TPageSettings) => {\n      const { continuationToken } = settings ?? {};\n      return getPageAsyncIterator(pagedResult, {\n        pageLink: continuationToken,\n      });\n    },\n  };\n  return getPagedAsyncIterator(pagedResult);\n}\n\n/**\n * returns an async iterator that iterates over results. It also has a `byPage`\n * method that returns pages of items at once.\n *\n * @param pagedResult - an object that specifies how to get pages.\n * @returns a paged async iterator that iterates over results.\n */\n\nfunction getPagedAsyncIterator<\n  TElement,\n  TPage = TElement[],\n  TPageSettings extends PageSettings = PageSettings,\n>(\n  pagedResult: PagedResult<TElement, TPage, TPageSettings>,\n): PagedAsyncIterableIterator<TElement, TPage, TPageSettings> {\n  const iter = getItemAsyncIterator<TElement, TPage, TPageSettings>(pagedResult);\n  return {\n    next() {\n      return iter.next();\n    },\n    [Symbol.asyncIterator]() {\n      return this;\n    },\n    byPage:\n      pagedResult?.byPage ??\n      ((settings?: TPageSettings) => {\n        const { continuationToken } = settings ?? {};\n        return getPageAsyncIterator(pagedResult, {\n          pageLink: continuationToken,\n        });\n      }),\n  };\n}\n\nasync function* getItemAsyncIterator<TElement, TPage, TPageSettings extends PageSettings>(\n  pagedResult: PagedResult<TElement, TPage, TPageSettings>,\n): AsyncIterableIterator<TElement> {\n  const pages = getPageAsyncIterator(pagedResult);\n  for await (const page of pages) {\n    yield* page as unknown as TElement[];\n  }\n}\n\nasync function* getPageAsyncIterator<TElement, TPage, TPageSettings extends PageSettings>(\n  pagedResult: PagedResult<TElement, TPage, TPageSettings>,\n  options: {\n    pageLink?: string;\n  } = {},\n): AsyncIterableIterator<ContinuablePage<TElement, TPage>> {\n  const { pageLink } = options;\n  let response = await pagedResult.getPage(pageLink ?? pagedResult.firstPageLink);\n  if (!response) {\n    return;\n  }\n  let result = response.page as ContinuablePage<TElement, TPage>;\n  result.continuationToken = response.nextPageLink;\n  yield result;\n  while (response.nextPageLink) {\n    response = await pagedResult.getPage(response.nextPageLink);\n    if (!response) {\n      return;\n    }\n    result = response.page as ContinuablePage<TElement, TPage>;\n    result.continuationToken = response.nextPageLink;\n    yield result;\n  }\n}\n\n/**\n * Gets for the value of nextLink in the body\n */\nfunction getNextLink(body: unknown, nextLinkName?: string): string | undefined {\n  if (!nextLinkName) {\n    return undefined;\n  }\n\n  const nextLink = (body as Record<string, unknown>)[nextLinkName];\n\n  if (typeof nextLink !== \"string\" && typeof nextLink !== \"undefined\" && nextLink !== null) {\n    throw new RestError(\n      `Body Property ${nextLinkName} should be a string or undefined or null but got ${typeof nextLink}`,\n    );\n  }\n\n  if (nextLink === null) {\n    return undefined;\n  }\n\n  return nextLink;\n}\n\n/**\n * Gets the elements of the current request in the body.\n */\nfunction getElements<T = unknown>(body: unknown, itemName: string): T[] {\n  const value = (body as Record<string, unknown>)[itemName] as T[];\n  if (!Array.isArray(value)) {\n    throw new RestError(\n      `Couldn't paginate response\\n Body doesn't contain an array property with name: ${itemName}`,\n    );\n  }\n\n  return value ?? [];\n}\n\n/**\n * Checks if a request failed\n */\nfunction checkPagingRequest(response: PathUncheckedResponse, expectedStatuses: string[]): void {\n  if (!expectedStatuses.includes(response.status)) {\n    throw createRestError(\n      `Pagination failed with unexpected statusCode ${response.status}`,\n      response,\n    );\n  }\n}\n\n/**\n * Adds the api-version query parameter on a URL if it's not present.\n * @param url - the URL to modify\n * @param apiVersion - the API version to set\n * @returns - the URL with the api-version query parameter set\n */\nfunction addApiVersionToUrl(url: string, apiVersion: string): string {\n  // The base URL is only used for parsing and won't appear in the returned URL\n  const urlObj = new URL(url, \"https://microsoft.com\");\n  if (!urlObj.searchParams.get(\"api-version\")) {\n    // Append one if there is no apiVersion\n    return `${url}${urlObj.search ? \"&\" : \"?\"}api-version=${apiVersion}`;\n  }\n  return url;\n}\n"]}

package/dist/esm/static-helpers/serialization/check-prop-undefined.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns true if all specified properties of the item are undefined.
+ * @param item The object to check.
+ * @param properties The list of property names to check on the item.
+ * @returns True if all specified properties are undefined, otherwise false.
+ */
+export declare function areAllPropsUndefined(item: Record<string, any>, properties: string[]): boolean;
+//# sourceMappingURL=check-prop-undefined.d.ts.map

package/dist/esm/static-helpers/serialization/check-prop-undefined.js

@@ -0,0 +1,17 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * Returns true if all specified properties of the item are undefined.
+ * @param item The object to check.
+ * @param properties The list of property names to check on the item.
+ * @returns True if all specified properties are undefined, otherwise false.
+ */
+export function areAllPropsUndefined(item, properties) {
+    for (const property of properties) {
+        if (item[property] !== undefined) {
+            return false;
+        }
+    }
+    return true;
+}
+//# sourceMappingURL=check-prop-undefined.js.map

package/dist/esm/static-helpers/serialization/check-prop-undefined.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-prop-undefined.js","sourceRoot":"","sources":["../../../../src/static-helpers/serialization/check-prop-undefined.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAyB,EAAE,UAAoB;IAClF,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;QAClC,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Returns true if all specified properties of the item are undefined.\n * @param item The object to check.\n * @param properties The list of property names to check on the item.\n * @returns True if all specified properties are undefined, otherwise false.\n */\nexport function areAllPropsUndefined(item: Record<string, any>, properties: string[]): boolean {\n  for (const property of properties) {\n    if (item[property] !== undefined) {\n      return false;\n    }\n  }\n  return true;\n}\n"]}

package/dist/esm/static-helpers/serialization/serialize-record.d.ts

@@ -0,0 +1,2 @@
+export declare function serializeRecord(item: any, excludes?: string[], serializer?: (item: any) => any): Record<string, any>;
+//# sourceMappingURL=serialize-record.d.ts.map

package/dist/esm/static-helpers/serialization/serialize-record.js

@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export function serializeRecord(item, excludes, serializer) {
+    const propertiesToExclude = excludes ?? [];
+    const res = {};
+    for (const key of Object.keys(item)) {
+        if (propertiesToExclude.includes(key) || item[key] === undefined) {
+            continue;
+        }
+        if (serializer) {
+            res[key] = serializer(item[key]);
+        }
+        else {
+            res[key] = item[key];
+        }
+    }
+    return res;
+}
+//# sourceMappingURL=serialize-record.js.map

package/dist/esm/static-helpers/serialization/serialize-record.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serialize-record.js","sourceRoot":"","sources":["../../../../src/static-helpers/serialization/serialize-record.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,UAAU,eAAe,CAC7B,IAAS,EACT,QAAmB,EACnB,UAA+B;IAE/B,MAAM,mBAAmB,GAAG,QAAQ,IAAI,EAAE,CAAC;IAC3C,MAAM,GAAG,GAAQ,EAAE,CAAC;IACpB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACpC,IAAI,mBAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;YACjE,SAAS;QACX,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACf,GAAG,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAQ,CAAC;QAC9B,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport function serializeRecord(\n  item: any,\n  excludes?: string[],\n  serializer?: (item: any) => any,\n): Record<string, any> {\n  const propertiesToExclude = excludes ?? [];\n  const res: any = {};\n  for (const key of Object.keys(item)) {\n    if (propertiesToExclude.includes(key) || item[key] === undefined) {\n      continue;\n    }\n    if (serializer) {\n      res[key] = serializer(item[key]);\n    } else {\n      res[key] = item[key] as any;\n    }\n  }\n  return res;\n}\n"]}

package/dist/esm/static-helpers/urlTemplate.d.ts

@@ -0,0 +1,5 @@
+export interface UrlTemplateOptions {
+    allowReserved?: boolean;
+}
+export declare function expandUrlTemplate(template: string, context: Record<string, any>, option?: UrlTemplateOptions): string;
+//# sourceMappingURL=urlTemplate.d.ts.map