@pulumi/databricks/getFunctions.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * > This data source can only be used with a workspace-level provider!
 *
 * Retrieves a list of [User-Defined Functions (UDFs) registered in the Unity Catalog](https://docs.databricks.com/en/udf/unity-catalog.html).
 *
 * ## Example Usage
 *
 * List all functions defined in a specific schema (`main.default` in this example):
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const all = databricks.getFunctions({
 *     catalogName: "main",
 *     schemaName: "default",
 * });
 * export const allExternalLocations = all.then(all => all.functions);
 * ```
 *
 * ## Related Resources
 *
 * The following resources are used in the same context:
 *
 * * databricks.Schema to get information about a single schema
 */
export declare function getFunctions(args: GetFunctionsArgs, opts?: pulumi.InvokeOptions): Promise<GetFunctionsResult>;
/**
 * A collection of arguments for invoking getFunctions.
 */
export interface GetFunctionsArgs {
    /**
     * Name of databricks_catalog.
     */
    catalogName: string;
    /**
     * list of objects describing individual UDF. Each object consists of the following attributes (refer to [REST API documentation](https://docs.databricks.com/api/workspace/functions/list#functions) for up-to-date list of attributes. Default type is String):
     */
    functions?: inputs.GetFunctionsFunction[];
    /**
     * flag to specify if include UDFs in the response for which the principal can only access selective metadata for.
     */
    includeBrowse?: boolean;
    /**
     * Name of databricks_schema.
     */
    schemaName: string;
}
/**
 * A collection of values returned by getFunctions.
 */
export interface GetFunctionsResult {
    /**
     * Name of parent catalog.
     */
    readonly catalogName: string;
    /**
     * list of objects describing individual UDF. Each object consists of the following attributes (refer to [REST API documentation](https://docs.databricks.com/api/workspace/functions/list#functions) for up-to-date list of attributes. Default type is String):
     */
    readonly functions: outputs.GetFunctionsFunction[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly includeBrowse?: boolean;
    /**
     * Name of parent schema relative to its parent catalog.
     */
    readonly schemaName: string;
}
/**
 * > This data source can only be used with a workspace-level provider!
 *
 * Retrieves a list of [User-Defined Functions (UDFs) registered in the Unity Catalog](https://docs.databricks.com/en/udf/unity-catalog.html).
 *
 * ## Example Usage
 *
 * List all functions defined in a specific schema (`main.default` in this example):
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const all = databricks.getFunctions({
 *     catalogName: "main",
 *     schemaName: "default",
 * });
 * export const allExternalLocations = all.then(all => all.functions);
 * ```
 *
 * ## Related Resources
 *
 * The following resources are used in the same context:
 *
 * * databricks.Schema to get information about a single schema
 */
export declare function getFunctionsOutput(args: GetFunctionsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetFunctionsResult>;
/**
 * A collection of arguments for invoking getFunctions.
 */
export interface GetFunctionsOutputArgs {
    /**
     * Name of databricks_catalog.
     */
    catalogName: pulumi.Input<string>;
    /**
     * list of objects describing individual UDF. Each object consists of the following attributes (refer to [REST API documentation](https://docs.databricks.com/api/workspace/functions/list#functions) for up-to-date list of attributes. Default type is String):
     */
    functions?: pulumi.Input<pulumi.Input<inputs.GetFunctionsFunctionArgs>[]>;
    /**
     * flag to specify if include UDFs in the response for which the principal can only access selective metadata for.
     */
    includeBrowse?: pulumi.Input<boolean>;
    /**
     * Name of databricks_schema.
     */
    schemaName: pulumi.Input<string>;
}