Compartilhar via

Set-AzApiManagementAuthorizationServer

  • Referência
Módulo:
Az.ApiManagement

Modifica um servidor de autorização.

Sintaxe

Set-AzApiManagementAuthorizationServer
   -Context <PsApiManagementContext>
   -ServerId <String>
   -Name <String>
   [-Description <String>]
   -ClientRegistrationPageUrl <String>
   -AuthorizationEndpointUrl <String>
   -TokenEndpointUrl <String>
   -ClientId <String>
   [-ClientSecret <String>]
   [-AuthorizationRequestMethods <PsApiManagementAuthorizationRequestMethod[]>]
   -GrantTypes <PsApiManagementGrantType[]>
   -ClientAuthenticationMethods <PsApiManagementClientAuthenticationMethod[]>
   [-TokenBodyParameters <Hashtable>]
   [-SupportState <Boolean>]
   [-DefaultScope <String>]
   -AccessTokenSendingMethods <PsApiManagementAccessTokenSendingMethod[]>
   [-ResourceOwnerUsername <String>]
   [-ResourceOwnerPassword <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

O cmdlet Set-AzApiManagementAuthorizationServer modifica os detalhes do servidor de autorização do Gerenciamento de API do Azure.

Exemplos

Exemplo 1: modificar um servidor de autorização

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementAuthorizationServer -Context $ApiMgmtContext -ServerId 0123456789 -Name "Contoso OAuth2 server" -ClientRegistrationPageUrl "https://contoso/signupv2" -AuthorizationEndpointUrl "https://contoso/authv2" -TokenEndpointUrl "https://contoso/tokenv2" -ClientId "clientid" -ClientSecret "e041ed1b660b4eadbad5a29d066e6e88" -AuthorizationRequestMethods @('Get') -GrantTypes @( 'AuthorizationCode', 'Implicit', 'ClientCredentials') -ClientAuthenticationMethods @('Basic') -TokenBodyParameters @{'par1'='val1'} -AccessTokenSendingMethods @('AuthorizationHeader')

Esse comando modifica o servidor de autorização do Gerenciamento de API especificado.

Exemplo 2

Modifica um servidor de autorização. (gerado automaticamente)

Set-AzApiManagementAuthorizationServer -AccessTokenSendingMethods AuthorizationHeader -AuthorizationEndpointUrl 'https://contoso/authv2' -AuthorizationRequestMethods Get -ClientAuthenticationMethods Basic -ClientId 'clientid' -ClientRegistrationPageUrl 'https://contoso/signupv2' -ClientSecret '0000000000000000000000000000000000000' -Context <PsApiManagementContext> -DefaultScope <String> -GrantTypes AuthorizationCode -Name 'Contoso OAuth2 server' -ServerId 0123456789 -TokenEndpointUrl 'https://contoso/tokenv2'

Parâmetros

-AccessTokenSendingMethods

Especifica uma matriz de métodos para enviar um token de acesso. psdx_paramvalues AuthorizationHeader e Query.

Tipo:PsApiManagementAccessTokenSendingMethod[]
Valores aceitos:AuthorizationHeader, Query
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-AuthorizationEndpointUrl

Especifica o ponto de extremidade de autorização para autenticar os proprietários de recursos e obter concessões de autorização.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-AuthorizationRequestMethods

Especifica uma matriz de métodos de solicitação de autorização. psdx_paramvalues GET e POST. O valor padrão é GET.

Tipo:PsApiManagementAuthorizationRequestMethod[]
Valores aceitos:Get, Post, Head, Options, Trace, Put, Patch, Delete
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ClientAuthenticationMethods

Especifica uma matriz de métodos de autenticação de cliente. psdx_paramvalues Básico e Corpo.

Tipo:PsApiManagementClientAuthenticationMethod[]
Valores aceitos:Basic, Body
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ClientId

Especifica a ID do cliente do console do desenvolvedor que é o aplicativo cliente.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ClientRegistrationPageUrl

Especifica o ponto de extremidade de registro do cliente para registrar clientes com o servidor de autorização e obter credenciais de cliente.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ClientSecret

Especifica o segredo do cliente do console do desenvolvedor que é o aplicativo cliente.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Context

Especifica um objeto PsApiManagementContext.

Tipo:PsApiManagementContext
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultScope

Especifica o escopo padrão do servidor de autorização.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Description

Especifica uma descrição para um servidor de autorização.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-GrantTypes

Especifica uma matriz de tipos de concessão. psdx_paramvalues

  • AuthorizationCode
  • ClientCredentials
  • Implícito
  • ResourceOwnerPassword
Tipo:PsApiManagementGrantType[]
Valores aceitos:AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Name

Especifica o nome do servidor de autorização a ser modificado.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-PassThru

passthru

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ResourceOwnerPassword

Especifica a senha do proprietário do recurso. Você deve especificar esse parâmetro se ResourceOwnerPassword for especificado pelo parâmetro GrantTypes.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ResourceOwnerUsername

Especifica o nome de usuário do proprietário do recurso. Você deve especificar esse parâmetro se ResourceOwnerPassword for especificado pelo parâmetro GrantTypes.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ServerId

Especifica a ID do servidor de autorização a ser modificado.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-SupportState

Indica se o parâmetro State deve ser compatível.

Tipo:Nullable<T>[Boolean]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-TokenBodyParameters

Especifica parâmetros de corpo adicionais usando o formato application/x-www-form-urlencoded.

Tipo:Hashtable
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-TokenEndpointUrl

Especifica o ponto de extremidade de token para os clientes obterem tokens de acesso em troca de apresentar concessões de autorização ou atualizar tokens.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

Entradas

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Saídas