User - Create Or Update

Service:

API Management

Version d'API:

2021-08-01

Crée ou met à jour un utilisateur.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources.
serviceName	path	True	string	Nom du service Gestion des API. Modèle d’expression régulière: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
userId	path	True	string	Identificateur de l'utilisateur. Doit être unique dans le instance de service Gestion des API actuel.
api-version	query	True	string	Version de l’API à utiliser avec la demande du client.
notify	query		boolean	Envoyer une notification Email à l’utilisateur.

En-tête de la demande

Nom	Obligatoire	Type	Description
If-Match		string	ETag de l’entité. Non obligatoire lors de la création d’une entité, mais obligatoire lors de la mise à jour d’une entité.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.email	True	string	Adresse e-mail. Ne doit pas être vide et doit être unique au sein de l’instance de service.
properties.firstName	True	string	Prénom.
properties.lastName	True	string	Nom.
properties.appType		AppType	Détermine le type d’application qui envoie la demande d’utilisateur de création. La valeur par défaut est le portail hérité.
properties.confirmation		Confirmation	Détermine le type d’e-mail de confirmation qui sera envoyé à l’utilisateur nouvellement créé.
properties.identities		UserIdentityContract[]	Collection d’identités d’utilisateur.
properties.note		string	Remarque facultative sur un utilisateur définie par l'administrateur.
properties.password		string	Mot de passe utilisateur. Si aucune valeur n’est fournie, un mot de passe par défaut est généré.
properties.state		UserState	État du compte. Spécifie si l'utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ni appeler des API de produits auxquels ils sont abonnés. L’état par défaut est Actif.

Réponses

Nom	Type	Description
200 OK	UserContract	L’utilisateur a été correctement mis à jour. En-têtes ETag: string
201 Created	UserContract	L'utilisateur a été correctement créé. En-têtes ETag: string
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementCreateUser

Exemple de requête

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

Exemple de réponse

Code d’état:

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"
      }
    ]
  }
}

Code d’état:

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"
      }
    ]
  }
}

Définitions

Nom	Description
AppType	Détermine le type d’application qui envoie la demande d’utilisateur de création. La valeur par défaut est le portail hérité.
Confirmation	Détermine le type d’e-mail de confirmation qui sera envoyé à l’utilisateur nouvellement créé.
ErrorFieldContract	Contrat champ d’erreur.
ErrorResponse	Réponse d’erreur.
GroupContractProperties	Propriétés du contrat de groupe.
GroupType	Type du groupe.
UserContract	Détails de l’utilisateur.
UserCreateParameters	Détails de la création de l’utilisateur.
UserIdentityContract	Détails de l’identité de l’utilisateur.
UserState	État du compte. Spécifie si l'utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ni appeler des API de produits auxquels ils sont abonnés. L’état par défaut est Actif.

AppType

Détermine le type d’application qui envoie la demande d’utilisateur de création. La valeur par défaut est le portail hérité.

Nom	Type	Description
developerPortal	string	La demande de création d’utilisateur a été envoyée par le nouveau portail des développeurs.
portal	string	La demande de création d’utilisateur a été envoyée par le portail des développeurs hérité.

Confirmation

Détermine le type d’e-mail de confirmation qui sera envoyé à l’utilisateur nouvellement créé.

Nom	Type	Description
invite	string	Envoyez un e-mail invitant l’utilisateur à s’inscrire et à terminer l’inscription.
signup	string	Envoyez un e-mail à l’utilisateur confirmant qu’il s’est bien inscrit.

ErrorFieldContract

Contrat champ d’erreur.

Nom	Type	Description
code	string	Code d'erreur de niveau propriété.
message	string	Représentation lisible par l’homme de l’erreur au niveau de la propriété.
target	string	Nom de propriété.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
error.code	string	Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.
error.details	ErrorFieldContract[]	Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.
error.message	string	Représentation contrôlable de visu de l’erreur.

GroupContractProperties

Propriétés du contrat de groupe.

Nom	Type	Description
builtIn	boolean	true si le groupe est l’un des trois groupes système (administrateurs, développeurs ou invités) ; sinon, false.
description	string	Description de groupe. Peut contenir des balises au format HTML.
displayName	string	Nom de groupe.
externalId	string	Pour les groupes externes, cette propriété contient l’ID du groupe du fournisseur d’identité externe, par exemple pour Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; sinon, la valeur est null.
type	GroupType	Type du groupe.

GroupType

Type du groupe.

Nom	Type	Description
custom	string
external	string
system	string

UserContract

Détails de l’utilisateur.

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		nom de la ressource.
properties.email	string		Adresse e-mail.
properties.firstName	string		Prénom.
properties.groups	GroupContractProperties[]		Collection de groupes dont l’utilisateur fait partie.
properties.identities	UserIdentityContract[]		Collection d’identités d’utilisateur.
properties.lastName	string		Nom.
properties.note	string		Remarque facultative sur un utilisateur définie par l'administrateur.
properties.registrationDate	string		Date d’inscription de l’utilisateur. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601.
properties.state	UserState	active	État du compte. Spécifie si l'utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ni appeler des API de produits auxquels ils sont abonnés. L’état par défaut est Actif.
type	string		Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

UserCreateParameters

Détails de la création de l’utilisateur.

Nom	Type	Valeur par défaut	Description
properties.appType	AppType		Détermine le type d’application qui envoie la demande d’utilisateur de création. La valeur par défaut est le portail hérité.
properties.confirmation	Confirmation		Détermine le type d’e-mail de confirmation qui sera envoyé à l’utilisateur nouvellement créé.
properties.email	string		Adresse e-mail. Ne doit pas être vide et doit être unique au sein de l’instance de service.
properties.firstName	string		Prénom.
properties.identities	UserIdentityContract[]		Collection d’identités d’utilisateur.
properties.lastName	string		Nom.
properties.note	string		Remarque facultative sur un utilisateur définie par l'administrateur.
properties.password	string		Mot de passe utilisateur. Si aucune valeur n’est fournie, un mot de passe par défaut est généré.
properties.state	UserState	active	État du compte. Spécifie si l'utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ni appeler des API de produits auxquels ils sont abonnés. L’état par défaut est Actif.

UserIdentityContract

Détails de l’identité de l’utilisateur.

Nom	Type	Description
id	string	Valeur d’identificateur dans le fournisseur.
provider	string	Nom du fournisseur d’identité.

UserState

État du compte. Spécifie si l'utilisateur est actif ou non. Les utilisateurs bloqués ne peuvent pas se connecter au portail des développeurs ni appeler des API de produits auxquels ils sont abonnés. L’état par défaut est Actif.

Nom	Type	Description
active	string	L’état utilisateur est actif.
blocked	string	L’utilisateur est bloqué. Les utilisateurs bloqués ne peuvent pas s’authentifier sur le portail des développeurs ou appeler l’API.
deleted	string	Le compte d’utilisateur est fermé. Toutes les identités et entités associées sont supprimées.
pending	string	Le compte d’utilisateur est en attente. Nécessite une confirmation d’identité avant qu’elle puisse être activée.