Update-MgTenantRelationshipMultiTenantOrganizationJoinRequest
Join a multitenant organization, after the owner of the multitenant organization has added your tenant to the multitenant organization as pending. Before a tenant added to a multitenant organization can participate in the multitenant organization, the administrator of the joining tenant must submit a join request. To allow for asynchronous processing, you must wait up to 2 hours before joining a multitenant organization is completed.
Note
To view the beta release of this cmdlet, view Update-MgBetaTenantRelationshipMultiTenantOrganizationJoinRequest
Syntax
Update-MgTenantRelationshipMultiTenantOrganizationJoinRequest
[-ResponseHeadersVariable <String>]
[-AddedByTenantId <String>]
[-AdditionalProperties <Hashtable>]
[-Id <String>]
[-MemberState <String>]
[-Role <String>]
[-TransitionDetails <IMicrosoftGraphMultiTenantOrganizationJoinRequestTransitionDetails>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgTenantRelationshipMultiTenantOrganizationJoinRequest
-BodyParameter <IMicrosoftGraphMultiTenantOrganizationJoinRequestRecord>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Join a multitenant organization, after the owner of the multitenant organization has added your tenant to the multitenant organization as pending. Before a tenant added to a multitenant organization can participate in the multitenant organization, the administrator of the joining tenant must submit a join request. To allow for asynchronous processing, you must wait up to 2 hours before joining a multitenant organization is completed.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | MultiTenantOrganization.ReadWrite.All | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | MultiTenantOrganization.ReadWrite.All | Not available. |
Examples
Example 1: Join a multitenant organization
Import-Module Microsoft.Graph.Identity.SignIns
$params = @{
addedByTenantId = "1fd6544e-e994-4de2-9f1b-787b51c7d325"
}
Update-MgTenantRelationshipMultiTenantOrganizationJoinRequest -BodyParameter $params
This example will join a multitenant organization
Example 2: Reset a failed join request
Import-Module Microsoft.Graph.Identity.SignIns
$params = @{
addedByTenantId = "00000000-0000-0000-0000-000000000000"
}
Update-MgTenantRelationshipMultiTenantOrganizationJoinRequest -BodyParameter $params
This example will reset a failed join request
Parameters
-AddedByTenantId
Tenant ID of the Microsoft Entra tenant that added a tenant to the multitenant organization. To reset a failed join request, set addedByTenantId to 00000000-0000-0000-0000-000000000000. Required.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AdditionalProperties
Additional Parameters
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BodyParameter
multiTenantOrganizationJoinRequestRecord To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IMicrosoftGraphMultiTenantOrganizationJoinRequestRecord |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
Type: | IDictionary |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Id
The unique identifier for an entity. Read-only.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MemberState
multiTenantOrganizationMemberState
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
Type: | ActionPreference |
Aliases: | proga |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Type: | String |
Aliases: | RHV |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Role
multiTenantOrganizationMemberRole
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TransitionDetails
multiTenantOrganizationJoinRequestTransitionDetails To construct, see NOTES section for TRANSITIONDETAILS properties and create a hash table.
Type: | IMicrosoftGraphMultiTenantOrganizationJoinRequestTransitionDetails |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphMultiTenantOrganizationJoinRequestRecord
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphMultiTenantOrganizationJoinRequestRecord
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 <IMicrosoftGraphMultiTenantOrganizationJoinRequestRecord>
: multiTenantOrganizationJoinRequestRecord
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AddedByTenantId <String>]
: Tenant ID of the Microsoft Entra tenant that added a tenant to the multitenant organization. To reset a failed join request, set addedByTenantId to 00000000-0000-0000-0000-000000000000. Required.[MemberState <String>]
: multiTenantOrganizationMemberState[Role <String>]
: multiTenantOrganizationMemberRole[TransitionDetails <IMicrosoftGraphMultiTenantOrganizationJoinRequestTransitionDetails>]
: multiTenantOrganizationJoinRequestTransitionDetails[(Any) <Object>]
: This indicates any property can be added to this object.[DesiredMemberState <String>]
: multiTenantOrganizationMemberState[Details <String>]
: Details that explain the processing status if any. Read-only.[Status <String>]
: multiTenantOrganizationMemberProcessingStatus
TRANSITIONDETAILS <IMicrosoftGraphMultiTenantOrganizationJoinRequestTransitionDetails>
: multiTenantOrganizationJoinRequestTransitionDetails
[(Any) <Object>]
: This indicates any property can be added to this object.[DesiredMemberState <String>]
: multiTenantOrganizationMemberState[Details <String>]
: Details that explain the processing status if any. Read-only.[Status <String>]
: multiTenantOrganizationMemberProcessingStatus