@pulumi/azuread/getDomains.js

A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.

"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getDomainsOutput = exports.getDomains = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * Use this data source to access information about existing Domains within Azure Active Directory.
 *
 * ## API Permissions
 *
 * The following API permissions are required in order to use this data source.
 *
 * When authenticated with a service principal, this data source requires one of the following application roles: `Domain.Read.All` or `Directory.Read.All`
 *
 * When authenticated with a user principal, this data source does not require any additional roles.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const aadDomains = azuread.getDomains({});
 * export const domainNames = aadDomains.then(aadDomains => aadDomains.domains.map(__item => __item.domainName));
 * ```
 */
function getDomains(args, opts) {
    args = args || {};
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("azuread:index/getDomains:getDomains", {
        "adminManaged": args.adminManaged,
        "includeUnverified": args.includeUnverified,
        "onlyDefault": args.onlyDefault,
        "onlyInitial": args.onlyInitial,
        "onlyRoot": args.onlyRoot,
        "supportsServices": args.supportsServices,
    }, opts);
}
exports.getDomains = getDomains;
/**
 * Use this data source to access information about existing Domains within Azure Active Directory.
 *
 * ## API Permissions
 *
 * The following API permissions are required in order to use this data source.
 *
 * When authenticated with a service principal, this data source requires one of the following application roles: `Domain.Read.All` or `Directory.Read.All`
 *
 * When authenticated with a user principal, this data source does not require any additional roles.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const aadDomains = azuread.getDomains({});
 * export const domainNames = aadDomains.then(aadDomains => aadDomains.domains.map(__item => __item.domainName));
 * ```
 */
function getDomainsOutput(args, opts) {
    args = args || {};
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("azuread:index/getDomains:getDomains", {
        "adminManaged": args.adminManaged,
        "includeUnverified": args.includeUnverified,
        "onlyDefault": args.onlyDefault,
        "onlyInitial": args.onlyInitial,
        "onlyRoot": args.onlyRoot,
        "supportsServices": args.supportsServices,
    }, opts);
}
exports.getDomainsOutput = getDomainsOutput;
//# sourceMappingURL=getDomains.js.map