@pulumi/databricks/getVolume.js

A Pulumi package for creating and managing databricks cloud resources.

"use strict";
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getVolumeOutput = exports.getVolume = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * Retrieves details about databricks.Volume that was created by Pulumi or manually.
 * A volume can be identified by its three-level (fully qualified) name (in the form of: `catalogName`.`schemaName`.`volumeName`) as input. This can be retrieved programmatically using databricks.getVolumes data source.
 *
 * ## Example Usage
 *
 * * Retrieve details of all volumes in in a _things_ databricks.Schema of a  _sandbox_ databricks_catalog:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const all = databricks.getVolumes({
 *     catalogName: "sandbox",
 *     schemaName: "things",
 * });
 * const _this = all.then(all => .reduce((__obj, [__key, __value]) => ({ ...__obj, [__key]: databricks.getVolume({
 *     name: __value,
 * }) })));
 * ```
 *
 * * Search for a specific volume by its fully qualified name
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const _this = databricks.getVolume({
 *     name: "catalog.schema.volume",
 * });
 * ```
 *
 * ## Related Resources
 *
 * The following resources are used in the same context:
 *
 * * databricks.Volume to manage volumes within Unity Catalog.
 * * databricks.Schema to manage schemas within Unity Catalog.
 * * databricks.Catalog to manage catalogs within Unity Catalog.
 */
function getVolume(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("databricks:index/getVolume:getVolume", {
        "id": args.id,
        "name": args.name,
        "volumeInfo": args.volumeInfo,
    }, opts);
}
exports.getVolume = getVolume;
/**
 * Retrieves details about databricks.Volume that was created by Pulumi or manually.
 * A volume can be identified by its three-level (fully qualified) name (in the form of: `catalogName`.`schemaName`.`volumeName`) as input. This can be retrieved programmatically using databricks.getVolumes data source.
 *
 * ## Example Usage
 *
 * * Retrieve details of all volumes in in a _things_ databricks.Schema of a  _sandbox_ databricks_catalog:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const all = databricks.getVolumes({
 *     catalogName: "sandbox",
 *     schemaName: "things",
 * });
 * const _this = all.then(all => .reduce((__obj, [__key, __value]) => ({ ...__obj, [__key]: databricks.getVolume({
 *     name: __value,
 * }) })));
 * ```
 *
 * * Search for a specific volume by its fully qualified name
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const _this = databricks.getVolume({
 *     name: "catalog.schema.volume",
 * });
 * ```
 *
 * ## Related Resources
 *
 * The following resources are used in the same context:
 *
 * * databricks.Volume to manage volumes within Unity Catalog.
 * * databricks.Schema to manage schemas within Unity Catalog.
 * * databricks.Catalog to manage catalogs within Unity Catalog.
 */
function getVolumeOutput(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("databricks:index/getVolume:getVolume", {
        "id": args.id,
        "name": args.name,
        "volumeInfo": args.volumeInfo,
    }, opts);
}
exports.getVolumeOutput = getVolumeOutput;
//# sourceMappingURL=getVolume.js.map