Authorization Server - Update

リファレンス

Service:: API Management

API Version:: 2022-08-01

id で指定された承認サーバーの詳細を更新します。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}?api-version=2022-08-01

URI パラメーター

名前	/	必須	型	説明
authsid	path	True	string	承認サーバーの識別子。 Regex pattern: `^[^*#&+:<>?]+$`
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
serviceName	path	True	string	API Management サービスの名前。 Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
If-Match	True	string	エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。

要求本文

名前	型	説明
properties.authorizationEndpoint	string	OAuth 承認エンドポイント。「http://tools.ietf.org/html/rfc6749#section-3.2」を参照してください。
properties.authorizationMethods	AuthorizationMethod[]	承認エンドポイントによってサポートされる HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	アクセストークンを API に渡すメカニズムを指定します。
properties.clientAuthenticationMethod	ClientAuthenticationMethod[]	この承認サーバーのトークンエンドポイントによってサポートされる認証の方法。使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターがアプリケーション/x-www-form-urlencoded 形式で要求本文内で渡されます。
properties.clientId	string	この承認サーバーに登録されているクライアント ID またはアプリ ID。
properties.clientRegistrationEndpoint	string	この承認サーバーに対するクライアントまたはアプリの登録が実行されるページへの参照 (オプション)。参照するエンティティの絶対 URL が含まれます。
properties.clientSecret	string	この承認サーバーに登録されているクライアントシークレットまたはアプリシークレット。このプロパティは、'GET' 操作では入力されません。値を取得するには、'/listSecrets' POST 要求を使用します。
properties.defaultScope	string	既定で要求されるアクセストークンスコープ。 API レベルでオーバーライドできます。スペース区切り値を含む文字列の形式で提供される必要があります。
properties.description	string	承認サーバーの説明。 HTML 書式設定タグを含めることができます。
properties.displayName	string	ユーザーフレンドリな承認サーバー名。
properties.grantTypes	GrantType[]	クライアントがアクセストークンの要求に使用する承認許可の形式。
properties.resourceOwnerPassword	string	リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。既定のリソース所有者のパスワードです。
properties.resourceOwnerUsername	string	リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。既定のリソース所有者のユーザー名。
properties.supportState	boolean	true の場合、承認サーバーには、承認要求から応答への state パラメーターが含まれます。クライアントは状態パラメーターを使用して、プロトコルのセキュリティを高めることができます。
properties.tokenBodyParameters	TokenBodyParameterContract[]	名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークンエンドポイントに必要な追加パラメーター ({"name" : "name value","value": "a value"} など)。
properties.tokenEndpoint	string	OAuth トークンエンドポイント。参照するエンティティの絶対 URI が含まれます。
properties.useInApiDocumentation	boolean	true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。値が指定されていない場合、既定では False です。
properties.useInTestConsole	boolean	true の場合、承認サーバーは開発者ポータルのテストコンソールで使用できます。値が指定されていない場合は、既定で True を指定します。

応答

名前	型	説明
200 OK	AuthorizationServerContract	承認サーバーの設定が正常に更新されました。 Headers ETag: string
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

AuthorizationServerContract

承認サーバーの設定が正常に更新されました。

Headers

ETag: string

Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

ApiManagementUpdateAuthorizationServer

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer?api-version=2022-08-01


{
  "properties": {
    "clientId": "update",
    "clientSecret": "updated",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

import com.azure.resourcemanager.apimanagement.models.AuthorizationServerContract;

/** Samples for AuthorizationServer Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateAuthorizationServer.json
     */
    /**
     * Sample code: ApiManagementUpdateAuthorizationServer.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateAuthorizationServer(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        AuthorizationServerContract resource =
            manager
                .authorizationServers()
                .getWithResponse("rg1", "apimService1", "newauthServer", com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withUseInTestConsole(false)
            .withUseInApiDocumentation(true)
            .withClientId("update")
            .withClientSecret("updated")
            .withIfMatch("*")
            .apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_update_authorization_server.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.authorization_server.update(
        resource_group_name="rg1",
        service_name="apimService1",
        authsid="newauthServer",
        if_match="*",
        parameters={
            "properties": {
                "clientId": "update",
                "clientSecret": "updated",
                "useInApiDocumentation": True,
                "useInTestConsole": False,
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateAuthorizationServer.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateAuthorizationServer.json
func ExampleAuthorizationServerClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAuthorizationServerClient().Update(ctx, "rg1", "apimService1", "newauthServer", "*", armapimanagement.AuthorizationServerUpdateContract{
		Properties: &armapimanagement.AuthorizationServerUpdateContractProperties{
			ClientID:              to.Ptr("update"),
			ClientSecret:          to.Ptr("updated"),
			UseInAPIDocumentation: to.Ptr(true),
			UseInTestConsole:      to.Ptr(false),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AuthorizationServerContract = armapimanagement.AuthorizationServerContract{
	// 	Name: to.Ptr("newauthServer"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/authorizationServers"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer"),
	// 	Properties: &armapimanagement.AuthorizationServerContractProperties{
	// 		Description: to.Ptr("test server"),
	// 		AuthorizationMethods: []*armapimanagement.AuthorizationMethod{
	// 			to.Ptr(armapimanagement.AuthorizationMethodGET)},
	// 			BearerTokenSendingMethods: []*armapimanagement.BearerTokenSendingMethod{
	// 				to.Ptr(armapimanagement.BearerTokenSendingMethodAuthorizationHeader)},
	// 				ClientAuthenticationMethod: []*armapimanagement.ClientAuthenticationMethod{
	// 					to.Ptr(armapimanagement.ClientAuthenticationMethodBasic)},
	// 					DefaultScope: to.Ptr("read write"),
	// 					ResourceOwnerPassword: to.Ptr("pwd"),
	// 					ResourceOwnerUsername: to.Ptr("un"),
	// 					SupportState: to.Ptr(true),
	// 					TokenEndpoint: to.Ptr("https://www.contoso.com/oauth2/token"),
	// 					AuthorizationEndpoint: to.Ptr("https://www.contoso.com/oauth2/auth"),
	// 					ClientID: to.Ptr("updated"),
	// 					ClientRegistrationEndpoint: to.Ptr("https://www.contoso.com/apps"),
	// 					DisplayName: to.Ptr("test3"),
	// 					GrantTypes: []*armapimanagement.GrantType{
	// 						to.Ptr(armapimanagement.GrantTypeAuthorizationCode),
	// 						to.Ptr(armapimanagement.GrantTypeImplicit)},
	// 						UseInAPIDocumentation: to.Ptr(true),
	// 						UseInTestConsole: to.Ptr(false),
	// 					},
	// 				}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates the details of the authorization server specified by its identifier.
 *
 * @summary Updates the details of the authorization server specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateAuthorizationServer.json
 */
async function apiManagementUpdateAuthorizationServer() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const authsid = "newauthServer";
  const ifMatch = "*";
  const parameters = {
    clientId: "update",
    clientSecret: "updated",
    useInApiDocumentation: true,
    useInTestConsole: false,
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.authorizationServer.update(
    resourceGroupName,
    serviceName,
    authsid,
    ifMatch,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test3",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "clientAuthenticationMethod": [
      "Basic"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "updated",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

定義

名前	説明
AuthorizationMethod	承認エンドポイントによってサポートされる HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。
AuthorizationServerContract	外部 OAuth 承認サーバーの設定。
AuthorizationServerUpdateContract	外部 OAuth 承認サーバーの設定。
BearerTokenSendingMethod	アクセストークンを API に渡すメカニズムを指定します。
ClientAuthenticationMethod	この承認サーバーのトークンエンドポイントによってサポートされる認証の方法。使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターがアプリケーション/x-www-form-urlencoded 形式で要求本文内で渡されます。
ErrorFieldContract	エラーフィールドコントラクト。
ErrorResponse	エラー応答。
GrantType	クライアントがアクセストークンの要求に使用する承認許可の形式。
TokenBodyParameterContract	OAuth 取得トークン要求本文パラメーター (www-url-form-encoded)。

AuthorizationMethod

承認エンドポイントによってサポートされる HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。

名前	型	説明
DELETE	string
GET	string
HEAD	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

AuthorizationServerContract

外部 OAuth 承認サーバーの設定。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.authorizationEndpoint	string	OAuth 承認エンドポイント。「http://tools.ietf.org/html/rfc6749#section-3.2」を参照してください。
properties.authorizationMethods	AuthorizationMethod[]	承認エンドポイントによってサポートされる HTTP 動詞。 GET は常に存在する必要があります。 POST は省略可能です。
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	アクセストークンを API に渡すメカニズムを指定します。
properties.clientAuthenticationMethod	ClientAuthenticationMethod[]	この承認サーバーのトークンエンドポイントによってサポートされる認証の方法。使用できる値は Basic または Body です。 Body を指定すると、クライアント資格情報とその他のパラメーターがアプリケーション/x-www-form-urlencoded 形式で要求本文内で渡されます。
properties.clientId	string	この承認サーバーに登録されているクライアント ID またはアプリ ID。
properties.clientRegistrationEndpoint	string	この承認サーバーに対するクライアントまたはアプリの登録が実行されるページへの参照 (オプション)。参照するエンティティの絶対 URL が含まれます。
properties.clientSecret	string	この承認サーバーに登録されているクライアントシークレットまたはアプリシークレット。このプロパティは、'GET' 操作では入力されません。値を取得するには、'/listSecrets' POST 要求を使用します。
properties.defaultScope	string	既定で要求されるアクセストークンスコープ。 API レベルでオーバーライドできます。スペース区切り値を含む文字列の形式で提供される必要があります。
properties.description	string	承認サーバーの説明。 HTML 書式設定タグを含めることができます。
properties.displayName	string	ユーザーフレンドリな承認サーバー名。
properties.grantTypes	GrantType[]	クライアントがアクセストークンの要求に使用する承認許可の形式。
properties.resourceOwnerPassword	string	リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。既定のリソース所有者のパスワードです。
properties.resourceOwnerUsername	string	リソース所有者のパスワード許可タイプがこの承認サーバーでサポートされている場合、オプションとして指定できます。既定のリソース所有者のユーザー名。
properties.supportState	boolean	true の場合、承認サーバーには、承認要求から応答への state パラメーターが含まれます。クライアントは状態パラメーターを使用して、プロトコルのセキュリティを高めることができます。
properties.tokenBodyParameters	TokenBodyParameterContract[]	名前と値の文字列プロパティを持つ JSON オブジェクトの配列として表される、この承認サーバーのトークンエンドポイントに必要な追加パラメーター ({"name" : "name value","value": "a value"} など)。
properties.tokenEndpoint	string	OAuth トークンエンドポイント。参照するエンティティの絶対 URI が含まれます。
properties.useInApiDocumentation	boolean	true の場合、承認サーバーは開発者ポータルの API ドキュメントで使用されます。値が指定されていない場合、既定では False です。
properties.useInTestConsole	boolean	true の場合、承認サーバーは開発者ポータルのテストコンソールで使用できます。値が指定されていない場合は、既定で True を指定します。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"