Connect-SPOService

Подключает администратора SharePoint или администратора SharePoint Embedded к Центру администрирования 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
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

AuthenticationUrl
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Certificate

Применимо: SharePoint Online

Указывает сертификат X.509, используемый для проверки подлинности.

Свойства параметров

Тип:X509Certificate2
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

AuthenticationCertificate
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-CertificatePassword

Применимо: SharePoint Online

Указывает пароль для файла сертификата.

Свойства параметров

Тип:SecureString
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

AuthenticationCertificate
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-CertificatePath

Применимо: SharePoint Online

Указывает путь к локальному .pfx файлу сертификата.

Свойства параметров

Тип:String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

AuthenticationCertificate
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-CertificateThumbprint

Применимо: SharePoint Online

Указывает отпечаток сертификата в хранилище сертификатов текущего пользователя.

Свойства параметров

Тип:String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

AuthenticationCertificate
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ClientId

Применимо: SharePoint Online

Указывает идентификатор клиента приложения.

Свойства параметров

Тип:String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:ApplicationId

Наборы параметров

AuthenticationCertificate
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ClientTag

Применимо: SharePoint Online

При необходимости добавляет тег клиента к HTTP-трафику CSOM, чтобы помочь определить вызывающий сценарий или решение.

Свойства параметров

Тип:System.String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Credential

Применимо: SharePoint Online

Указывает учетные данные, используемые для подключения. Если вы не предоставите учетные данные, вам будет предложено ввести их. Учетные данные должны принадлежать администратору, имеющему доступ к Центру администрирования SharePoint.

Свойства параметров

Тип:Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

AuthenticationUrl
Position:Named
Обязательно:False
Значение из конвейера:True
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
AuthenticationLocation
Position:Named
Обязательно:False
Значение из конвейера:True
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ManagedIdentity

Применимо: SharePoint Online

Указывает, что подключение использует управляемое удостоверение вместо проверки подлинности на основе пользователя или сертификата.

Свойства параметров

Тип:SwitchParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

AuthenticationManagedIdentity
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ManagedIdentityClientId

Применимо: SharePoint Online

Указывает идентификатор клиента назначенного пользователю управляемого удостоверения, используемого для проверки подлинности.

Свойства параметров

Тип:String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

AuthenticationManagedIdentity
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ManagedIdentityType

Применимо: SharePoint Online

Указывает тип управляемого удостоверения для проверки подлинности. Если параметр не задан, используется тип управляемого удостоверения по умолчанию.

Свойства параметров

Тип:ManagedIdentityType
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

AuthenticationManagedIdentity
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ModernAuth

Применимо: SharePoint Online

Включает современную проверку подлинности при подключении к командлетам администрирования SharePoint. При использовании этого параметра необходимо также указать AuthenticationUrl его.

Свойства параметров

Тип:System.Boolean
Значение по умолчанию: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
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

AuthenticationLocation
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
AuthenticationCertificate
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-TenantId

Применимо: SharePoint Online

Указывает идентификатор клиента для подключения.

Свойства параметров

Тип:String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

AuthenticationCertificate
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Url

Применимо: SharePoint Online

Указывает URL-адрес Центра администрирования SharePoint.

Свойства параметров

Тип:Microsoft.Online.SharePoint.PowerShell.UrlCmdletPipeBind
Значение по умолчанию: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
Значение по умолчанию: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.

Входные данные

Microsoft.Online.SharePoint.PowerShell.UrlCmdletPipeBind

Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind

Выходные данные

System.Object