@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
95 lines (94 loc) • 3.33 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* > **Note** This data source can only be used with an account-level provider!
*
* Retrieves a mapping of name to id of databricks.Metastore objects, that were created by Pulumi or manually, so that special handling could be applied.
*
* > **Note** `accountId` provider configuration property is required for this resource to work. Data resource will error in case of metastores with duplicate names. This data source is only available for users & service principals with account admin status
*
* ## Example Usage
*
* Mapping of name to id of all metastores:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const all = databricks.getMetastores({});
* export const allMetastores = all.then(all => all.ids);
* ```
*
* ## Related Resources
*
* The following resources are used in the same context:
*
* * databricks.Metastore to get information about a single metastore.
* * databricks.Metastore to manage Metastores within Unity Catalog.
* * databricks.Catalog to manage catalogs within Unity Catalog.
*/
export declare function getMetastores(args?: GetMetastoresArgs, opts?: pulumi.InvokeOptions): Promise<GetMetastoresResult>;
/**
* A collection of arguments for invoking getMetastores.
*/
export interface GetMetastoresArgs {
/**
* Mapping of name to id of databricks_metastore
*/
ids?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getMetastores.
*/
export interface GetMetastoresResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Mapping of name to id of databricks_metastore
*/
readonly ids: {
[key: string]: string;
};
}
/**
* > **Note** This data source can only be used with an account-level provider!
*
* Retrieves a mapping of name to id of databricks.Metastore objects, that were created by Pulumi or manually, so that special handling could be applied.
*
* > **Note** `accountId` provider configuration property is required for this resource to work. Data resource will error in case of metastores with duplicate names. This data source is only available for users & service principals with account admin status
*
* ## Example Usage
*
* Mapping of name to id of all metastores:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const all = databricks.getMetastores({});
* export const allMetastores = all.then(all => all.ids);
* ```
*
* ## Related Resources
*
* The following resources are used in the same context:
*
* * databricks.Metastore to get information about a single metastore.
* * databricks.Metastore to manage Metastores within Unity Catalog.
* * databricks.Catalog to manage catalogs within Unity Catalog.
*/
export declare function getMetastoresOutput(args?: GetMetastoresOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetMetastoresResult>;
/**
* A collection of arguments for invoking getMetastores.
*/
export interface GetMetastoresOutputArgs {
/**
* Mapping of name to id of databricks_metastore
*/
ids?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}