Set-AzApiManagementAuthorizationServer
Upraví autorizační server.
Syntaxe
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 upraví 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řípustné hodnoty: | AuthorizationHeader, Query |
Position: | Named |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | 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 |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-AuthorizationRequestMethods
Určuje pole metod žádosti o autorizaci. psdx_paramvalues GET a POST. Výchozí hodnota je GET.
Typ: | PsApiManagementAuthorizationRequestMethod[] |
Přípustné hodnoty: | Get, Post, Head, Options, Trace, Put, Patch, Delete |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-ClientAuthenticationMethods
Určuje pole metod ověřování klientů. psdx_paramvalues Základní a základní text.
Typ: | PsApiManagementClientAuthenticationMethod[] |
Přípustné hodnoty: | Basic, Body |
Position: | Named |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-ClientId
Určuje ID klienta konzoly pro vývojáře, která je klientskou aplikací.
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | 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 |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-ClientSecret
Určuje tajný klíč klienta konzoly pro vývojáře, která je klientskou aplikací.
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-Context
Určuje PsApiManagementContext objektu.
Typ: | PsApiManagementContext |
Position: | Named |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-DefaultProfile
Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.
Typ: | IAzureContextContainer |
Aliasy: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-DefaultScope
Určuje výchozí obor autorizačního serveru.
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-Description
Určuje popis autorizačního serveru.
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-GrantTypes
Určuje pole typů udělení. psdx_paramvalues
- AuthorizationCode
- ClientCredentials
- Implicitní
- ResourceOwnerPassword
Typ: | PsApiManagementGrantType[] |
Přípustné hodnoty: | AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials |
Position: | Named |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-Name
Určuje název autorizačního serveru, který se má upravit.
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-PassThru
passthru
Typ: | SwitchParameter |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | 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 |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | 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 |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-ServerId
Určuje ID autorizačního serveru, který se má upravit.
Typ: | String |
Position: | Named |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-SupportState
Určuje, zda se má parametr state podporovat.
Typ: | Nullable<T>[Boolean] |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-TokenBodyParameters
Určuje další parametry textu pomocí formátu application/x-www-form-urlencoded.
Typ: | Hashtable |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | 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 |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
Vstupy
Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Výstupy
Související odkazy
Azure PowerShell