User - Create Or Update

Служба:

API Management

Версия API:

2022-08-01

Создает или обновляет пользователя.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
serviceName	path	True	string	Имя службы Управление API. Шаблон регулярного выражения: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Идентификатор целевой подписки.
userId	path	True	string	Идентификатор пользователя. Должен быть уникальным в текущем экземпляре службы Управление API.
api-version	query	True	string	Версия API, используемая для данной операции.
notify	query		boolean	Отправьте пользователю уведомление о Email.

Заголовок запроса

Имя	Обязательно	Тип	Описание
If-Match		string	ETag сущности. Не требуется при создании сущности, но требуется при обновлении сущности.

Текст запроса

Имя	Обязательно	Тип	Описание
properties.email	True	string	Электронная почта. Не может быть пустым и должно быть уникальным в пределах экземпляра службы.
properties.firstName	True	string	Имя.
properties.lastName	True	string	Фамилия.
properties.appType		AppType	Определяет тип приложения, отправляющего запрос пользователя на создание. По умолчанию используется устаревший портал.
properties.confirmation		Confirmation	Определяет тип сообщения электронной почты с подтверждением, которое будет отправлено только что созданному пользователю.
properties.identities		UserIdentityContract[]	Коллекция удостоверений пользователей.
properties.note		string	Дополнительное примечание о пользователе, заданном администратором.
properties.password		string	Пароль пользователя. Если значение не указано, создается пароль по умолчанию.
properties.state		UserState	Состояние учетной записи. Указывает, активен пользователь или нет. Заблокированные пользователи не могут войти на портал разработчиков или вызвать API продуктов с подпиской. Состояние по умолчанию — Активно.

Ответы

Имя	Тип	Описание
200 OK	UserContract	Пользователь успешно обновлен. Заголовки ETag: string
201 Created	UserContract	Пользователь успешно создан. Заголовки ETag: string
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ApiManagementCreateUser

Образец запроса

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2022-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/2022-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 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_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/2022-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/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/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.160Z"); 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/2022-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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-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"
      }
    ]
  }
}

Определения

Имя	Описание
AppType	Определяет тип приложения, отправляющего запрос пользователя на создание. По умолчанию используется устаревший портал.
Confirmation	Определяет тип сообщения электронной почты с подтверждением, которое будет отправлено только что созданному пользователю.
ErrorFieldContract	Контракт поля ошибки.
ErrorResponse	Ответ об ошибке.
GroupContractProperties	Свойства контракта группы.
GroupType	Тип группы.
UserContract	Сведения о пользователе.
UserCreateParameters	Сведения о создании пользователя.
UserIdentityContract	Сведения об удостоверении пользователя.
UserState	Состояние учетной записи. Указывает, активен пользователь или нет. Заблокированные пользователи не могут войти на портал разработчиков или вызвать API продуктов с подпиской. Состояние по умолчанию — Активно.

AppType

Определяет тип приложения, отправляющего запрос пользователя на создание. По умолчанию используется устаревший портал.

Имя	Тип	Описание
developerPortal	string	Запрос на создание пользователя был отправлен новым порталом разработчика.
portal	string	Запрос на создание пользователя был отправлен устаревшим порталом разработчика.

Confirmation

Определяет тип сообщения электронной почты с подтверждением, которое будет отправлено только что созданному пользователю.

Имя	Тип	Описание
invite	string	Отправьте сообщение электронной почты с приглашением пользователя зарегистрироваться и завершить регистрацию.
signup	string	Отправьте пользователю сообщение электронной почты с подтверждением успешной регистрации.

ErrorFieldContract

Контракт поля ошибки.

Имя	Тип	Описание
code	string	Код ошибки уровня свойства.
message	string	Удобочитаемое представление ошибки на уровне свойств.
target	string	Имя свойства.

ErrorResponse

Ответ об ошибке.

Имя	Тип	Описание
error.code	string	Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе.
error.details	ErrorFieldContract[]	Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки.
error.message	string	Читаемое представление ошибки.

GroupContractProperties

Свойства контракта группы.

Имя	Тип	Описание
builtIn	boolean	Значение true, если группа является одной из трех системных групп (администраторы, разработчики или гости); в противном случае — false.
description	string	Описание группы. Может содержать теги форматирования HTML.
displayName	string	Имя группы.
externalId	string	Для внешних групп это свойство содержит идентификатор группы от внешнего поставщика удостоверений, например для Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; в противном случае значение равно NULL.
type	GroupType	Тип группы.

GroupType

Тип группы.

Имя	Тип	Описание
custom	string
external	string
system	string

UserContract

Сведения о пользователе.

Имя	Тип	Default value	Описание
id	string		Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Имя ресурса.
properties.email	string		Электронная почта.
properties.firstName	string		Имя.
properties.groups	GroupContractProperties[]		Коллекция групп пользователей является частью.
properties.identities	UserIdentityContract[]		Коллекция удостоверений пользователей.
properties.lastName	string		Фамилия.
properties.note	string		Дополнительное примечание о пользователе, заданном администратором.
properties.registrationDate	string		Дата регистрации пользователя. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601.
properties.state	UserState	active	Состояние учетной записи. Указывает, активен пользователь или нет. Заблокированные пользователи не могут войти на портал разработчиков или вызвать API продуктов с подпиской. Состояние по умолчанию — Активно.
type	string		Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

UserCreateParameters

Сведения о создании пользователя.

Имя	Тип	Default value	Описание
properties.appType	AppType		Определяет тип приложения, отправляющего запрос пользователя на создание. По умолчанию используется устаревший портал.
properties.confirmation	Confirmation		Определяет тип сообщения электронной почты с подтверждением, которое будет отправлено только что созданному пользователю.
properties.email	string		Электронная почта. Не может быть пустым и должно быть уникальным в пределах экземпляра службы.
properties.firstName	string		Имя.
properties.identities	UserIdentityContract[]		Коллекция удостоверений пользователей.
properties.lastName	string		Фамилия.
properties.note	string		Дополнительное примечание о пользователе, заданном администратором.
properties.password	string		Пароль пользователя. Если значение не указано, создается пароль по умолчанию.
properties.state	UserState	active	Состояние учетной записи. Указывает, активен пользователь или нет. Заблокированные пользователи не могут войти на портал разработчиков или вызвать API продуктов с подпиской. Состояние по умолчанию — Активно.

UserIdentityContract

Сведения об удостоверении пользователя.

Имя	Тип	Описание
id	string	Значение идентификатора в поставщике.
provider	string	Имя поставщика удостоверений.

UserState

Состояние учетной записи. Указывает, активен пользователь или нет. Заблокированные пользователи не могут войти на портал разработчиков или вызвать API продуктов с подпиской. Состояние по умолчанию — Активно.

Имя	Тип	Описание
active	string	Состояние пользователя активно.
blocked	string	Пользователь заблокирован. Заблокированные пользователи не могут пройти проверку подлинности на портале разработчика или вызвать API.
deleted	string	Учетная запись пользователя закрыта. Все удостоверения и связанные сущности удаляются.
pending	string	Учетная запись пользователя находится в состоянии ожидания. Прежде чем сделать его активным, требуется подтверждение удостоверения.