@drunk-pulumi/azure 1.0.23 → 1.0.25

package/Builder/types/envRoleBuilder.d.ts

@@ -1,17 +1,43 @@
 import { Input, Output } from '@pulumi/pulumi';
-import { EnvRoleKeyTypes, EnvRolesInfo } from '../../AzAd/EnvRoles';
-import { RoleEnableTypes } from '../../AzAd/EnvRoles.Consts';
-import { KeyVaultInfo, WithNamedType } from '../../types';
+import { EnvRoleKeyTypes, EnvRolesInfo, KeyVaultInfo, RoleEnableTypes, WithNamedType } from '../../types';
 import { IInfo } from './genericBuilder';
+/**
+ * Properties for granting permissions to an environment role.
+ */
 export type EnvRoleBuilderGrantType = WithNamedType & {
     permissions: RoleEnableTypes;
     scope: Input<string>;
 };
+/**
+ * Interface for building environment roles.
+ */
 export interface IEnvRoleBuilder extends EnvRolesInfo, IInfo<EnvRolesInfo> {
+    /**
+     * Method to grant permissions to an environment role.
+     * @param props - Properties for granting permissions.
+     * @returns An instance of IEnvRoleBuilder.
+     */
     grant(props: EnvRoleBuilderGrantType): IEnvRoleBuilder;
+    /**
+     * Method to add a member to an environment role.
+     * @param type - The type of the environment role key.
+     * @param memberId - The ID of the member to add.
+     * @returns An instance of IEnvRoleBuilder.
+     */
     addMember(type: EnvRoleKeyTypes, memberId: Input<string>): IEnvRoleBuilder;
+    /**
+     * Method to add an identity to an environment role.
+     * @param type - The type of the environment role key.
+     * @param identity - The identity to add.
+     * @returns An instance of IEnvRoleBuilder.
+     */
     addIdentity(type: EnvRoleKeyTypes, identity: Output<{
         principalId: string;
     } | undefined>): IEnvRoleBuilder;
+    /**
+     * Method to push the environment role to a key vault.
+     * @param vaultInfo - The key vault information.
+     * @returns An instance of IEnvRoleBuilder.
+     */
     pushTo(vaultInfo: KeyVaultInfo): IEnvRoleBuilder;
 }

package/Builder/types/genericBuilder.d.ts

@@ -1,36 +1,114 @@
 import { BasicResourceWithVaultArgs, LoginArgs, ResourceInfo, TypeOmit, WithDependsOn } from '../../types';
+/**
+ * Properties for a builder, including basic resource properties with vault information and dependencies.
+ */
 export type BuilderProps = BasicResourceWithVaultArgs & WithDependsOn;
+/**
+ * Type to omit builder properties from a given type.
+ */
 export type OmitBuilderProps<T> = TypeOmit<T, BuilderProps>;
+/**
+ * Interface for a login builder.
+ * @template IReturnInterface - The return type of the builder methods.
+ */
 export interface ILoginBuilder<IReturnInterface> {
+    /**
+     * Method to generate login credentials.
+     * @returns The return type specified by IReturnInterface.
+     */
     generateLogin(): IReturnInterface;
+    /**
+     * Method to set login information.
+     * @param props - The login arguments.
+     * @returns The return type specified by IReturnInterface.
+     */
     withLoginInfo(props: LoginArgs): IReturnInterface;
 }
+/**
+ * Interface for a synchronous builder.
+ * @template TResults - The type of the build result.
+ */
 export interface IBuilder<TResults extends ResourceInfo> {
     commonProps: BuilderProps;
+    /**
+     * Method to build the resource.
+     * @returns The build result of type TResults.
+     */
     build(): TResults;
 }
+/**
+ * Abstract class for a synchronous builder.
+ * @template TResults - The type of the build result.
+ */
 export declare abstract class Builder<TResults extends ResourceInfo> implements IBuilder<TResults> {
     commonProps: BuilderProps;
     protected constructor(commonProps: BuilderProps);
     abstract build(): TResults;
 }
+/**
+ * Interface for an asynchronous builder.
+ * @template TResults - The type of the build result.
+ */
 export interface IBuilderAsync<TResults extends ResourceInfo> extends Omit<IBuilder<TResults>, 'build'> {
+    /**
+     * Method to build the resource asynchronously.
+     * @returns A promise that resolves to the build result of type TResults.
+     */
     build(): Promise<TResults>;
 }
+/**
+ * Abstract class for an asynchronous builder.
+ * @template TResults - The type of the build result.
+ */
 export declare abstract class BuilderAsync<TResults extends ResourceInfo> implements IBuilderAsync<TResults> {
     commonProps: BuilderProps;
     protected constructor(commonProps: BuilderProps);
     abstract build(): Promise<TResults>;
 }
+/**
+ * Interface for enabling encryption on a builder.
+ * @template TBuilderResults - The return type of the builder methods.
+ */
 export interface IEncryptable<TBuilderResults> {
+    /**
+     * Method to enable encryption.
+     * @param enabled - Whether encryption is enabled.
+     * @returns The return type specified by TBuilderResults.
+     */
     enableEncryption(enabled?: boolean): TBuilderResults;
 }
+/**
+ * Interface for locking a builder.
+ * @template TBuilderResults - The return type of the builder methods.
+ */
 export interface ILockable<TBuilderResults> {
+    /**
+     * Method to lock the builder.
+     * @param lock - Whether the builder is locked.
+     * @returns The return type specified by TBuilderResults.
+     */
     lock(lock?: boolean): TBuilderResults;
 }
+/**
+ * Interface for ignoring changes on a builder.
+ * @template TBuilderResults - The return type of the builder methods.
+ */
 export interface IIgnoreChanges<TBuilderResults> {
+    /**
+     * Method to specify properties to ignore changes from.
+     * @param props - The properties to ignore changes from.
+     * @returns The return type specified by TBuilderResults.
+     */
     ignoreChangesFrom(...props: string[]): TBuilderResults;
 }
+/**
+ * Interface for retrieving information from a builder.
+ * @template TBuilderResults - The return type of the builder methods.
+ */
 export interface IInfo<TBuilderResults> {
+    /**
+     * Method to retrieve information from the builder.
+     * @returns The return type specified by TBuilderResults.
+     */
     info(): TBuilderResults;
 }

package/Builder/types/genericBuilder.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BuilderAsync = exports.Builder = void 0;
+/**
+ * Abstract class for a synchronous builder.
+ * @template TResults - The type of the build result.
+ */
 class Builder {
     commonProps;
     constructor(commonProps) {
@@ -8,6 +12,10 @@ class Builder {
     }
 }
 exports.Builder = Builder;
+/**
+ * Abstract class for an asynchronous builder.
+ * @template TResults - The type of the build result.
+ */
 class BuilderAsync {
     commonProps;
     constructor(commonProps) {
@@ -15,4 +23,4 @@ class BuilderAsync {
     }
 }
 exports.BuilderAsync = BuilderAsync;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2VuZXJpY0J1aWxkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvQnVpbGRlci90eXBlcy9nZW5lcmljQnVpbGRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUF1QkEsTUFBc0IsT0FBTztJQUdFO0lBQTdCLFlBQTZCLFdBQXlCO1FBQXpCLGdCQUFXLEdBQVgsV0FBVyxDQUFjO0lBQUcsQ0FBQztDQUUzRDtBQUxELDBCQUtDO0FBUUQsTUFBc0IsWUFBWTtJQUdIO0lBQTdCLFlBQTZCLFdBQXlCO1FBQXpCLGdCQUFXLEdBQVgsV0FBVyxDQUFjO0lBQUcsQ0FBQztDQUUzRDtBQUxELG9DQUtDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2VuZXJpY0J1aWxkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvQnVpbGRlci90eXBlcy9nZW5lcmljQnVpbGRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFtREE7OztHQUdHO0FBQ0gsTUFBc0IsT0FBTztJQUdFO0lBQTdCLFlBQTZCLFdBQXlCO1FBQXpCLGdCQUFXLEdBQVgsV0FBVyxDQUFjO0lBQUcsQ0FBQztDQUUzRDtBQUxELDBCQUtDO0FBZUQ7OztHQUdHO0FBQ0gsTUFBc0IsWUFBWTtJQUdIO0lBQTdCLFlBQTZCLFdBQXlCO1FBQXpCLGdCQUFXLEdBQVgsV0FBVyxDQUFjO0lBQUcsQ0FBQztDQUUzRDtBQUxELG9DQUtDIn0=

package/Builder/types/iotHubBuilder.d.ts

@@ -2,30 +2,63 @@ import { BuilderProps, IBuilder } from './genericBuilder';
 import { ResourceInfo, WithEncryptionInfo } from '../../types';
 import * as devices from '@pulumi/azure-native/devices';
 import { Input } from '@pulumi/pulumi';
+/**
+ * Arguments for the IoT Hub Builder.
+ */
 export type IotHubBuilderArgs = BuilderProps & WithEncryptionInfo;
+/**
+ * Properties for configuring the SKU of an IoT Hub.
+ */
 export type IotHubSkuBuilderType = {
     name: devices.IotHubSku;
     capacity?: number;
 };
+/**
+ * Properties for configuring the service bus settings of an IoT Hub.
+ */
 export type IotHubBusBuilderType = {
-    /** provide the queue connection string to enable message to be pushing to service bus queue */
+    /** Provide the queue connection string to enable messages to be pushed to the service bus queue */
     queueMessageConnectionString?: Input<string>;
-    /** provide the topic connection string to enable message to be pushing to service bus topic */
+    /** Provide the topic connection string to enable messages to be pushed to the service bus topic */
     topicMessageConnectionString?: Input<string>;
 };
+/**
+ * Properties for configuring the storage settings of an IoT Hub.
+ */
 export type IotHubStorageBuilderType = {
     connectionString: Input<string>;
-    /** provide the file container name to enable file to be upload in IOT hub*/
+    /** Provide the file container name to enable files to be uploaded in IoT Hub */
     fileContainerName?: Input<string>;
-    /** provide the message container name to enable message to be pushing to storage */
+    /** Provide the message container name to enable messages to be pushed to storage */
     messageContainerName?: Input<string>;
-    /** provide the event container name to enable events to be pushing to storage */
+    /** Provide the event container name to enable events to be pushed to storage */
     eventContainerName?: Input<string>;
 };
+/**
+ * Interface for building the SKU of an IoT Hub.
+ */
 export interface IIotHubSkuBuilder {
+    /**
+     * Method to set the SKU for the IoT Hub.
+     * @param props - Properties for the IoT Hub SKU.
+     * @returns An instance of IIotHubBuilder.
+     */
     withSku(props: IotHubSkuBuilderType): IIotHubBuilder;
 }
+/**
+ * Interface for building an IoT Hub.
+ */
 export interface IIotHubBuilder extends IBuilder<ResourceInfo> {
+    /**
+     * Method to set the service bus properties for the IoT Hub.
+     * @param props - Properties for the service bus.
+     * @returns An instance of IIotHubBuilder.
+     */
     withBus(props: IotHubBusBuilderType): IIotHubBuilder;
+    /**
+     * Method to set the storage properties for the IoT Hub.
+     * @param props - Properties for the storage.
+     * @returns An instance of IIotHubBuilder.
+     */
     withStorage(props: IotHubStorageBuilderType): IIotHubBuilder;
 }

package/Builder/types/logicAppBuilder.d.ts

@@ -1,10 +1,27 @@
 import { BuilderProps, IBuilder } from './genericBuilder';
 import { ResourceInfo } from '../../types';
 import * as logic from '@pulumi/azure-native/logic';
+/**
+ * Arguments for the Logic App Builder.
+ */
 export type LogicAppBuilderArgs = BuilderProps;
+/**
+ * Type for specifying the SKU of a Logic App.
+ */
 export type LogicAppSku = logic.IntegrationAccountSkuName | string;
+/**
+ * Interface for building the SKU of a Logic App.
+ */
 export interface ILogicAppSkuBuilder {
+    /**
+     * Method to set the SKU for the Logic App.
+     * @param props - The SKU name or a custom SKU string.
+     * @returns An instance of ILogicAppBuilder.
+     */
     withSku(props: LogicAppSku): ILogicAppBuilder;
 }
+/**
+ * Interface for building a Logic App.
+ */
 export interface ILogicAppBuilder extends IBuilder<ResourceInfo> {
 }

package/Builder/types/mySqlBuilder.d.ts

@@ -4,10 +4,16 @@ import * as pulumi from '@pulumi/pulumi';
 import * as dbformysql from '@pulumi/azure-native/dbformysql';
 import { Input } from '@pulumi/pulumi';
 import { enums } from '@pulumi/azure-native/types';
+/**
+ * Arguments for the MySQL Builder.
+ */
 export type MySqlBuilderArgs = BuilderProps & WithEncryptionInfo;
+/**
+ * Properties for configuring the SKU of a MySQL server.
+ */
 type MySqlSkuArgs = {
     /**
-     * The name of the sku, e.g. Standard_D32s_v3.
+     * The name of the SKU, e.g. Standard_D32s_v3.
      */
     name: pulumi.Input<string>;
     /**
@@ -15,13 +21,22 @@ type MySqlSkuArgs = {
      */
     tier: pulumi.Input<string | enums.dbformysql.SkuTier>;
 };
+/**
+ * Properties for configuring the MySQL SKU and version.
+ */
 export type MySqlSkuBuilderType = {
     sku: MySqlSkuArgs;
     version: dbformysql.ServerVersion;
 };
+/**
+ * Properties for configuring the network settings of a MySQL server.
+ */
 export type MySqlNetworkBuilderType = NetworkPropsType & {
     allowsPublicAccess?: Input<boolean>;
 };
+/**
+ * Properties for configuring additional options of a MySQL server.
+ */
 export type MySqlOptionsBuilderType = {
     storageSizeGB?: Input<number>;
     maintenanceWindow?: {
@@ -30,16 +45,54 @@ export type MySqlOptionsBuilderType = {
         startMinute: Input<number>;
     };
 };
+/**
+ * Interface for building the SKU of a MySQL server.
+ */
 export interface IMySqlSkuBuilder {
+    /**
+     * Method to set the SKU for the MySQL server.
+     * @param props - Properties for the MySQL SKU and version.
+     * @returns An instance of IMySqlLoginBuilder.
+     */
     withSku(props: MySqlSkuBuilderType): IMySqlLoginBuilder;
 }
+/**
+ * Interface for building login credentials for a MySQL server.
+ */
 export interface IMySqlLoginBuilder {
+    /**
+     * Method to set login credentials for the MySQL server.
+     * @param props - Properties for the login credentials.
+     * @returns An instance of IMySqlBuilder.
+     */
     withLogin(props: LoginArgs): IMySqlBuilder;
+    /**
+     * Method to generate login credentials for the MySQL server.
+     * @returns An instance of IMySqlBuilder.
+     */
     generateLogin(): IMySqlBuilder;
 }
+/**
+ * Interface for building a MySQL server.
+ */
 export interface IMySqlBuilder extends IBuilder<ResourceInfo> {
+    /**
+     * Method to set network properties for the MySQL server.
+     * @param props - Properties for the network configuration.
+     * @returns An instance of IMySqlBuilder.
+     */
     withNetwork(props: MySqlNetworkBuilderType): IMySqlBuilder;
+    /**
+     * Method to set additional options for the MySQL server.
+     * @param props - Properties for the additional options.
+     * @returns An instance of IMySqlBuilder.
+     */
     withOptions(props: MySqlOptionsBuilderType): IMySqlBuilder;
+    /**
+     * Method to add databases to the MySQL server.
+     * @param props - Names of the databases to add.
+     * @returns An instance of IMySqlBuilder.
+     */
     withDatabases(...props: string[]): IMySqlBuilder;
 }
 export {};

package/Builder/types/posgreSqlBuilder.d.ts

@@ -4,42 +4,104 @@ import * as pulumi from '@pulumi/pulumi';
 import * as postgresql from '@pulumi/azure-native/dbforpostgresql';
 import { Input } from '@pulumi/pulumi';
 import { enums } from '@pulumi/azure-native/types';
+/**
+ * Arguments required for building a PostgreSQL resource.
+ */
 export type PostgreSqlBuilderArgs = BuilderProps & WithEncryptionInfo;
+/**
+ * Arguments for defining the SKU of a PostgreSQL server.
+ */
 type PostgreSkuArgs = {
     /**
-     * The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.
+     * The name of the SKU, typically tier + family + cores, e.g., Standard_D4s_v3.
      */
     name: pulumi.Input<string>;
     /**
-     * The tier of the particular SKU, e.g. Burstable.
+     * The tier of the particular SKU, e.g., Burstable.
      */
     tier: pulumi.Input<string | enums.dbforpostgresql.SkuTier>;
 };
+/**
+ * Type for defining the SKU and version of a PostgreSQL server.
+ */
 export type PostgreSqlSkuBuilderType = {
     sku: PostgreSkuArgs;
     version: postgresql.ServerVersion;
 };
+/**
+ * Type for defining network properties for a PostgreSQL server.
+ */
 export type PostgreSqlNetworkBuilderType = NetworkPropsType & {
+    /**
+     * Whether the server allows public access.
+     */
     allowsPublicAccess?: Input<boolean>;
 };
+/**
+ * Type for defining additional options for a PostgreSQL server.
+ */
 export type PostgreSqlOptionsBuilderType = {
+    /**
+     * The storage size in GB.
+     */
     storageSizeGB?: Input<number>;
+    /**
+     * Maintenance window settings.
+     */
     maintenanceWindow?: {
         dayOfWeek: Input<number>;
         startHour: Input<number>;
         startMinute: Input<number>;
     };
 };
+/**
+ * Interface for building the SKU of a PostgreSQL server.
+ */
 export interface IPostgreSqlSkuBuilder {
+    /**
+     * Sets the SKU properties for the PostgreSQL server.
+     * @param props - The SKU properties.
+     * @returns An instance of IPostgreSqlLoginBuilder.
+     */
     withSku(props: PostgreSqlSkuBuilderType): IPostgreSqlLoginBuilder;
 }
+/**
+ * Interface for building the login credentials of a PostgreSQL server.
+ */
 export interface IPostgreSqlLoginBuilder {
+    /**
+     * Sets the login credentials for the PostgreSQL server.
+     * @param props - The login arguments.
+     * @returns An instance of IPostgreSqlBuilder.
+     */
     withLogin(props: LoginArgs): IPostgreSqlBuilder;
+    /**
+     * Generates login credentials for the PostgreSQL server.
+     * @returns An instance of IPostgreSqlBuilder.
+     */
     generateLogin(): IPostgreSqlBuilder;
 }
+/**
+ * Interface for building a PostgreSQL server.
+ */
 export interface IPostgreSqlBuilder extends IBuilder<ResourceInfo> {
+    /**
+     * Sets the network properties for the PostgreSQL server.
+     * @param props - The network properties.
+     * @returns An instance of IPostgreSqlBuilder.
+     */
     withNetwork(props: PostgreSqlNetworkBuilderType): IPostgreSqlBuilder;
+    /**
+     * Sets additional options for the PostgreSQL server.
+     * @param props - The options properties.
+     * @returns An instance of IPostgreSqlBuilder.
+     */
     withOptions(props: PostgreSqlOptionsBuilderType): IPostgreSqlBuilder;
+    /**
+     * Adds databases to the PostgreSQL server.
+     * @param props - The names of the databases.
+     * @returns An instance of IPostgreSqlBuilder.
+     */
     withDatabases(...props: string[]): IPostgreSqlBuilder;
 }
 export {};

package/Builder/types/privateDnsZoneBuilder.d.ts

@@ -1,12 +1,38 @@
 import { Input } from '@pulumi/pulumi';
 import { ResourceInfo } from '../../types';
 import { DnsZoneARecordType } from './dnsZoneBuilder';
+/**
+ * Type for defining the virtual network linking properties for a private DNS zone.
+ */
 export type PrivateDnsZoneVnetLinkingType = {
+    /**
+     * List of virtual network IDs to link to the private DNS zone.
+     */
     vnetIds?: Input<string>[];
+    /**
+     * List of subnet IDs to link to the private DNS zone. The vnetId will be calculated based on subnetId.
+     */
     subnetIds?: Input<string>[];
 };
+/**
+ * Interface for building a private DNS zone.
+ */
 export interface IPrivateDnsZoneBuilder {
+    /**
+     * Adds an A record to the private DNS zone.
+     * @param props - The properties of the A record.
+     * @returns An instance of IPrivateDnsZoneBuilder.
+     */
     withARecord(props: DnsZoneARecordType): IPrivateDnsZoneBuilder;
+    /**
+     * Links the private DNS zone to virtual networks.
+     * @param props - The linking properties.
+     * @returns An instance of IPrivateDnsZoneBuilder.
+     */
     linkTo(props: PrivateDnsZoneVnetLinkingType): IPrivateDnsZoneBuilder;
+    /**
+     * Builds the private DNS zone and returns the resource information.
+     * @returns The resource information of the built private DNS zone.
+     */
     build(): ResourceInfo;
 }

package/Builder/types/redisCacheBuilder.d.ts

@@ -1,15 +1,46 @@
 import { BuilderProps, IBuilder } from './genericBuilder';
 import * as cache from '@pulumi/azure-native/cache';
 import { NetworkPropsType, ResourceInfo } from '../../types';
+/**
+ * Arguments required for building a Redis Cache resource.
+ */
 export type RedisCacheBuilderArgs = BuilderProps;
+/**
+ * Arguments for defining the SKU of a Redis Cache.
+ */
 export type RedisCacheSkuBuilder = {
+    /**
+     * The name of the SKU.
+     */
     name: cache.SkuName | string;
+    /**
+     * The family of the SKU.
+     */
     family: cache.SkuFamily | string;
+    /**
+     * The capacity of the SKU.
+     */
     capacity: number;
 };
+/**
+ * Interface for building the SKU of a Redis Cache.
+ */
 export interface IRedisCacheSkuBuilder {
+    /**
+     * Sets the SKU properties for the Redis Cache.
+     * @param props - The SKU properties.
+     * @returns An instance of IRedisCacheBuilder.
+     */
     withSku(props: RedisCacheSkuBuilder): IRedisCacheBuilder;
 }
+/**
+ * Interface for building a Redis Cache.
+ */
 export interface IRedisCacheBuilder extends IBuilder<ResourceInfo> {
+    /**
+     * Sets the network properties for the Redis Cache.
+     * @param props - The network properties.
+     * @returns An instance of IRedisCacheBuilder.
+     */
     withNetwork(props: NetworkPropsType): IRedisCacheBuilder;
 }