Set-AuthServer

Este cmdlet está disponível somente no Exchange local.

Use o cmdlet Set-AuthServer para configurar um servidor de autorização que os aplicativos parceiros podem usar para obter tokens reconhecidos pelo Microsoft Exchange.

Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.

Syntax

Set-AuthServer
   [-Identity] <AuthServerIdParameter>
   [-AuthMetadataUrl <String>]
   [-TrustAnySSLCertificate]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-DomainName <MultiValuedProperty>]
   [-Enabled <Boolean>]
   [-Name <String>]
   [-WhatIf]
   [<CommonParameters>]
Set-AuthServer
   [-Identity] <AuthServerIdParameter>
   [-AuthMetadataUrl <String>]
   [-IsDefaultAuthorizationEndpoint <Boolean>]
   [-TrustAnySSLCertificate]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-DomainName <MultiValuedProperty>]
   [-Enabled <Boolean>]
   [-Name <String>]
   [-WhatIf]
   [<CommonParameters>]
Set-AuthServer
   [-Identity] <AuthServerIdParameter>
   [-RefreshAuthMetadata]
   [-Confirm]
   [-DomainController <Fqdn>]
   [-DomainName <MultiValuedProperty>]
   [-Enabled <Boolean>]
   [-Name <String>]
   [-WhatIf]
   [<CommonParameters>]

Description

Os aplicativos parceiros autorizados pelo Exchange podem acessar seus recursos depois de autenticados usando a autenticação servidor a servidor. Um aplicativo parceiro pode se autenticar usando tokens auto-emitidos confiáveis pelo Exchange ou usando um servidor de autorização confiável pelo Exchange. Você pode usar o cmdlet New-AuthServer para criar um objeto de servidor de autorização confiável no Exchange, o que permite confiar em tokens emitidos pelo servidor de autorização.

Use o cmdlet Set-AuthServer para habilitar ou desabilitar o servidor de autorização, alterar o parâmetro AuthMetadataUrl ou atualizar metadados de autorização.

Para executar esse cmdlet, você precisa ter permissões. Embora este tópico liste todos os parâmetros do cmdlet, talvez você não tenha acesso a alguns parâmetros se eles não estiverem incluídos nas permissões atribuídas a você. Para localizar as permissões necessárias para executar qualquer cmdlet ou parâmetro em sua organização, confira Find the permissions required to run any Exchange cmdlet.

Exemplos

Exemplo 1

Set-AuthServer ACS -Enabled $false

Este comando desabilita o servidor de autorização ACS.

Parâmetros

-AuthMetadataUrl

O parâmetro AuthMetadataUrl especifica a URL do servidor de autorização. Este pode ser o AuthMetadataUrl de sua organização Exchange Online.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Confirm

A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. Como essa opção afeta o cmdlet dependerá do fato de o cmdlet exigir ou não confirmação antes de continuar.

  • Cmdlets destrutivos (por exemplo, cmdlets Remove-*) têm uma pausa interna que força você a reconhecer o comando antes de prosseguir. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata: -Confirm:$false.
  • A maioria dos outros cmdlets (por exemplo, cmdlets New-* e Set-*) não tem uma pausa interna. Para esses cmdlets, especificar a opção Confirm sem um valor introduz uma pausa que força você a confirmar o comando antes de continuar.
Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-DomainController

O parâmetro DomainController especifica o controlador de domínio que é usado por esse cmdlet para ler dados ou gravar dados no Active Directory. Você identifica o controlador de domínio por seu FQDN (nome de domínio totalmente qualificado). Por exemplo, dc01.contoso.com.

Type:Fqdn
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-DomainName

Esse parâmetro só está disponível em Exchange Server 2016 (CU18 ou superior) e Exchange Server 2019 (CU7 ou superior).

O parâmetro DomainName especifica o domínio de locatário vinculado ao objeto AuthServer. Esse parâmetro usa a sintaxe: "tenantname.onmicrosoft.com".

Esse parâmetro é usado para vincular Locatário ao objeto authserver correspondente no Multilocatário Exchange Hybrid. Por exemplo, se DomainName for contoso.onmicrosoft.com, o objeto AuthServer será associado ao locatário contoso.

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-Enabled

O parâmetro Enabled especifica se o servidor de autorização está habilitado. Somente os servidores de autorização habilitados podem emitir e aceitar tokens. Desabilitar o servidor de autorização impede que quaisquer aplicativos de parceiros configurados usem o servidor de autorização para obter um token.

O parâmetro Enabled especifica se o servidor de autorização está habilitado. Os valores válidos são:

  • $true: os tokens de autorização emitidos pelo servidor de autorização são aceitos. Este é o valor padrão
  • $false: o servidor de autorização não emite nem aceita tokens de autorização.
Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Identity

O parâmetro Identity especifica o objeto do servidor de autorização que você deseja modificar. Você pode usar qualquer valor que identifique exclusivamente o servidor de autorização. Por exemplo:

  • Nome
  • DN (nome diferenciado)
  • GUID
Type:AuthServerIdParameter
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-IsDefaultAuthorizationEndpoint

O parâmetro IsDefaultAuthorizationEndpoint especifica se este servidor é o ponto de extremidade padrão. Os valores válidos são:

$true: a URL do servidor de autorização é anunciada para chamar aplicativos e aplicativos parceiros que precisam obter seus tokens de acesso OAuth do servidor de autorização.

$false: a URL do servidor de autorização não é anunciada. O valor padrão é $false.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Name

O parâmetro Name especifica um nome exclusivo para o objeto do servidor de autorização. O tamanho máximo é de 64 caracteres. Se o valor contiver espaços, coloque-o entre aspas (").

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-RefreshAuthMetadata

A opção RefreshAuthMetadata especifica se o Exchange deve atualizar os metadados de auth da URL especificada. Não é preciso especificar um valor com essa opção.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-TrustAnySSLCertificate

A opção TrustAnySSSLCertificate permite que o Exchange aceite certificados de CAs (autoridades de certificação não confiáveis). Não é preciso especificar um valor com essa opção.

Nós não recomendamos usar essa opção em um ambiente de produção.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-WhatIf

A opção WhatIf simula as ações do comando. Você pode usar essa opção para exibir as alterações que ocorreriam sem realmente aplicar essas alterações. Não é preciso especificar um valor com essa opção.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

Entradas

Input types

Para ver os tipos de entrada que este cmdlet aceita, confira Tipos de entrada e saída de cmdlet. Se o campo Tipo de Entrada de um cmdlet estiver em branco, isso significa que o cmdlet não aceita dados de entrada.

Saídas

Output types

Para ver os tipos de retorno, também conhecidos como tipos de saída, que este cmdlet aceita, consulte Tipos de entrada e saída de cmdlet. Se o campo Tipo de Saída estiver em branco, o cmdlet não retorna dados.