@drunk-pulumi/azure 1.0.22 → 1.0.24

package/Builder/index.js

@@ -17,25 +17,45 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VnetBuilder = exports.VmBuilder = exports.VdiBuilder = exports.VaultBuilder = exports.StorageBuilder = exports.SqlBuilder = exports.ServiceBusBuilder = exports.ResourceBuilder = exports.PrivateDnsZoneBuilder = exports.EnvRoleBuilder = exports.DnsZoneBuilder = exports.CdnBuilder = exports.ApimRootBuilder = exports.ApimBuilder = exports.AksBuilder = void 0;
+exports.VnetBuilder = exports.VmBuilder = exports.VdiBuilder = exports.VaultBuilder = exports.StorageBuilder = exports.SqlBuilder = exports.SignalRBuilder = exports.ServiceBusBuilder = exports.ResourceBuilder = exports.RedisCacheBuilder = exports.PrivateDnsZoneBuilder = exports.PostgreSqlBuilder = exports.MySqlBuilder = exports.LogicAppBuilder = exports.IotHubBuilder = exports.EnvRoleBuilder = exports.DnsZoneBuilder = exports.CdnBuilder = exports.AutomationBuilder = exports.AppConfigBuilder = exports.AppCertBuilder = exports.ApimRootBuilder = exports.ApimBuilder = exports.AksBuilder = exports.AcrBuilder = void 0;
+var AcrBuilder_1 = require("./AcrBuilder");
+Object.defineProperty(exports, "AcrBuilder", { enumerable: true, get: function () { return __importDefault(AcrBuilder_1).default; } });
 var AksBuilder_1 = require("./AksBuilder");
 Object.defineProperty(exports, "AksBuilder", { enumerable: true, get: function () { return __importDefault(AksBuilder_1).default; } });
 var ApimBuilder_1 = require("./ApimBuilder");
 Object.defineProperty(exports, "ApimBuilder", { enumerable: true, get: function () { return __importDefault(ApimBuilder_1).default; } });
 var ApimRootBuilder_1 = require("./ApimRootBuilder");
 Object.defineProperty(exports, "ApimRootBuilder", { enumerable: true, get: function () { return __importDefault(ApimRootBuilder_1).default; } });
+var AppCertBuilder_1 = require("./AppCertBuilder");
+Object.defineProperty(exports, "AppCertBuilder", { enumerable: true, get: function () { return __importDefault(AppCertBuilder_1).default; } });
+var AppConfigBuilder_1 = require("./AppConfigBuilder");
+Object.defineProperty(exports, "AppConfigBuilder", { enumerable: true, get: function () { return __importDefault(AppConfigBuilder_1).default; } });
+var AutomationBuilder_1 = require("./AutomationBuilder");
+Object.defineProperty(exports, "AutomationBuilder", { enumerable: true, get: function () { return __importDefault(AutomationBuilder_1).default; } });
 var CdnBuilder_1 = require("./CdnBuilder");
 Object.defineProperty(exports, "CdnBuilder", { enumerable: true, get: function () { return __importDefault(CdnBuilder_1).default; } });
 var DnsZoneBuilder_1 = require("./DnsZoneBuilder");
 Object.defineProperty(exports, "DnsZoneBuilder", { enumerable: true, get: function () { return __importDefault(DnsZoneBuilder_1).default; } });
 var EnvRoleBuilder_1 = require("./EnvRoleBuilder");
 Object.defineProperty(exports, "EnvRoleBuilder", { enumerable: true, get: function () { return EnvRoleBuilder_1.EnvRoleBuilder; } });
+var IotHubBuilder_1 = require("./IotHubBuilder");
+Object.defineProperty(exports, "IotHubBuilder", { enumerable: true, get: function () { return __importDefault(IotHubBuilder_1).default; } });
+var LogicAppBuilder_1 = require("./LogicAppBuilder");
+Object.defineProperty(exports, "LogicAppBuilder", { enumerable: true, get: function () { return __importDefault(LogicAppBuilder_1).default; } });
+var MySqlBuilder_1 = require("./MySqlBuilder");
+Object.defineProperty(exports, "MySqlBuilder", { enumerable: true, get: function () { return __importDefault(MySqlBuilder_1).default; } });
+var PostgreSqlBuilder_1 = require("./PostgreSqlBuilder");
+Object.defineProperty(exports, "PostgreSqlBuilder", { enumerable: true, get: function () { return __importDefault(PostgreSqlBuilder_1).default; } });
 var PrivateDnsZoneBuilder_1 = require("./PrivateDnsZoneBuilder");
 Object.defineProperty(exports, "PrivateDnsZoneBuilder", { enumerable: true, get: function () { return __importDefault(PrivateDnsZoneBuilder_1).default; } });
+var RedisCacheBuilder_1 = require("./RedisCacheBuilder");
+Object.defineProperty(exports, "RedisCacheBuilder", { enumerable: true, get: function () { return __importDefault(RedisCacheBuilder_1).default; } });
 var ResourceBuilder_1 = require("./ResourceBuilder");
 Object.defineProperty(exports, "ResourceBuilder", { enumerable: true, get: function () { return __importDefault(ResourceBuilder_1).default; } });
 var ServiceBusBuilder_1 = require("./ServiceBusBuilder");
 Object.defineProperty(exports, "ServiceBusBuilder", { enumerable: true, get: function () { return __importDefault(ServiceBusBuilder_1).default; } });
+var SignalRBuilder_1 = require("./SignalRBuilder");
+Object.defineProperty(exports, "SignalRBuilder", { enumerable: true, get: function () { return __importDefault(SignalRBuilder_1).default; } });
 var SqlBuilder_1 = require("./SqlBuilder");
 Object.defineProperty(exports, "SqlBuilder", { enumerable: true, get: function () { return __importDefault(SqlBuilder_1).default; } });
 var StorageBuilder_1 = require("./StorageBuilder");
@@ -49,4 +69,4 @@ Object.defineProperty(exports, "VmBuilder", { enumerable: true, get: function ()
 var VnetBuilder_1 = require("./VnetBuilder");
 Object.defineProperty(exports, "VnetBuilder", { enumerable: true, get: function () { return __importDefault(VnetBuilder_1).default; } });
 __exportStar(require("./types"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvQnVpbGRlci9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLDJDQUFxRDtBQUE1Qyx5SEFBQSxPQUFPLE9BQWM7QUFDOUIsNkNBQXVEO0FBQTlDLDJIQUFBLE9BQU8sT0FBZTtBQUMvQixxREFBK0Q7QUFBdEQsbUlBQUEsT0FBTyxPQUFtQjtBQUNuQywyQ0FBcUQ7QUFBNUMseUhBQUEsT0FBTyxPQUFjO0FBQzlCLG1EQUE2RDtBQUFwRCxpSUFBQSxPQUFPLE9BQWtCO0FBQ2xDLG1EQUFrRDtBQUF6QyxnSEFBQSxjQUFjLE9BQUE7QUFDdkIsaUVBQTJFO0FBQWxFLCtJQUFBLE9BQU8sT0FBeUI7QUFDekMscURBQStEO0FBQXRELG1JQUFBLE9BQU8sT0FBbUI7QUFDbkMseURBQW1FO0FBQTFELHVJQUFBLE9BQU8sT0FBcUI7QUFDckMsMkNBQXFEO0FBQTVDLHlIQUFBLE9BQU8sT0FBYztBQUM5QixtREFBNkQ7QUFBcEQsaUlBQUEsT0FBTyxPQUFrQjtBQUNsQywrQ0FBeUQ7QUFBaEQsNkhBQUEsT0FBTyxPQUFnQjtBQUNoQywyQ0FBcUQ7QUFBNUMseUhBQUEsT0FBTyxPQUFjO0FBQzlCLHlDQUFtRDtBQUExQyx1SEFBQSxPQUFPLE9BQWE7QUFDN0IsNkNBQXVEO0FBQTlDLDJIQUFBLE9BQU8sT0FBZTtBQUUvQiwwQ0FBd0IifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvQnVpbGRlci9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLDJDQUFxRDtBQUE1Qyx5SEFBQSxPQUFPLE9BQWM7QUFDOUIsMkNBQXFEO0FBQTVDLHlIQUFBLE9BQU8sT0FBYztBQUM5Qiw2Q0FBdUQ7QUFBOUMsMkhBQUEsT0FBTyxPQUFlO0FBQy9CLHFEQUErRDtBQUF0RCxtSUFBQSxPQUFPLE9BQW1CO0FBQ25DLG1EQUE2RDtBQUFwRCxpSUFBQSxPQUFPLE9BQWtCO0FBQ2xDLHVEQUFpRTtBQUF4RCxxSUFBQSxPQUFPLE9BQW9CO0FBQ3BDLHlEQUFtRTtBQUExRCx1SUFBQSxPQUFPLE9BQXFCO0FBQ3JDLDJDQUFxRDtBQUE1Qyx5SEFBQSxPQUFPLE9BQWM7QUFDOUIsbURBQTZEO0FBQXBELGlJQUFBLE9BQU8sT0FBa0I7QUFDbEMsbURBQWtEO0FBQXpDLGdIQUFBLGNBQWMsT0FBQTtBQUN2QixpREFBMkQ7QUFBbEQsK0hBQUEsT0FBTyxPQUFpQjtBQUNqQyxxREFBK0Q7QUFBdEQsbUlBQUEsT0FBTyxPQUFtQjtBQUNuQywrQ0FBeUQ7QUFBaEQsNkhBQUEsT0FBTyxPQUFnQjtBQUNoQyx5REFBbUU7QUFBMUQsdUlBQUEsT0FBTyxPQUFxQjtBQUNyQyxpRUFBMkU7QUFBbEUsK0lBQUEsT0FBTyxPQUF5QjtBQUN6Qyx5REFBbUU7QUFBMUQsdUlBQUEsT0FBTyxPQUFxQjtBQUNyQyxxREFBK0Q7QUFBdEQsbUlBQUEsT0FBTyxPQUFtQjtBQUNuQyx5REFBbUU7QUFBMUQsdUlBQUEsT0FBTyxPQUFxQjtBQUNyQyxtREFBNkQ7QUFBcEQsaUlBQUEsT0FBTyxPQUFrQjtBQUNsQywyQ0FBcUQ7QUFBNUMseUhBQUEsT0FBTyxPQUFjO0FBQzlCLG1EQUE2RDtBQUFwRCxpSUFBQSxPQUFPLE9BQWtCO0FBQ2xDLCtDQUF5RDtBQUFoRCw2SEFBQSxPQUFPLE9BQWdCO0FBQ2hDLDJDQUFxRDtBQUE1Qyx5SEFBQSxPQUFPLE9BQWM7QUFDOUIseUNBQW1EO0FBQTFDLHVIQUFBLE9BQU8sT0FBYTtBQUM3Qiw2Q0FBdUQ7QUFBOUMsMkhBQUEsT0FBTyxPQUFlO0FBRS9CLDBDQUF3QiJ9

package/Builder/types/acrBuilder.d.ts

@@ -0,0 +1,54 @@
+import { BuilderProps, IBuilder } from './genericBuilder';
+import { NetworkPropsType, ResourceInfo, WithEncryptionInfo } from '../../types';
+import * as registry from '@pulumi/azure-native/containerregistry';
+/**
+ * Arguments for the ACR Builder, extending BuilderProps with encryption information.
+ */
+export type AcrBuilderArgs = BuilderProps & WithEncryptionInfo;
+/**
+ * Type for ACR SKU, can be either a predefined SkuName from the registry or a custom string.
+ */
+export type AcrSkuBuilderType = registry.SkuName | string;
+/**
+ * Policies for ACR, currently only including retention day.
+ */
+export type AcrBuilderPolicies = {
+    retentionDay: number;
+};
+/**
+ * Network properties for ACR, excluding subnetId from NetworkPropsType.
+ */
+export type AcrBuilderNetworkType = Omit<NetworkPropsType, 'subnetId'>;
+/**
+ * Interface for building Azure Container Registry (ACR) resources.
+ * This interface extends the generic IBuilder interface with ACR-specific methods.
+ * It provides a fluent API for configuring ACR properties such as SKU, network settings, and policies.
+ */
+export interface IAcrSkuBuilder {
+    /**
+     * Sets the SKU for the ACR.
+     * @param props The SKU to set for the ACR.
+     * @returns An instance of IAcrBuilder for further configuration.
+     */
+    withSku(props: AcrSkuBuilderType): IAcrBuilder;
+}
+/**
+ * Interface for configuring ACR-specific properties.
+ * Extends the generic IBuilder interface with ResourceInfo as the build result type.
+ */
+export interface IAcrBuilder extends IBuilder<ResourceInfo> {
+    /**
+     * Sets the network configuration for the ACR.
+     * This is only available for premium SKU.
+     * @param props The network properties to set.
+     * @returns The current IAcrBuilder instance for method chaining.
+     */
+    withNetwork(props: AcrBuilderNetworkType): IAcrBuilder;
+    /**
+     * Sets the policies for the ACR.
+     * This is only available for premium SKU.
+     * @param props The policies to set, including retention day.
+     * @returns The current IAcrBuilder instance for method chaining.
+     */
+    withPolicy(props: AcrBuilderPolicies): IAcrBuilder;
+}

package/Builder/types/acrBuilder.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWNyQnVpbGRlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9CdWlsZGVyL3R5cGVzL2FjckJ1aWxkZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/Builder/types/apimBuilder.d.ts

@@ -2,68 +2,172 @@ import { SkuType } from '@pulumi/azure-native/apimanagement';
 import { Input } from '@pulumi/pulumi';
 import { BuilderProps, IBuilder } from './genericBuilder';
 import { PrivateLinkPropsType, ResourceInfo, WithLogInfo } from '../../types';
+/**
+ * Type for arguments passed to the APIM builder.
+ */
 export type ApimBuilderArgs = BuilderProps & WithLogInfo;
+/**
+ * Type for configuring SKU (Stock Keeping Unit) for APIM.
+ */
 export type ApimSkuBuilderType = {
     sku: SkuType;
     capacity?: number;
 };
+/**
+ * Type for configuring publisher information for APIM.
+ */
 export type ApimPublisherBuilderType = {
     publisherEmail: Input<string>;
-    /** default is organization name */
+    /** Default is organization name */
     publisherName?: Input<string>;
-    /** default is apimgmt-noreply@mail.windowsazure.com */
+    /** Default is apimgmt-noreply@mail.windowsazure.com */
     notificationSenderEmail?: 'apimgmt-noreply@mail.windowsazure.com' | Input<string>;
 };
+/**
+ * Type for configuring certificates for APIM.
+ */
 export type ApimCertBuilderType = {
     certificate: Input<string>;
     certificatePassword?: Input<string>;
 };
+/**
+ * Type for configuring domain and certificates for APIM.
+ */
 export type ApimDomainBuilderType = {
     domain: Input<string>;
 } & ApimCertBuilderType;
+/**
+ * Type for configuring additional locations for APIM.
+ */
 export type ApimAdditionalLocationType = {
     disableGateway?: Input<boolean>;
     location: string;
 };
+/**
+ * Type for configuring availability zones for APIM.
+ */
 export type ApimZoneType = ['1', '2'] | ['1', '2', '3'];
+/**
+ * Type for configuring virtual network (VNet) for APIM.
+ */
 export type ApimVnetType = {
     enableGateway?: Input<boolean>;
     subnetId: Input<string>;
     /**
-     * The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network,
+     * The type of VPN in which API Management service needs to be configured in.
+     * None (Default Value) means the API Management service is not part of any Virtual Network,
      * External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint,
      * and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.
-     * */
+     */
     type: 'External' | 'Internal';
 };
+/**
+ * Type for configuring private link for APIM.
+ */
 export type ApimPrivateLinkType = PrivateLinkPropsType & {
     disablePublicAccess?: boolean;
 };
+/**
+ * Type for configuring authentication for APIM.
+ */
 export type ApimAuthType = {
     clientId: Input<string>;
     clientSecret: Input<string>;
     authority?: Input<string>;
     type: 'facebook' | 'google' | 'microsoft' | 'twitter' | 'aad' | 'aadB2C' | string;
 };
+/**
+ * Interface for building SKU configuration for APIM.
+ */
 export interface IApimSkuBuilder {
+    /**
+     * Configures the SKU for APIM.
+     * @param props - The SKU configuration.
+     * @returns The publisher builder instance.
+     */
     withSku(props: ApimSkuBuilderType): IApimPublisherBuilder;
 }
+/**
+ * Interface for building publisher configuration for APIM.
+ */
 export interface IApimPublisherBuilder {
+    /**
+     * Configures the publisher information for APIM.
+     * @param props - The publisher configuration.
+     * @returns The APIM builder instance.
+     */
     withPublisher(props: ApimPublisherBuilderType): IApimBuilder;
 }
+/**
+ * Interface for building authentication configuration for APIM.
+ */
 export interface IApimAuthBuilder {
+    /**
+     * Configures Entra ID authentication for APIM.
+     * @returns The APIM builder instance.
+     */
     withEntraID(): IApimBuilder;
+    /**
+     * Configures authentication for APIM.
+     * @param props - The authentication configuration.
+     * @returns The APIM builder instance.
+     */
     withAuth(props: ApimAuthType): IApimBuilder;
+    /**
+     * Disables sign-in for APIM.
+     * @returns The APIM builder instance.
+     */
     disableSignIn(): IApimBuilder;
 }
+/**
+ * Interface for building APIM configuration.
+ */
 export interface IApimBuilder extends IBuilder<ResourceInfo>, IApimAuthBuilder {
+    /**
+     * Configures a CA certificate for APIM.
+     * @param props - The certificate configuration.
+     * @returns The APIM builder instance.
+     */
     withCACert(props: ApimCertBuilderType): IApimBuilder;
+    /**
+     * Configures a root certificate for APIM.
+     * @param props - The certificate configuration.
+     * @returns The APIM builder instance.
+     */
     withRootCert(props: ApimCertBuilderType): IApimBuilder;
+    /**
+     * Configures a proxy domain for APIM.
+     * @param props - The domain configuration.
+     * @returns The APIM builder instance.
+     */
     withProxyDomain(props: ApimDomainBuilderType): IApimBuilder;
-    /**Allows multi locations*/
+    /**
+     * Configures additional locations for APIM.
+     * @param props - The additional location configuration.
+     * @returns The APIM builder instance.
+     */
     withAdditionalLocation(props: ApimAdditionalLocationType): IApimBuilder;
+    /**
+     * Configures availability zones for APIM.
+     * @param props - The zone configuration.
+     * @returns The APIM builder instance.
+     */
     withZones(props: ApimZoneType): IApimBuilder;
+    /**
+     * Configures a subnet for APIM.
+     * @param props - The subnet configuration.
+     * @returns The APIM builder instance.
+     */
     withSubnet(props: ApimVnetType): IApimBuilder;
+    /**
+     * Configures a private link for APIM.
+     * @param props - The private link configuration.
+     * @returns The APIM builder instance.
+     */
     withPrivateLink(props: ApimPrivateLinkType): IApimBuilder;
+    /**
+     * Restores APIM from a deleted state.
+     * @returns The APIM builder instance.
+     */
     restoreFomDeleted(): IApimBuilder;
 }

package/Builder/types/apimPolicyBuilder.d.ts

@@ -1,83 +1,205 @@
 import { WithNamedType } from '../../types';
+/**
+ * Enum for different types of header operations.
+ */
 export declare enum SetHeaderTypes {
     delete = "delete",
     override = "override",
     skip = "skip",
     append = "append"
 }
+/**
+ * Type for base URL configuration.
+ */
 export type ApimBaseUrlType = {
     url: string;
 };
+/**
+ * Type for setting headers, extends WithNamedType.
+ */
 export type ApimSetHeaderType = WithNamedType & {
     value?: string;
     type: SetHeaderTypes;
 };
+/**
+ * Type for checking headers, extends WithNamedType.
+ */
 export type ApimCheckHeaderType = WithNamedType & {
     value?: string[];
 };
+/**
+ * Type for mocking responses.
+ */
 export type ApimMockPropsType = {
     code?: number;
     contentType?: string;
 };
+/**
+ * Type for rewriting URIs.
+ */
 export type ApimRewriteUriType = {
     template?: string;
 };
+/**
+ * Type for rate limiting configuration.
+ */
 export type ApimRateLimitType = {
-    /** Number of call */
+    /** Number of calls */
     calls?: number;
-    /** in period (second) */
+    /** Time period in seconds */
     inSecond?: number;
-    /** only applied to the success condition `@(context.Response.StatusCode >= 200 && context.Response.StatusCode < 300)` */
+    /** Apply only to successful responses */
     successConditionOnly?: boolean;
 };
+/**
+ * Type for output caching configuration.
+ */
 export type ApimOutCacheType = {
     duration?: number;
 };
+/**
+ * Type for authentication certificate configuration.
+ */
 export type ApimAuthCertType = {
     thumbprint: string;
 };
+/**
+ * Type for client certificate configuration, extends Partial<ApimAuthCertType>.
+ */
 export type ApimClientCertType = Partial<ApimAuthCertType> & {
     issuer?: string;
     subject?: string;
     verifyCert?: boolean;
 };
+/**
+ * Type for CORS configuration.
+ */
 export type ApimCorsType = {
     origins?: string[];
 };
+/**
+ * Type for client IP header configuration.
+ */
 export type ApimClientIpHeaderType = {
-    /** ex: `x-${organization}-clientIp` */
+    /** Example: `x-${organization}-clientIp` */
     headerKey: string;
 };
+/**
+ * Type for validating JWT whitelist IPs.
+ */
 export type ApimValidateJwtWhitelistIpType = {
     claimKey: 'client_IpWhitelist' | string;
 };
+/**
+ * Type for IP address whitelisting.
+ */
 export type ApimWhitelistIpType = {
     ipAddresses: string[];
 };
+/**
+ * Type for find and replace operations.
+ */
 export type ApimFindAndReplaceType = {
     from: string;
     to: string;
 };
+/**
+ * Type for custom policies.
+ */
 export type ApimCustomPolicyType = {
     policy: string;
 };
+/**
+ * Interface for building APIM policies.
+ */
 export interface IApimPolicyBuilder {
+    /**
+     * Sets the base URL.
+     * @param props - The base URL configuration.
+     * @returns The policy builder instance.
+     */
     setBaseUrl(props: ApimBaseUrlType): IApimPolicyBuilder;
+    /**
+     * Sets a header.
+     * @param props - The header configuration.
+     * @returns The policy builder instance.
+     */
     setHeader(props: ApimSetHeaderType): IApimPolicyBuilder;
+    /**
+     * Checks a header.
+     * @param props - The header check configuration.
+     * @returns The policy builder instance.
+     */
     checkHeader(props: ApimCheckHeaderType): IApimPolicyBuilder;
+    /**
+     * Mocks a response.
+     * @param props - The mock response configuration.
+     * @returns The policy builder instance.
+     */
     mockResponse(props: ApimMockPropsType): IApimPolicyBuilder;
+    /**
+     * Rewrites a URI.
+     * @param props - The URI rewrite configuration.
+     * @returns The policy builder instance.
+     */
     rewriteUri(props: ApimRewriteUriType): IApimPolicyBuilder;
+    /**
+     * Sets rate limiting.
+     * @param props - The rate limit configuration.
+     * @returns The policy builder instance.
+     */
     setRateLimit(props: ApimRateLimitType): IApimPolicyBuilder;
+    /**
+     * Sets cache options.
+     * @param props - The cache options configuration.
+     * @returns The policy builder instance.
+     */
     setCacheOptions(props: ApimOutCacheType): IApimPolicyBuilder;
+    /**
+     * Sets a backend certificate.
+     * @param props - The backend certificate configuration.
+     * @returns The policy builder instance.
+     */
     setBackendCert(props: ApimAuthCertType): IApimPolicyBuilder;
+    /**
+     * Verifies a client certificate.
+     * @param props - The client certificate configuration.
+     * @returns The policy builder instance.
+     */
     verifyClientCert(props: ApimClientCertType): IApimPolicyBuilder;
+    /**
+     * Sets CORS options.
+     * @param props - The CORS configuration.
+     * @returns The policy builder instance.
+     */
     setCors(props: ApimCorsType): IApimPolicyBuilder;
+    /**
+     * Sets a client IP header.
+     * @param props - The client IP header configuration.
+     * @returns The policy builder instance.
+     */
     setClientIpHeader(props: ApimClientIpHeaderType): IApimPolicyBuilder;
-    /** Filter IP from Bearer Token */
+    /**
+     * Validates JWT whitelist IPs.
+     * @param props - The JWT whitelist IP configuration.
+     * @returns The policy builder instance.
+     */
     validateJwtWhitelistIp(props: ApimValidateJwtWhitelistIpType): IApimPolicyBuilder;
-    /** IP Address Whitelisting */
+    /**
+     * Sets IP address whitelisting.
+     * @param props - The IP address whitelist configuration.
+     * @returns The policy builder instance.
+     */
     setWhitelistIPs(props: ApimWhitelistIpType): IApimPolicyBuilder;
-    /**Replace outbound results */
+    /**
+     * Sets find and replace operations.
+     * @param props - The find and replace configuration.
+     * @returns The policy builder instance.
+     */
     setFindAndReplaces(props: ApimFindAndReplaceType): IApimPolicyBuilder;
+    /**
+     * Builds the policy and returns it as a string.
+     * @returns The built policy as a string.
+     */
     build(): string;
 }

package/Builder/types/apimPolicyBuilder.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SetHeaderTypes = void 0;
+/**
+ * Enum for different types of header operations.
+ */
 var SetHeaderTypes;
 (function (SetHeaderTypes) {
     SetHeaderTypes["delete"] = "delete";
@@ -8,4 +11,4 @@ var SetHeaderTypes;
     SetHeaderTypes["skip"] = "skip";
     SetHeaderTypes["append"] = "append";
 })(SetHeaderTypes || (exports.SetHeaderTypes = SetHeaderTypes = {}));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBpbVBvbGljeUJ1aWxkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvQnVpbGRlci90eXBlcy9hcGltUG9saWN5QnVpbGRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFFQSxJQUFZLGNBS1g7QUFMRCxXQUFZLGNBQWM7SUFDeEIsbUNBQWlCLENBQUE7SUFDakIsdUNBQXFCLENBQUE7SUFDckIsK0JBQWEsQ0FBQTtJQUNiLG1DQUFpQixDQUFBO0FBQ25CLENBQUMsRUFMVyxjQUFjLDhCQUFkLGNBQWMsUUFLekIifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBpbVBvbGljeUJ1aWxkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvQnVpbGRlci90eXBlcy9hcGltUG9saWN5QnVpbGRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFFQTs7R0FFRztBQUNILElBQVksY0FLWDtBQUxELFdBQVksY0FBYztJQUN4QixtQ0FBaUIsQ0FBQTtJQUNqQix1Q0FBcUIsQ0FBQTtJQUNyQiwrQkFBYSxDQUFBO0lBQ2IsbUNBQWlCLENBQUE7QUFDbkIsQ0FBQyxFQUxXLGNBQWMsOEJBQWQsY0FBYyxRQUt6QiJ9