@azure/arm-databoundaries 1.0.0-beta.2 → 1.0.0-beta.3

package/dist/browser/models/models.d.ts

@@ -0,0 +1,236 @@
+/**
+ * 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.
+ */
+/** A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. */
+export interface _OperationListResult {
+    /** The Operation items on this page */
+    value: Operation[];
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+export declare function _operationListResultDeserializer(item: any): _OperationListResult;
+export declare function operationArrayDeserializer(result: Array<Operation>): any[];
+/** Details of a REST API operation, returned from the Resource Provider Operations API */
+export interface Operation {
+    /** The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" */
+    readonly name?: string;
+    /** Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for Azure Resource Manager/control-plane operations. */
+    readonly isDataAction?: boolean;
+    /** Localized display information for this particular operation. */
+    display?: OperationDisplay;
+    /** The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" */
+    readonly origin?: Origin;
+    /** Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. */
+    readonly actionType?: ActionType;
+}
+export declare function operationDeserializer(item: any): Operation;
+/** Localized display information for an operation. */
+export interface OperationDisplay {
+    /** The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". */
+    readonly provider?: string;
+    /** The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". */
+    readonly resource?: string;
+    /** The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". */
+    readonly operation?: string;
+    /** The short, localized friendly description of the operation; suitable for tool tips and detailed views. */
+    readonly description?: string;
+}
+export declare function operationDisplayDeserializer(item: any): OperationDisplay;
+/** The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" */
+export declare enum KnownOrigin {
+    /** Indicates the operation is initiated by a user. */
+    User = "user",
+    /** Indicates the operation is initiated by a system. */
+    System = "system",
+    /** Indicates the operation is initiated by a user or system. */
+    UserSystem = "user,system"
+}
+/**
+ * The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" \
+ * {@link KnownOrigin} can be used interchangeably with Origin,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **user**: Indicates the operation is initiated by a user. \
+ * **system**: Indicates the operation is initiated by a system. \
+ * **user,system**: Indicates the operation is initiated by a user or system.
+ */
+export type Origin = string;
+/** Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. */
+export declare enum KnownActionType {
+    /** Actions are for internal-only APIs. */
+    Internal = "Internal"
+}
+/**
+ * Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. \
+ * {@link KnownActionType} can be used interchangeably with ActionType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Internal**: Actions are for internal-only APIs.
+ */
+export type ActionType = string;
+/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. */
+export interface ErrorResponse {
+    /** The error object. */
+    error?: ErrorDetail;
+}
+export declare function errorResponseDeserializer(item: any): ErrorResponse;
+/** The error detail. */
+export interface ErrorDetail {
+    /** The error code. */
+    readonly code?: string;
+    /** The error message. */
+    readonly message?: string;
+    /** The error target. */
+    readonly target?: string;
+    /** The error details. */
+    readonly details?: ErrorDetail[];
+    /** The error additional info. */
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+}
+export declare function errorDetailDeserializer(item: any): ErrorDetail;
+export declare function errorDetailArrayDeserializer(result: Array<ErrorDetail>): any[];
+export declare function errorAdditionalInfoArrayDeserializer(result: Array<ErrorAdditionalInfo>): any[];
+/** The resource management error additional info. */
+export interface ErrorAdditionalInfo {
+    /** The additional info type. */
+    readonly type?: string;
+    /** The additional info. */
+    readonly info?: any;
+}
+export declare function errorAdditionalInfoDeserializer(item: any): ErrorAdditionalInfo;
+/** A data boundary definition. */
+export interface DataBoundaryDefinition extends ProxyResource {
+    /** Data boundary properties */
+    properties?: DataBoundaryProperties;
+}
+export declare function dataBoundaryDefinitionSerializer(item: DataBoundaryDefinition): any;
+export declare function dataBoundaryDefinitionDeserializer(item: any): DataBoundaryDefinition;
+/** Data boundary properties */
+export interface DataBoundaryProperties {
+    /** The data boundary definition. */
+    dataBoundary?: DataBoundary;
+    /** Denotes the state of provisioning. */
+    readonly provisioningState?: ProvisioningState;
+}
+export declare function dataBoundaryPropertiesSerializer(item: DataBoundaryProperties): any;
+export declare function dataBoundaryPropertiesDeserializer(item: any): DataBoundaryProperties;
+/** The data boundary definition. */
+export declare enum KnownDataBoundary {
+    /** NotDefined */
+    NotDefined = "NotDefined",
+    /** Global */
+    Global = "Global",
+    /** EU */
+    EU = "EU"
+}
+/**
+ * The data boundary definition. \
+ * {@link KnownDataBoundary} can be used interchangeably with DataBoundary,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **NotDefined**: NotDefined \
+ * **Global**: Global \
+ * **EU**: EU
+ */
+export type DataBoundary = string;
+/** Denotes the state of provisioning. */
+export declare enum KnownProvisioningState {
+    /** Accepted */
+    Accepted = "Accepted",
+    /** Running */
+    Running = "Running",
+    /** Creating */
+    Creating = "Creating",
+    /** Canceled */
+    Canceled = "Canceled",
+    /** Failed */
+    Failed = "Failed",
+    /** Succeeded */
+    Succeeded = "Succeeded",
+    /** Updating */
+    Updating = "Updating"
+}
+/**
+ * Denotes the state of provisioning. \
+ * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Accepted**: Accepted \
+ * **Running**: Running \
+ * **Creating**: Creating \
+ * **Canceled**: Canceled \
+ * **Failed**: Failed \
+ * **Succeeded**: Succeeded \
+ * **Updating**: Updating
+ */
+export type ProvisioningState = string;
+/** Known values of {@link DefaultName} that the service accepts. */
+export declare enum KnownDefaultName {
+    /** default */
+    Default = "default"
+}
+/** Type of DefaultName */
+export type DefaultName = string;
+/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
+export interface ProxyResource extends Resource {
+}
+export declare function proxyResourceSerializer(_item: ProxyResource): any;
+export declare function proxyResourceDeserializer(item: any): ProxyResource;
+/** Common fields that are returned in the response for all Azure Resource Manager resources */
+export interface Resource {
+    /** Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */
+    readonly id?: string;
+    /** The name of the resource */
+    readonly name?: string;
+    /** The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */
+    readonly type?: string;
+    /** Azure Resource Manager metadata containing createdBy and modifiedBy information. */
+    readonly systemData?: SystemData;
+}
+export declare function resourceSerializer(_item: Resource): any;
+export declare function resourceDeserializer(item: any): Resource;
+/** Metadata pertaining to creation and last modification of the resource. */
+export interface SystemData {
+    /** The identity that created the resource. */
+    createdBy?: string;
+    /** The type of identity that created the resource. */
+    createdByType?: CreatedByType;
+    /** The timestamp of resource creation (UTC). */
+    createdAt?: Date;
+    /** The identity that last modified the resource. */
+    lastModifiedBy?: string;
+    /** The type of identity that last modified the resource. */
+    lastModifiedByType?: CreatedByType;
+    /** The timestamp of resource last modification (UTC) */
+    lastModifiedAt?: Date;
+}
+export declare function systemDataDeserializer(item: any): SystemData;
+/** The kind of entity that created the resource. */
+export declare enum KnownCreatedByType {
+    /** The entity was created by a user. */
+    User = "User",
+    /** The entity was created by an application. */
+    Application = "Application",
+    /** The entity was created by a managed identity. */
+    ManagedIdentity = "ManagedIdentity",
+    /** The entity was created by a key. */
+    Key = "Key"
+}
+/**
+ * The kind of entity that created the resource. \
+ * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **User**: The entity was created by a user. \
+ * **Application**: The entity was created by an application. \
+ * **ManagedIdentity**: The entity was created by a managed identity. \
+ * **Key**: The entity was created by a key.
+ */
+export type CreatedByType = string;
+/** The available API versions. */
+export declare enum KnownVersions {
+    /** The 2024-08-01 API version. */
+    V20240801 = "2024-08-01"
+}
+//# sourceMappingURL=models.d.ts.map

package/dist/browser/models/models.js

@@ -0,0 +1,198 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export function _operationListResultDeserializer(item) {
+    return {
+        value: operationArrayDeserializer(item["value"]),
+        nextLink: item["nextLink"],
+    };
+}
+export function operationArrayDeserializer(result) {
+    return result.map((item) => {
+        return operationDeserializer(item);
+    });
+}
+export function operationDeserializer(item) {
+    return {
+        name: item["name"],
+        isDataAction: item["isDataAction"],
+        display: !item["display"] ? item["display"] : operationDisplayDeserializer(item["display"]),
+        origin: item["origin"],
+        actionType: item["actionType"],
+    };
+}
+export function operationDisplayDeserializer(item) {
+    return {
+        provider: item["provider"],
+        resource: item["resource"],
+        operation: item["operation"],
+        description: item["description"],
+    };
+}
+/** The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" */
+export var KnownOrigin;
+(function (KnownOrigin) {
+    /** Indicates the operation is initiated by a user. */
+    KnownOrigin["User"] = "user";
+    /** Indicates the operation is initiated by a system. */
+    KnownOrigin["System"] = "system";
+    /** Indicates the operation is initiated by a user or system. */
+    KnownOrigin["UserSystem"] = "user,system";
+})(KnownOrigin || (KnownOrigin = {}));
+/** Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. */
+export var KnownActionType;
+(function (KnownActionType) {
+    /** Actions are for internal-only APIs. */
+    KnownActionType["Internal"] = "Internal";
+})(KnownActionType || (KnownActionType = {}));
+export function errorResponseDeserializer(item) {
+    return {
+        error: !item["error"] ? item["error"] : errorDetailDeserializer(item["error"]),
+    };
+}
+export function errorDetailDeserializer(item) {
+    return {
+        code: item["code"],
+        message: item["message"],
+        target: item["target"],
+        details: !item["details"] ? item["details"] : errorDetailArrayDeserializer(item["details"]),
+        additionalInfo: !item["additionalInfo"]
+            ? item["additionalInfo"]
+            : errorAdditionalInfoArrayDeserializer(item["additionalInfo"]),
+    };
+}
+export function errorDetailArrayDeserializer(result) {
+    return result.map((item) => {
+        return errorDetailDeserializer(item);
+    });
+}
+export function errorAdditionalInfoArrayDeserializer(result) {
+    return result.map((item) => {
+        return errorAdditionalInfoDeserializer(item);
+    });
+}
+export function errorAdditionalInfoDeserializer(item) {
+    return {
+        type: item["type"],
+        info: item["info"],
+    };
+}
+export function dataBoundaryDefinitionSerializer(item) {
+    return {
+        properties: !item["properties"]
+            ? item["properties"]
+            : dataBoundaryPropertiesSerializer(item["properties"]),
+    };
+}
+export function dataBoundaryDefinitionDeserializer(item) {
+    return {
+        id: item["id"],
+        name: item["name"],
+        type: item["type"],
+        systemData: !item["systemData"]
+            ? item["systemData"]
+            : systemDataDeserializer(item["systemData"]),
+        properties: !item["properties"]
+            ? item["properties"]
+            : dataBoundaryPropertiesDeserializer(item["properties"]),
+    };
+}
+export function dataBoundaryPropertiesSerializer(item) {
+    return { dataBoundary: item["dataBoundary"] };
+}
+export function dataBoundaryPropertiesDeserializer(item) {
+    return {
+        dataBoundary: item["dataBoundary"],
+        provisioningState: item["provisioningState"],
+    };
+}
+/** The data boundary definition. */
+export var KnownDataBoundary;
+(function (KnownDataBoundary) {
+    /** NotDefined */
+    KnownDataBoundary["NotDefined"] = "NotDefined";
+    /** Global */
+    KnownDataBoundary["Global"] = "Global";
+    /** EU */
+    KnownDataBoundary["EU"] = "EU";
+})(KnownDataBoundary || (KnownDataBoundary = {}));
+/** Denotes the state of provisioning. */
+export var KnownProvisioningState;
+(function (KnownProvisioningState) {
+    /** Accepted */
+    KnownProvisioningState["Accepted"] = "Accepted";
+    /** Running */
+    KnownProvisioningState["Running"] = "Running";
+    /** Creating */
+    KnownProvisioningState["Creating"] = "Creating";
+    /** Canceled */
+    KnownProvisioningState["Canceled"] = "Canceled";
+    /** Failed */
+    KnownProvisioningState["Failed"] = "Failed";
+    /** Succeeded */
+    KnownProvisioningState["Succeeded"] = "Succeeded";
+    /** Updating */
+    KnownProvisioningState["Updating"] = "Updating";
+})(KnownProvisioningState || (KnownProvisioningState = {}));
+/** Known values of {@link DefaultName} that the service accepts. */
+export var KnownDefaultName;
+(function (KnownDefaultName) {
+    /** default */
+    KnownDefaultName["Default"] = "default";
+})(KnownDefaultName || (KnownDefaultName = {}));
+export function proxyResourceSerializer(_item) {
+    return {};
+}
+export function proxyResourceDeserializer(item) {
+    return {
+        id: item["id"],
+        name: item["name"],
+        type: item["type"],
+        systemData: !item["systemData"]
+            ? item["systemData"]
+            : systemDataDeserializer(item["systemData"]),
+    };
+}
+export function resourceSerializer(_item) {
+    return {};
+}
+export function resourceDeserializer(item) {
+    return {
+        id: item["id"],
+        name: item["name"],
+        type: item["type"],
+        systemData: !item["systemData"]
+            ? item["systemData"]
+            : systemDataDeserializer(item["systemData"]),
+    };
+}
+export function systemDataDeserializer(item) {
+    return {
+        createdBy: item["createdBy"],
+        createdByType: item["createdByType"],
+        createdAt: !item["createdAt"] ? item["createdAt"] : new Date(item["createdAt"]),
+        lastModifiedBy: item["lastModifiedBy"],
+        lastModifiedByType: item["lastModifiedByType"],
+        lastModifiedAt: !item["lastModifiedAt"]
+            ? item["lastModifiedAt"]
+            : new Date(item["lastModifiedAt"]),
+    };
+}
+/** The kind of entity that created the resource. */
+export var KnownCreatedByType;
+(function (KnownCreatedByType) {
+    /** The entity was created by a user. */
+    KnownCreatedByType["User"] = "User";
+    /** The entity was created by an application. */
+    KnownCreatedByType["Application"] = "Application";
+    /** The entity was created by a managed identity. */
+    KnownCreatedByType["ManagedIdentity"] = "ManagedIdentity";
+    /** The entity was created by a key. */
+    KnownCreatedByType["Key"] = "Key";
+})(KnownCreatedByType || (KnownCreatedByType = {}));
+/** The available API versions. */
+export var KnownVersions;
+(function (KnownVersions) {
+    /** The 2024-08-01 API version. */
+    KnownVersions["V20240801"] = "2024-08-01";
+})(KnownVersions || (KnownVersions = {}));
+//# sourceMappingURL=models.js.map

package/dist/browser/models/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../src/models/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAgBlC,MAAM,UAAU,gCAAgC,CAAC,IAAS;IACxD,OAAO;QACL,KAAK,EAAE,0BAA0B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChD,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC;KAC3B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,MAAwB;IACjE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACzB,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;AACL,CAAC;AAgBD,MAAM,UAAU,qBAAqB,CAAC,IAAS;IAC7C,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,YAAY,EAAE,IAAI,CAAC,cAAc,CAAC;QAClC,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,4BAA4B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3F,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC;QACtB,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC;KAC/B,CAAC;AACJ,CAAC;AAcD,MAAM,UAAU,4BAA4B,CAAC,IAAS;IACpD,OAAO;QACL,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC;QAC1B,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC;QAC1B,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC;QAC5B,WAAW,EAAE,IAAI,CAAC,aAAa,CAAC;KACjC,CAAC;AACJ,CAAC;AAED,2IAA2I;AAC3I,MAAM,CAAN,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,sDAAsD;IACtD,4BAAa,CAAA;IACb,wDAAwD;IACxD,gCAAiB,CAAA;IACjB,gEAAgE;IAChE,yCAA0B,CAAA;AAC5B,CAAC,EAPW,WAAW,KAAX,WAAW,QAOtB;AAaD,gHAAgH;AAChH,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,0CAA0C;IAC1C,wCAAqB,CAAA;AACvB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AAiBD,MAAM,UAAU,yBAAyB,CAAC,IAAS;IACjD,OAAO;QACL,KAAK,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;KAC/E,CAAC;AACJ,CAAC;AAgBD,MAAM,UAAU,uBAAuB,CAAC,IAAS;IAC/C,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;QACxB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC;QACtB,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,4BAA4B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3F,cAAc,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACrC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACxB,CAAC,CAAC,oCAAoC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;KACjE,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,MAA0B;IACrE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACzB,OAAO,uBAAuB,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,oCAAoC,CAAC,MAAkC;IACrF,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACzB,OAAO,+BAA+B,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;AACL,CAAC;AAUD,MAAM,UAAU,+BAA+B,CAAC,IAAS;IACvD,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;KACnB,CAAC;AACJ,CAAC;AAQD,MAAM,UAAU,gCAAgC,CAAC,IAA4B;IAC3E,OAAO;QACL,UAAU,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;YAC7B,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;YACpB,CAAC,CAAC,gCAAgC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;KACzD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kCAAkC,CAAC,IAAS;IAC1D,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC;QACd,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,UAAU,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;YAC7B,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;YACpB,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC9C,UAAU,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;YAC7B,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;YACpB,CAAC,CAAC,kCAAkC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;KAC3D,CAAC;AACJ,CAAC;AAUD,MAAM,UAAU,gCAAgC,CAAC,IAA4B;IAC3E,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,kCAAkC,CAAC,IAAS;IAC1D,OAAO;QACL,YAAY,EAAE,IAAI,CAAC,cAAc,CAAC;QAClC,iBAAiB,EAAE,IAAI,CAAC,mBAAmB,CAAC;KAC7C,CAAC;AACJ,CAAC;AAED,oCAAoC;AACpC,MAAM,CAAN,IAAY,iBAOX;AAPD,WAAY,iBAAiB;IAC3B,iBAAiB;IACjB,8CAAyB,CAAA;IACzB,aAAa;IACb,sCAAiB,CAAA;IACjB,SAAS;IACT,8BAAS,CAAA;AACX,CAAC,EAPW,iBAAiB,KAAjB,iBAAiB,QAO5B;AAaD,yCAAyC;AACzC,MAAM,CAAN,IAAY,sBAeX;AAfD,WAAY,sBAAsB;IAChC,eAAe;IACf,+CAAqB,CAAA;IACrB,cAAc;IACd,6CAAmB,CAAA;IACnB,eAAe;IACf,+CAAqB,CAAA;IACrB,eAAe;IACf,+CAAqB,CAAA;IACrB,aAAa;IACb,2CAAiB,CAAA;IACjB,gBAAgB;IAChB,iDAAuB,CAAA;IACvB,eAAe;IACf,+CAAqB,CAAA;AACvB,CAAC,EAfW,sBAAsB,KAAtB,sBAAsB,QAejC;AAiBD,oEAAoE;AACpE,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,cAAc;IACd,uCAAmB,CAAA;AACrB,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B;AAQD,MAAM,UAAU,uBAAuB,CAAC,KAAoB;IAC1D,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,IAAS;IACjD,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC;QACd,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,UAAU,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;YAC7B,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;YACpB,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;KAC/C,CAAC;AACJ,CAAC;AAcD,MAAM,UAAU,kBAAkB,CAAC,KAAe;IAChD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAS;IAC5C,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC;QACd,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,UAAU,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;YAC7B,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;YACpB,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;KAC/C,CAAC;AACJ,CAAC;AAkBD,MAAM,UAAU,sBAAsB,CAAC,IAAS;IAC9C,OAAO;QACL,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC;QAC5B,aAAa,EAAE,IAAI,CAAC,eAAe,CAAC;QACpC,SAAS,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/E,cAAc,EAAE,IAAI,CAAC,gBAAgB,CAAC;QACtC,kBAAkB,EAAE,IAAI,CAAC,oBAAoB,CAAC;QAC9C,cAAc,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACrC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACxB,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;KACrC,CAAC;AACJ,CAAC;AAED,oDAAoD;AACpD,MAAM,CAAN,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,wCAAwC;IACxC,mCAAa,CAAA;IACb,gDAAgD;IAChD,iDAA2B,CAAA;IAC3B,oDAAoD;IACpD,yDAAmC,CAAA;IACnC,uCAAuC;IACvC,iCAAW,CAAA;AACb,CAAC,EATW,kBAAkB,KAAlB,kBAAkB,QAS7B;AAcD,kCAAkC;AAClC,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,kCAAkC;IAClC,yCAAwB,CAAA;AAC1B,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\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/** A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. */\nexport interface _OperationListResult {\n  /** The Operation items on this page */\n  value: Operation[];\n  /** The link to the next page of items */\n  nextLink?: string;\n}\n\nexport function _operationListResultDeserializer(item: any): _OperationListResult {\n  return {\n    value: operationArrayDeserializer(item[\"value\"]),\n    nextLink: item[\"nextLink\"],\n  };\n}\n\nexport function operationArrayDeserializer(result: Array<Operation>): any[] {\n  return result.map((item) => {\n    return operationDeserializer(item);\n  });\n}\n\n/** Details of a REST API operation, returned from the Resource Provider Operations API */\nexport interface Operation {\n  /** The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\" */\n  readonly name?: string;\n  /** Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for Azure Resource Manager/control-plane operations. */\n  readonly isDataAction?: boolean;\n  /** Localized display information for this particular operation. */\n  display?: OperationDisplay;\n  /** The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\" */\n  readonly origin?: Origin;\n  /** Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs. */\n  readonly actionType?: ActionType;\n}\n\nexport function operationDeserializer(item: any): Operation {\n  return {\n    name: item[\"name\"],\n    isDataAction: item[\"isDataAction\"],\n    display: !item[\"display\"] ? item[\"display\"] : operationDisplayDeserializer(item[\"display\"]),\n    origin: item[\"origin\"],\n    actionType: item[\"actionType\"],\n  };\n}\n\n/** Localized display information for an operation. */\nexport interface OperationDisplay {\n  /** The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\". */\n  readonly provider?: string;\n  /** The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\". */\n  readonly resource?: string;\n  /** The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\". */\n  readonly operation?: string;\n  /** The short, localized friendly description of the operation; suitable for tool tips and detailed views. */\n  readonly description?: string;\n}\n\nexport function operationDisplayDeserializer(item: any): OperationDisplay {\n  return {\n    provider: item[\"provider\"],\n    resource: item[\"resource\"],\n    operation: item[\"operation\"],\n    description: item[\"description\"],\n  };\n}\n\n/** The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\" */\nexport enum KnownOrigin {\n  /** Indicates the operation is initiated by a user. */\n  User = \"user\",\n  /** Indicates the operation is initiated by a system. */\n  System = \"system\",\n  /** Indicates the operation is initiated by a user or system. */\n  UserSystem = \"user,system\",\n}\n\n/**\n * The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\" \\\n * {@link KnownOrigin} can be used interchangeably with Origin,\n *  this enum contains the known values that the service supports.\n * ### Known values supported by the service\n * **user**: Indicates the operation is initiated by a user. \\\n * **system**: Indicates the operation is initiated by a system. \\\n * **user,system**: Indicates the operation is initiated by a user or system.\n */\nexport type Origin = string;\n\n/** Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs. */\nexport enum KnownActionType {\n  /** Actions are for internal-only APIs. */\n  Internal = \"Internal\",\n}\n\n/**\n * Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs. \\\n * {@link KnownActionType} can be used interchangeably with ActionType,\n *  this enum contains the known values that the service supports.\n * ### Known values supported by the service\n * **Internal**: Actions are for internal-only APIs.\n */\nexport type ActionType = string;\n\n/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. */\nexport interface ErrorResponse {\n  /** The error object. */\n  error?: ErrorDetail;\n}\n\nexport function errorResponseDeserializer(item: any): ErrorResponse {\n  return {\n    error: !item[\"error\"] ? item[\"error\"] : errorDetailDeserializer(item[\"error\"]),\n  };\n}\n\n/** The error detail. */\nexport interface ErrorDetail {\n  /** The error code. */\n  readonly code?: string;\n  /** The error message. */\n  readonly message?: string;\n  /** The error target. */\n  readonly target?: string;\n  /** The error details. */\n  readonly details?: ErrorDetail[];\n  /** The error additional info. */\n  readonly additionalInfo?: ErrorAdditionalInfo[];\n}\n\nexport function errorDetailDeserializer(item: any): ErrorDetail {\n  return {\n    code: item[\"code\"],\n    message: item[\"message\"],\n    target: item[\"target\"],\n    details: !item[\"details\"] ? item[\"details\"] : errorDetailArrayDeserializer(item[\"details\"]),\n    additionalInfo: !item[\"additionalInfo\"]\n      ? item[\"additionalInfo\"]\n      : errorAdditionalInfoArrayDeserializer(item[\"additionalInfo\"]),\n  };\n}\n\nexport function errorDetailArrayDeserializer(result: Array<ErrorDetail>): any[] {\n  return result.map((item) => {\n    return errorDetailDeserializer(item);\n  });\n}\n\nexport function errorAdditionalInfoArrayDeserializer(result: Array<ErrorAdditionalInfo>): any[] {\n  return result.map((item) => {\n    return errorAdditionalInfoDeserializer(item);\n  });\n}\n\n/** The resource management error additional info. */\nexport interface ErrorAdditionalInfo {\n  /** The additional info type. */\n  readonly type?: string;\n  /** The additional info. */\n  readonly info?: any;\n}\n\nexport function errorAdditionalInfoDeserializer(item: any): ErrorAdditionalInfo {\n  return {\n    type: item[\"type\"],\n    info: item[\"info\"],\n  };\n}\n\n/** A data boundary definition. */\nexport interface DataBoundaryDefinition extends ProxyResource {\n  /** Data boundary properties */\n  properties?: DataBoundaryProperties;\n}\n\nexport function dataBoundaryDefinitionSerializer(item: DataBoundaryDefinition): any {\n  return {\n    properties: !item[\"properties\"]\n      ? item[\"properties\"]\n      : dataBoundaryPropertiesSerializer(item[\"properties\"]),\n  };\n}\n\nexport function dataBoundaryDefinitionDeserializer(item: any): DataBoundaryDefinition {\n  return {\n    id: item[\"id\"],\n    name: item[\"name\"],\n    type: item[\"type\"],\n    systemData: !item[\"systemData\"]\n      ? item[\"systemData\"]\n      : systemDataDeserializer(item[\"systemData\"]),\n    properties: !item[\"properties\"]\n      ? item[\"properties\"]\n      : dataBoundaryPropertiesDeserializer(item[\"properties\"]),\n  };\n}\n\n/** Data boundary properties */\nexport interface DataBoundaryProperties {\n  /** The data boundary definition. */\n  dataBoundary?: DataBoundary;\n  /** Denotes the state of provisioning. */\n  readonly provisioningState?: ProvisioningState;\n}\n\nexport function dataBoundaryPropertiesSerializer(item: DataBoundaryProperties): any {\n  return { dataBoundary: item[\"dataBoundary\"] };\n}\n\nexport function dataBoundaryPropertiesDeserializer(item: any): DataBoundaryProperties {\n  return {\n    dataBoundary: item[\"dataBoundary\"],\n    provisioningState: item[\"provisioningState\"],\n  };\n}\n\n/** The data boundary definition. */\nexport enum KnownDataBoundary {\n  /** NotDefined */\n  NotDefined = \"NotDefined\",\n  /** Global */\n  Global = \"Global\",\n  /** EU */\n  EU = \"EU\",\n}\n\n/**\n * The data boundary definition. \\\n * {@link KnownDataBoundary} can be used interchangeably with DataBoundary,\n *  this enum contains the known values that the service supports.\n * ### Known values supported by the service\n * **NotDefined**: NotDefined \\\n * **Global**: Global \\\n * **EU**: EU\n */\nexport type DataBoundary = string;\n\n/** Denotes the state of provisioning. */\nexport enum KnownProvisioningState {\n  /** Accepted */\n  Accepted = \"Accepted\",\n  /** Running */\n  Running = \"Running\",\n  /** Creating */\n  Creating = \"Creating\",\n  /** Canceled */\n  Canceled = \"Canceled\",\n  /** Failed */\n  Failed = \"Failed\",\n  /** Succeeded */\n  Succeeded = \"Succeeded\",\n  /** Updating */\n  Updating = \"Updating\",\n}\n\n/**\n * Denotes the state of provisioning. \\\n * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,\n *  this enum contains the known values that the service supports.\n * ### Known values supported by the service\n * **Accepted**: Accepted \\\n * **Running**: Running \\\n * **Creating**: Creating \\\n * **Canceled**: Canceled \\\n * **Failed**: Failed \\\n * **Succeeded**: Succeeded \\\n * **Updating**: Updating\n */\nexport type ProvisioningState = string;\n\n/** Known values of {@link DefaultName} that the service accepts. */\nexport enum KnownDefaultName {\n  /** default */\n  Default = \"default\",\n}\n\n/** Type of DefaultName */\nexport type DefaultName = string;\n\n/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */\nexport interface ProxyResource extends Resource {}\n\nexport function proxyResourceSerializer(_item: ProxyResource): any {\n  return {};\n}\n\nexport function proxyResourceDeserializer(item: any): ProxyResource {\n  return {\n    id: item[\"id\"],\n    name: item[\"name\"],\n    type: item[\"type\"],\n    systemData: !item[\"systemData\"]\n      ? item[\"systemData\"]\n      : systemDataDeserializer(item[\"systemData\"]),\n  };\n}\n\n/** Common fields that are returned in the response for all Azure Resource Manager resources */\nexport interface Resource {\n  /** Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */\n  readonly id?: string;\n  /** The name of the resource */\n  readonly name?: string;\n  /** The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\" */\n  readonly type?: string;\n  /** Azure Resource Manager metadata containing createdBy and modifiedBy information. */\n  readonly systemData?: SystemData;\n}\n\nexport function resourceSerializer(_item: Resource): any {\n  return {};\n}\n\nexport function resourceDeserializer(item: any): Resource {\n  return {\n    id: item[\"id\"],\n    name: item[\"name\"],\n    type: item[\"type\"],\n    systemData: !item[\"systemData\"]\n      ? item[\"systemData\"]\n      : systemDataDeserializer(item[\"systemData\"]),\n  };\n}\n\n/** Metadata pertaining to creation and last modification of the resource. */\nexport interface SystemData {\n  /** The identity that created the resource. */\n  createdBy?: string;\n  /** The type of identity that created the resource. */\n  createdByType?: CreatedByType;\n  /** The timestamp of resource creation (UTC). */\n  createdAt?: Date;\n  /** The identity that last modified the resource. */\n  lastModifiedBy?: string;\n  /** The type of identity that last modified the resource. */\n  lastModifiedByType?: CreatedByType;\n  /** The timestamp of resource last modification (UTC) */\n  lastModifiedAt?: Date;\n}\n\nexport function systemDataDeserializer(item: any): SystemData {\n  return {\n    createdBy: item[\"createdBy\"],\n    createdByType: item[\"createdByType\"],\n    createdAt: !item[\"createdAt\"] ? item[\"createdAt\"] : new Date(item[\"createdAt\"]),\n    lastModifiedBy: item[\"lastModifiedBy\"],\n    lastModifiedByType: item[\"lastModifiedByType\"],\n    lastModifiedAt: !item[\"lastModifiedAt\"]\n      ? item[\"lastModifiedAt\"]\n      : new Date(item[\"lastModifiedAt\"]),\n  };\n}\n\n/** The kind of entity that created the resource. */\nexport enum KnownCreatedByType {\n  /** The entity was created by a user. */\n  User = \"User\",\n  /** The entity was created by an application. */\n  Application = \"Application\",\n  /** The entity was created by a managed identity. */\n  ManagedIdentity = \"ManagedIdentity\",\n  /** The entity was created by a key. */\n  Key = \"Key\",\n}\n\n/**\n * The kind of entity that created the resource. \\\n * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,\n *  this enum contains the known values that the service supports.\n * ### Known values supported by the service\n * **User**: The entity was created by a user. \\\n * **Application**: The entity was created by an application. \\\n * **ManagedIdentity**: The entity was created by a managed identity. \\\n * **Key**: The entity was created by a key.\n */\nexport type CreatedByType = string;\n\n/** The available API versions. */\nexport enum KnownVersions {\n  /** The 2024-08-01 API version. */\n  V20240801 = \"2024-08-01\",\n}\n"]}

package/dist/browser/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/browser/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/browser/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/browser/static-helpers/pagingHelpers.d.ts

@@ -0,0 +1,74 @@
+import { 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