User - Update

Ссылка

Служба:: API Management

Версия API:: 2022-08-01

Обновления сведения о пользователе, заданном его идентификатором.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?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, используемая для данной операции.

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

Имя	Обязательно	Тип	Описание
If-Match	True	string	ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.

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

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

Ответы

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

Имя

Тип

Описание

200 OK

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	олицетворения учетной записи пользователя

Примеры

ApiManagementUpdateUser

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

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


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

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

/** Samples for User Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateUser.json
     */
    /**
     * Sample code: ApiManagementUpdateUser.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateUser(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        UserContract resource =
            manager
                .users()
                .getWithResponse("rg1", "apimService1", "5931a75ae4bbd512a88c680b", com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withEmail("foobar@outlook.com")
            .withFirstName("foo")
            .withLastName("bar")
            .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_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.update(
        resource_group_name="rg1",
        service_name="apimService1",
        user_id="5931a75ae4bbd512a88c680b",
        if_match="*",
        parameters={"properties": {"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/ApiManagementUpdateUser.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/ApiManagementUpdateUser.json
func ExampleUserClient_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.NewUserClient().Update(ctx, "rg1", "apimService1", "5931a75ae4bbd512a88c680b", "*", armapimanagement.UserUpdateParameters{
		Properties: &armapimanagement.UserUpdateParametersProperties{
			Email:     to.Ptr("foobar@outlook.com"),
			FirstName: to.Ptr("foo"),
			LastName:  to.Ptr("bar"),
		},
	}, 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("5931a75ae4bbd512a88c680b"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/users"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b"),
	// 	Properties: &armapimanagement.UserContractProperties{
	// 		Identities: []*armapimanagement.UserIdentityContract{
	// 			{
	// 				ID: to.Ptr("*************"),
	// 				Provider: to.Ptr("Microsoft"),
	// 		}},
	// 		State: to.Ptr(armapimanagement.UserStateActive),
	// 		Email: to.Ptr("foobar@outlook.com"),
	// 		FirstName: to.Ptr("foo"),
	// 		LastName: to.Ptr("bar"),
	// 		RegistrationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-02T17:58:50.357Z"); 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

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

/**
 * This sample demonstrates how to Updates the details of the user specified by its identifier.
 *
 * @summary Updates the details of the user specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateUser.json
 */
async function apiManagementUpdateUser() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const userId = "5931a75ae4bbd512a88c680b";
  const ifMatch = "*";
  const parameters = {
    email: "foobar@outlook.com",
    firstName: "foo",
    lastName: "bar",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.user.update(
    resourceGroupName,
    serviceName,
    userId,
    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

Пример ответа

Код состояния:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
  "type": "Microsoft.ApiManagement/service/users",
  "name": "5931a75ae4bbd512a88c680b",
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "state": "active",
    "registrationDate": "2017-06-02T17:58:50.357Z",
    "identities": [
      {
        "provider": "Microsoft",
        "id": "*************"
      }
    ]
  }
}

Определения

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

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"

UserIdentityContract

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

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

UserState

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

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

UserUpdateParameters

Параметры обновления пользователей.

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

Поделиться через

User - Update

Параметры URI

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

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

Ответы

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

azure_auth

Области

Примеры

ApiManagementUpdateUser

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

Пример ответа

Определения

ErrorFieldContract

ErrorResponse

GroupContractProperties

GroupType

UserContract

UserIdentityContract

UserState

UserUpdateParameters

Дополнительные ресурсы