Sdílet prostřednictvím

Set-AzApiManagementAuthorizationServer

  • Reference
Modul:
Az.ApiManagement

Upraví autorizační server.

Syntax

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

Rutina Set-AzApiManagementAuthorizationServer upravuje podrobnosti o autorizačním serveru služby Azure API Management.

Příklady

Příklad 1: Úprava autorizačního serveru

$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')

Tento příkaz upraví zadaný autorizační server služby API Management.

Příklad 2

Upraví autorizační server. (automaticky vygenerováno)

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'

Parametry

-AccessTokenSendingMethods

Určuje pole metod pro odeslání přístupového tokenu. psdx_paramvalues AuthorizationHeader a Query.

Typ:PsApiManagementAccessTokenSendingMethod[]
přijímané hodnoty:AuthorizationHeader, Query
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-AuthorizationEndpointUrl

Určuje koncový bod autorizace pro ověření vlastníků prostředků a získání udělení autorizace.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-AuthorizationRequestMethods

Určuje pole metod žádosti o autorizaci. psdx_paramvalues GET a POST. Výchozí hodnota je GET.

Typ:PsApiManagementAuthorizationRequestMethod[]
přijímané hodnoty:Get, Post, Head, Options, Trace, Put, Patch, Delete
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-ClientAuthenticationMethods

Určuje pole metod ověřování klientů. psdx_paramvalues Základní a základní text.

Typ:PsApiManagementClientAuthenticationMethod[]
přijímané hodnoty:Basic, Body
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-ClientId

Určuje ID klienta konzoly pro vývojáře, která je klientskou aplikací.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-ClientRegistrationPageUrl

Určuje koncový bod registrace klienta pro registraci klientů pro registraci klientů na autorizačním serveru a získání přihlašovacích údajů klienta.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-ClientSecret

Určuje tajný klíč klienta konzoly pro vývojáře, která je klientskou aplikací.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-Context

Určuje PsApiManagementContext objektu.

Typ:PsApiManagementContext
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Typ:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultScope

Určuje výchozí obor autorizačního serveru.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-Description

Určuje popis autorizačního serveru.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-GrantTypes

Určuje pole typů udělení. psdx_paramvalues

  • AuthorizationCode
  • ClientCredentials
  • Implicitní
  • ResourceOwnerPassword
Typ:PsApiManagementGrantType[]
přijímané hodnoty:AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Určuje název autorizačního serveru, který se má upravit.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

passthru

Typ:SwitchParameter
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceOwnerPassword

Určuje heslo vlastníka prostředku. Tento parametr je nutné zadat, pokud resourceOwnerPassword je určen parametrem GrantTypes .

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceOwnerUsername

Určuje uživatelské jméno vlastníka prostředku. Tento parametr je nutné zadat, pokud resourceOwnerPassword je určen parametrem GrantTypes .

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-ServerId

Určuje ID autorizačního serveru, který se má upravit.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-SupportState

Určuje, zda se má parametr State podporovat.

Typ:Nullable<T>[Boolean]
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-TokenBodyParameters

Určuje další parametry textu pomocí formátu application/x-www-form-urlencoded.

Typ:Hashtable
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-TokenEndpointUrl

Určuje koncový bod tokenu pro klienty, kteří mají získat přístupové tokeny výměnou za účelem předložení autorizačních grantů nebo obnovovacích tokenů.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

Vstupy

PsApiManagementContext

String

PsApiManagementAuthorizationRequestMethod[]

PsApiManagementGrantType[]

PsApiManagementClientAuthenticationMethod[]

Hashtable

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

PsApiManagementAccessTokenSendingMethod[]

SwitchParameter

Výstupy

PsApiManagementOAuth2AuthorizationServer