Set-SPOTenantPreAuthSettings

Define a configuração da pré-autenticação.

Sintaxe

IsDisabled

Set-SPOTenantPreAuthSettings
    -IsDisabled <Boolean>
    [<CommonParameters>]

AddListItem

Set-SPOTenantPreAuthSettings
    -Type <TenantPreAuthSettingsListType>
    [-Add]
    [-IncludedApps <String>]
    [-ExcludedApps <String>]
    [-IncludedFeatures <String>]
    [-ExcludedFeatures <String>]
    [<CommonParameters>]

RemoveListItem

Set-SPOTenantPreAuthSettings
    -Id <String>
    [-Remove]
    [<CommonParameters>]

Description

Você pode usar esse cmdlet para configurar ou desabilitar o recurso de pré-autenticação no SharePoint Online. A desabilitação pode ser combinada com comutadores para dar suporte ao gerenciamento granular de pré-autenticação para aplicativos e recursos específicos no nível do locatário.

Observação

O que é pré-autenticação?

O SharePoint inclui tokens auto-emitidos em URLs chamados URLs de pré-autenticação (também conhecidas como URLs tempauth) para fornecer acesso temporário a um recurso do SharePoint, o que ajuda a dar suporte a experiências de usuário mais avançadas. Por exemplo, um cenário comum é baixar um arquivo usando uma URL que inclui um token no tempauth parâmetro de consulta como o seguinte:

https://<tenant>.sharepoint.com/sites/samplesite/_layouts/15/download.aspx?UniqueId=<id>&tempauth=v1.ey...

Mas esse recurso está sendo preterido no momento, portanto, esse cmdlet permite controlar o uso da pré-autenticação em vários casos de uso.

Importante

As configurações aproveitam uma ordem de precedência:

  1. Negar
  2. Permitir
  3. IsDisabled

Além disso, como o uso desse cmdlet pode desabilitar a funcionalidade em seu locatário do SharePoint Online, é altamente recomendável testar e avaliar cada alteração em um locatário de teste antes de fazer alterações em um ambiente de produção.

Você deve ser um administrador do SharePoint para executar o cmdlet.

Exemplos

Exemplo 1

Set-SPOTenantPreAuthSettings -IsDisabled $true

Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"

Este exemplo desabilita a pré-autenticação geral e adiciona uma configuração que permite que dois aplicativos usem a pré-autenticação para todos os recursos.

Exemplo 2

Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e" -ExcludedApps "" -IncludedFeatures "" -ExcludedFeatures ""

Este exemplo executa a mesma função que o exemplo 1, exceto que, nesse caso, as opções para -ExcludedApps, -IncludedFeaturese -ExcludedFeatures são adicionadas ao cmdlet.

Supõe-se que essas opções tenham o valor padrão de "" se não forem usadas com o cmdlet, e o exemplo 2 é usado para demonstrar apenas o conjunto completo de opções.

Exemplo 3

Set-SPOTenantPreAuthSettings -Remove -Id "368dde6f-c857-4383-a8a7-02a04a294e6d"

Este exemplo removerá um item existente da lista atual de itens. A opção de remoção pode remover entradas permitidas ou negadas da lista.

Exemplo 4

Set-SPOTenantPreAuthSettings -IsDisabled $true

Set-SPOTenantPreAuthSettings -Add -Type Allow -ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -ExcludedFeatures "Download,WebRenderingEmbed"

Este exemplo desabilita a pré-autenticação geral e permite que todos os aplicativos, exceto um, usem a pré-autenticação para todos os recursos, exceto para "Download" e "WebRenderingEmbed".

Nesse caso, o aplicativo sempre terá o uso "029e7c27-4b9c-4f8b-ba32-b96249468d42" da pré-autenticação, pois ele é excluído da configuração da lista de permissões. Qualquer outro aplicativo terá permissão para usar a pré-autenticação para qualquer recurso além de "Download" e "WebRenderingEmbed".

Exemplo 5

Set-SPOTenantPreAuthSettings -IsDisabled $true

Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -IncludedFeatures "OfficeOnline,WebRenderingEmbed,Download"

Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"

Este exemplo desabilita a pré-autenticação geral, mas contém uma sobreposição entre as configurações na lista de permissões e na lista de negações. Primeiro, ele permite que um aplicativo use a pré-autenticação para os "OfficeOnline"recursos , "WebRenderingEmbed", e "Download" . Mas na execução final do cmdlet, ele nega que o mesmo aplicativo use a pré-autenticação para todos os recursos.

Nesse caso, o aplicativo "029e7c27-4b9c-4f8b-ba32-b96249468d42" não teria permissão para usar a pré-autenticação para nenhum dos recursos da lista de permissões, apesar de ter a configuração. Isso ocorre porque a lista Negar tem precedência sobre a lista Permitir.

Exemplo 6

Set-SPOTenantPreAuthSettings -IsDisabled $false

Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "Empty"

Este exemplo permite a pré-autenticação geral e nega que solicitações que não sejam provenientes de um aplicativo (por exemplo, solicitações provenientes por meio de um navegador) usem a pré-autenticação para todos os recursos.

Observação

O "Empty" valor para -IncludedApps ou -ExcludedApps é diferente de uma cadeia de caracteres ""vazia. As regras são as seguintes:

  • "Empty" representa todas as solicitações que não são provenientes de um aplicativo (por exemplo, solicitações diretas do navegador) e não terá uma ID de aplicativo associada a ela
  • "" Pode significar várias coisas:
    • Se você tiver –IncludedApps "" -ExcludedApps "", significa que a configuração se aplica a todos
    • Se você tiver –IncludedApps "" -ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42", significa que a configuração se aplica a todos os aplicativos, exceto ."029e7c27-4b9c-4f8b-ba32-b96249468d42"
    • Se você tiver –IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" and -ExcludedApps "", significa que a configuração só se aplica ao aplicativo "029e7c27-4b9c-4f8b-ba32-b96249468d42"
    • Você não pode ter uma configuração com –IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" –ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42"

Parâmetros

-Add

Esse parâmetro especifica que a operação do cmdlet é Adicionar uma configuração à lista de permissões ou à lista de negações.

Propriedades do parâmetro

Tipo:System.Management.Automation.SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

AddListItem
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ExcludedApps

Esse valor de parâmetro contém as IDs de aplicativos a serem configuradas dentro do -ExcludedApps escopo. Os valores possíveis incluem: "", "Empty"ou uma lista separada por vírgulas de IDs de aplicativo.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

AddListItem
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ExcludedFeatures

Esse valor de parâmetro contém os nomes de recurso a serem configurados dentro do -ExcludedFeatures escopo. Os valores possíveis incluem: "" ou uma lista separada por vírgulas de nomes de recursos (consulte a seção NOTAS abaixo).

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

AddListItem
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Id

Esse parâmetro identifica a configuração do item de lista a ser removida da configuração atual. Ele só é necessário com o -Remove parâmetro.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

RemoveListItem
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-IncludedApps

Esse valor de parâmetro contém as IDs de aplicativo a serem configuradas dentro do -IncludedApps escopo. Os valores possíveis incluem: "", "Empty"ou uma lista separada por vírgulas de IDs de aplicativo.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

AddListItem
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-IncludedFeatures

Esse valor de parâmetro contém os nomes de recurso a serem configurados dentro do -IncludedFeatures escopo. Os valores possíveis incluem: "" ou uma lista separada por vírgulas de nomes de recursos (consulte a seção NOTAS abaixo).

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

AddListItem
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-IsDisabled

Esse parâmetro permite que o administrador alterne a pré-autenticação para todos os aplicativos e recursos a serem habilitados ou desabilitados.

Propriedades do parâmetro

Tipo:Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

IsDisabled
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Remove

Esse parâmetro especifica que a operação do cmdlet é remover uma configuração da lista de permissões ou negações.

Propriedades do parâmetro

Tipo:System.Management.Automation.SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

RemoveListItem
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Type

Esse parâmetro indica se o cmdlet está interagindo com a lista de permissões ou com a lista de negações.

Propriedades do parâmetro

Tipo:TenantPreAuthSettingsListType
Valor padrão:None
Valores aceitos:Allow, Deny
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

AddListItem
Cargo:Named
Obrigatório:True
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.

Entradas

None

Saídas

System.Object

Observações

O -IncludedFeatures e -ExcludedFeatures use nomes de recursos da tabela a seguir. Ele menciona explicitamente se o recurso será interrompido se for desabilitado por meio do cmdlet do PowerShell.

Nome do recurso Descrição Informações Adicionais
DataFormWebpart Cenários envolvidos com DataFormWebParts para exibir/interagir com dados do SharePoint. Propriedades de DataFormWebPart (Microsoft.SharePoint.WebPartPages) - Microsoft Learn
Baixar Cenários para obter URLs de download pré-autenticadas. Aplicativos de terceiros e alguns aplicativos de terceiros podem estar corrompidos. Protocolos OAuth 2.0 e OpenID Connect na plataforma de identidade da Microsoft - Microsoft Learn
OfficeOnline Office na Web cenários. O desempenho pode ser afetado.
SearchPreview Cenários envolvidos na geração de visualizações/miniaturas/conversões para resultados de consulta de pesquisa. A experiência pode estar quebrada.
Conector do SharePoint Cenários envolvidos com Conectores do SharePoint Conectores do SharePoint - Microsoft Learn
Miniatura Cenários para obter URLs de geração de miniaturas pré-autenticadas.
UploadSession Cenários para a criação de sessões de upload. Aplicativo de terceiros e alguns aplicativos de terceiros podem estar quebrados
Vídeo A reprodução de vídeo hospedado no SharePoint pode estar interrompida
WebRendering Cenários para renderizar visualizações de arquivos no navegador.
WebRenderingEmbed Insira arquivos do SharePoint em outro aplicativo. Aplicativo de terceiros e alguns aplicativos de terceiros podem estar quebrados Web Part de Inserir
Whiteboard A integração do Teams com o aplicativo Whiteboard será interrompida para usuários anônimos e convidados. Usar o Whiteboard em uma reunião do Teams - Suporte da Microsoft