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
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>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgTenantRelationshipMultiTenantOrganizationTenant
-BodyParameter <IMicrosoftGraphMultiTenantOrganizationMember>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-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 | 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. |
Parameters
-AddedByTenantId
Tenant ID of the tenant that added the tenant to the multitenant organization. Read-only.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AddedDateTime
Date and time when the tenant was added to the multitenant organization. Read-only.
Type: | DateTime |
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
multiTenantOrganizationMember To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IMicrosoftGraphMultiTenantOrganizationMember |
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 |
-DeletedDateTime
Date and time when this object was deleted. Always null when the object hasn't been deleted.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisplayName
Display name of the tenant added to the multitenant organization.
Type: | String |
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 |
-JoinedDateTime
Date and time when the tenant joined the multitenant organization. Read-only.
Type: | DateTime |
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 |
-State
multiTenantOrganizationMemberState
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TenantId
Tenant ID of the Microsoft Entra tenant added to the multitenant organization. Set at the time tenant is added.Supports $filter. Key.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TransitionDetails
multiTenantOrganizationMemberTransitionDetails To construct, see NOTES section for TRANSITIONDETAILS properties and create a hash table.
Type: | IMicrosoftGraphMultiTenantOrganizationMemberTransitionDetails |
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.IMicrosoftGraphMultiTenantOrganizationMember
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphMultiTenantOrganizationMember
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