@gradientedge/cdk-utils-azure 2.0.0 → 2.1.0

package/README.md

@@ -0,0 +1,30 @@
+# @gradientedge/cdk-utils-azure
+
+Azure Pulumi utilities for provisioning and managing Azure infrastructure using [Pulumi](https://www.pulumi.com/) with the [Azure Native](https://www.pulumi.com/registry/packages/azure-native/) provider (`@pulumi/azure-native`).
+
+## Overview
+
+This package provides high-level constructs and service managers for Azure:
+
+- **Constructs** — patterns for REST APIs, Function Apps, Event Handlers, and web apps
+- **Services** — manager classes for Azure services including API Management, CosmosDB, DNS, EventGrid, Key Vault, Redis, Storage, and more
+- **Common** — base constructs, stack classes, and resource name formatting utilities
+
+## Installation
+
+```bash
+pnpm add @gradientedge/cdk-utils-azure
+```
+
+## Usage
+
+```typescript
+import { CommonAzureConstruct } from '@gradientedge/cdk-utils-azure'
+
+class MyAzureStack extends CommonAzureConstruct {
+  constructor(name: string, args: any, opts?: pulumi.ComponentResourceOptions) {
+    super(name, args, opts)
+    this.initResources()
+  }
+}
+```

package/dist/src/common/constants.d.ts

@@ -1,3 +1,4 @@
+/** @category Enum */
 export declare enum AzureRemoteBackend {
     azurerm = "azurerm",
     pulumi = "pulumi",
@@ -6,10 +7,12 @@ export declare enum AzureRemoteBackend {
 /**
  * List of Azure resources that excludes tags
  */
+/** @category Constant */
 export declare const RESOURCES_TO_EXCLUDE_TAGS: Set<string>;
 /**
  * @see https://learn.microsoft.com/en-us/azure/reliability/regions-list?tabs=all
  */
+/** @category Constant */
 export declare const AzureLocation: {
     readonly BrazilSouth: "brazilsouth";
     readonly BrazilSoutheast: "brazilsoutheast";
@@ -80,4 +83,5 @@ export declare const AzureLocation: {
     readonly TaiwanNorthwest: "taiwannorthwest";
     readonly WestIndia: "westindia";
 };
+/** @category Interface */
 export type AzureLocation = (typeof AzureLocation)[keyof typeof AzureLocation];

package/dist/src/common/constants.js

@@ -1,3 +1,4 @@
+/** @category Enum */
 export var AzureRemoteBackend;
 (function (AzureRemoteBackend) {
     AzureRemoteBackend["azurerm"] = "azurerm";
@@ -7,10 +8,12 @@ export var AzureRemoteBackend;
 /**
  * List of Azure resources that excludes tags
  */
+/** @category Constant */
 export const RESOURCES_TO_EXCLUDE_TAGS = new Set(['ApiManagementNamedValue', 'Application', 'ServicePrincipal']);
 /**
  * @see https://learn.microsoft.com/en-us/azure/reliability/regions-list?tabs=all
  */
+/** @category Constant */
 export const AzureLocation = {
     // Americas
     BrazilSouth: 'brazilsouth',

package/dist/src/common/construct.d.ts

@@ -7,7 +7,7 @@ import { AzureApiManagementManager, AzureAppConfigurationManager, AzureApplicati
 import { AzureResourceNameFormatter } from './resource-name-formatter.js';
 import { CommonAzureStackProps } from './types.js';
 /**
- * @classdesc Common Azure construct to use as a base for all higher level constructs using Pulumi
+ * Common Azure construct to use as a base for all higher level constructs using Pulumi
  * - Provides manager instances for all Azure services
  * - Handles resource naming conventions
  * - Manages common properties and utilities
@@ -22,6 +22,7 @@ import { CommonAzureStackProps } from './types.js';
  *   }
  * }
  * ```
+ * @category Common
  */
 export declare class CommonAzureConstruct extends ComponentResource {
     props: CommonAzureStackProps;

package/dist/src/common/construct.js

@@ -6,7 +6,7 @@ import { AzureAuthorisationManager } from '../services/authorisation/main.js';
 import { AzureApiManagementManager, AzureAppConfigurationManager, AzureApplicationInsightsManager, AzureAppServiceManager, AzureCosmosDbManager, AzureDnsManager, AzureEventgridManager, AzureFunctionManager, AzureKeyVaultManager, AzureMonitorManager, AzureOperationalInsightsManager, AzurePortalManager, AzureRedisManager, AzureResourceGroupManager, AzureSecurityCentermanager, AzureServiceBusManager, AzureStorageManager, } from '../services/index.js';
 import { AzureResourceNameFormatter } from './resource-name-formatter.js';
 /**
- * @classdesc Common Azure construct to use as a base for all higher level constructs using Pulumi
+ * Common Azure construct to use as a base for all higher level constructs using Pulumi
  * - Provides manager instances for all Azure services
  * - Handles resource naming conventions
  * - Manages common properties and utilities
@@ -21,6 +21,7 @@ import { AzureResourceNameFormatter } from './resource-name-formatter.js';
  *   }
  * }
  * ```
+ * @category Common
  */
 export class CommonAzureConstruct extends ComponentResource {
     id;

package/dist/src/common/resource-name-formatter.d.ts

@@ -1,9 +1,10 @@
 import { AzureResourceNameFormatterProps, CommonAzureStackProps } from '../index.js';
 /**
- * @classdesc Formats Azure resource names according to naming conventions
+ * Formats Azure resource names according to naming conventions
  * - Applies global/resource prefixes and suffixes
  * - Automatically appends stage to resource names
  * - Supports per-resource customization via options
+ * @category Common
  */
 export declare class AzureResourceNameFormatter {
     props: CommonAzureStackProps;

package/dist/src/common/resource-name-formatter.js

@@ -1,8 +1,9 @@
 /**
- * @classdesc Formats Azure resource names according to naming conventions
+ * Formats Azure resource names according to naming conventions
  * - Applies global/resource prefixes and suffixes
  * - Automatically appends stage to resource names
  * - Supports per-resource customization via options
+ * @category Common
  */
 export class AzureResourceNameFormatter {
     props;

package/dist/src/common/stack.d.ts

@@ -2,7 +2,7 @@ import { ComponentResource, ComponentResourceOptions, Config } from '@pulumi/pul
 import { CommonAzureConstruct } from './construct.js';
 import { CommonAzureStackProps } from './types.js';
 /**
- * @classdesc Common stack to use as a base for all higher level constructs using Pulumi
+ * Common stack to use as a base for all higher level constructs using Pulumi
  * @example
  * ```typescript
  * import { CommonAzureStack } from '@gradientedge/cdk-utils'
@@ -14,6 +14,7 @@ import { CommonAzureStackProps } from './types.js';
  *   }
  * }
  * ```
+ * @category Common
  */
 export declare class CommonAzureStack extends ComponentResource {
     static NODEJS_RUNTIME: string;

package/dist/src/common/stack.js

@@ -6,7 +6,7 @@ import _ from 'lodash';
 import { isDevStage } from '@gradientedge/cdk-utils-common';
 import { registerTagTransformation } from './tagging.js';
 /**
- * @classdesc Common stack to use as a base for all higher level constructs using Pulumi
+ * Common stack to use as a base for all higher level constructs using Pulumi
  * @example
  * ```typescript
  * import { CommonAzureStack } from '@gradientedge/cdk-utils'
@@ -18,6 +18,7 @@ import { registerTagTransformation } from './tagging.js';
  *   }
  * }
  * ```
+ * @category Common
  */
 export class CommonAzureStack extends ComponentResource {
     static NODEJS_RUNTIME = '22';

package/dist/src/common/tagging.d.ts

@@ -3,6 +3,7 @@
  * @param resourceType The Pulumi resource type (e.g., 'azure-native:resources:ResourceGroup')
  * @returns True if the resource supports tags, false otherwise
  */
+/** @category Constant */
 export declare function isTaggableResource(resourceType: string): boolean;
 /**
  * @summary Register a stack transformation to automatically apply tags to Azure resources
@@ -13,6 +14,7 @@ export declare function isTaggableResource(resourceType: string): boolean;
  * registerTagTransformation({ environment: 'production', team: 'platform' })
  * ```
  */
+/** @category Constant */
 export declare function registerTagTransformation(defaultTags: Record<string, string>, tagsToIgnore?: string[]): void;
 /**
  * @summary Helper function to apply tags to a specific resource's properties
@@ -24,6 +26,7 @@ export declare function registerTagTransformation(defaultTags: Record<string, st
  * const resourceGroupProps = applyTags(props, { environment: 'dev' })
  * ```
  */
+/** @category Constant */
 export declare function applyTags<T extends {
     tags?: Record<string, string>;
 }>(props: T, defaultTags: Record<string, string>): T;

package/dist/src/common/tagging.js

@@ -5,6 +5,7 @@ import { RESOURCES_TO_EXCLUDE_TAGS } from './constants.js';
  * @param resourceType The Pulumi resource type (e.g., 'azure-native:resources:ResourceGroup')
  * @returns True if the resource supports tags, false otherwise
  */
+/** @category Constant */
 export function isTaggableResource(resourceType) {
     // Extract the resource name from the type (e.g., 'ResourceGroup' from 'azure-native:resources:ResourceGroup')
     const resourceName = resourceType.split(':').pop() || '';
@@ -24,6 +25,7 @@ export function isTaggableResource(resourceType) {
  * registerTagTransformation({ environment: 'production', team: 'platform' })
  * ```
  */
+/** @category Constant */
 export function registerTagTransformation(defaultTags, tagsToIgnore = []) {
     pulumi.runtime.registerStackTransformation((args) => {
         // Only process taggable resources
@@ -67,6 +69,7 @@ export function registerTagTransformation(defaultTags, tagsToIgnore = []) {
  * const resourceGroupProps = applyTags(props, { environment: 'dev' })
  * ```
  */
+/** @category Constant */
 export function applyTags(props, defaultTags) {
     return {
         ...props,

package/dist/src/common/types.d.ts

@@ -2,14 +2,16 @@ import { GetComponentOutputArgs } from '@pulumi/azure-native/applicationinsights
 import { GetWorkspaceOutputArgs } from '@pulumi/azure-native/operationalinsights/index.js';
 import { BaseProps } from '@gradientedge/cdk-utils-common';
 import { AzureLocation, AzureRemoteBackend } from './constants.js';
+/** @category Interface */
 export interface AzureLocationConfig {
     id: string;
     name: string;
 }
 /**
  * @interface CommonAzureStackProps
- * @description Common properties for Azure stack configuration using Pulumi
+ * Common properties for Azure stack configuration using Pulumi
  */
+/** @category Interface */
 export interface CommonAzureStackProps extends BaseProps {
     stackName?: string;
     resourceGroupName?: string;
@@ -40,6 +42,7 @@ export interface CommonAzureStackProps extends BaseProps {
     useMsi?: boolean;
     msiEndpoint?: string;
 }
+/** @category Interface */
 export interface AzureRemoteBackendProps {
     type: AzureRemoteBackend;
     storageAccountName?: string;
@@ -48,6 +51,7 @@ export interface AzureRemoteBackendProps {
     subscriptionId?: string;
     key?: string;
 }
+/** @category Interface */
 export interface AzureResourceNameFormatterProps {
     exclude?: boolean;
     globalPrefix?: boolean;

package/dist/src/construct/event-handler/main.d.ts

@@ -3,7 +3,7 @@ import { Output } from '@pulumi/pulumi';
 import { AzureFunctionApp } from '../function-app/index.js';
 import { AzureEventHandlerProps, EventHandlerEventGridSubscription, EventHandlerServiceBus } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy an Azure EventGrid Event Handler with Service Bus integration
+ * Provides a construct to create and deploy an Azure EventGrid Event Handler with Service Bus integration
  * @example
  * import { AzureEventHandler, AzureEventHandlerProps } from '@gradientedge/cdk-utils'
  *
@@ -15,6 +15,7 @@ import { AzureEventHandlerProps, EventHandlerEventGridSubscription, EventHandler
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class AzureEventHandler extends AzureFunctionApp {
     props: AzureEventHandlerProps;

package/dist/src/construct/event-handler/main.js

@@ -2,7 +2,7 @@ import { Provider } from '@pulumi/azure-native';
 import { getTopicOutput } from '@pulumi/azure-native/eventgrid/index.js';
 import { AzureFunctionApp } from '../function-app/index.js';
 /**
- * @classdesc Provides a construct to create and deploy an Azure EventGrid Event Handler with Service Bus integration
+ * Provides a construct to create and deploy an Azure EventGrid Event Handler with Service Bus integration
  * @example
  * import { AzureEventHandler, AzureEventHandlerProps } from '@gradientedge/cdk-utils'
  *
@@ -14,6 +14,7 @@ import { AzureFunctionApp } from '../function-app/index.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class AzureEventHandler extends AzureFunctionApp {
     props;

package/dist/src/construct/event-handler/types.d.ts

@@ -3,29 +3,35 @@ import { Namespace, Queue } from '@pulumi/azure-native/servicebus/index.js';
 import { BlobContainer, StorageAccount } from '@pulumi/azure-native/storage/index.js';
 import { DefenderForStorageProps, EventgridEventSubscriptionProps, EventgridTopicProps, ServiceBusNamespaceProps, ServiceBusQueueProps, StorageAccountProps, StorageContainerProps } from '../../services/index.js';
 import { AzureFunctionAppProps } from '../function-app/index.js';
+/** @category Interface */
 export interface EventHandlerEventGridSubscriptionProps {
     dlqStorageAccount: StorageAccountProps;
     dlqStorageContainer: StorageContainerProps;
 }
+/** @category Interface */
 export interface EventHandlerEventGridSubscription {
     dlqStorageAccount: StorageAccount;
     dlqStorageContainer: BlobContainer;
     eventSubscription: EventSubscription;
 }
+/** @category Interface */
 export interface EventHandlerServiceBusProps {
     namespace: ServiceBusNamespaceProps;
     queue: ServiceBusQueueProps;
 }
+/** @category Interface */
 export interface EventHandlerServiceBus {
     namespace: Namespace;
     queue: Queue;
 }
+/** @category Interface */
 export interface EventHandlerEventGridTopicProps extends EventgridTopicProps {
     useExistingTopic: boolean;
     existingSubscriptionId?: string;
     existingTopicName?: string;
     existingResourceGroupName?: string;
 }
+/** @category Interface */
 export interface AzureEventHandlerProps extends AzureFunctionAppProps {
     defender?: DefenderForStorageProps;
     eventGridEventSubscription: EventgridEventSubscriptionProps;

package/dist/src/construct/function-app/main.d.ts

@@ -8,7 +8,7 @@ import { Output, ResourceOptions } from '@pulumi/pulumi';
 import { CommonAzureConstruct } from '../../common/index.js';
 import { AzureFunctionAppProps } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy an Azure Function App with Flex Consumption hosting
+ * Provides a construct to create and deploy an Azure Function App with Flex Consumption hosting
  * @example
  * import { AzureFunctionApp, AzureFunctionAppProps } from '@gradientedge/cdk-utils'
  *
@@ -20,6 +20,7 @@ import { AzureFunctionAppProps } from './types.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class AzureFunctionApp extends CommonAzureConstruct {
     props: AzureFunctionAppProps;

package/dist/src/construct/function-app/main.js

@@ -12,7 +12,7 @@ import { CommonAzureConstruct } from '../../common/index.js';
 import { CosmosRoleDefinition } from '../../services/cosmosdb/constants.js';
 import { AzureAppConfigurationManager, RoleDefinitionId } from '../../services/index.js';
 /**
- * @classdesc Provides a construct to create and deploy an Azure Function App with Flex Consumption hosting
+ * Provides a construct to create and deploy an Azure Function App with Flex Consumption hosting
  * @example
  * import { AzureFunctionApp, AzureFunctionAppProps } from '@gradientedge/cdk-utils'
  *
@@ -24,6 +24,7 @@ import { AzureAppConfigurationManager, RoleDefinitionId } from '../../services/i
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class AzureFunctionApp extends CommonAzureConstruct {
     props;

package/dist/src/construct/function-app/types.d.ts

@@ -1,7 +1,9 @@
 import { AppConfigurationProps, CommonAzureStackProps, ContainerSasTokenProps, FunctionAppFlexConsumptionProps, PortalDashboardProps, ServicePlanProps, StorageAccountProps, StorageContainerProps } from '../../index.js';
+/** @category Interface */
 export interface OtelProps {
     otelTracesSamplerArg: string;
 }
+/** @category Interface */
 export interface FunctionAppProperties {
     app: FunctionAppFlexConsumptionProps;
     appConfiguration: AppConfigurationProps;
@@ -15,6 +17,7 @@ export interface FunctionAppProperties {
     storageContainer: StorageContainerProps;
     timerTriggerCronExpression: string;
 }
+/** @category Interface */
 export interface AzureFunctionAppProps extends CommonAzureStackProps {
     existingTopicName: string;
     existingTopicResourceGroupName: string;

package/dist/src/construct/rest-api/main.d.ts

@@ -3,7 +3,7 @@ import { Output } from '@pulumi/pulumi';
 import { CommonAzureConstruct } from '../../common/index.js';
 import { AzureApi, AzureRestApiProps } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy an Azure API Management service with diagnostics and logging
+ * Provides a construct to create and deploy an Azure API Management service with diagnostics and logging
  * @example
  * import { AzureRestApi, AzureRestApiProps } from '@gradientedge/cdk-utils'
  *
@@ -15,6 +15,7 @@ import { AzureApi, AzureRestApiProps } from './types.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class AzureRestApi extends CommonAzureConstruct {
     props: AzureRestApiProps;

package/dist/src/construct/rest-api/main.js

@@ -5,7 +5,7 @@ import * as pulumi from '@pulumi/pulumi';
 import { CommonAzureConstruct } from '../../common/index.js';
 import { RoleDefinitionId } from '../../services/index.js';
 /**
- * @classdesc Provides a construct to create and deploy an Azure API Management service with diagnostics and logging
+ * Provides a construct to create and deploy an Azure API Management service with diagnostics and logging
  * @example
  * import { AzureRestApi, AzureRestApiProps } from '@gradientedge/cdk-utils'
  *
@@ -17,6 +17,7 @@ import { RoleDefinitionId } from '../../services/index.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class AzureRestApi extends CommonAzureConstruct {
     props;

package/dist/src/construct/rest-api/types.d.ts

@@ -3,16 +3,19 @@ import { RoleAssignment } from '@pulumi/azure-native/authorization/index.js';
 import { GetVaultResult, Secret } from '@pulumi/azure-native/keyvault/index.js';
 import { Input, Output } from '@pulumi/pulumi';
 import { ApiDiagnosticProps, ApiManagementProps, CommonAzureStackProps, MonitorDiagnosticSettingProps } from '../../index.js';
+/** @category Interface */
 export interface ApiAuthKeyVault {
     name: string;
     resourceGroupName: string;
 }
+/** @category Interface */
 export interface AzureRestApiProps extends CommonAzureStackProps {
     apiAuthKeyVault: ApiAuthKeyVault;
     apiManagement: ApiManagementProps;
     apiManagementDiagnostic: ApiDiagnosticProps;
     apiManagementDiagnosticSettings: MonitorDiagnosticSettingProps;
 }
+/** @category Interface */
 export interface AzureApi {
     id: Input<string>;
     name: Input<string>;

package/dist/src/construct/rest-api-function/main.d.ts

@@ -2,7 +2,7 @@ import { ApiManagementApiOperationProps } from '../../services/index.js';
 import { AzureFunctionApp } from '../function-app/index.js';
 import { AzureApiFunction, AzureRestApiFunctionProps } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy an Azure Function App with API Management integration
+ * Provides a construct to create and deploy an Azure Function App with API Management integration
  * @example
  * import { AzureRestApiFunction, AzureRestApiFunctionProps } from '@gradientedge/cdk-utils'
  *
@@ -14,6 +14,7 @@ import { AzureApiFunction, AzureRestApiFunctionProps } from './types.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class AzureRestApiFunction extends AzureFunctionApp {
     props: AzureRestApiFunctionProps;

package/dist/src/construct/rest-api-function/main.js

@@ -6,7 +6,7 @@ import _ from 'lodash';
 import { RoleDefinitionId } from '../../services/index.js';
 import { AzureFunctionApp } from '../function-app/index.js';
 /**
- * @classdesc Provides a construct to create and deploy an Azure Function App with API Management integration
+ * Provides a construct to create and deploy an Azure Function App with API Management integration
  * @example
  * import { AzureRestApiFunction, AzureRestApiFunctionProps } from '@gradientedge/cdk-utils'
  *
@@ -18,6 +18,7 @@ import { AzureFunctionApp } from '../function-app/index.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class AzureRestApiFunction extends AzureFunctionApp {
     props;

package/dist/src/construct/rest-api-function/types.d.ts

@@ -1,8 +1,10 @@
 import { Api, ApiOperation, Backend, NamedValue } from '@pulumi/azure-native/apimanagement/index.js';
 import { ApiManagementApiProps, ApiManagementBackendProps, ApiManagementProps, ApplicationInsightsProps, AzureApi, AzureFunctionAppProps, AzureRestApiProps } from '../../index.js';
+/** @category Interface */
 export interface ApiManagementRestApiProps extends ApiManagementProps {
     useExistingApiManagement: boolean;
 }
+/** @category Interface */
 export interface ApiManagementCors {
     enableCors: boolean;
     allowCredentials: boolean;
@@ -11,6 +13,7 @@ export interface ApiManagementCors {
     allowedOrigins?: string[];
     originSubdomain?: string;
 }
+/** @category Interface */
 export interface AzureRestApiFunctionProps extends AzureRestApiProps, AzureFunctionAppProps {
     apiManagementBackend: ApiManagementBackendProps;
     apiManagementApi: ApiManagementApiProps;
@@ -18,6 +21,7 @@ export interface AzureRestApiFunctionProps extends AzureRestApiProps, AzureFunct
     apiManagement: ApiManagementRestApiProps;
     apiManagementCors?: ApiManagementCors;
 }
+/** @category Interface */
 export interface AzureApiFunction extends AzureApi {
     corsPolicyXmlContent?: string;
     apiOperations: {

package/dist/src/construct/rest-api-with-cache/main.d.ts

@@ -1,7 +1,7 @@
 import { AzureRestApi } from '../rest-api/main.js';
 import { AzureApiWithCache, AzureRestApiWithCacheProps } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy an Azure API Management service with Redis cache integration
+ * Provides a construct to create and deploy an Azure API Management service with Redis cache integration
  * @example
  * import { AzureRestApiWithCache, AzureRestApiWithCacheProps } from '@gradientedge/cdk-utils'
  *
@@ -13,6 +13,7 @@ import { AzureApiWithCache, AzureRestApiWithCacheProps } from './types.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class AzureRestApiWithCache extends AzureRestApi {
     props: AzureRestApiWithCacheProps;

package/dist/src/construct/rest-api-with-cache/main.js

@@ -1,6 +1,6 @@
 import { AzureRestApi } from '../rest-api/main.js';
 /**
- * @classdesc Provides a construct to create and deploy an Azure API Management service with Redis cache integration
+ * Provides a construct to create and deploy an Azure API Management service with Redis cache integration
  * @example
  * import { AzureRestApiWithCache, AzureRestApiWithCacheProps } from '@gradientedge/cdk-utils'
  *
@@ -12,6 +12,7 @@ import { AzureRestApi } from '../rest-api/main.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class AzureRestApiWithCache extends AzureRestApi {
     props;

package/dist/src/construct/rest-api-with-cache/types.d.ts

@@ -3,9 +3,11 @@ import { Secret } from '@pulumi/azure-native/keyvault/index.js';
 import { Redis } from '@pulumi/azure-native/redis/index.js';
 import { RedisProps } from '../../index.js';
 import { AzureApi, AzureRestApiProps } from '../index.js';
+/** @category Interface */
 export interface AzureRestApiWithCacheProps extends AzureRestApiProps {
     apiManagementManagedRedis: RedisProps;
 }
+/** @category Interface */
 export interface AzureApiWithCache extends AzureApi {
     redis: Redis;
     redisNamedValueSecret: Secret;

package/dist/src/construct/site-with-webapp/main.d.ts

@@ -3,7 +3,7 @@ import { Output, ResourceOptions } from '@pulumi/pulumi';
 import { CommonAzureConstruct } from '../../common/index.js';
 import { Site, SiteWithWebAppProps } from './types.js';
 /**
- * @classdesc Provides a construct to create and deploy a site hosted with an Azure Linux Web App
+ * Provides a construct to create and deploy a site hosted with an Azure Linux Web App
  * @example
  * import { SiteWithWebApp, SiteWithWebAppProps } from '@gradientedge/cdk-utils'
  *
@@ -15,6 +15,7 @@ import { Site, SiteWithWebAppProps } from './types.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export declare class SiteWithWebApp extends CommonAzureConstruct {
     props: SiteWithWebAppProps;

package/dist/src/construct/site-with-webapp/main.js

@@ -5,7 +5,7 @@ import { getComponentOutput } from '@pulumi/azure-native/applicationinsights/ind
 import _ from 'lodash';
 import { CommonAzureConstruct } from '../../common/index.js';
 /**
- * @classdesc Provides a construct to create and deploy a site hosted with an Azure Linux Web App
+ * Provides a construct to create and deploy a site hosted with an Azure Linux Web App
  * @example
  * import { SiteWithWebApp, SiteWithWebAppProps } from '@gradientedge/cdk-utils'
  *
@@ -17,6 +17,7 @@ import { CommonAzureConstruct } from '../../common/index.js';
  *     this.initResources()
  *   }
  * }
+ * @category Construct
  */
 export class SiteWithWebApp extends CommonAzureConstruct {
     props;

package/dist/src/construct/site-with-webapp/types.d.ts

@@ -5,6 +5,7 @@ import { AppServicePlan, WebApp } from '@pulumi/azure-native/web/index.js';
 import { Output } from '@pulumi/pulumi';
 import { CommonAzureStackProps } from '../../common/index.js';
 import { LinuxWebAppProps, ServicePlanProps, StorageAccountProps, StorageContainerProps } from '../../services/index.js';
+/** @category Interface */
 export interface SiteProps {
     appServicePlan: ServicePlanProps;
     codeArchiveFile: GetFileOutputArgs;
@@ -12,6 +13,7 @@ export interface SiteProps {
     storageContainer: StorageContainerProps;
     webApp: LinuxWebAppProps;
 }
+/** @category Interface */
 export interface SiteWithWebAppProps extends CommonAzureStackProps {
     deploySource: string;
     nodeOptions: string;
@@ -20,6 +22,7 @@ export interface SiteWithWebAppProps extends CommonAzureStackProps {
     site: SiteProps;
     startCommand: string;
 }
+/** @category Interface */
 export interface Site {
     appServicePlan: AppServicePlan;
     codeArchiveFile: Output<archive.GetFileResult>;

package/dist/src/services/api-management/main.d.ts

@@ -3,7 +3,7 @@ import { ResourceOptions } from '@pulumi/pulumi';
 import { CommonAzureConstruct } from '../../common/index.js';
 import { ApiDiagnosticProps, ApiManagementApiProps, ApiManagementBackendProps, ApiManagementProps, ApiOperationPolicyProps, ApiOperationProps, ApiPolicyProps, ApiSubscriptionProps, CacheProps, LoggerProps, NamedValueProps, ResolveApiManagementProps } from './types.js';
 /**
- * @classdesc Provides operations on Azure API Management using Pulumi
+ * Provides operations on Azure API Management using Pulumi
  * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
  * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
  * @example
@@ -18,6 +18,7 @@ import { ApiDiagnosticProps, ApiManagementApiProps, ApiManagementBackendProps, A
  *   }
  * }
  * ```
+ * @category Service
  */
 export declare class AzureApiManagementManager {
     /**
@@ -132,7 +133,7 @@ export declare class AzureApiManagementManager {
     createPolicy(id: string, scope: CommonAzureConstruct, props: ApiPolicyProps, resourceOptions?: ResourceOptions): import("@pulumi/azure-native/apimanagement/apiPolicy.js").ApiPolicy;
     /**
      * @summary Method to create a new API Management custom domain
-     * @note In Pulumi Azure Native, custom domains are configured as part of the API Management service resource,
+     * In Pulumi Azure Native, custom domains are configured as part of the API Management service resource,
      * not as a separate resource. Use the hostnameConfigurations property when creating the service.
      */
     createApiManagementCustomDomain(): void;