@azure/arm-hybridcompute 5.0.0-beta.1 → 5.0.0-beta.2

package/dist/esm/restorePollerHelpers.d.ts

@@ -0,0 +1,21 @@
+import type { HybridComputeManagementClient } from "./hybridComputeManagementClient.js";
+import type { OperationOptions, PathUncheckedResponse } from "@azure-rest/core-client";
+import type { AbortSignalLike } from "@azure/abort-controller";
+import type { PollerLike, OperationState } from "@azure/core-lro";
+export interface RestorePollerOptions<TResult, TResponse extends PathUncheckedResponse = PathUncheckedResponse> extends OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /**
+     * The signal which can be used to abort requests.
+     */
+    abortSignal?: AbortSignalLike;
+    /** Deserialization function for raw response body */
+    processResponseBody?: (result: TResponse) => Promise<TResult>;
+}
+/**
+ * Creates a poller from the serialized state of another poller. This can be
+ * useful when you want to create pollers on a different host or a poller
+ * needs to be constructed after the original one is not in scope.
+ */
+export declare function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: HybridComputeManagementClient, serializedState: string, sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult>): PollerLike<OperationState<TResult>, TResult>;
+//# sourceMappingURL=restorePollerHelpers.d.ts.map

package/dist/esm/restorePollerHelpers.js

@@ -0,0 +1,146 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { _setupExtensionsDeserialize, _upgradeExtensionsDeserialize } from "./api/operations.js";
+import { _$deleteDeserialize } from "./api/privateLinkScopes/operations.js";
+import { _reconcileForPrivateLinkScopeDeserialize } from "./api/networkSecurityPerimeterConfigurations/operations.js";
+import { _$deleteDeserialize as _$deleteDeserializePrivateEndpointConnections, _createOrUpdateDeserialize, } from "./api/privateEndpointConnections/operations.js";
+import { _$deleteDeserialize as _$deleteDeserializeGateways, _createOrUpdateDeserialize as _createOrUpdateDeserializeGateways, } from "./api/gateways/operations.js";
+import { _$deleteDeserialize as _$deleteDeserializeMachineRunCommands, _createOrUpdateDeserialize as _createOrUpdateDeserializeMachineRunCommands, } from "./api/machineRunCommands/operations.js";
+import { _$deleteDeserialize as _$deleteDeserializeMachineExtensions, _updateDeserialize, _createOrUpdateDeserialize as _createOrUpdateDeserializeMachineExtensions, } from "./api/machineExtensions/operations.js";
+import { _$deleteDeserialize as _$deleteDeserializeLicenseProfiles, _updateDeserialize as _updateDeserializeLicenseProfiles, _createOrUpdateDeserialize as _createOrUpdateDeserializeLicenseProfiles, } from "./api/licenseProfiles/operations.js";
+import { _installPatchesDeserialize, _assessPatchesDeserialize, _$deleteDeserialize as _$deleteDeserializeMachines, } from "./api/machines/operations.js";
+import { _validateLicenseDeserialize, _$deleteDeserialize as _$deleteDeserializeLicenses, _updateDeserialize as _updateDeserializeLicenses, _createOrUpdateDeserialize as _createOrUpdateDeserializeLicenses, } from "./api/licenses/operations.js";
+import { getLongRunningPoller } from "./static-helpers/pollingHelpers.js";
+import { deserializeState } from "@azure/core-lro";
+/**
+ * Creates a poller from the serialized state of another poller. This can be
+ * useful when you want to create pollers on a different host or a poller
+ * needs to be constructed after the original one is not in scope.
+ */
+export function restorePoller(client, serializedState, sourceOperation, options) {
+    const pollerConfig = deserializeState(serializedState).config;
+    const { initialRequestUrl, requestMethod, metadata } = pollerConfig;
+    if (!initialRequestUrl || !requestMethod) {
+        throw new Error(`Invalid serialized state: ${serializedState} for sourceOperation ${sourceOperation?.name}`);
+    }
+    const resourceLocationConfig = metadata?.["resourceLocationConfig"];
+    const { deserializer, expectedStatuses = [] } = getDeserializationHelper(initialRequestUrl, requestMethod) ?? {};
+    const deserializeHelper = options?.processResponseBody ?? deserializer;
+    if (!deserializeHelper) {
+        throw new Error(`Please ensure the operation is in this client! We can't find its deserializeHelper for ${sourceOperation?.name}.`);
+    }
+    const apiVersion = getApiVersionFromUrl(initialRequestUrl);
+    return getLongRunningPoller(client["_client"] ?? client, deserializeHelper, expectedStatuses, {
+        updateIntervalInMs: options?.updateIntervalInMs,
+        abortSignal: options?.abortSignal,
+        resourceLocationConfig,
+        restoreFrom: serializedState,
+        initialRequestUrl,
+        apiVersion,
+    });
+}
+const deserializeMap = {
+    "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/addExtensions": { deserializer: _setupExtensionsDeserialize, expectedStatuses: ["202", "200", "201"] },
+    "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/upgradeExtensions": { deserializer: _upgradeExtensionsDeserialize, expectedStatuses: ["202", "200", "201"] },
+    "DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}": { deserializer: _$deleteDeserialize, expectedStatuses: ["200", "202", "204"] },
+    "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/networkSecurityPerimeterConfigurations/{perimeterName}/reconcile": {
+        deserializer: _reconcileForPrivateLinkScopeDeserialize,
+        expectedStatuses: ["202", "200", "201"],
+    },
+    "DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}": {
+        deserializer: _$deleteDeserializePrivateEndpointConnections,
+        expectedStatuses: ["200", "202", "204"],
+    },
+    "PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}": { deserializer: _createOrUpdateDeserialize, expectedStatuses: ["200", "202", "201"] },
+    "DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName}": { deserializer: _$deleteDeserializeGateways, expectedStatuses: ["202", "204", "200"] },
+    "PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName}": { deserializer: _createOrUpdateDeserializeGateways, expectedStatuses: ["200", "201", "202"] },
+    "DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}": {
+        deserializer: _$deleteDeserializeMachineRunCommands,
+        expectedStatuses: ["202", "204", "200"],
+    },
+    "PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}": {
+        deserializer: _createOrUpdateDeserializeMachineRunCommands,
+        expectedStatuses: ["200", "201", "202"],
+    },
+    "DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}": { deserializer: _$deleteDeserializeMachineExtensions, expectedStatuses: ["200", "202", "204"] },
+    "PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}": { deserializer: _updateDeserialize, expectedStatuses: ["200", "202", "201"] },
+    "PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}": {
+        deserializer: _createOrUpdateDeserializeMachineExtensions,
+        expectedStatuses: ["200", "202", "201"],
+    },
+    "DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles/{licenseProfileName}": { deserializer: _$deleteDeserializeLicenseProfiles, expectedStatuses: ["202", "204", "200"] },
+    "PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles/{licenseProfileName}": { deserializer: _updateDeserializeLicenseProfiles, expectedStatuses: ["200", "202", "201"] },
+    "PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles/{licenseProfileName}": {
+        deserializer: _createOrUpdateDeserializeLicenseProfiles,
+        expectedStatuses: ["200", "201", "202"],
+    },
+    "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/installPatches": { deserializer: _installPatchesDeserialize, expectedStatuses: ["200", "202", "201"] },
+    "POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/assessPatches": { deserializer: _assessPatchesDeserialize, expectedStatuses: ["200", "202", "201"] },
+    "DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}": { deserializer: _$deleteDeserializeMachines, expectedStatuses: ["202", "204", "200"] },
+    "POST /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/validateLicense": {
+        deserializer: _validateLicenseDeserialize,
+        expectedStatuses: ["200", "201", "202"],
+    },
+    "DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses/{licenseName}": { deserializer: _$deleteDeserializeLicenses, expectedStatuses: ["200", "204", "202"] },
+    "PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses/{licenseName}": { deserializer: _updateDeserializeLicenses, expectedStatuses: ["200", "201", "202"] },
+    "PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses/{licenseName}": { deserializer: _createOrUpdateDeserializeLicenses, expectedStatuses: ["200", "201", "202"] },
+};
+function getDeserializationHelper(urlStr, method) {
+    const path = new URL(urlStr).pathname;
+    const pathParts = path.split("/");
+    // Traverse list to match the longest candidate
+    // matchedLen: the length of candidate path
+    // matchedValue: the matched status code array
+    let matchedLen = -1, matchedValue;
+    // Iterate the responseMap to find a match
+    for (const [key, value] of Object.entries(deserializeMap)) {
+        // Extracting the path from the map key which is in format
+        // GET /path/foo
+        if (!key.startsWith(method)) {
+            continue;
+        }
+        const candidatePath = getPathFromMapKey(key);
+        // Get each part of the url path
+        const candidateParts = candidatePath.split("/");
+        // track if we have found a match to return the values found.
+        let found = true;
+        for (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {
+            if (candidateParts[i]?.startsWith("{") && candidateParts[i]?.indexOf("}") !== -1) {
+                const start = candidateParts[i].indexOf("}") + 1, end = candidateParts[i]?.length;
+                // If the current part of the candidate is a "template" part
+                // Try to use the suffix of pattern to match the path
+                // {guid} ==> $
+                // {guid}:export ==> :export$
+                const isMatched = new RegExp(`${candidateParts[i]?.slice(start, end)}`).test(pathParts[j] || "");
+                if (!isMatched) {
+                    found = false;
+                    break;
+                }
+                continue;
+            }
+            // If the candidate part is not a template and
+            // the parts don't match mark the candidate as not found
+            // to move on with the next candidate path.
+            if (candidateParts[i] !== pathParts[j]) {
+                found = false;
+                break;
+            }
+        }
+        // We finished evaluating the current candidate parts
+        // Update the matched value if and only if we found the longer pattern
+        if (found && candidatePath.length > matchedLen) {
+            matchedLen = candidatePath.length;
+            matchedValue = value;
+        }
+    }
+    return matchedValue;
+}
+function getPathFromMapKey(mapKey) {
+    const pathStart = mapKey.indexOf("/");
+    return mapKey.slice(pathStart);
+}
+function getApiVersionFromUrl(urlStr) {
+    const url = new URL(urlStr);
+    return url.searchParams.get("api-version") ?? undefined;
+}
+//# sourceMappingURL=restorePollerHelpers.js.map

package/dist/esm/restorePollerHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"restorePollerHelpers.js","sourceRoot":"","sources":["../../src/restorePollerHelpers.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,2BAA2B,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AACjG,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AAC5E,OAAO,EAAE,wCAAwC,EAAE,MAAM,4DAA4D,CAAC;AACtH,OAAO,EACL,mBAAmB,IAAI,6CAA6C,EACpE,0BAA0B,GAC3B,MAAM,gDAAgD,CAAC;AACxD,OAAO,EACL,mBAAmB,IAAI,2BAA2B,EAClD,0BAA0B,IAAI,kCAAkC,GACjE,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,mBAAmB,IAAI,qCAAqC,EAC5D,0BAA0B,IAAI,4CAA4C,GAC3E,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,mBAAmB,IAAI,oCAAoC,EAC3D,kBAAkB,EAClB,0BAA0B,IAAI,2CAA2C,GAC1E,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACL,mBAAmB,IAAI,kCAAkC,EACzD,kBAAkB,IAAI,iCAAiC,EACvD,0BAA0B,IAAI,yCAAyC,GACxE,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACL,0BAA0B,EAC1B,yBAAyB,EACzB,mBAAmB,IAAI,2BAA2B,GACnD,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,2BAA2B,EAC3B,mBAAmB,IAAI,2BAA2B,EAClD,kBAAkB,IAAI,0BAA0B,EAChD,0BAA0B,IAAI,kCAAkC,GACjE,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAI1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAgBnD;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAqC,EACrC,eAAuB,EACvB,eAAiF,EACjF,OAAuC;IAEvC,MAAM,YAAY,GAAG,gBAAgB,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC;IAC9D,MAAM,EAAE,iBAAiB,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,YAAY,CAAC;IACpE,IAAI,CAAC,iBAAiB,IAAI,CAAC,aAAa,EAAE,CAAC;QACzC,MAAM,IAAI,KAAK,CACb,6BAA6B,eAAe,wBAAwB,eAAe,EAAE,IAAI,EAAE,CAC5F,CAAC;IACJ,CAAC;IACD,MAAM,sBAAsB,GAAG,QAAQ,EAAE,CAAC,wBAAwB,CAErD,CAAC;IACd,MAAM,EAAE,YAAY,EAAE,gBAAgB,GAAG,EAAE,EAAE,GAC3C,wBAAwB,CAAC,iBAAiB,EAAE,aAAa,CAAC,IAAI,EAAE,CAAC;IACnE,MAAM,iBAAiB,GAAG,OAAO,EAAE,mBAAmB,IAAI,YAAY,CAAC;IACvE,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,0FAA0F,eAAe,EAAE,IAAI,GAAG,CACnH,CAAC;IACJ,CAAC;IACD,MAAM,UAAU,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;IAC3D,OAAO,oBAAoB,CACxB,MAAc,CAAC,SAAS,CAAC,IAAI,MAAM,EACpC,iBAA4D,EAC5D,gBAAgB,EAChB;QACE,kBAAkB,EAAE,OAAO,EAAE,kBAAkB;QAC/C,WAAW,EAAE,OAAO,EAAE,WAAW;QACjC,sBAAsB;QACtB,WAAW,EAAE,eAAe;QAC5B,iBAAiB;QACjB,UAAU;KACX,CACF,CAAC;AACJ,CAAC;AAOD,MAAM,cAAc,GAA0C;IAC5D,gJAAgJ,EAC9I,EAAE,YAAY,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IACxF,oJAAoJ,EAClJ,EAAE,YAAY,EAAE,6BAA6B,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IAC1F,2IAA2I,EACzI,EAAE,YAAY,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IAChF,0MAA0M,EACxM;QACE,YAAY,EAAE,wCAAwC;QACtD,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACxC;IACH,sMAAsM,EACpM;QACE,YAAY,EAAE,6CAA6C;QAC3D,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACxC;IACH,mMAAmM,EACjM,EAAE,YAAY,EAAE,0BAA0B,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IACvF,oIAAoI,EAClI,EAAE,YAAY,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IACxF,iIAAiI,EAC/H,EAAE,YAAY,EAAE,kCAAkC,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IAC/F,iKAAiK,EAC/J;QACE,YAAY,EAAE,qCAAqC;QACnD,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACxC;IACH,8JAA8J,EAC5J;QACE,YAAY,EAAE,4CAA4C;QAC1D,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACxC;IACH,+JAA+J,EAC7J,EAAE,YAAY,EAAE,oCAAoC,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IACjG,8JAA8J,EAC5J,EAAE,YAAY,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IAC/E,4JAA4J,EAC1J;QACE,YAAY,EAAE,2CAA2C;QACzD,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACxC;IACH,yKAAyK,EACvK,EAAE,YAAY,EAAE,kCAAkC,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IAC/F,wKAAwK,EACtK,EAAE,YAAY,EAAE,iCAAiC,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IAC9F,sKAAsK,EACpK;QACE,YAAY,EAAE,yCAAyC;QACvD,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACxC;IACH,0IAA0I,EACxI,EAAE,YAAY,EAAE,0BAA0B,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IACvF,yIAAyI,EACvI,EAAE,YAAY,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IACtF,oIAAoI,EAClI,EAAE,YAAY,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IACxF,wFAAwF,EAAE;QACxF,YAAY,EAAE,2BAA2B;QACzC,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACxC;IACD,oIAAoI,EAClI,EAAE,YAAY,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IACxF,mIAAmI,EACjI,EAAE,YAAY,EAAE,0BAA0B,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;IACvF,iIAAiI,EAC/H,EAAE,YAAY,EAAE,kCAAkC,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE;CAChG,CAAC;AAEF,SAAS,wBAAwB,CAC/B,MAAc,EACd,MAAc;IAEd,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC;IACtC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAElC,+CAA+C;IAC/C,2CAA2C;IAC3C,8CAA8C;IAC9C,IAAI,UAAU,GAAG,CAAC,CAAC,EACjB,YAA+C,CAAC;IAElD,0CAA0C;IAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;QAC1D,0DAA0D;QAC1D,gBAAgB;QAChB,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;QACD,MAAM,aAAa,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAC7C,gCAAgC;QAChC,MAAM,cAAc,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEhD,6DAA6D;QAC7D,IAAI,KAAK,GAAG,IAAI,CAAC;QACjB,KAAK,IAAI,CAAC,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7F,IAAI,cAAc,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjF,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAC/C,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;gBAClC,4DAA4D;gBAC5D,qDAAqD;gBACrD,eAAe;gBACf,6BAA6B;gBAC7B,MAAM,SAAS,GAAG,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAC1E,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,CACnB,CAAC;gBAEF,IAAI,CAAC,SAAS,EAAE,CAAC;oBACf,KAAK,GAAG,KAAK,CAAC;oBACd,MAAM;gBACR,CAAC;gBACD,SAAS;YACX,CAAC;YAED,8CAA8C;YAC9C,wDAAwD;YACxD,2CAA2C;YAC3C,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;gBACvC,KAAK,GAAG,KAAK,CAAC;gBACd,MAAM;YACR,CAAC;QACH,CAAC;QAED,qDAAqD;QACrD,sEAAsE;QACtE,IAAI,KAAK,IAAI,aAAa,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YAC/C,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC;YAClC,YAAY,GAAG,KAAK,CAAC;QACvB,CAAC;IACH,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAc;IACvC,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAc;IAC1C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5B,OAAO,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,SAAS,CAAC;AAC1D,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { HybridComputeManagementClient } from \"./hybridComputeManagementClient.js\";\nimport { _setupExtensionsDeserialize, _upgradeExtensionsDeserialize } from \"./api/operations.js\";\nimport { _$deleteDeserialize } from \"./api/privateLinkScopes/operations.js\";\nimport { _reconcileForPrivateLinkScopeDeserialize } from \"./api/networkSecurityPerimeterConfigurations/operations.js\";\nimport {\n  _$deleteDeserialize as _$deleteDeserializePrivateEndpointConnections,\n  _createOrUpdateDeserialize,\n} from \"./api/privateEndpointConnections/operations.js\";\nimport {\n  _$deleteDeserialize as _$deleteDeserializeGateways,\n  _createOrUpdateDeserialize as _createOrUpdateDeserializeGateways,\n} from \"./api/gateways/operations.js\";\nimport {\n  _$deleteDeserialize as _$deleteDeserializeMachineRunCommands,\n  _createOrUpdateDeserialize as _createOrUpdateDeserializeMachineRunCommands,\n} from \"./api/machineRunCommands/operations.js\";\nimport {\n  _$deleteDeserialize as _$deleteDeserializeMachineExtensions,\n  _updateDeserialize,\n  _createOrUpdateDeserialize as _createOrUpdateDeserializeMachineExtensions,\n} from \"./api/machineExtensions/operations.js\";\nimport {\n  _$deleteDeserialize as _$deleteDeserializeLicenseProfiles,\n  _updateDeserialize as _updateDeserializeLicenseProfiles,\n  _createOrUpdateDeserialize as _createOrUpdateDeserializeLicenseProfiles,\n} from \"./api/licenseProfiles/operations.js\";\nimport {\n  _installPatchesDeserialize,\n  _assessPatchesDeserialize,\n  _$deleteDeserialize as _$deleteDeserializeMachines,\n} from \"./api/machines/operations.js\";\nimport {\n  _validateLicenseDeserialize,\n  _$deleteDeserialize as _$deleteDeserializeLicenses,\n  _updateDeserialize as _updateDeserializeLicenses,\n  _createOrUpdateDeserialize as _createOrUpdateDeserializeLicenses,\n} from \"./api/licenses/operations.js\";\nimport { getLongRunningPoller } from \"./static-helpers/pollingHelpers.js\";\nimport type { OperationOptions, PathUncheckedResponse } from \"@azure-rest/core-client\";\nimport type { AbortSignalLike } from \"@azure/abort-controller\";\nimport type { PollerLike, OperationState, ResourceLocationConfig } from \"@azure/core-lro\";\nimport { deserializeState } from \"@azure/core-lro\";\n\nexport interface RestorePollerOptions<\n  TResult,\n  TResponse extends PathUncheckedResponse = PathUncheckedResponse,\n> extends OperationOptions {\n  /** Delay to wait until next poll, in milliseconds. */\n  updateIntervalInMs?: number;\n  /**\n   * The signal which can be used to abort requests.\n   */\n  abortSignal?: AbortSignalLike;\n  /** Deserialization function for raw response body */\n  processResponseBody?: (result: TResponse) => Promise<TResult>;\n}\n\n/**\n * Creates a poller from the serialized state of another poller. This can be\n * useful when you want to create pollers on a different host or a poller\n * needs to be constructed after the original one is not in scope.\n */\nexport function restorePoller<TResponse extends PathUncheckedResponse, TResult>(\n  client: HybridComputeManagementClient,\n  serializedState: string,\n  sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>,\n  options?: RestorePollerOptions<TResult>,\n): PollerLike<OperationState<TResult>, TResult> {\n  const pollerConfig = deserializeState(serializedState).config;\n  const { initialRequestUrl, requestMethod, metadata } = pollerConfig;\n  if (!initialRequestUrl || !requestMethod) {\n    throw new Error(\n      `Invalid serialized state: ${serializedState} for sourceOperation ${sourceOperation?.name}`,\n    );\n  }\n  const resourceLocationConfig = metadata?.[\"resourceLocationConfig\"] as\n    | ResourceLocationConfig\n    | undefined;\n  const { deserializer, expectedStatuses = [] } =\n    getDeserializationHelper(initialRequestUrl, requestMethod) ?? {};\n  const deserializeHelper = options?.processResponseBody ?? deserializer;\n  if (!deserializeHelper) {\n    throw new Error(\n      `Please ensure the operation is in this client! We can't find its deserializeHelper for ${sourceOperation?.name}.`,\n    );\n  }\n  const apiVersion = getApiVersionFromUrl(initialRequestUrl);\n  return getLongRunningPoller(\n    (client as any)[\"_client\"] ?? client,\n    deserializeHelper as (result: TResponse) => Promise<TResult>,\n    expectedStatuses,\n    {\n      updateIntervalInMs: options?.updateIntervalInMs,\n      abortSignal: options?.abortSignal,\n      resourceLocationConfig,\n      restoreFrom: serializedState,\n      initialRequestUrl,\n      apiVersion,\n    },\n  );\n}\n\ninterface DeserializationHelper {\n  deserializer: (result: PathUncheckedResponse) => Promise<any>;\n  expectedStatuses: string[];\n}\n\nconst deserializeMap: Record<string, DeserializationHelper> = {\n  \"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/addExtensions\":\n    { deserializer: _setupExtensionsDeserialize, expectedStatuses: [\"202\", \"200\", \"201\"] },\n  \"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/upgradeExtensions\":\n    { deserializer: _upgradeExtensionsDeserialize, expectedStatuses: [\"202\", \"200\", \"201\"] },\n  \"DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}\":\n    { deserializer: _$deleteDeserialize, expectedStatuses: [\"200\", \"202\", \"204\"] },\n  \"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/networkSecurityPerimeterConfigurations/{perimeterName}/reconcile\":\n    {\n      deserializer: _reconcileForPrivateLinkScopeDeserialize,\n      expectedStatuses: [\"202\", \"200\", \"201\"],\n    },\n  \"DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}\":\n    {\n      deserializer: _$deleteDeserializePrivateEndpointConnections,\n      expectedStatuses: [\"200\", \"202\", \"204\"],\n    },\n  \"PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}\":\n    { deserializer: _createOrUpdateDeserialize, expectedStatuses: [\"200\", \"202\", \"201\"] },\n  \"DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName}\":\n    { deserializer: _$deleteDeserializeGateways, expectedStatuses: [\"202\", \"204\", \"200\"] },\n  \"PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName}\":\n    { deserializer: _createOrUpdateDeserializeGateways, expectedStatuses: [\"200\", \"201\", \"202\"] },\n  \"DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}\":\n    {\n      deserializer: _$deleteDeserializeMachineRunCommands,\n      expectedStatuses: [\"202\", \"204\", \"200\"],\n    },\n  \"PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}\":\n    {\n      deserializer: _createOrUpdateDeserializeMachineRunCommands,\n      expectedStatuses: [\"200\", \"201\", \"202\"],\n    },\n  \"DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}\":\n    { deserializer: _$deleteDeserializeMachineExtensions, expectedStatuses: [\"200\", \"202\", \"204\"] },\n  \"PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}\":\n    { deserializer: _updateDeserialize, expectedStatuses: [\"200\", \"202\", \"201\"] },\n  \"PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}\":\n    {\n      deserializer: _createOrUpdateDeserializeMachineExtensions,\n      expectedStatuses: [\"200\", \"202\", \"201\"],\n    },\n  \"DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles/{licenseProfileName}\":\n    { deserializer: _$deleteDeserializeLicenseProfiles, expectedStatuses: [\"202\", \"204\", \"200\"] },\n  \"PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles/{licenseProfileName}\":\n    { deserializer: _updateDeserializeLicenseProfiles, expectedStatuses: [\"200\", \"202\", \"201\"] },\n  \"PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles/{licenseProfileName}\":\n    {\n      deserializer: _createOrUpdateDeserializeLicenseProfiles,\n      expectedStatuses: [\"200\", \"201\", \"202\"],\n    },\n  \"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/installPatches\":\n    { deserializer: _installPatchesDeserialize, expectedStatuses: [\"200\", \"202\", \"201\"] },\n  \"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/assessPatches\":\n    { deserializer: _assessPatchesDeserialize, expectedStatuses: [\"200\", \"202\", \"201\"] },\n  \"DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}\":\n    { deserializer: _$deleteDeserializeMachines, expectedStatuses: [\"202\", \"204\", \"200\"] },\n  \"POST /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/validateLicense\": {\n    deserializer: _validateLicenseDeserialize,\n    expectedStatuses: [\"200\", \"201\", \"202\"],\n  },\n  \"DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses/{licenseName}\":\n    { deserializer: _$deleteDeserializeLicenses, expectedStatuses: [\"200\", \"204\", \"202\"] },\n  \"PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses/{licenseName}\":\n    { deserializer: _updateDeserializeLicenses, expectedStatuses: [\"200\", \"201\", \"202\"] },\n  \"PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses/{licenseName}\":\n    { deserializer: _createOrUpdateDeserializeLicenses, expectedStatuses: [\"200\", \"201\", \"202\"] },\n};\n\nfunction getDeserializationHelper(\n  urlStr: string,\n  method: string,\n): DeserializationHelper | undefined {\n  const path = new URL(urlStr).pathname;\n  const pathParts = path.split(\"/\");\n\n  // Traverse list to match the longest candidate\n  // matchedLen: the length of candidate path\n  // matchedValue: the matched status code array\n  let matchedLen = -1,\n    matchedValue: DeserializationHelper | undefined;\n\n  // Iterate the responseMap to find a match\n  for (const [key, value] of Object.entries(deserializeMap)) {\n    // Extracting the path from the map key which is in format\n    // GET /path/foo\n    if (!key.startsWith(method)) {\n      continue;\n    }\n    const candidatePath = getPathFromMapKey(key);\n    // Get each part of the url path\n    const candidateParts = candidatePath.split(\"/\");\n\n    // track if we have found a match to return the values found.\n    let found = true;\n    for (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {\n      if (candidateParts[i]?.startsWith(\"{\") && candidateParts[i]?.indexOf(\"}\") !== -1) {\n        const start = candidateParts[i]!.indexOf(\"}\") + 1,\n          end = candidateParts[i]?.length;\n        // If the current part of the candidate is a \"template\" part\n        // Try to use the suffix of pattern to match the path\n        // {guid} ==> $\n        // {guid}:export ==> :export$\n        const isMatched = new RegExp(`${candidateParts[i]?.slice(start, end)}`).test(\n          pathParts[j] || \"\",\n        );\n\n        if (!isMatched) {\n          found = false;\n          break;\n        }\n        continue;\n      }\n\n      // If the candidate part is not a template and\n      // the parts don't match mark the candidate as not found\n      // to move on with the next candidate path.\n      if (candidateParts[i] !== pathParts[j]) {\n        found = false;\n        break;\n      }\n    }\n\n    // We finished evaluating the current candidate parts\n    // Update the matched value if and only if we found the longer pattern\n    if (found && candidatePath.length > matchedLen) {\n      matchedLen = candidatePath.length;\n      matchedValue = value;\n    }\n  }\n\n  return matchedValue;\n}\n\nfunction getPathFromMapKey(mapKey: string): string {\n  const pathStart = mapKey.indexOf(\"/\");\n  return mapKey.slice(pathStart);\n}\n\nfunction getApiVersionFromUrl(urlStr: string): string | undefined {\n  const url = new URL(urlStr);\n  return url.searchParams.get(\"api-version\") ?? undefined;\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/pollingHelpers.d.ts

@@ -0,0 +1,34 @@
+import type { OperationState, PollerLike, ResourceLocationConfig } from "@azure/core-lro";
+import type { Client, PathUncheckedResponse } from "@azure-rest/core-client";
+import type { AbortSignalLike } from "@azure/abort-controller";
+export interface GetLongRunningPollerOptions<TResponse> {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /**
+     * The signal which can be used to abort requests.
+     */
+    abortSignal?: AbortSignalLike;
+    /**
+     * The potential location of the result of the LRO if specified by the LRO extension in the swagger.
+     */
+    resourceLocationConfig?: ResourceLocationConfig;
+    /**
+     * The original url of the LRO
+     * Should not be null when restoreFrom is set
+     */
+    initialRequestUrl?: string;
+    /**
+     * A serialized poller which can be used to resume an existing paused Long-Running-Operation.
+     */
+    restoreFrom?: string;
+    /**
+     * The function to get the initial response
+     */
+    getInitialResponse?: () => PromiseLike<TResponse>;
+    /**
+     * The api-version of the LRO
+     */
+    apiVersion?: string;
+}
+export declare function getLongRunningPoller<TResponse extends PathUncheckedResponse, TResult = void>(client: Client, processResponseBody: (result: TResponse) => Promise<TResult>, expectedStatuses: string[], options: GetLongRunningPollerOptions<TResponse>): PollerLike<OperationState<TResult>, TResult>;
+//# sourceMappingURL=pollingHelpers.d.ts.map