1. Docs
  2. Reference
  3. API
  4. Azure AD
  5. GetDomains

GetDomains

Use this data source to access information about an existing Domains within Azure Active Directory.

NOTE: If you’re authenticating using a Service Principal then it must have permissions to Directory.Read.All within the Windows Azure Active Directory API.

Example Usage

using Pulumi;
using AzureAD = Pulumi.AzureAD;

class MyStack : Stack
{
    public MyStack()
    {
        var aadDomains = Output.Create(AzureAD.GetDomains.InvokeAsync());
        this.Domains = aadDomains.Apply(aadDomains => aadDomains.Domains);
    }

    [Output("domains")]
    public Output<string> Domains { get; set; }
}

Coming soon!

import pulumi
import pulumi_azuread as azuread

aad_domains = azuread.get_domains()
pulumi.export("domains", aad_domains.domains)
import * as pulumi from "@pulumi/pulumi";
import * as azuread from "@pulumi/azuread";

const aadDomains = pulumi.output(azuread.getDomains({ async: true }));

export const domains = aadDomains.domains;

Using GetDomains

function getDomains(args: GetDomainsArgs, opts?: InvokeOptions): Promise<GetDomainsResult>
function  get_domains(include_unverified=None, only_default=None, only_initial=None, opts=None)
func GetDomains(ctx *Context, args *GetDomainsArgs, opts ...InvokeOption) (*GetDomainsResult, error)
public static class GetDomains {
    public static Task<GetDomainsResult> InvokeAsync(GetDomainsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

IncludeUnverified bool

Set to true if unverified Azure AD Domains should be included. Defaults to false.

OnlyDefault bool

Set to true to only return the default domain.

OnlyInitial bool

Set to true to only return the initial domain, which is your primary Azure Active Directory tenant domain. Defaults to false.

IncludeUnverified bool

Set to true if unverified Azure AD Domains should be included. Defaults to false.

OnlyDefault bool

Set to true to only return the default domain.

OnlyInitial bool

Set to true to only return the initial domain, which is your primary Azure Active Directory tenant domain. Defaults to false.

includeUnverified boolean

Set to true if unverified Azure AD Domains should be included. Defaults to false.

onlyDefault boolean

Set to true to only return the default domain.

onlyInitial boolean

Set to true to only return the initial domain, which is your primary Azure Active Directory tenant domain. Defaults to false.

include_unverified bool

Set to true if unverified Azure AD Domains should be included. Defaults to false.

only_default bool

Set to true to only return the default domain.

only_initial bool

Set to true to only return the initial domain, which is your primary Azure Active Directory tenant domain. Defaults to false.

GetDomains Result

The following output properties are available:

Domains List<Pulumi.AzureAD.Outputs.GetDomainsDomain>

One or more domain blocks as defined below.

Id string

The provider-assigned unique ID for this managed resource.

IncludeUnverified bool
OnlyDefault bool
OnlyInitial bool
Domains []GetDomainsDomain

One or more domain blocks as defined below.

Id string

The provider-assigned unique ID for this managed resource.

IncludeUnverified bool
OnlyDefault bool
OnlyInitial bool
domains GetDomainsDomain[]

One or more domain blocks as defined below.

id string

The provider-assigned unique ID for this managed resource.

includeUnverified boolean
onlyDefault boolean
onlyInitial boolean
domains List[GetDomainsDomain]

One or more domain blocks as defined below.

id str

The provider-assigned unique ID for this managed resource.

include_unverified bool
only_default bool
only_initial bool

Supporting Types

GetDomainsDomain

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

AuthenticationType string

The authentication type of the domain (Managed or Federated).

DomainName string

The name of the domain.

IsDefault bool

True if this is the default domain that is used for user creation.

IsInitial bool

True if this is the initial domain created by Azure Activie Directory.

IsVerified bool

True if the domain has completed domain ownership verification.

AuthenticationType string

The authentication type of the domain (Managed or Federated).

DomainName string

The name of the domain.

IsDefault bool

True if this is the default domain that is used for user creation.

IsInitial bool

True if this is the initial domain created by Azure Activie Directory.

IsVerified bool

True if the domain has completed domain ownership verification.

authenticationType string

The authentication type of the domain (Managed or Federated).

domainName string

The name of the domain.

isDefault boolean

True if this is the default domain that is used for user creation.

isInitial boolean

True if this is the initial domain created by Azure Activie Directory.

isVerified boolean

True if the domain has completed domain ownership verification.

authenticationType str

The authentication type of the domain (Managed or Federated).

domainName str

The name of the domain.

isDefault bool

True if this is the default domain that is used for user creation.

isInitial bool

True if this is the initial domain created by Azure Activie Directory.

isVerified bool

True if the domain has completed domain ownership verification.

Package Details

Repository
https://github.com/pulumi/pulumi-azuread
License
Apache-2.0
Notes
This Pulumi package is based on the azuread Terraform Provider.