Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Update-MgBetaTenantRelationshipMultiTenantOrganization
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[]>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update
Update-MgBetaTenantRelationshipMultiTenantOrganization
-BodyParameter <IMicrosoftGraphMultiTenantOrganization>
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-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: | System.Collections.Hashtable |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-BodyParameter
multiTenantOrganization To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphMultiTenantOrganization |
| 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
-CreatedDateTime
Date when multitenant organization was created. Read-only.
Parameter properties
| Type: | System.DateTime |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Description
Description of the multitenant organization.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DisplayName
Display name of 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.Beta.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.Beta.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
-JoinRequest
multiTenantOrganizationJoinRequestRecord To construct, see NOTES section for JOINREQUEST properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphMultiTenantOrganizationJoinRequestRecord |
| 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
-State
multiTenantOrganizationState
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Tenants
Defines tenants added to a multitenant organization. To construct, see NOTES section for TENANTS properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphMultiTenantOrganizationMember[] |
| 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.Beta.PowerShell.Models.IMicrosoftGraphMultiTenantOrganization
{{ Fill in the Description }}
System.Collections.IDictionary
{{ Fill in the Description }}
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphMultiTenantOrganization
{{ 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 <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
