Udostępnij za pośrednictwem

Set-AzApiManagementAuthorizationServer

  • Odwołanie
Moduł:
Az.ApiManagement

Modyfikuje serwer autoryzacji.

Składnia

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>]

Opis

Polecenie cmdlet Set-AzApiManagementAuthorizationServer modyfikuje szczegóły serwera autoryzacji usługi Azure API Management.

Przykłady

Przykład 1. Modyfikowanie serwera autoryzacji

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

To polecenie modyfikuje określony serwer autoryzacji usługi API Management.

Przykład 2

Modyfikuje serwer autoryzacji. (automatycznie wygenerowane)

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

Określa tablicę metod wysyłania tokenu dostępu. psdx_paramvalues AuthorizationHeader i Query.

Typ:PsApiManagementAccessTokenSendingMethod[]
Dopuszczalne wartości:AuthorizationHeader, Query
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-AuthorizationEndpointUrl

Określa punkt końcowy autoryzacji do uwierzytelniania właścicieli zasobów i uzyskiwania dotacji autoryzacji.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-AuthorizationRequestMethods

Określa tablicę metod żądania autoryzacji. psdx_paramvalues GET i POST. Wartość domyślna to GET.

Typ:PsApiManagementAuthorizationRequestMethod[]
Dopuszczalne wartości:Get, Post, Head, Options, Trace, Put, Patch, Delete
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ClientAuthenticationMethods

Określa tablicę metod uwierzytelniania klienta. psdx_paramvalues Podstawowa i Treść.

Typ:PsApiManagementClientAuthenticationMethod[]
Dopuszczalne wartości:Basic, Body
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ClientId

Określa identyfikator klienta konsoli dewelopera, która jest aplikacją kliencą.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ClientRegistrationPageUrl

Określa punkt końcowy rejestracji klienta do rejestrowania klientów na serwerze autoryzacji i uzyskiwania poświadczeń klienta.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ClientSecret

Określa klucz tajny klienta konsoli dewelopera, który jest aplikacją kliencją.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Context

Określa obiekt PsApiManagementContext.

Typ:PsApiManagementContext
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-DefaultScope

Określa domyślny zakres serwera autoryzacji.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Description

Określa opis serwera autoryzacji.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-GrantTypes

Określa tablicę typów dotacji. psdx_paramvalues

  • Kod autoryzacji
  • ClientCredentials
  • Niejawny
  • ZasóbOwnerPassword
Typ:PsApiManagementGrantType[]
Dopuszczalne wartości:AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Name

Określa nazwę serwera autoryzacji do zmodyfikowania.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-PassThru

passthru

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ResourceOwnerPassword

Określa hasło właściciela zasobu. Należy określić ten parametr, jeśli parametr ResourceOwnerPassword jest określony przez parametr GrantTypes.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ResourceOwnerUsername

Określa nazwę użytkownika właściciela zasobu. Należy określić ten parametr, jeśli parametr ResourceOwnerPassword jest określony przez parametr GrantTypes.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ServerId

Określa identyfikator serwera autoryzacji do zmodyfikowania.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-SupportState

Wskazuje, czy należy obsługiwać parametr stanu.

Typ:Nullable<T>[Boolean]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-TokenBodyParameters

Określa dodatkowe parametry treści przy użyciu formatu application/x-www-form-urlencoded.

Typ:Hashtable
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-TokenEndpointUrl

Określa punkt końcowy tokenu dla klientów w celu uzyskania tokenów dostępu w zamian za prezentowanie dotacji autoryzacji lub tokenów odświeżania.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

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

Dane wyjściowe