New-AzApiManagementAuthorizationServer
建立授權伺服器。
語法
New-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>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
New-AzApiManagementAuthorizationServer Cmdlet 會建立 Azure API 管理 授權伺服器。
範例
範例 1:建立授權伺服器
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementAuthorizationServer -Context $ApiMgmtContext -Name "Contoso OAuth2 server" -ClientRegistrationPageUrl "https://contoso/signup" -AuthorizationEndpointUrl "https://contoso/auth" -TokenEndpointUrl "https://contoso/token" -ClientId "clientid" -ClientSecret "e041ed1b660b4eadbad5a29d066e6e88" -AuthorizationRequestMethods @('Get', 'Post') -GrantTypes @( 'AuthorizationCode', 'Implicit', 'ResourceOwnerPassword', 'ClientCredentials') -ClientAuthenticationMethods @('Basic') -TokenBodyParameters @{'par1'='val1'; 'par2'='val2'} -AccessTokenSendingMethods @('AuthorizationHeader', 'Query') -ResourceOwnerUsername "ivan" -ResourceOwnerPassword "qwerty"
此命令會建立授權伺服器。
範例 2
建立授權伺服器。 ( 自動產生 )
New-AzApiManagementAuthorizationServer -AccessTokenSendingMethods AuthorizationHeader -AuthorizationEndpointUrl 'https://contoso/auth' -AuthorizationRequestMethods Get -ClientAuthenticationMethods Basic -ClientId 'clientid' -ClientRegistrationPageUrl 'https://contoso/signup' -ClientSecret '0000000000000000000000000000000000000' -Context <PsApiManagementContext> -GrantTypes AuthorizationCode -Name 'Contoso OAuth2 server' -ServerId '0123456789' -TokenBodyParameters @{'par1'='val1'} -TokenEndpointUrl 'https://contoso/token'
參數
-AccessTokenSendingMethods
指定要傳送存取令牌的方法陣列。 psdx_paramvalues AuthorizationHeader 和 Query。
類型: | PsApiManagementAccessTokenSendingMethod[] |
接受的值: | AuthorizationHeader, Query |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-AuthorizationEndpointUrl
指定要驗證資源擁有者的授權端點,並取得授權授與。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-AuthorizationRequestMethods
指定授權要求方法的陣列。 有效值為:GET、POST。 預設值為 GET。
類型: | PsApiManagementAuthorizationRequestMethod[] |
接受的值: | Get, Post, Head, Options, Trace, Put, Patch, Delete |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-ClientAuthenticationMethods
指定客戶端驗證方法的陣列。 psdx_paramvalues基本和主體。
類型: | PsApiManagementClientAuthenticationMethod[] |
接受的值: | Basic, Body |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-ClientId
指定用戶端應用程式之開發人員控制台的用戶端標識碼。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-ClientRegistrationPageUrl
指定客戶端註冊端點,以向授權伺服器註冊用戶端,並取得客戶端認證。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-ClientSecret
指定開發人員主控台的客戶端密碼,也就是用戶端應用程式。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Context
指定 PsApiManagementContext 物件。
類型: | PsApiManagementContext |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-DefaultProfile
用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶。
類型: | IAzureContextContainer |
別名: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-DefaultScope
指定授權伺服器的預設範圍。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Description
指定授權伺服器的描述。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-GrantTypes
指定授與類型的陣列。 psdx_paramvalues
- AuthorizationCode
- ClientCredentials
- 隱含
- ResourceOwnerPassword
類型: | PsApiManagementGrantType[] |
接受的值: | AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-Name
指定要建立的授權伺服器名稱。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-ResourceOwnerPassword
指定資源擁有者密碼。 如果 GrantTypes 參數指定 ResourceOwnerPassword,則必須指定此參數。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-ResourceOwnerUsername
指定資源擁有者用戶名稱。 如果 GrantTypes 參數指定 ResourceOwnerPassword,您必須指定此參數。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-ServerId
指定要建立的授權伺服器識別碼。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-SupportState
指出是否支援 State 參數。
類型: | Nullable<T>[Boolean] |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-TokenBodyParameters
使用 application/x-www-form-urlencoded 格式指定其他主體參數。
類型: | Hashtable |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-TokenEndpointUrl
指定客戶端用來取得存取令牌的令牌端點 URL,以換取呈現授權授與或重新整理令牌。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
輸入
PsApiManagementAuthorizationRequestMethod[]
PsApiManagementClientAuthenticationMethod[]
Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
PsApiManagementAccessTokenSendingMethod[]