Update-MgTenantRelationshipMultiTenantOrganization

Module:

Microsoft.Graph.Identity.SignIns

Update the properties of a multitenant organization.

Note

To view the beta release of this cmdlet, view Update-MgBetaTenantRelationshipMultiTenantOrganization

Syntax

Update-MgTenantRelationshipMultiTenantOrganization
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-CreatedDateTime <DateTime>]
      [-Description <String>]
      [-DisplayName <String>]
      [-Id <String>]
      [-JoinRequest <IMicrosoftGraphMultiTenantOrganizationJoinRequestRecord>]
      [-State <String>]
      [-Tenants <IMicrosoftGraphMultiTenantOrganizationMember[]>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgTenantRelationshipMultiTenantOrganization
      -BodyParameter <IMicrosoftGraphMultiTenantOrganization>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update the properties of a 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.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Identity.SignIns

$params = @{
	displayName = "Contoso organization"
	description = "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
}

Update-MgTenantRelationshipMultiTenantOrganization -BodyParameter $params

This example shows how to use the Update-MgTenantRelationshipMultiTenantOrganization Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

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

Type:	IMicrosoftGraphMultiTenantOrganization
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

-CreatedDateTime

Date when multitenant organization was created. Read-only.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Description of the multitenant organization.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisplayName

Display name of 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

-JoinRequest

multiTenantOrganizationJoinRequestRecord To construct, see NOTES section for JOINREQUEST properties and create a hash table.

Type:	IMicrosoftGraphMultiTenantOrganizationJoinRequestRecord
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

-State

multiTenantOrganizationState

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tenants

Defines tenants added to a multitenant organization. To construct, see NOTES section for TENANTS properties and create a hash table.

Type:	IMicrosoftGraphMultiTenantOrganizationMember[]
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.IMicrosoftGraphMultiTenantOrganization

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphMultiTenantOrganization

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 <IMicrosoftGraphMultiTenantOrganization>: multiTenantOrganization

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Id <String>]: The unique identifier for an entity. Read-only.
• [CreatedDateTime <DateTime?>]: Date when multitenant organization was created. Read-only.
• [Description <String>]: Description of the multitenant organization.
• [DisplayName <String>]: Display name of the multitenant organization.
• [JoinRequest <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
• [State <String>]: multiTenantOrganizationState
• [Tenants <IMicrosoftGraphMultiTenantOrganizationMember- []>]: Defines tenants added to a multitenant organization.
  • [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

JOINREQUEST <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

TENANTS <IMicrosoftGraphMultiTenantOrganizationMember- []>: Defines tenants added to a multitenant organization.

• [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

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.identity.signins/update-mgtenantrelationshipmultitenantorganization
• https://learn.microsoft.com/graph/api/multitenantorganization-update?view=graph-rest-1.0