Share via

Update-MgBetaTenantRelationshipMultiTenantOrganization

Module:
Microsoft.Graph.Beta.Identity.SignIns Module

Update the properties of a multi-tenant organization.

Note

To view the v1.0 release of this cmdlet, view Update-MgTenantRelationshipMultiTenantOrganization

Syntax

UpdateExpanded (Default) 

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

Update 

Update-MgBetaTenantRelationshipMultiTenantOrganization
    -BodyParameter <IMicrosoftGraphMultiTenantOrganization>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update the properties of a multi-tenant organization.

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Beta.Identity.SignIns

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

Update-MgBetaTenantRelationshipMultiTenantOrganization -BodyParameter $params

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

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

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

Parameter properties

Type:IMicrosoftGraphMultiTenantOrganization
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Update
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

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

-CreatedDateTime

Date when multitenant organization was created. Read-only.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Description of the multitenant organization.

Parameter properties

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

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayName

Display name of the multitenant organization.

Parameter properties

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

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:IDictionary
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-Id

The unique identifier for an entity. Read-only.

Parameter properties

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

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-JoinRequest

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

Parameter properties

Type:IMicrosoftGraphMultiTenantOrganizationJoinRequestRecord
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

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

-State

multiTenantOrganizationState

Parameter properties

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

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Tenants

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

Parameter properties

Type:

IMicrosoftGraphMultiTenantOrganizationMember[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

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.

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphMultiTenantOrganization

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.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 multi-tenant 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 multi-tenant 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