Set-AzApiManagementAuthorizationServer
承認サーバーを変更します。
構文
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>] 説明
Set-AzApiManagementAuthorizationServer コマンドレットは、Azure API Management 承認サーバーの詳細を変更します。
例
例 1: 承認サーバーを変更する
$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')このコマンドは、指定された API Management 承認サーバーを変更します。
例 2
承認サーバーを変更します。 (自動生成)
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'パラメーター
-AccessTokenSendingMethods
アクセス トークンを送信するメソッドの配列を指定します。 AuthorizationHeader と Query をpsdx_paramvaluesします。
| Type: | PsApiManagementAccessTokenSendingMethod[] |
| Accepted values: | AuthorizationHeader, Query |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AuthorizationEndpointUrl
リソース所有者を認証し、承認許可を取得する承認エンドポイントを指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AuthorizationRequestMethods
承認要求メソッドの配列を指定します。 GET と POST をpsdx_paramvaluesします。 既定値は GET です。
| Type: | PsApiManagementAuthorizationRequestMethod[] |
| Accepted values: | Get, Post, Head, Options, Trace, Put, Patch, Delete |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ClientAuthenticationMethods
クライアント認証方法の配列を指定します。 psdx_paramvalues基本と本文。
| Type: | PsApiManagementClientAuthenticationMethod[] |
| Accepted values: | Basic, Body |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ClientId
クライアント アプリケーションである開発者コンソールのクライアント ID を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ClientRegistrationPageUrl
クライアントを承認サーバーに登録し、クライアント資格情報を取得するクライアント登録エンドポイントを指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ClientSecret
クライアント アプリケーションである開発者コンソールのクライアント シークレットを指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Context
PsApiManagementContext オブジェクトを指定します。
| Type: | PsApiManagementContext |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultScope
承認サーバーの既定のスコープを指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Description
承認サーバーの説明を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-GrantTypes
許可の種類の配列を指定します。 psdx_paramvalues
- AuthorizationCode
- ClientCredentials
- 暗黙
- ResourceOwnerPassword
| Type: | PsApiManagementGrantType[] |
| Accepted values: | AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
変更する承認サーバーの名前を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
Passthru
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceOwnerPassword
リソース所有者のパスワードを指定します。 ResourceOwnerPassword が GrantTypes パラメーターで指定されている場合は、このパラメーターを 指定する 必要があります。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceOwnerUsername
リソース所有者のユーザー名を指定します。 ResourceOwnerPassword が GrantTypes パラメーターで指定されている場合は、このパラメーターを 指定する 必要があります。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ServerId
変更する承認サーバーの ID を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SupportState
State パラメーターをサポートするかどうかを示します。
| Type: | Nullable<T>[Boolean] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TokenBodyParameters
application/x-www-form-urlencoded 形式を使用して、追加の本文パラメーターを指定します。
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TokenEndpointUrl
承認許可または更新トークンの提示と引き換えに、クライアントがアクセス トークンを取得するためのトークン エンドポイントを指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
入力
PsApiManagementAuthorizationRequestMethod[]
PsApiManagementClientAuthenticationMethod[]
Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
PsApiManagementAccessTokenSendingMethod[]
出力
PsApiManagementOAuth2AuthorizationServer
関連リンク
Azure PowerShell
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示