次の方法で共有

Set-AzApiManagementAuthorizationServer

  • リファレンス
モジュール:
Az.ApiManagement

承認サーバーを変更します。

構文

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します。

型:PsApiManagementAccessTokenSendingMethod[]
指定可能な値:AuthorizationHeader, Query
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-AuthorizationEndpointUrl

リソース所有者を認証し、承認許可を取得する承認エンドポイントを指定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-AuthorizationRequestMethods

承認要求メソッドの配列を指定します。 GET と POST をpsdx_paramvaluesします。 既定値は GET です。

型:PsApiManagementAuthorizationRequestMethod[]
指定可能な値:Get, Post, Head, Options, Trace, Put, Patch, Delete
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ClientAuthenticationMethods

クライアント認証方法の配列を指定します。 psdx_paramvalues基本と本文。

型:PsApiManagementClientAuthenticationMethod[]
指定可能な値:Basic, Body
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ClientId

クライアント アプリケーションである開発者コンソールのクライアント ID を指定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ClientRegistrationPageUrl

クライアントを承認サーバーに登録し、クライアント資格情報を取得するクライアント登録エンドポイントを指定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ClientSecret

クライアント アプリケーションである開発者コンソールのクライアント シークレットを指定します。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Context

PsApiManagementContext オブジェクト を指定します。

型:PsApiManagementContext
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

型:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DefaultScope

承認サーバーの既定のスコープを指定します。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Description

承認サーバーの説明を指定します。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-GrantTypes

許可の種類の配列を指定します。 psdx_paramvalues

  • AuthorizationCode
  • ClientCredentials
  • 暗黙の
  • ResourceOwnerPassword
型:PsApiManagementGrantType[]
指定可能な値:AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Name

変更する承認サーバーの名前を指定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-PassThru

passthru

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ResourceOwnerPassword

リソース所有者のパスワードを指定します。 GrantTypes パラメーターで ResourceOwnerPassword が指定されている場合は、このパラメーターを指定する必要があります。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ResourceOwnerUsername

リソース所有者のユーザー名を指定します。 GrantTypes パラメーターで ResourceOwnerPassword が指定されている場合は、このパラメーターを指定する必要があります。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ServerId

変更する承認サーバーの ID を指定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-SupportState

State パラメーターをサポートするかどうかを示します。

型:Nullable<T>[Boolean]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-TokenBodyParameters

application/x-www-form-urlencoded 形式を使用して、追加の本文パラメーターを指定します。

型:Hashtable
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-TokenEndpointUrl

承認許可または更新トークンの提示と引き換えに、クライアントがアクセス トークンを取得するためのトークン エンドポイントを指定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

入力

PsApiManagementContext

String

PsApiManagementAuthorizationRequestMethod[]

PsApiManagementGrantType[]

PsApiManagementClientAuthenticationMethod[]

Hashtable

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

PsApiManagementAccessTokenSendingMethod[]

SwitchParameter

出力

PsApiManagementOAuth2AuthorizationServer