User - Create Or Update

서비스:

API Management

API 버전:

2021-08-01

사용자를 만들거나 업데이트합니다.

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

선택적 매개 변수:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?notify={notify}&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의 파트를 형성합니다.
userId	path	True	string	사용자 식별자 현재 API Management 서비스 instance 고유해야 합니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다.
notify	query		boolean	사용자에게 Email 알림을 보냅니다.

요청 헤더

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

요청 본문

Name	필수	형식	Description
properties.email	True	string	메일 주소입니다. 비어 있지 않아야 하며 서비스 인스턴스 내에서 고유해야 합니다.
properties.firstName	True	string	이름입니다.
properties.lastName	True	string	성입니다.
properties.appType		AppType	사용자 만들기 요청을 보내는 애플리케이션의 유형을 결정합니다. 기본값은 레거시 포털입니다.
properties.confirmation		Confirmation	새로 만든 사용자에게 보낼 확인 전자 메일의 유형을 결정합니다.
properties.identities		UserIdentityContract[]	사용자 ID의 컬렉션입니다.
properties.note		string	사용자에 대해 관리자가 설정하는 선택적 참고입니다.
properties.password		string	사용자 암호입니다. 값이 제공되지 않으면 기본 암호가 생성됩니다.
properties.state		UserState	계정 상태. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독하는 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다.

응답

Name	형식	Description
200 OK	UserContract	사용자가 업데이트되었습니다. 헤더 ETag: string
201 Created	UserContract	사용자가 성공적으로 만들어졌습니다. 헤더 ETag: string
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	사용자 계정 가장

예제

ApiManagementCreateUser

샘플 요청

HTTP

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

{
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "confirmation": "signup"
  }
}

Java

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

/** Samples for User CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateUser.json
     */
    /**
     * Sample code: ApiManagementCreateUser.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateUser(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .users()
            .define("5931a75ae4bbd512288c680b")
            .withExistingService("rg1", "apimService1")
            .withEmail("foobar@outlook.com")
            .withFirstName("foo")
            .withLastName("bar")
            .withConfirmation(Confirmation.SIGNUP)
            .create();
    }
}

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

Python

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_create_user.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.user.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        user_id="5931a75ae4bbd512288c680b",
        parameters={
            "properties": {
                "confirmation": "signup",
                "email": "foobar@outlook.com",
                "firstName": "foo",
                "lastName": "bar",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateUser.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

Go

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/ApiManagementCreateUser.json
func ExampleUserClient_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.NewUserClient().CreateOrUpdate(ctx, "rg1", "apimService1", "5931a75ae4bbd512288c680b", armapimanagement.UserCreateParameters{
		Properties: &armapimanagement.UserCreateParameterProperties{
			Confirmation: to.Ptr(armapimanagement.ConfirmationSignup),
			Email:        to.Ptr("foobar@outlook.com"),
			FirstName:    to.Ptr("foo"),
			LastName:     to.Ptr("bar"),
		},
	}, &armapimanagement.UserClientCreateOrUpdateOptions{Notify: nil,
		IfMatch: 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.UserContract = armapimanagement.UserContract{
	// 	Name: to.Ptr("5931a75ae4bbd512288c680b"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/users"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b"),
	// 	Properties: &armapimanagement.UserContractProperties{
	// 		Identities: []*armapimanagement.UserIdentityContract{
	// 			{
	// 				ID: to.Ptr("foobar@outlook.com"),
	// 				Provider: to.Ptr("Basic"),
	// 		}},
	// 		State: to.Ptr(armapimanagement.UserStateActive),
	// 		Email: to.Ptr("foobar@outlook.com"),
	// 		FirstName: to.Ptr("foo"),
	// 		Groups: []*armapimanagement.GroupContractProperties{
	// 		},
	// 		LastName: to.Ptr("bar"),
	// 		RegistrationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-07T21:21:29.16Z"); return t}()),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Creates or Updates a user.
 *
 * @summary Creates or Updates a user.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateUser.json
 */
async function apiManagementCreateUser() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const userId = "5931a75ae4bbd512288c680b";
  const parameters = {
    confirmation: "signup",
    email: "foobar@outlook.com",
    firstName: "foo",
    lastName: "bar",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.user.createOrUpdate(
    resourceGroupName,
    serviceName,
    userId,
    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

dotnet

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/ApiManagementCreateUser.json
// this example is just showing the usage of "User_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 ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementUserResource
ApiManagementUserCollection collection = apiManagementService.GetApiManagementUsers();

// invoke the operation
string userId = "5931a75ae4bbd512288c680b";
ApiManagementUserCreateOrUpdateContent content = new ApiManagementUserCreateOrUpdateContent()
{
    Email = "foobar@outlook.com",
    FirstName = "foo",
    LastName = "bar",
    Confirmation = ConfirmationEmailType.SignUp,
};
ArmOperation<ApiManagementUserResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, userId, content);
ApiManagementUserResource 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
UserContractData 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

샘플 응답

상태 코드:

201

{
  "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b",
  "type": "Microsoft.ApiManagement/service/users",
  "name": "5931a75ae4bbd512288c680b",
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "state": "active",
    "registrationDate": "2018-01-07T21:21:29.16Z",
    "groups": [],
    "identities": [
      {
        "provider": "Basic",
        "id": "foobar@outlook.com"
      }
    ]
  }
}

상태 코드:

200

{
  "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b",
  "type": "Microsoft.ApiManagement/service/users",
  "name": "5931a75ae4bbd512288c680b",
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "state": "active",
    "registrationDate": "2018-01-07T21:21:29.16Z",
    "groups": [],
    "identities": [
      {
        "provider": "Basic",
        "id": "foobar@outlook.com"
      }
    ]
  }
}

정의

Name	Description
AppType	사용자 만들기 요청을 보내는 애플리케이션의 유형을 결정합니다. 기본값은 레거시 포털입니다.
Confirmation	새로 만든 사용자에게 보낼 확인 전자 메일의 유형을 결정합니다.
ErrorFieldContract	오류 필드 계약.
ErrorResponse	오류 응답.
GroupContractProperties	그룹 계약 속성입니다.
GroupType	그룹 유형.
UserContract	사용자 세부 정보.
UserCreateParameters	사용자가 세부 정보를 만듭니다.
UserIdentityContract	사용자 ID 세부 정보입니다.
UserState	계정 상태. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독하는 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다.

AppType

사용자 만들기 요청을 보내는 애플리케이션의 유형을 결정합니다. 기본값은 레거시 포털입니다.

Name	형식	Description
developerPortal	string	사용자 만들기 요청이 새 개발자 포털에서 전송되었습니다.
portal	string	레거시 개발자 포털에서 사용자 만들기 요청을 보냈습니다.

Confirmation

새로 만든 사용자에게 보낼 확인 전자 메일의 유형을 결정합니다.

Name	형식	Description
invite	string	등록하고 등록을 완료하도록 사용자를 초대하는 전자 메일을 보냅니다.
signup	string	성공적으로 등록되었는지 확인하는 전자 메일을 사용자에게 보냅니다.

ErrorFieldContract

오류 필드 계약.

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

ErrorResponse

오류 응답.

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

GroupContractProperties

그룹 계약 속성입니다.

Name	형식	Description
builtIn	boolean	그룹이 세 가지 시스템 그룹(관리자, 개발자 또는 게스트) 중 하나인 경우 true입니다. 그렇지 않으면 false입니다.
description	string	그룹 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다.
displayName	string	그룹 이름입니다.
externalId	string	외부 그룹의 경우 이 속성은 외부 ID 공급자의 그룹 ID를 포함합니다(예: Azure Active Directory의 aad://<tenant>.onmicrosoft.com/groups/<group object id>경우). 그렇지 않으면 값이 null입니다.
type	GroupType	그룹 유형.

GroupType

그룹 유형.

Name	형식	Description
custom	string
external	string
system	string

UserContract

사용자 세부 정보.

Name	형식	Default value	Description
id	string		리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		리소스의 이름입니다.
properties.email	string		메일 주소입니다.
properties.firstName	string		이름입니다.
properties.groups	GroupContractProperties[]		사용자가 속한 그룹 컬렉션입니다.
properties.identities	UserIdentityContract[]		사용자 ID의 컬렉션입니다.
properties.lastName	string		성입니다.
properties.note	string		사용자에 대해 관리자가 설정하는 선택적 참고입니다.
properties.registrationDate	string		사용자 등록 날짜입니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
properties.state	UserState	active	계정 상태. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독하는 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다.
type	string		리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

UserCreateParameters

사용자가 세부 정보를 만듭니다.

Name	형식	Default value	Description
properties.appType	AppType		사용자 만들기 요청을 보내는 애플리케이션의 유형을 결정합니다. 기본값은 레거시 포털입니다.
properties.confirmation	Confirmation		새로 만든 사용자에게 보낼 확인 전자 메일의 유형을 결정합니다.
properties.email	string		메일 주소입니다. 비어 있지 않아야 하며 서비스 인스턴스 내에서 고유해야 합니다.
properties.firstName	string		이름입니다.
properties.identities	UserIdentityContract[]		사용자 ID의 컬렉션입니다.
properties.lastName	string		성입니다.
properties.note	string		사용자에 대해 관리자가 설정하는 선택적 참고입니다.
properties.password	string		사용자 암호입니다. 값이 제공되지 않으면 기본 암호가 생성됩니다.
properties.state	UserState	active	계정 상태. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독하는 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다.

UserIdentityContract

사용자 ID 세부 정보입니다.

Name	형식	Description
id	string	공급자 내의 식별자 값입니다.
provider	string	ID 공급자 이름입니다.

UserState

계정 상태. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독하는 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다.

Name	형식	Description
active	string	사용자 상태가 활성 상태입니다.
blocked	string	사용자가 차단됩니다. 차단된 사용자는 개발자 포털에서 인증하거나 API를 호출할 수 없습니다.
deleted	string	사용자 계정이 닫혔습니다. 모든 ID 및 관련 엔터티가 제거됩니다.
pending	string	사용자 계정이 보류 중입니다. ID를 활성화하려면 ID 확인이 필요합니다.