Connect-SPOService

將 SharePoint 系統管理員或 SharePoint Embedded 系統管理員連接到 SharePoint 系統管理中心。 您必須先執行此 Cmdlet,再執行任何其他 SharePoint Online Cmdlet。

語法

AuthenticationCertificate

Connect-SPOService
    [-Url] <UrlCmdletPipeBind>
    [[-ClientTag] <String>]
    -ClientId <String>
    -TenantId <String>
    [-Region <AADCrossTenantAuthenticationLocation>]
    [-AuthenticationUrl <String>]
    [-Certificate <X509Certificate2>]
    [-CertificatePath <String>]
    [-CertificateThumbprint <String>]
    [-CertificatePassword <SecureString>]
    [<CommonParameters>]

AuthenticationLocation

Connect-SPOService
    [-Url] <UrlCmdletPipeBind>
    [[-Credential] <CredentialCmdletPipeBind>]
    [[-ClientTag] <String>]
    [[-ModernAuth] <Boolean>]
    [[-UseSystemBrowser] <Boolean>]
    [-Region <AADCrossTenantAuthenticationLocation>]
    [<CommonParameters>]

AuthenticationManagedIdentity

Connect-SPOService
    -Url <UrlCmdletPipeBind>
    [-ClientTag <String>]
    [-ManagedIdentity]
    [-ManagedIdentityType <ManagedIdentityType>]
    [-ManagedIdentityClientId <String>]
    [<CommonParameters>]

AuthenticationUrl

Connect-SPOService
    [-Url] <UrlCmdletPipeBind>
    [[-Credential] <CredentialCmdletPipeBind>]
    [[-ClientTag] <String>]
    [[-ModernAuth] <Boolean>]
    [[-UseSystemBrowser] <Boolean>]
    -AuthenticationUrl <String>
    [<CommonParameters>]

Description

此 Cmdlet 可將 SharePoint 系統管理員或 SharePoint Embedded 系統管理員連線至 SharePoint 系統管理中心。 組織內每個 Windows PowerShell 工作階段和每個地理位置僅支援一個 SharePoint Online 服務連線。 如果您再次執行這個 Cmdlet,現有連線會自動中斷連線,並以新連線取代。 然後,PowerShell 工作階段會使用新指定的管理員內容。 委派的合作夥伴系統管理員在管理相同 PowerShell 工作階段內的多個組織時,必須切換連線。 若要執行此 Cmdlet,您必須是 SharePoint 系統管理員或 SharePoint Embedded 系統管理員。 如需權限需求和最新指南,請參閱 SharePoint Online 管理命令介面簡介文件。

範例

範例 1

Connect-SPOService -Url https://contoso-admin.sharepoint.com -Credential admin@contoso.com

此範例顯示使用帳戶的 admin@contoso.com SharePoint 系統管理員如何連線至 SharePoint 系統管理中心 https://contoso-admin.sharepoint.com。

範例 2

$username = "admin@contoso.sharepoint.com"
$password = Read-Host -Prompt "Enter user password" -AsSecureString
$cred = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $userName, $password
Connect-SPOService -Url https://contoso-admin.sharepoint.com -Credential $cred

此範例顯示 SharePoint 系統管理員如何透過從使用者名稱和密碼建立認證物件,連線到 SharePoint 系統管理中心 https://contoso-admin.sharepoint.com 。

範例 3

Connect-SPOService -Url https://contoso-admin.sharepoint.com

此範例會提示輸入認證。 當帳戶使用多重要素驗證時,需要此方法。

範例 4

Connect-SPOService -Url https://contoso-admin.sharepoint.com -Region ITAR

此範例會透過指定驗證區域連線到 SharePoint 系統管理中心。

範例 5

Connect-SPOService -Credential $creds -Url https://tenant-admin.sharepoint.com -ModernAuth $true -AuthenticationUrl https://login.microsoftonline.com/organizations

此範例使用新式驗證連線到 SharePoint 系統管理中心。

範例 6

Connect-SPOService -Url https://contoso-admin.sharepoint.com -UseSystemBrowser $true

此範例使用 MSAL) 的 Microsoft 驗證程式庫 (進行驗證,並在驗證成功之後連線到 SharePoint 系統管理中心。

範例 7

$password = Read-Host -Prompt "Enter certificate password" -AsSecureString
Connect-SPOService -Url https://contoso-admin.sharepoint.com -ClientId 00000000-0000-0000-0000-000000000000 -TenantId 11111111-1111-1111-1111-111111111111 -CertificatePath C:\Certs\ContosoAppAuth.pfx -CertificatePassword $password

此範例使用應用程式身分識別和憑證檔案路徑,以及選擇性的憑證密碼來連線到 SharePoint 系統管理中心。

範例 8

Connect-SPOService -Url https://contoso-admin.sharepoint.com -ClientId 00000000-0000-0000-0000-000000000000 -TenantId 11111111-1111-1111-1111-111111111111 -CertificateThumbprint "3FAAAA1111AAAAAAAAAAA2222AAAAAAAAAAAAAAA"

此範例使用應用程式身分識別和憑證指紋連線到 SharePoint 系統管理中心。

範例 9

$thumbprint = "3F2A5C9D4E7B8A1234567890ABCDEF1234567890"
$cert = Get-ChildItem Cert:\LocalMachine\My\$thumbprint
Connect-SPOService -Url https://contoso-admin.sharepoint.com -ClientId 00000000-0000-0000-0000-000000000000 -TenantId 11111111-1111-1111-1111-111111111111 -Certificate $cert

此範例使用應用程式身分識別和憑證物件連線到 SharePoint 系統管理中心。

範例 10

Connect-SPOService -Url https://contoso-admin.sharepoint.com -ManagedIdentity

此範例使用系統指派的受控身分識別連線到 SharePoint 系統管理中心。

範例 11

Connect-SPOService -url https://contoso-admin.sharepoint.com -ManagedIdentity -ManagedIdentityType UserAssigned -ManagedIdentityClientId 00000000-0000-0000-0000-000000000000

此範例使用使用者指派的受控身分識別連線到 SharePoint 系統管理中心。

參數

-AuthenticationUrl

適用對象:SharePoint Online

指定 Microsoft Entra 跨租用戶驗證服務的 URL。 當需要非預設的跨租用戶驗證端點時,請使用此參數。

參數屬性

類型:System.String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthenticationUrl
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Certificate

適用對象:SharePoint Online

指定要用於驗證的 X.509 憑證。

參數屬性

類型:X509Certificate2
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthenticationCertificate
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-CertificatePassword

適用對象:SharePoint Online

指定憑證檔案的密碼。

參數屬性

類型:SecureString
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthenticationCertificate
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-CertificatePath

適用對象:SharePoint Online

指定本機 .pfx 憑證檔案的路徑。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthenticationCertificate
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-CertificateThumbprint

適用對象:SharePoint Online

指定目前使用者憑證存放區中憑證的指紋。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthenticationCertificate
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ClientId

適用對象:SharePoint Online

指定應用程式的用戶端識別碼。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False
別名:ApplicationID

參數集

AuthenticationCertificate
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ClientTag

適用對象:SharePoint Online

選擇性地將用戶端標籤新增至 CSOM HTTP 流量,以協助識別呼叫指令碼或解決方案。

參數屬性

類型:System.String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Credential

適用對象:SharePoint Online

指定用來連線的認證。 如果您未提供認證,系統會提示您輸入認證。 認證必須屬於具有 SharePoint 系統管理中心存取權的系統管理員。

參數屬性

類型:Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthenticationUrl
Position:Named
必要:False
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
AuthenticationLocation
Position:Named
必要:False
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ManagedIdentity

適用對象:SharePoint Online

表示連線使用受控身分識別,而非使用者或憑證型驗證。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthenticationManagedIdentity
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ManagedIdentityClientId

適用對象:SharePoint Online

指定使用者指派的受控身分識別的用戶端識別碼,以用於驗證。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthenticationManagedIdentity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ManagedIdentityType

適用對象:SharePoint Online

指定驗證時要使用的受控身分識別類型。 如果未指定,則會使用預設的受控識別類型。

參數屬性

類型:ManagedIdentityType
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthenticationManagedIdentity
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ModernAuth

適用對象:SharePoint Online

連線到 SharePoint 系統管理 Cmdlet 時啟用新式驗證。 使用此參數時,您也必須指定 AuthenticationUrl 參數。

參數屬性

類型:System.Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthenticationUrl
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
AuthenticationLocation
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Region

適用對象:SharePoint Online

指定驗證區域。 有效值為: Default、 ITAR、 Germany和 China。 預設值為 Default。 注意: 此 ITAR 值僅適用于 GCC High 和 DoD 租用戶。

參數屬性

類型:Microsoft.Online.SharePoint.PowerShell.AADCrossTenantAuthenticationLocation
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthenticationLocation
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
AuthenticationCertificate
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-TenantId

適用對象:SharePoint Online

指定要連線的租用戶識別碼。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthenticationCertificate
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Url

適用對象:SharePoint Online

指定 SharePoint 系統管理中心的 URL。

參數屬性

類型:Microsoft.Online.SharePoint.PowerShell.UrlCmdletPipeBind
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:True
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-UseSystemBrowser

適用對象:SharePoint Online

使用 Microsoft 驗證程式庫 (MSAL) ,透過系統瀏覽器來驗證使用者。

注意事項

為避免每次執行Connect-SPOService時新增-UseSystemBrowser參數,您可以改為設定登錄機碼。

將登錄機碼 (類型REG_DWORD設定為 UseSystemBrowser) :HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\SPO\CMDLETS\

如果其中一個登錄機碼設定為非零整數值或 -UseSystemBrowser 參數設定為 true,驗證流程將會使用系統瀏覽器進行登入。

參數屬性

類型:System.Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AuthenticationUrl
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
AuthenticationLocation
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援常見參數: -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。

輸入

Microsoft.Online.SharePoint.PowerShell.UrlCmdletPipeBind

Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind

輸出

System.Object