@pulumi/databricks/getGroup.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.getGroupOutput = exports.getGroup = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * > **Note** If you have a fully automated setup with workspaces created by databricks.MwsWorkspaces or azurerm_databricks_workspace, please make sure to add dependsOn attribute in order to prevent _default auth: cannot configure default credentials_ errors.
 *
 * Retrieves information about databricks.Group members, entitlements and instance profiles.
 *
 * ## Example Usage
 *
 * Adding user to administrative group
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const admins = databricks.getGroup({
 *     displayName: "admins",
 * });
 * const me = new databricks.User("me", {userName: "me@example.com"});
 * const myMemberA = new databricks.GroupMember("my_member_a", {
 *     groupId: admins.then(admins => admins.id),
 *     memberId: me.id,
 * });
 * ```
 *
 * ## Related Resources
 *
 * The following resources are used in the same context:
 *
 * * End to end workspace management guide
 * * databricks.Cluster to create [Databricks Clusters](https://docs.databricks.com/clusters/index.html).
 * * databricks.Directory to manage directories in [Databricks Workpace](https://docs.databricks.com/workspace/workspace-objects.html).
 * * databricks.GroupMember to attach users and groups as group members.
 * * databricks.Permissions to manage [access control](https://docs.databricks.com/security/access-control/index.html) in Databricks workspace.
 * * databricks.User to [manage users](https://docs.databricks.com/administration-guide/users-groups/users.html), that could be added to databricks.Group within the workspace.
 */
function getGroup(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("databricks:index/getGroup:getGroup", {
        "aclPrincipalId": args.aclPrincipalId,
        "allowClusterCreate": args.allowClusterCreate,
        "allowInstancePoolCreate": args.allowInstancePoolCreate,
        "childGroups": args.childGroups,
        "databricksSqlAccess": args.databricksSqlAccess,
        "displayName": args.displayName,
        "externalId": args.externalId,
        "groups": args.groups,
        "instanceProfiles": args.instanceProfiles,
        "members": args.members,
        "recursive": args.recursive,
        "servicePrincipals": args.servicePrincipals,
        "users": args.users,
        "workspaceAccess": args.workspaceAccess,
    }, opts);
}
exports.getGroup = getGroup;
/**
 * > **Note** If you have a fully automated setup with workspaces created by databricks.MwsWorkspaces or azurerm_databricks_workspace, please make sure to add dependsOn attribute in order to prevent _default auth: cannot configure default credentials_ errors.
 *
 * Retrieves information about databricks.Group members, entitlements and instance profiles.
 *
 * ## Example Usage
 *
 * Adding user to administrative group
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const admins = databricks.getGroup({
 *     displayName: "admins",
 * });
 * const me = new databricks.User("me", {userName: "me@example.com"});
 * const myMemberA = new databricks.GroupMember("my_member_a", {
 *     groupId: admins.then(admins => admins.id),
 *     memberId: me.id,
 * });
 * ```
 *
 * ## Related Resources
 *
 * The following resources are used in the same context:
 *
 * * End to end workspace management guide
 * * databricks.Cluster to create [Databricks Clusters](https://docs.databricks.com/clusters/index.html).
 * * databricks.Directory to manage directories in [Databricks Workpace](https://docs.databricks.com/workspace/workspace-objects.html).
 * * databricks.GroupMember to attach users and groups as group members.
 * * databricks.Permissions to manage [access control](https://docs.databricks.com/security/access-control/index.html) in Databricks workspace.
 * * databricks.User to [manage users](https://docs.databricks.com/administration-guide/users-groups/users.html), that could be added to databricks.Group within the workspace.
 */
function getGroupOutput(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("databricks:index/getGroup:getGroup", {
        "aclPrincipalId": args.aclPrincipalId,
        "allowClusterCreate": args.allowClusterCreate,
        "allowInstancePoolCreate": args.allowInstancePoolCreate,
        "childGroups": args.childGroups,
        "databricksSqlAccess": args.databricksSqlAccess,
        "displayName": args.displayName,
        "externalId": args.externalId,
        "groups": args.groups,
        "instanceProfiles": args.instanceProfiles,
        "members": args.members,
        "recursive": args.recursive,
        "servicePrincipals": args.servicePrincipals,
        "users": args.users,
        "workspaceAccess": args.workspaceAccess,
    }, opts);
}
exports.getGroupOutput = getGroupOutput;
//# sourceMappingURL=getGroup.js.map