User - Create Or Update

Servizio:

API Management

Versione API:

2021-08-01

Crea o Aggiornamenti un utente.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse.
serviceName	path	True	string	Nome del servizio Gestione API. Criterio di espressione regolare: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
userId	path	True	string	Identificatore dell'utente. Deve essere univoco nell'istanza corrente del servizio Gestione API.
api-version	query	True	string	Versione dell'API da usare con la richiesta client.
notify	query		boolean	Inviare una notifica Email all'utente.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-Match		string	ETag dell'entità. Non richiesto durante la creazione di un'entità, ma necessario quando si aggiorna un'entità.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.email	True	string	Indirizzo di posta elettronica. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio.
properties.firstName	True	string	Nome.
properties.lastName	True	string	Cognome.
properties.appType		AppType	Determina il tipo di applicazione che invia la richiesta di creazione dell'utente. Il valore predefinito è il portale legacy.
properties.confirmation		Confirmation	Determina il tipo di posta elettronica di conferma che verrà inviato all'utente appena creato.
properties.identities		UserIdentityContract[]	Raccolta di identità utente.
properties.note		string	Nota facoltativa su un utente impostata dall'amministratore.
properties.password		string	Password utente. Se non viene specificato alcun valore, viene generata una password predefinita.
properties.state		UserState	Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono eseguire l'accesso al portale per sviluppatori o chiamare le API di prodotti sottoscritti. Lo stato predefinito è Attivo.

Risposte

Nome	Tipo	Descrizione
200 OK	UserContract	L'utente è stato aggiornato correttamente. Intestazioni ETag: string
201 Created	UserContract	Utente creato correttamente. Intestazioni ETag: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementCreateUser

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Definizioni

Nome	Descrizione
AppType	Determina il tipo di applicazione che invia la richiesta di creazione dell'utente. Il valore predefinito è il portale legacy.
Confirmation	Determina il tipo di posta elettronica di conferma che verrà inviato all'utente appena creato.
ErrorFieldContract	Contratto campo errore.
ErrorResponse	Risposta errore.
GroupContractProperties	Proprietà del contratto di gruppo.
GroupType	Tipo di gruppo.
UserContract	Dettagli utente.
UserCreateParameters	Dettagli di creazione utente.
UserIdentityContract	Dettagli dell'identità utente.
UserState	Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono eseguire l'accesso al portale per sviluppatori o chiamare le API di prodotti sottoscritti. Lo stato predefinito è Attivo.

AppType

Determina il tipo di applicazione che invia la richiesta di creazione dell'utente. Il valore predefinito è il portale legacy.

Nome	Tipo	Descrizione
developerPortal	string	La richiesta di creazione utente è stata inviata dal nuovo portale per sviluppatori.
portal	string	La richiesta di creazione utente è stata inviata dal portale per sviluppatori legacy.

Confirmation

Determina il tipo di posta elettronica di conferma che verrà inviato all'utente appena creato.

Nome	Tipo	Descrizione
invite	string	Inviare un messaggio di posta elettronica che invita l'utente ad iscriversi e completare la registrazione.
signup	string	Inviare un messaggio di posta elettronica all'utente confermando di aver completato l'iscrizione.

ErrorFieldContract

Contratto campo errore.

Nome	Tipo	Descrizione
code	string	Codice di errore a livello di proprietà.
message	string	Rappresentazione leggibile dell'errore a livello di proprietà.
target	string	Nome della proprietà.

ErrorResponse

Risposta errore.

Nome	Tipo	Descrizione
error.code	string	Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.
error.details	ErrorFieldContract[]	Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
error.message	string	Rappresentazione leggibile dell'errore.

GroupContractProperties

Proprietà del contratto di gruppo.

Nome	Tipo	Descrizione
builtIn	boolean	true se il gruppo è uno dei tre gruppi di sistema (amministratori, sviluppatori o guest); in caso contrario false.
description	string	Descrizione del gruppo. Può contenere tag di formattazione HTML.
displayName	string	Nome del gruppo.
externalId	string	Per i gruppi esterni, questa proprietà contiene l'ID del gruppo dal provider di identità esterno, ad esempio per Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; in caso contrario, il valore è Null.
type	GroupType	Tipo di gruppo.

GroupType

Tipo di gruppo.

Nome	Tipo	Descrizione
custom	string
external	string
system	string

UserContract

Dettagli utente.

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		nome della risorsa.
properties.email	string		Indirizzo di posta elettronica.
properties.firstName	string		Nome.
properties.groups	GroupContractProperties[]		La raccolta di utenti di gruppi fa parte di .
properties.identities	UserIdentityContract[]		Raccolta di identità utente.
properties.lastName	string		Cognome.
properties.note	string		Nota facoltativa su un utente impostata dall'amministratore.
properties.registrationDate	string		Data di registrazione dell'utente. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.
properties.state	UserState	active	Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono eseguire l'accesso al portale per sviluppatori o chiamare le API di prodotti sottoscritti. Lo stato predefinito è Attivo.
type	string		Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

UserCreateParameters

Dettagli di creazione utente.

Nome	Tipo	Valore predefinito	Descrizione
properties.appType	AppType		Determina il tipo di applicazione che invia la richiesta di creazione dell'utente. Il valore predefinito è il portale legacy.
properties.confirmation	Confirmation		Determina il tipo di posta elettronica di conferma che verrà inviato all'utente appena creato.
properties.email	string		Indirizzo di posta elettronica. Non deve essere vuoto e deve essere univoco all'interno dell'istanza del servizio.
properties.firstName	string		Nome.
properties.identities	UserIdentityContract[]		Raccolta di identità utente.
properties.lastName	string		Cognome.
properties.note	string		Nota facoltativa su un utente impostata dall'amministratore.
properties.password	string		Password utente. Se non viene specificato alcun valore, viene generata una password predefinita.
properties.state	UserState	active	Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono eseguire l'accesso al portale per sviluppatori o chiamare le API di prodotti sottoscritti. Lo stato predefinito è Attivo.

UserIdentityContract

Dettagli dell'identità utente.

Nome	Tipo	Descrizione
id	string	Valore identificatore all'interno del provider.
provider	string	Nome del provider di identità.

UserState

Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono eseguire l'accesso al portale per sviluppatori o chiamare le API di prodotti sottoscritti. Lo stato predefinito è Attivo.

Nome	Tipo	Descrizione
active	string	Lo stato utente è attivo.
blocked	string	L'utente viene bloccato. Gli utenti bloccati non possono eseguire l'autenticazione nel portale per sviluppatori o chiamare l'API.
deleted	string	L'account utente viene chiuso. Tutte le identità e le entità correlate vengono rimosse.
pending	string	L'account utente è in sospeso. Richiede conferma dell'identità prima di poter essere attivata.