Delegation Settings - Create Or Update

참조

서비스:: API Management

API 버전:: 2021-08-01

위임 설정을 만들거나 업데이트합니다.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/delegation?api-version=2021-08-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	리소스 그룹의 이름.
serviceName	path	True	string	API Management 서비스의 이름입니다. regex 패턴: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다.

요청 헤더

Name	필수	형식	Description
If-Match		string	엔터티의 ETag입니다. 엔터티를 만들 때는 필요하지 않지만 엔터티를 업데이트할 때 필요합니다.

요청 본문

Name	형식	Description
properties.subscriptions	SubscriptionsDelegationSettingsProperties	구독 위임 설정.
properties.url	string	위임 URL입니다.
properties.userRegistration	RegistrationDelegationSettingsProperties	사용자 등록 위임 설정.
properties.validationKey	string	Azure API Management 요청이 들어오는지 유효성을 검사하기 위한 base64로 인코딩된 유효성 검사 키입니다.

응답

Name	형식	Description
200 OK	PortalDelegationSettings	위임 설정이 업데이트되었습니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementPortalSettingsUpdateDelegation

샘플 요청

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation?api-version=2021-08-01


{
  "properties": {
    "url": "http://contoso.com/delegation",
    "validationKey": "<validationKey>",
    "subscriptions": {
      "enabled": true
    },
    "userRegistration": {
      "enabled": true
    }
  }
}

import com.azure.core.util.Context;
import com.azure.resourcemanager.apimanagement.fluent.models.PortalDelegationSettingsInner;
import com.azure.resourcemanager.apimanagement.models.RegistrationDelegationSettingsProperties;
import com.azure.resourcemanager.apimanagement.models.SubscriptionsDelegationSettingsProperties;

/** Samples for DelegationSettings CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementPortalSettingsPutDelegation.json
     */
    /**
     * Sample code: ApiManagementPortalSettingsUpdateDelegation.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementPortalSettingsUpdateDelegation(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .delegationSettings()
            .createOrUpdateWithResponse(
                "rg1",
                "apimService1",
                new PortalDelegationSettingsInner()
                    .withUrl("http://contoso.com/delegation")
                    .withValidationKey("<validationKey>")
                    .withSubscriptions(new SubscriptionsDelegationSettingsProperties().withEnabled(true))
                    .withUserRegistration(new RegistrationDelegationSettingsProperties().withEnabled(true)),
                "*",
                Context.NONE);
    }
}

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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementPortalSettingsPutDelegation.json
func ExampleDelegationSettingsClient_CreateOrUpdate() {
	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.NewDelegationSettingsClient().CreateOrUpdate(ctx, "rg1", "apimService1", armapimanagement.PortalDelegationSettings{
		Properties: &armapimanagement.PortalDelegationSettingsProperties{
			Subscriptions: &armapimanagement.SubscriptionsDelegationSettingsProperties{
				Enabled: to.Ptr(true),
			},
			URL: to.Ptr("http://contoso.com/delegation"),
			UserRegistration: &armapimanagement.RegistrationDelegationSettingsProperties{
				Enabled: to.Ptr(true),
			},
			ValidationKey: to.Ptr("<validationKey>"),
		},
	}, &armapimanagement.DelegationSettingsClientCreateOrUpdateOptions{IfMatch: to.Ptr("*")})
	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.PortalDelegationSettings = armapimanagement.PortalDelegationSettings{
	// 	Name: to.Ptr("delegation"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/portalsettings"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation"),
	// 	Properties: &armapimanagement.PortalDelegationSettingsProperties{
	// 		Subscriptions: &armapimanagement.SubscriptionsDelegationSettingsProperties{
	// 			Enabled: to.Ptr(true),
	// 		},
	// 		URL: to.Ptr("http://contoso.com/delegation"),
	// 		UserRegistration: &armapimanagement.RegistrationDelegationSettingsProperties{
	// 			Enabled: to.Ptr(true),
	// 		},
	// 	},
	// }
}

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 Create or Update Delegation settings.
 *
 * @summary Create or Update Delegation settings.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementPortalSettingsPutDelegation.json
 */
async function apiManagementPortalSettingsUpdateDelegation() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const ifMatch = "*";
  const parameters = {
    subscriptions: { enabled: true },
    url: "http://contoso.com/delegation",
    userRegistration: { enabled: true },
    validationKey: "<validationKey>",
  };
  const options = { ifMatch };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.delegationSettings.createOrUpdate(
    resourceGroupName,
    serviceName,
    parameters,
    options
  );
  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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementPortalSettingsPutDelegation.json
// this example is just showing the usage of "DelegationSettings_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementPortalDelegationSettingResource created on azure
// for more information of creating ApiManagementPortalDelegationSettingResource, please refer to the document of ApiManagementPortalDelegationSettingResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementPortalDelegationSettingResourceId = ApiManagementPortalDelegationSettingResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementPortalDelegationSettingResource apiManagementPortalDelegationSetting = client.GetApiManagementPortalDelegationSettingResource(apiManagementPortalDelegationSettingResourceId);

// invoke the operation
ApiManagementPortalDelegationSettingData data = new ApiManagementPortalDelegationSettingData()
{
    Uri = new Uri("http://contoso.com/delegation"),
    ValidationKey = "<validationKey>",
    IsSubscriptionDelegationEnabled = true,
    IsUserRegistrationDelegationEnabled = true,
};
ETag? ifMatch = new ETag("*");
ArmOperation<ApiManagementPortalDelegationSettingResource> lro = await apiManagementPortalDelegationSetting.CreateOrUpdateAsync(WaitUntil.Completed, data, ifMatch: ifMatch);
ApiManagementPortalDelegationSettingResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementPortalDelegationSettingData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

샘플 응답

상태 코드:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation",
  "type": "Microsoft.ApiManagement/service/portalsettings",
  "name": "delegation",
  "properties": {
    "url": "http://contoso.com/delegation",
    "subscriptions": {
      "enabled": true
    },
    "userRegistration": {
      "enabled": true
    }
  }
}

정의

Name	Description
ErrorFieldContract	오류 필드 계약.
ErrorResponse	오류 응답.
PortalDelegationSettings	개발자 포털에 대한 위임 설정입니다.
RegistrationDelegationSettingsProperties	사용자 등록 위임 설정 속성입니다.
SubscriptionsDelegationSettingsProperties	구독 위임 설정 속성입니다.

ErrorFieldContract

오류 필드 계약.

Name	형식	Description
code	string	속성 수준 오류 코드입니다.
message	string	사람이 읽을 수 있는 속성 수준 오류 표현입니다.
target	string	속성 이름입니다.

ErrorResponse

오류 응답.

Name	형식	Description
error.code	string	서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.
error.details	ErrorFieldContract[]	유효성 검사 오류가 발생한 경우 요청에 잘못된 필드가 전송됩니다.
error.message	string	사람이 읽을 수 있는 오류 표현입니다.

PortalDelegationSettings

개발자 포털에 대한 위임 설정입니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름입니다.
properties.subscriptions	SubscriptionsDelegationSettingsProperties	구독 위임 설정.
properties.url	string	위임 URL입니다.
properties.userRegistration	RegistrationDelegationSettingsProperties	사용자 등록 위임 설정.
properties.validationKey	string	Azure API Management 요청이 들어오는지 유효성을 검사하기 위한 base64로 인코딩된 유효성 검사 키입니다.
type	string	리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

RegistrationDelegationSettingsProperties

사용자 등록 위임 설정 속성입니다.

Name	형식	Description
enabled	boolean	사용자 등록에 대한 위임을 사용하거나 사용하지 않도록 설정합니다.

SubscriptionsDelegationSettingsProperties

구독 위임 설정 속성입니다.

Name	형식	Description
enabled	boolean	구독에 대한 위임을 사용하거나 사용하지 않도록 설정합니다.

다음을 통해 공유

Delegation Settings - Create Or Update

URI 매개 변수

요청 헤더

요청 본문

응답

보안

azure_auth

범위

예제

ApiManagementPortalSettingsUpdateDelegation

샘플 요청

샘플 응답

정의

ErrorFieldContract

ErrorResponse

PortalDelegationSettings

RegistrationDelegationSettingsProperties

SubscriptionsDelegationSettingsProperties

추가 리소스