使用 PowerShell 或 Microsoft Graph API 設定多租用戶組織

發行項
04/25/2024

本文說明使用 Microsoft Graph PowerShell 或 Microsoft Graph API 設定多租用戶組織的重要步驟。本文使用名為開羅的範例擁有者租使用者，以及名為柏林和雅典的兩個成員租使用者。

如果您想要改用 Microsoft 365 系統管理中心來設定多租用戶組織，請參閱在 Microsoft 365 中設定多租用戶組織，並在 Microsoft 365 中加入或離開多租用戶組織。若要瞭解如何為多租用戶組織設定 Microsoft Teams，請參閱新的 Microsoft Teams 桌面用戶端。

必要條件

擁有者租用戶的圖示。
擁有者租使用者

如需授權資訊，請參閱授權需求。
安全性管理員 istrator 角色，可設定多租用戶組織的跨租使用者存取設定和範本。
全域管理員 istrator 角色，同意所需的許可權。

成員租用戶的圖示。
成員租使用者

如需授權資訊，請參閱授權需求。
安全性管理員 istrator 角色，可設定多租用戶組織的跨租使用者存取設定和範本。
全域管理員管理員角色，以同意所需的許可權。

擁有者租用戶的圖示。
擁有者租使用者

PowerShell
Microsoft Graph

啟動 PowerShell。
如有必要，請安裝 Microsoft Graph PowerShell SDK。

取得擁有者和成員租使用者的租用戶標識碼，並初始化變數。

$OwnerTenantId = "<OwnerTenantId>"
$MemberTenantIdB = "<MemberTenantIdB>"
$MemberTenantIdA = "<MemberTenantIdA>"

使用連線-MgGraph 命令登入擁有者租使用者，並同意下列必要許可權。
- MultiTenantOrganization.ReadWrite.All
- Policy.Read.All
- Policy.ReadWrite.CrossTenantAccess
- Application.ReadWrite.All
- Directory.ReadWrite.All
```
Connect-MgGraph -TenantId $OwnerTenantId -Scopes "MultiTenantOrganization.ReadWrite.All","Policy.Read.All","Policy.ReadWrite.CrossTenantAccess","Application.ReadWrite.All","Directory.ReadWrite.All"
```

這些步驟說明如何使用 Microsoft Graph 總管，但您也可以使用另一個 REST API 用戶端。

啟動 Microsoft Graph 總管工具。
登入擁有者租使用者。
選取您的設定檔，然後選取 [ 同意許可權]。
同意下列必要許可權。
- MultiTenantOrganization.ReadWrite.All
- Policy.Read.All
- Policy.ReadWrite.CrossTenantAccess
- Application.ReadWrite.All
- Directory.ReadWrite.All

步驟 2：建立多租用戶組織

擁有者租用戶的圖示。
擁有者租使用者

PowerShell
Microsoft Graph

在擁有者租使用者中，使用 Update-MgBetaTenantRelationshipMultiTenantOrganization 命令來建立您的多租用戶組織。這項作業可能需要幾分鐘的時間。
```
Update-MgBetaTenantRelationshipMultiTenantOrganization -DisplayName "Cairo"
```

使用 Get-MgBetaTenantRelationshipMultiTenantOrganization 命令，檢查作業是否已完成再繼續。

Get-MgBetaTenantRelationshipMultiTenantOrganization | Format-List

CreatedDateTime      : 1/8/2024 7:47:45 PM
Description          :
DisplayName          : Cairo
Id                   : <MtoIdC>
JoinRequest          : Microsoft.Graph.Beta.PowerShell.Models.MicrosoftGraphMultiTenantOrganizationJoinRequestRecord
State                : active
Tenants              :
AdditionalProperties : {[@odata.context, https://graph.microsoft.com/beta/$metadata#tenantRelationships/multiTenantOrganization/$entity]}

在擁有者租使用者中，使用建立 multiTenantOrganization API 來建立您的多租用戶組織。這項作業可能需要幾分鐘的時間。

要求
```
PUT https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization
{
    "displayName": "Cairo"
}
```

使用 Get multiTenantOrganization API 來檢查作業是否已完成，再繼續進行。

要求

GET https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization

回應

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#tenantRelationships/multiTenantOrganization/$entity",
    "id": "{mtoId}",
    "createdDateTime": "2023-11-20T20:38:20Z",
    "state": "active",
    "displayName": "Cairo",
    "description": null
}

步驟 3：新增租使用者

擁有者租用戶的圖示。
擁有者租使用者

PowerShell
Microsoft Graph

在擁有者租使用者中，使用 New-MgBetaTenantRelationshipMultiTenantOrganizationTenant 命令，將租使用者新增至您的多租用戶組織。

New-MgBetaTenantRelationshipMultiTenantOrganizationTenant -TenantID $MemberTenantIdB -DisplayName "Berlin" | Format-List

New-MgBetaTenantRelationshipMultiTenantOrganizationTenant -TenantID $MemberTenantIdA -DisplayName "Athens" | Format-List

使用 Get-MgBetaTenantRelationshipMultiTenantOrganizationTenant 命令來確認作業已在繼續之前完成。

Get-MgBetaTenantRelationshipMultiTenantOrganizationTenant | Format-List

AddedByTenantId      : <OwnerTenantId>
AddedDateTime        : 1/8/2024 7:47:45 PM
DeletedDateTime      :
DisplayName          : Cairo
Id                   : <MtoIdC>
JoinedDateTime       :
Role                 : owner
State                : active
TenantId             : <OwnerTenantId>
TransitionDetails    : Microsoft.Graph.Beta.PowerShell.Models.MicrosoftGraphMultiTenantOrganizationMemberTransitionDetails
AdditionalProperties : {[multiTenantOrgLabelType, none]}

AddedByTenantId      : <OwnerTenantId>
AddedDateTime        : 1/8/2024 8:05:25 PM
DeletedDateTime      :
DisplayName          : Berlin
Id                   : <MtoIdB>
JoinedDateTime       :
Role                 : member
State                : pending
TenantId             : <MemberTenantIdB>
TransitionDetails    : Microsoft.Graph.Beta.PowerShell.Models.MicrosoftGraphMultiTenantOrganizationMemberTransitionDetails
AdditionalProperties : {[multiTenantOrgLabelType, none]}

AddedByTenantId      : <OwnerTenantId>
AddedDateTime        : 1/8/2024 8:08:47 PM
DeletedDateTime      :
DisplayName          : Athens
Id                   : <MtoIdA>
JoinedDateTime       :
Role                 : member
State                : pending
TenantId             : <MemberTenantIdA>
TransitionDetails    : Microsoft.Graph.Beta.PowerShell.Models.MicrosoftGraphMultiTenantOrganizationMemberTransitionDetails
AdditionalProperties : {[multiTenantOrgLabelType, none]}

在擁有者租使用者中，使用 [新增 multiTenantOrganizationMember API] 將租使用者新增至您的多租用戶組織。

要求

POST https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization/tenants
{
    "tenantId": "{memberTenantIdB}",
    "displayName": "Berlin"
}

要求

POST https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization/tenants
{
    "tenantId": "{memberTenantIdA}",
    "displayName": "Athens"
}

使用 List multiTenantOrganizationMembers API 來確認作業已在繼續之前完成。

要求

GET https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization/tenants

回應

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#tenantRelationships/multiTenantOrganization/tenants"
    "value": [
        {
            "tenantId": "{ownerTenantId}",
            "displayName": "Cairo",
            "addedDateTime": "2023-11-20T20:38:20Z",
            "joinedDateTime": null,
            "addedByTenantId": "{ownerTenantId}",
            "role": "owner",
            "state": "active",
            "transitionDetails": null
        },
        {
            "tenantId": "{memberTenantIdB}",
            "displayName": "Berlin",
            "addedDateTime": "2023-11-20T21:22:35Z",
            "joinedDateTime": null,
            "addedByTenantId": "{ownerTenantId}",
            "role": "member",
            "state": "pending",
            "transitionDetails": {
                "desiredState": "active",
                "desiredRole": "member",
                "status": "notStarted",
                "details": null
            }
        },
        {
            "tenantId": "{memberTenantIdA}",
            "displayName": "Athens",
            "addedDateTime": "2023-11-20T21:24:59Z",
            "joinedDateTime": null,
            "addedByTenantId": "{ownerTenantId}",
            "role": "member",
            "state": "pending",
            "transitionDetails": {
                "desiredState": "active",
                "desiredRole": "member",
                "status": "notStarted",
                "details": null
            }
        }
    ]
}

步驟 4：（選擇性）變更租使用者的角色

擁有者租用戶的圖示。
擁有者租使用者

根據預設，新增至多租用戶組織的租用戶是成員租使用者。您可以選擇性地將其變更為擁有者租使用者，以允許他們將其他租使用者新增至多租用戶組織。您也可以將擁有者租用戶變更為成員租使用者。

PowerShell
Microsoft Graph

在擁有者租使用者中，使用 Update-MgBetaTenantRelationshipMultiTenantOrganizationTenant 命令，將成員租用戶變更為擁有者租使用者。
```
Update-MgBetaTenantRelationshipMultiTenantOrganizationTenant -MultiTenantOrganizationMemberId $MemberTenantIdB -Role "Owner" | Format-List
```

使用 Get-MgBetaTenantRelationshipMultiTenantOrganizationTenant 命令來驗證變更。

Get-MgBetaTenantRelationshipMultiTenantOrganizationTenant -MultiTenantOrganizationMemberId $MemberTenantIdB | Format-List

AddedByTenantId      : <OwnerTenantId>
AddedDateTime        : 1/8/2024 8:05:25 PM
DeletedDateTime      :
DisplayName          : Berlin
Id                   : <MtoIdB>
JoinedDateTime       :
Role                 : owner
State                : pending
TenantId             : <MemberTenantIdB>
TransitionDetails    : Microsoft.Graph.Beta.PowerShell.Models.MicrosoftGraphMultiTenantOrganizationMemberTransitionDetails
AdditionalProperties : {[@odata.context, https://graph.microsoft.com/beta/$metadata#tenantRelationships/multiTenantOrganization/tenants/$entity],
                       [multiTenantOrgLabelType, none]}

在擁有者租使用者中，使用 Update multiTenantOrganizationMember API 將成員租用戶變更為擁有者租使用者。

要求

PATCH https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization/tenants/{memberTenantIdB}
{
    "role": "owner"
}

使用 Get multiTenantOrganizationMember API 來驗證變更。

要求

GET https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization/tenants/{memberTenantIdB}

回應

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#tenantRelationships/multiTenantOrganization/tenants/$entity",
    "tenantId": "{memberTenantIdB}",
    "displayName": "Berlin",
    "addedDateTime": "2023-11-20T21:22:35Z",
    "joinedDateTime": null,
    "addedByTenantId": "{ownerTenantId}",
    "role": "member",
    "state": "pending",
    "transitionDetails": {
        "desiredState": "active",
        "desiredRole": "owner",
        "status": "notStarted",
        "details": null
    } 
}

使用 Update multiTenantOrganizationMember API 將擁有者租用戶變更為成員租使用者。

要求

PATCH https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization/tenants/{memberTenantIdB}
{
    "role": "member"
}

步驟 5：（選擇性）移除成員租使用者

擁有者租用戶的圖示。
擁有者租使用者

您可以移除任何成員租使用者，包括您自己的租使用者。您無法移除擁有者租使用者。此外，即使已從擁有者變更為成員，您也無法移除原始建立者租使用者。

PowerShell
Microsoft Graph

在擁有者租使用者中，使用 Remove-MgBetaTenantRelationshipMultiTenantOrganizationTenant 命令來移除任何成員租使用者。此作業需要幾分鐘的時間。
```
Remove-MgBetaTenantRelationshipMultiTenantOrganizationTenant -MultiTenantOrganizationMemberId <MemberTenantIdD>
```

使用 Get-MgBetaTenantRelationshipMultiTenantOrganizationTenant 命令來驗證變更。

Get-MgBetaTenantRelationshipMultiTenantOrganizationTenant -MultiTenantOrganizationMemberId <MemberTenantIdD>

拿掉命令完成之後，輸出會類似下列內容。這是預期的錯誤訊息。它表示租使用者已從多租用戶組織中移除。

Get-MgBetaTenantRelationshipMultiTenantOrganizationTenant_Get: Unable to read the company information from the directory.

Status: 404 (NotFound)
ErrorCode: Directory_ObjectNotFound
Date: 2024-01-08T20:35:11

...

在擁有者租使用者中，使用 Remove multiTenantOrganizationMember API 來移除任何成員租使用者。此作業需要幾分鐘的時間。

要求
```
DELETE https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization/tenants/{memberTenantIdD}
```

使用 Get multiTenantOrganizationMember API 來驗證變更。

要求

GET https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization/tenants/{memberTenantIdD}

如果您在呼叫移除 API 之後立即檢查，它會顯示類似下列的回應。

回應

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#tenantRelationships/multiTenantOrganization/tenants/$entity",
    "tenantId": "{memberTenantIdD}",
    "displayName": "Denver",
    "addedDateTime": "2023-11-20T20:56:05Z",
    "joinedDateTime": null,
    "addedByTenantId": "{ownerTenantId}",
    "role": "member",
    "state": "pending",
    "transitionDetails": {
        "desiredState": "removed",
        "desiredRole": "member",
        "status": "notStarted",
        "details": null
    }
}

拿掉作業完成之後，回應會類似下列內容。這是預期的錯誤訊息。它表示租使用者已從多租用戶組織中移除。

回應

{
    "error": {
        "code": "Directory_ObjectNotFound",
        "message": "Unable to read the company information from the directory.",
        "innerError": {
            "date": "2023-11-20T21:09:53",
            "request-id": "75216961-c21d-49ed-8c1f-2cfe51f920f1",
            "client-request-id": "0000aaaa-11bb-cccc-dd22-eeeeee333333"
        }
    }
}

成員租用戶的圖示。
成員租使用者

開羅租使用者建立了一個多租用戶組織，並增加了柏林和雅典租使用者。在這些步驟中，您會登入柏林租使用者，並加入開羅建立的多租用戶組織。

PowerShell
Microsoft Graph

啟動 PowerShell。
使用連線-MgGraph 命令登入成員租使用者，並同意下列必要許可權。
- MultiTenantOrganization.ReadWrite.All
- Policy.Read.All
- Policy.ReadWrite.CrossTenantAccess
- Application.ReadWrite.All
- Directory.ReadWrite.All
```
Connect-MgGraph -TenantId $MemberTenantIdB -Scopes "MultiTenantOrganization.ReadWrite.All","Policy.Read.All","Policy.ReadWrite.CrossTenantAccess","Application.ReadWrite.All","Directory.ReadWrite.All"
```

步驟 7：加入多租用戶組織

成員租用戶的圖示。
成員租使用者

PowerShell
Microsoft Graph

在成員租使用者中，使用 Update-MgBetaTenantRelationshipMultiTenantOrganizationJoinRequest 命令加入多租用戶組織。
```
Update-MgBetaTenantRelationshipMultiTenantOrganizationJoinRequest -AddedByTenantId $OwnerTenantId | Format-List
```

使用 Get-MgBetaTenantRelationshipMultiTenantOrganizationJoinRequest 命令來驗證聯結。

Get-MgBetaTenantRelationshipMultiTenantOrganizationJoinRequest | Format-List

AddedByTenantId      : <OwnerTenantId>
Id                   : <MtoJoinRequestIdB>
MemberState          : active
Role                 : member
TransitionDetails    : Microsoft.Graph.Beta.PowerShell.Models.MicrosoftGraphMultiTenantOrganizationJoinRequestTransitionDetails
AdditionalProperties : {[@odata.context, https://graph.microsoft.com/beta/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity]}

使用 Get-MgBetaTenantRelationshipMultiTenantOrganizationTenant 命令來檢查多租用戶組織本身。它應該會反映聯結作業。

Get-MgBetaTenantRelationshipMultiTenantOrganizationTenant | Format-List

AddedByTenantId      : <OwnerTenantId>
AddedDateTime        : 1/8/2024 8:05:25 PM
DeletedDateTime      :
DisplayName          : Berlin
Id                   : <MtoJoinRequestIdB>
JoinedDateTime       : 1/8/2024 9:53:55 PM
Role                 : member
State                : active
TenantId             : <MemberTenantIdB>
TransitionDetails    : Microsoft.Graph.Beta.PowerShell.Models.MicrosoftGraphMultiTenantOrganizationMemberTransitionDetails
AdditionalProperties : {[multiTenantOrgLabelType, none]}

AddedByTenantId      : <OwnerTenantId>
AddedDateTime        : 1/8/2024 7:47:45 PM
DeletedDateTime      :
DisplayName          : Cairo
Id                   : <Id>
JoinedDateTime       :
Role                 : owner
State                : active
TenantId             : <OwnerTenantId>
TransitionDetails    : Microsoft.Graph.Beta.PowerShell.Models.MicrosoftGraphMultiTenantOrganizationMemberTransitionDetails
AdditionalProperties : {[multiTenantOrgLabelType, none]}

若要允許異步處理，請在加入多租用戶組織完成之前等候 最多 2 小時 。

在成員租使用者中，使用 Update multiTenantOrganizationJoinRequestRecord API 來加入多租用戶組織。

要求

PATCH https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization/joinRequest
{
    "addedByTenantId": "{ownerTenantId}"
}

使用 Get multiTenantOrganizationJoinRequestRecord API 來驗證聯結。

要求

GET https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization/joinRequest

此作業需要幾分鐘的時間。如果您在呼叫 API 以加入之後立即檢查，回應會如下所示。

回應

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity",
    "id": "aa87e8a4-9c88-4e67-971d-79c9e43319a3",
    "addedByTenantId": "{ownerTenantId}",
    "memberState": "pending",
    "role": null,
    "transitionDetails": {
        "desiredMemberState": "active",
        "status": "notStarted",
        "details": ""
    }
}

聯結作業完成之後，回應會類似下列內容。

回應

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity",
    "id": "aa87e8a4-9c88-4e67-971d-79c9e43319a3",
    "addedByTenantId": "{ownerTenantId}",
    "memberState": "active",
    "role": "member",
    "transitionDetails": null
}

使用 List multiTenantOrganizationMembers API 來檢查多租用戶組織本身。它應該會反映聯結作業。

要求

GET https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization/tenants

回應

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#tenantRelationships/multiTenantOrganization/tenants",
    "value": [
        {
            "tenantId": "{memberTenantIdA}",
            "displayName": "Athens",
            "addedDateTime": "2023-11-20T21:24:59Z",
            "joinedDateTime": "2023-11-21T22:09:18Z",
            "addedByTenantId": "{ownerTenantId}",
            "role": "member",
            "state": "active",
            "transitionDetails": null
        },
        {
            "tenantId": "{memberTenantIdB}",
            "displayName": "Berlin",
            "addedDateTime": "2023-11-20T21:22:35Z",
            "joinedDateTime": "2023-11-21T21:55:34Z",
            "addedByTenantId": "{ownerTenantId}",
            "role": "member",
            "state": "active",
            "transitionDetails": null
        },
        {
            "tenantId": "{ownerTenantId}",
            "displayName": "Cairo",
            "addedDateTime": "2023-11-20T20:38:20Z",
            "joinedDateTime": null,
            "addedByTenantId": "{ownerTenantId}",
            "role": "owner",
            "state": "active",
            "transitionDetails": null
        }
    ]
}

若要允許異步處理，請在加入多租用戶組織完成之前等候 最多 2 小時 。

步驟 8：（選擇性）離開多租用戶組織

成員租用戶的圖示。
成員租使用者

您可以離開已加入的多租用戶組織。從多租使用者組織移除您自己的租用戶的程式，與從多租用戶組織移除另一個租用戶的程式相同。

如果您的租使用者是唯一的多租用戶組織擁有者，您必須將新的租使用者指定為多租用戶組織擁有者。如需步驟，請參閱步驟 4：（選擇性）變更租使用者的角色。

PowerShell
Microsoft Graph

在租使用者中，使用 Remove-MgBetaTenantRelationshipMultiTenantOrganizationTenant 命令來移除租使用者。此作業需要幾分鐘的時間。
```
Remove-MgBetaTenantRelationshipMultiTenantOrganizationTenant -MultiTenantOrganizationMemberId <MemberTenantId>
```

在租使用者中，使用 Remove multiTenantOrganizationMember API 來移除租使用者。此作業需要幾分鐘的時間。

要求
```
DELETE https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization/tenants/{memberTenantId}
```

步驟 9：（選擇性）刪除多租用戶組織

擁有者租用戶的圖示。
擁有者租使用者

您可以移除所有租用戶來刪除多租用戶組織。拿掉最終擁有者租使用者的程式與移除所有其他成員租使用者的程式相同。

PowerShell
Microsoft Graph

在最終擁有者租使用者中，使用 Remove-MgBetaTenantRelationshipMultiTenantOrganizationTenant 命令來移除租使用者。此作業需要幾分鐘的時間。
```
Remove-MgBetaTenantRelationshipMultiTenantOrganizationTenant -MultiTenantOrganizationMemberId $OwnerTenantId
```

在最終擁有者租使用者中，使用 Remove multiTenantOrganizationMember API 來移除租使用者。此作業需要幾分鐘的時間。

要求
```
DELETE https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization/tenants/{ownerTenantId}
```

共用方式為

使用 PowerShell 或 Microsoft Graph API 設定多租用戶組織

必要條件

步驟 2：建立多租用戶組織

步驟 3：新增租使用者

步驟 4：（選擇性）變更租使用者的角色

步驟 5：（選擇性）移除成員租使用者

步驟 7：加入多租用戶組織

步驟 8：（選擇性）離開多租用戶組織

步驟 9：（選擇性）刪除多租用戶組織

下一步

其他資源

共用方式為

使用 PowerShell 或 Microsoft Graph API 設定多租用戶組織

必要條件

步驟 1：登入擁有者租使用者

步驟 2：建立多租用戶組織

步驟 3：新增租使用者

步驟 4：（選擇性） 變更租使用者的角色

步驟 5：（選擇性） 移除成員租使用者

步驟 6：登入成員租使用者

步驟 7：加入多租用戶組織

步驟 8：（選擇性） 離開多租用戶組織

步驟 9：（選擇性） 刪除多租用戶組織

下一步

其他資源

步驟 4：（選擇性）變更租使用者的角色

步驟 5：（選擇性）移除成員租使用者

步驟 8：（選擇性）離開多租用戶組織

步驟 9：（選擇性）刪除多租用戶組織