Connect-SPOService
Подключает администратора SharePoint или внедренного администратора SharePoint к Центру администрирования SharePoint. Этот командлет необходимо выполнить перед выполнением других командлетов SharePoint Online.
Синтаксис
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>]
Описание
Этот командлет подключает администратора SharePoint или администратора SharePoint Embedded к Центру администрирования SharePoint. Для Windows PowerShell сеанса и каждого региона в организации поддерживается только одно подключение к службе SharePoint Online. При повторном запуске этого командлета существующее подключение автоматически отключается и заменяется новым. Затем сеанс PowerShell использует только что указанный контекст администратора. Делегированные администраторы партнеров должны переключать подключения при управлении несколькими организациями в одном сеансе PowerShell. Для выполнения этого командлета необходимо быть администратором SharePoint или администратором SharePoint Embedded. Требования к разрешениям и последние рекомендации см. в руководстве по командная консоль SharePoint Online документации.
Примеры
ПРИМЕР 1
Connect-SPOService -Url https://contoso-admin.sharepoint.com -Credential admin@contoso.com
В этом примере показано, как администратор SharePoint с помощью учетной admin@contoso.com записи подключается к Центру администрирования 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) и подключение к Центру администрирования 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
Указывает URL-адрес службы проверки подлинности между клиентами Microsoft Entra. Используйте этот параметр, если требуется конечная точка проверки подлинности между клиентами, не используемая по умолчанию.
Свойства параметров
| Тип: | System.String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AuthenticationUrl
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Certificate
Применимо: SharePoint Online
Указывает сертификат X.509, используемый для проверки подлинности.
Свойства параметров
| Тип: | X509Certificate2 |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AuthenticationCertificate
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-CertificatePassword
Применимо: SharePoint Online
Указывает пароль для файла сертификата.
Свойства параметров
| Тип: | SecureString |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AuthenticationCertificate
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-CertificatePath
Применимо: SharePoint Online
Указывает путь к локальному .pfx файлу сертификата.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AuthenticationCertificate
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-CertificateThumbprint
Применимо: SharePoint Online
Указывает отпечаток сертификата в хранилище сертификатов текущего пользователя.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AuthenticationCertificate
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ClientId
Применимо: SharePoint Online
Указывает идентификатор клиента приложения.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | ApplicationId |
Наборы параметров
AuthenticationCertificate
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ClientTag
Применимо: SharePoint Online
При необходимости добавляет тег клиента в HTTP-трафик CSOM для идентификации вызывающего скрипта или решения.
Свойства параметров
| Тип: | System.String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Credential
Применимо: SharePoint Online
Указывает учетные данные, используемые для подключения. Если учетные данные не указаны, вам будет предложено ввести их. Учетные данные должны принадлежать администратору, который имеет доступ к Центру администрирования SharePoint.
Свойства параметров
| Тип: | Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AuthenticationUrl
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
AuthenticationLocation
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ManagedIdentity
Применимо: SharePoint Online
Указывает, что в подключении используется управляемое удостоверение, а не проверка подлинности на основе пользователя или сертификата.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AuthenticationManagedIdentity
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ManagedIdentityClientId
Применимо: SharePoint Online
Указывает идентификатор клиента управляемого удостоверения, назначаемого пользователем, который будет использоваться для проверки подлинности.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AuthenticationManagedIdentity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ManagedIdentityType
Применимо: SharePoint Online
Указывает тип управляемого удостоверения, используемого при проверке подлинности. Если не указано, используется тип управляемого удостоверения по умолчанию.
Свойства параметров
| Тип: | ManagedIdentityType |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AuthenticationManagedIdentity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ModernAuth
Применимо: SharePoint Online
Включает современную проверку подлинности при подключении к командлетам администрирования SharePoint.
При использовании этого параметра необходимо также указать AuthenticationUrl параметр .
Свойства параметров
| Тип: | System.Boolean |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | 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 |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AuthenticationLocation
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
AuthenticationCertificate
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-TenantId
Применимо: SharePoint Online
Указывает идентификатор клиента, к которому нужно подключиться.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AuthenticationCertificate
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Url
Применимо: SharePoint Online
Указывает URL-адрес Центра администрирования SharePoint.
Свойства параметров
| Тип: | Microsoft.Online.SharePoint.PowerShell.UrlCmdletPipeBind |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-UseSystemBrowser
Применимо: SharePoint Online
Использует библиотеку проверки подлинности Майкрософт (MSAL) для проверки подлинности пользователя с помощью системного браузера.
Примечание.
Чтобы избежать добавления -UseSystemBrowser параметра при каждом запуске Connect-SPOService, вместо этого можно задать раздел реестра.
UseSystemBrowser Задайте раздел реестра (тип REG_DWORD) в:HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\SPO\CMDLETS\
Если для любого раздела реестра задано ненулевое целочисленное значение или -UseSystemBrowser параметр имеет значение true, поток проверки подлинности будет использовать системный браузер для входа.
Свойства параметров
| Тип: | System.Boolean |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AuthenticationUrl
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
AuthenticationLocation
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в статье about_CommonParameters.