Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

New-MgTenantRelationshipMultiTenantOrganizationTenant

Add a tenant to a multitenant organization. The administrator of an owner tenant has the permissions to add tenants to the multitenant organization. The added tenant is in the pending state until the administrator of the added tenant joins the multitenant organization by submitting a join request. A tenant can be part of only one multitenant organization.

Note

To view the beta release of this cmdlet, view New-MgBetaTenantRelationshipMultiTenantOrganizationTenant

Syntax

CreateExpanded (Default) 

New-MgTenantRelationshipMultiTenantOrganizationTenant
 [-ResponseHeadersVariable <string>]
 [-AddedByTenantId <string>]
 [-AddedDateTime <datetime>]
 [-AdditionalProperties <hashtable>]
 [-DeletedDateTime <datetime>]
 [-DisplayName <string>]
 [-Id <string>]
 [-JoinedDateTime <datetime>]
 [-Role <string>]
 [-State <string>]
 [-TenantId <string>]
 [-TransitionDetails <IMicrosoftGraphMultiTenantOrganizationMemberTransitionDetails>]
 [-Break]
 [-Headers <IDictionary>]
 [-HttpPipelineAppend <SendAsyncStep[]>]
 [-HttpPipelinePrepend <SendAsyncStep[]>]
 [-Proxy <uri>]
 [-ProxyCredential <pscredential>]
 [-ProxyUseDefaultCredentials]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Create 

New-MgTenantRelationshipMultiTenantOrganizationTenant

 -BodyParameter <IMicrosoftGraphMultiTenantOrganizationMember>
 [-ResponseHeadersVariable <string>]
 [-Break]
 [-Headers <IDictionary>]
 [-HttpPipelineAppend <SendAsyncStep[]>]
 [-HttpPipelinePrepend <SendAsyncStep[]>]
 [-Proxy <uri>]
 [-ProxyCredential <pscredential>]
 [-ProxyUseDefaultCredentials]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Add a tenant to a multitenant organization. The administrator of an owner tenant has the permissions to add tenants to the multitenant organization. The added tenant is in the pending state until the administrator of the added tenant joins the multitenant organization by submitting a join request. A tenant can be part of only one multitenant organization.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) MultiTenantOrganization.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application MultiTenantOrganization.ReadWrite.All,

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Identity.SignIns

$params = @{
	tenantId = "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad"
	displayName = "Fabrikam"
}

New-MgTenantRelationshipMultiTenantOrganizationTenant -BodyParameter $params

This example shows how to use the New-MgTenantRelationshipMultiTenantOrganizationTenant Cmdlet.

Parameters

-AddedByTenantId

Tenant ID of the tenant that added the tenant to the multitenant organization. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-AddedDateTime

Date and time when the tenant was added to the multitenant organization. Read-only.

Parameter properties

Type:System.DateTime
Supports wildcards:False
DontShow:False

Parameter sets

-AdditionalProperties

Additional Parameters

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

-BodyParameter

multiTenantOrganizationMember To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphMultiTenantOrganizationMember
Supports wildcards:False
DontShow:False

Parameter sets

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-DeletedDateTime

Date and time when this object was deleted. Always null when the object hasn't been deleted.

Parameter properties

Type:System.DateTime
Supports wildcards:False
DontShow:False

Parameter sets

-DisplayName

Display name of the tenant added to the multitenant organization.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:System.Collections.IDictionary
Supports wildcards:False
DontShow:False

Parameter sets

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-JoinedDateTime

Date and time when the tenant joined the multitenant organization. Read-only.

Parameter properties

Type:System.DateTime
Supports wildcards:False
DontShow:False

Parameter sets

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

-Role

multiTenantOrganizationMemberRole

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-State

multiTenantOrganizationMemberState

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-TenantId

Tenant ID of the Microsoft Entra tenant added to the multitenant organization. Set at the time tenant is added.Supports $filter. Key.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-TransitionDetails

multiTenantOrganizationMemberTransitionDetails To construct, see NOTES section for TRANSITIONDETAILS properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphMultiTenantOrganizationMemberTransitionDetails
Supports wildcards:False
DontShow:False

Parameter sets

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

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.

Inputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphMultiTenantOrganizationMember

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphMultiTenantOrganizationMember

{{ Fill in the Description }}

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IMicrosoftGraphMultiTenantOrganizationMember>: multiTenantOrganizationMember [(Any) <Object>]: This indicates any property can be added to this object. [DeletedDateTime <DateTime?>]: Date and time when this object was deleted. Always null when the object hasn't been deleted. [Id <String>]: The unique identifier for an entity. Read-only. [AddedByTenantId <String>]: Tenant ID of the tenant that added the tenant to the multitenant organization. Read-only. [AddedDateTime <DateTime?>]: Date and time when the tenant was added to the multitenant organization. Read-only. [DisplayName <String>]: Display name of the tenant added to the multitenant organization. [JoinedDateTime <DateTime?>]: Date and time when the tenant joined the multitenant organization. Read-only. [Role <String>]: multiTenantOrganizationMemberRole [State <String>]: multiTenantOrganizationMemberState [TenantId <String>]: Tenant ID of the Microsoft Entra tenant added to the multitenant organization. Set at the time tenant is added.Supports $filter. Key. [TransitionDetails <IMicrosoftGraphMultiTenantOrganizationMemberTransitionDetails>]: multiTenantOrganizationMemberTransitionDetails [(Any) <Object>]: This indicates any property can be added to this object. [DesiredRole <String>]: multiTenantOrganizationMemberRole [DesiredState <String>]: multiTenantOrganizationMemberState [Details <String>]: Details that explain the processing status if any. Read-only. [Status <String>]: multiTenantOrganizationMemberProcessingStatus

TRANSITIONDETAILS <IMicrosoftGraphMultiTenantOrganizationMemberTransitionDetails>: multiTenantOrganizationMemberTransitionDetails [(Any) <Object>]: This indicates any property can be added to this object. [DesiredRole <String>]: multiTenantOrganizationMemberRole [DesiredState <String>]: multiTenantOrganizationMemberState [Details <String>]: Details that explain the processing status if any. Read-only. [Status <String>]: multiTenantOrganizationMemberProcessingStatus

Related Links