Set-AuthServer
Este cmdlet está disponível somente no Exchange local.
Utilize o cmdlet Set-AuthServer para configurar um servidor de autorização que as aplicações parceiras podem utilizar 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>]
[-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
As aplicações de parceiros autorizadas pelo Exchange podem aceder aos respetivos recursos depois de serem autenticadas através da autenticação servidor a servidor. Uma aplicação parceira pode autenticar-se através de tokens auto-emitidos fidedignos pelo Exchange ou através de um servidor de autorização fidedigno pelo Exchange. Pode utilizar o cmdlet New-AuthServer para criar um objeto de servidor de autorização fidedigno no Exchange, o que lhe permite confiar nos tokens emitidos pelo servidor de autorização.
Utilize o cmdlet Set-AuthServer para ativar ou desativar 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 artigo liste todos os parâmetros do cmdlet, poderá não ter acesso a alguns parâmetros se não estiverem incluídos nas permissões que lhe foram atribuídas. 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
Este parâmetro está disponível na atualização de Correção (HU) de 18 de abril de 2025 para o Exchange 2019 CU15 e Exchange 2016 CU23.
{{ Fill ApplicationIdentifier Description }}
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
O parâmetro AuthMetadataUrl especifica a URL do servidor de autorização. Este pode ser o AuthMetadataUrl da sua organização 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
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, 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 confirmar 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
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
Este parâmetro só está disponível no Exchange Server 2016 (CU18 ou superior) e Exchange Server 2019 (CU7 ou superior).
O parâmetro DomainName liga uma organização baseada na cloud ao objeto AuthServer correspondente no Exchange Híbrido Multi-Inquilino. Este parâmetro utiliza a sintaxe: "domain.onmicrosoft.com".
Por exemplo, se o valor DomainName for contoso.onmicrosoft.com, o objeto AuthServer está associado à organização baseada na cloud 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
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 aceites. Este valor é a predefiniçã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 |
-Identity
Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
O parâmetro Identity especifica o objeto de servidor de autorização que pretende modificar. Pode utilizar 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
O parâmetro IsDefaultAuthorizationEndpoint especifica se este servidor é o ponto de extremidade padrão. Os valores válidos são:
$true: o URL do servidor de autorização é anunciado para chamar aplicações e aplicações parceiras que precisam de obter os respetivos tokens de acesso OAuth a partir do servidor de autorização.
$false: o URL do servidor de autorização não é anunciado. O valor predefinido é $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
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
O comutador RefreshAuthMetadata especifica se o Exchange deve atualizar os metadados de autenticação a partir do URL especificado. 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
O comutador TrustAnySSLCertificate permite que o Exchange aceite certificados de autoridades de certificação (ACs) não fidedignas. 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
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.
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 suporta os 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.