Set-AuthServer

Módulo:
Exchange PowerShell

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.

Sintaxe

AuthMetadataUrl 

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

NativeClientAuthServer 

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

RefreshAuthMetadata 

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

AppSecret 

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

Description

Aplicativos de parceiros autorizados pelo Exchange podem acessar seus recursos depois de serem autenticados usando a autenticação de servidor para 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 os metadados de autorização.

Para executar esse cmdlet, você precisa ter permissões. Embora este artigo 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

-ApplicationIdentifier

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Esse parâmetro está disponível na HU (atualização de hotfix) de 18 de abril de 2025 para Exchange 2019 CU15 e Exchange 2016 CU23.

{{ Preencher descrição do ApplicationIdentifier }}

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-AuthMetadataUrl

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-Confirm

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. A forma como essa opção afeta o cmdlet depende se o cmdlet requer confirmação antes de continuar.

  • Cmdlets destrutivos (por exemplo, Remover- cmdlets) têm uma pausa interna que força você a confirmar o comando antes de continuar. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata: -Confirm:$false.
  • A maioria dos outros cmdlets (por exemplo, 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 reconhecer o comando antes de continuar.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

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

-DomainController

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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.

Propriedades do parâmetro

Tipo:Fqdn
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

-DomainName

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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

O parâmetro DomainName vincula uma organização baseada em nuvem ao objeto AuthServer correspondente no híbrido do Exchange multilocatário. Esse parâmetro usa a sintaxe: "domain.onmicrosoft.com".

Por exemplo, se o valor DomainName for contoso.onmicrosoft.com, o objeto AuthServer será associado à organização baseada em nuvem da contoso.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-Enabled

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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. Esse valor é o valor padrão
  • $false: O servidor de autorização não emite nem aceita tokens de autorização.

Propriedades do parâmetro

Tipo:Boolean
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

-GraphBaseUrl

Aplicável: Exchange Server 2019, Exchange Server SE

{{ Preencher GraphBaseUrl Description }}

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-Identity

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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

Propriedades do parâmetro

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

Conjuntos de parâmetros

(All)
Cargo:1
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-IsDefaultAuthorizationEndpoint

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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 aplicativos de parceiros de chamada e aplicativos 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.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-Name

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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 (").

Propriedades do parâmetro

Tipo: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

-RefreshAuthMetadata

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-TrustAnySSLCertificate

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

O comutador TrustAnySSLCertificate 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.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-WhatIf

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

A opção WhatIf mostra o que o comando faz sem fazer nenhuma alteração. Não é preciso especificar um valor com essa opção.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

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

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

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.