Edit

Share via


Set-EntraDomain

Updates a domain.

Syntax

Default (Default)

Set-EntraDomain

    -Name <String>
    [-IsDefault <Boolean>]
    [-SupportedServices <System.Collections.Generic.List`1[System.String]>]
    [<CommonParameters>]

Description

The Set-EntraDomain cmdlet updates a verified domain in Microsoft Entra ID.

The work or school account needs to belong to at least one of the following Microsoft Entra roles:

  • Domain Name Administrator
  • Security Administrator
  • External Identity Provider Administrator

Examples

Example 1: Set the domain as the default domain for new user account creation

Connect-Entra -Scopes 'Domain.ReadWrite.All'
Set-EntraDomain -Name Contoso.com -IsDefault $true

This example demonstrates how to set default domain for new user account in Microsoft Entra ID.

Example 2: Set the list of domain capabilities

Connect-Entra -Scopes 'Domain.ReadWrite.All'
Set-EntraDomain -Name Contoso.com -SupportedServices @('Email', 'OfficeCommunicationsOnline')

This example demonstrates how to set domain capabilities for new user account in Microsoft Entra ID.

Parameters

-IsDefault

Indicates whether or not this is the default domain that is used for user creation. There's only one default domain per company.

Parameter properties

Type:System.Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The fully qualified name of the domain.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-SupportedServices

The capabilities assigned to the domain.

Parameter properties

Type:

System.Collections.Generic.List`1[System.String]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.