Connect-SPOService
Conecta um Administrador do SharePoint ou um Administrador do SharePoint Embedded ao centro de administração do SharePoint. Você deve executar esse cmdlet antes de executar qualquer outro cmdlet do SharePoint Online.
Sintaxe
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
Esse cmdlet conecta um Administrador do SharePoint ou um Administrador do SharePoint Embedded ao centro de administração do SharePoint. Há suporte apenas para uma conexão de serviço do SharePoint Online por sessão do Windows PowerShell e por área geográfica em uma organização. Se você executar esse cmdlet novamente, a conexão existente será automaticamente desconectada e substituída pela nova conexão. Em seguida, a sessão do PowerShell usa o contexto de administrador recém-especificado. Os administradores de parceiros delegados devem alternar conexões ao gerenciar várias organizações na mesma sessão do PowerShell. Para executar este cmdlet, você deve ser um Administrador do SharePoint ou um Administrador do SharePoint Embedded. Para obter os requisitos de permissão e as diretrizes mais recentes, consulte a documentação Introdução ao Shell de Gerenciamento do SharePoint Online.
Exemplos
EXEMPLO 1
Connect-SPOService -Url https://contoso-admin.sharepoint.com -Credential admin@contoso.com
Este exemplo mostra como um administrador do SharePoint usando a admin@contoso.com conta se conecta ao centro de administração do SharePoint em https://contoso-admin.sharepoint.com.
EXEMPLO 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
Este exemplo mostra como um administrador do SharePoint se conecta ao centro de administração do SharePoint criando um objeto de credencial com base em https://contoso-admin.sharepoint.com um nome de usuário e senha.
EXEMPLO 3
Connect-SPOService -Url https://contoso-admin.sharepoint.com
Este exemplo solicita credenciais. Essa abordagem é necessária quando a conta usa autenticação multifator.
EXEMPLO 4
Connect-SPOService -Url https://contoso-admin.sharepoint.com -Region ITAR
Este exemplo se conecta ao centro de administração do SharePoint especificando a região de autenticação.
EXEMPLO 5
Connect-SPOService -Credential $creds -Url https://tenant-admin.sharepoint.com -ModernAuth $true -AuthenticationUrl https://login.microsoftonline.com/organizations
Este exemplo se conecta ao centro de administração do SharePoint usando a autenticação moderna.
EXEMPLO 6
Connect-SPOService -Url https://contoso-admin.sharepoint.com -UseSystemBrowser $true
Este exemplo é autenticado usando a Biblioteca de Autenticação da Microsoft (MSAL) e se conecta ao centro de administração do SharePoint após a autenticação ser bem-sucedida.
EXEMPLO 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
Este exemplo se conecta ao centro de administração do SharePoint usando uma identidade de aplicativo e um caminho de arquivo de certificado, com uma senha de certificado opcional.
EXEMPLO 8
Connect-SPOService -Url https://contoso-admin.sharepoint.com -ClientId 00000000-0000-0000-0000-000000000000 -TenantId 11111111-1111-1111-1111-111111111111 -CertificateThumbprint "3FAAAA1111AAAAAAAAAAA2222AAAAAAAAAAAAAAA"
Este exemplo se conecta ao centro de administração do SharePoint usando uma identidade de aplicativo e uma impressão digital de certificado.
EXEMPLO 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
Este exemplo se conecta ao centro de administração do SharePoint usando uma identidade de aplicativo e um objeto de certificado.
EXEMPLO 10
Connect-SPOService -Url https://contoso-admin.sharepoint.com -ManagedIdentity
Este exemplo se conecta ao centro de administração do SharePoint usando a identidade gerenciada atribuída pelo sistema.
EXEMPLO 11
Connect-SPOService -url https://contoso-admin.sharepoint.com -ManagedIdentity -ManagedIdentityType UserAssigned -ManagedIdentityClientId 00000000-0000-0000-0000-000000000000
Este exemplo se conecta ao centro de administração do SharePoint usando a identidade gerenciada atribuída pelo usuário.
Parâmetros
-AuthenticationUrl
Aplicável: SharePoint Online
Especifica a URL do serviço de autenticação entre locatários do Microsoft Entra. Use esse parâmetro quando for necessário um ponto de extremidade de autenticação entre locatários não padrão.
Propriedades do parâmetro
| Tipo: | System.String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AuthenticationUrl
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Certificate
Aplicável: SharePoint Online
Especifica o certificado X.509 usado para autenticação.
Propriedades do parâmetro
| Tipo: | X509Certificate2 |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AuthenticationCertificate
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-CertificatePassword
Aplicável: SharePoint Online
Especifica a senha para o arquivo de certificado.
Propriedades do parâmetro
| Tipo: | SecureString |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AuthenticationCertificate
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-CertificatePath
Aplicável: SharePoint Online
Especifica o caminho para o arquivo de certificado local .pfx .
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AuthenticationCertificate
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-CertificateThumbprint
Aplicável: SharePoint Online
Especifica a impressão digital do certificado no repositório de certificados do usuário atual.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AuthenticationCertificate
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ClientId
Aplicável: SharePoint Online
Especifica a ID do cliente do aplicativo.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | ApplicationId |
Conjuntos de parâmetros
AuthenticationCertificate
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ClientTag
Aplicável: SharePoint Online
Opcionalmente, adiciona uma marca de cliente ao tráfego HTTP do CSOM para ajudar a identificar o script ou a solução de chamada.
Propriedades do parâmetro
| Tipo: | System.String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Credential
Aplicável: SharePoint Online
Especifica as credenciais usadas para se conectar. Se você não fornecer credenciais, será solicitado que você as insira. As credenciais devem pertencer a um administrador que tenha acesso ao centro de administração do SharePoint.
Propriedades do parâmetro
| Tipo: | Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AuthenticationUrl
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
AuthenticationLocation
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ManagedIdentity
Aplicável: SharePoint Online
Indica que a conexão usa uma identidade gerenciada em vez de autenticação baseada em certificado ou usuário.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AuthenticationManagedIdentity
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ManagedIdentityClientId
Aplicável: SharePoint Online
Especifica a ID do cliente de uma identidade gerenciada atribuída pelo usuário a ser usada para autenticação.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AuthenticationManagedIdentity
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ManagedIdentityType
Aplicável: SharePoint Online
Especifica o tipo de identidade gerenciada a ser usada durante a autenticação. Se não for especificado, o tipo de identidade gerenciada padrão será usado.
Propriedades do parâmetro
| Tipo: | ManagedIdentityType |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AuthenticationManagedIdentity
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ModernAuth
Aplicável: SharePoint Online
Habilita a autenticação moderna ao se conectar aos cmdlets de administração do SharePoint.
Ao usar esse parâmetro, você também deve especificar o AuthenticationUrl parâmetro.
Propriedades do parâmetro
| Tipo: | System.Boolean |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AuthenticationUrl
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
AuthenticationLocation
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Region
Aplicável: SharePoint Online
Especifica a região de autenticação. Os valores válidos são: Default, ITAR, Germanye China.
O valor padrão é Default.
Observação: O ITAR valor se aplica somente a locatários do GCC High e do DoD.
Propriedades do parâmetro
| Tipo: | Microsoft.Online.SharePoint.PowerShell.AADCrossTenantAuthenticationLocation |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AuthenticationLocation
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
AuthenticationCertificate
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-TenantId
Aplicável: SharePoint Online
Especifica a ID do locatário ao qual se conectar.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AuthenticationCertificate
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Url
Aplicável: SharePoint Online
Especifica a URL do centro de administração do SharePoint.
Propriedades do parâmetro
| Tipo: | Microsoft.Online.SharePoint.PowerShell.UrlCmdletPipeBind |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-UseSystemBrowser
Aplicável: SharePoint Online
Usa a Biblioteca de Autenticação da Microsoft (MSAL) para autenticar o usuário usando o navegador do sistema.
Observação
Para evitar adicionar o -UseSystemBrowser parâmetro sempre que executar Connect-SPOServiceo , você pode definir uma chave do Registro.
Defina a chave do UseSystemBrowser Registro (tipo REG_DWORD) em: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\SPO\CMDLETS\
Se a chave do Registro for definida como um valor inteiro diferente de zero ou -UseSystemBrowser o parâmetro for definido como , o fluxo de autenticação usará o truenavegador do sistema para entrar.
Propriedades do parâmetro
| Tipo: | System.Boolean |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
AuthenticationUrl
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
AuthenticationLocation
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet dá suporte aos parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.