User - Create Or Update

Serviço:

API Management

Versão da API:

2021-08-01

Cria ou Atualizações um utilizador.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
serviceName	path	True	string	O nome do serviço Gestão de API. Padrão Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
userId	path	True	string	Identificador de utilizador. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente.
notify	query		boolean	Envie uma notificação de Email ao Utilizador.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-Match		string	ETag da Entidade. Não é necessário ao criar uma entidade, mas é necessário ao atualizar uma entidade.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.email	True	string	Endereço de e-mail. Não pode estar vazio e tem de ser exclusivo na instância de serviço.
properties.firstName	True	string	Nome próprio.
properties.lastName	True	string	Apelido.
properties.appType		AppType	Determina o tipo de aplicação que envia o pedido de criação de utilizador. A predefinição é o portal legado.
properties.confirmation		Confirmation	Determina o tipo de e-mail de confirmação que será enviado para o utilizador recém-criado.
properties.identities		UserIdentityContract[]	Coleção de identidades de utilizador.
properties.note		string	Nota opcional sobre um utilizador definido pelo administrador.
properties.password		string	Palavra-passe de Utilizador. Se não for fornecido nenhum valor, é gerada uma palavra-passe predefinida.
properties.state		UserState	Estado da conta. Especifica se o utilizador está ativo ou não. Os utilizadores bloqueados não conseguem iniciar sessão no portal do programador ou chamar quaisquer APIs de produtos subscritos. O estado predefinido é Ativo.

Respostas

Name	Tipo	Description
200 OK	UserContract	O utilizador foi atualizado com êxito. Cabeçalhos ETag: string
201 Created	UserContract	O utilizador foi criado com êxito. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ApiManagementCreateUser

Pedido de amostra

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

Resposta da amostra

Código de estado:

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

Código de estado:

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

Definições

Name	Description
AppType	Determina o tipo de aplicação que envia o pedido de criação de utilizador. A predefinição é o portal legado.
Confirmation	Determina o tipo de e-mail de confirmação que será enviado para o utilizador recém-criado.
ErrorFieldContract	Contrato de Campo de Erro.
ErrorResponse	Resposta do Erro.
GroupContractProperties	Propriedades do contrato de grupo.
GroupType	Tipo de grupo.
UserContract	Detalhes do utilizador.
UserCreateParameters	Os utilizadores criam detalhes.
UserIdentityContract	Detalhes da identidade do utilizador.
UserState	Estado da conta. Especifica se o utilizador está ativo ou não. Os utilizadores bloqueados não conseguem iniciar sessão no portal do programador ou chamar quaisquer APIs de produtos subscritos. O estado predefinido é Ativo.

AppType

Determina o tipo de aplicação que envia o pedido de criação de utilizador. A predefinição é o portal legado.

Name	Tipo	Description
developerPortal	string	O pedido de criação do utilizador foi enviado pelo novo portal do programador.
portal	string	O pedido de criação do utilizador foi enviado pelo portal do programador legado.

Confirmation

Determina o tipo de e-mail de confirmação que será enviado para o utilizador recém-criado.

Name	Tipo	Description
invite	string	Envie um e-mail a convidar o utilizador para se inscrever e concluir o registo.
signup	string	Envie uma mensagem de correio eletrónico ao utilizador a confirmar que se inscreveu com êxito.

ErrorFieldContract

Contrato de Campo de Erro.

Name	Tipo	Description
code	string	Código de erro de nível de propriedade.
message	string	Representação legível por humanos do erro ao nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta do Erro.

Name	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Este código serve como um subestado para o código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados no pedido, em caso de erro de validação.
error.message	string	Representação legível por humanos do erro.

GroupContractProperties

Propriedades do contrato de grupo.

Name	Tipo	Description
builtIn	boolean	verdadeiro se o grupo for um dos três grupos de sistema (Administradores, Programadores ou Convidados); caso contrário, falso.
description	string	Descrição do grupo. Pode conter etiquetas de formatação HTML.
displayName	string	Nome do grupo.
externalId	string	Para grupos externos, esta propriedade contém o ID do grupo do fornecedor de identidade externo, por exemplo, para o Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; caso contrário, o valor é nulo.
type	GroupType	Tipo de grupo.

GroupType

Tipo de grupo.

Name	Tipo	Description
custom	string
external	string
system	string

UserContract

Detalhes do utilizador.

Name	Tipo	Default value	Description
id	string		ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		O nome do recurso
properties.email	string		Endereço de e-mail.
properties.firstName	string		Nome próprio.
properties.groups	GroupContractProperties[]		A coleção de grupos de que o utilizador faz parte.
properties.identities	UserIdentityContract[]		Coleção de identidades de utilizador.
properties.lastName	string		Apelido.
properties.note	string		Nota opcional sobre um utilizador definido pelo administrador.
properties.registrationDate	string		Data do registo do utilizador. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601.
properties.state	UserState	active	Estado da conta. Especifica se o utilizador está ativo ou não. Os utilizadores bloqueados não conseguem iniciar sessão no portal do programador ou chamar quaisquer APIs de produtos subscritos. O estado predefinido é Ativo.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

UserCreateParameters

Os utilizadores criam detalhes.

Name	Tipo	Default value	Description
properties.appType	AppType		Determina o tipo de aplicação que envia o pedido de criação de utilizador. A predefinição é o portal legado.
properties.confirmation	Confirmation		Determina o tipo de e-mail de confirmação que será enviado para o utilizador recém-criado.
properties.email	string		Endereço de e-mail. Não pode estar vazio e tem de ser exclusivo na instância de serviço.
properties.firstName	string		Nome próprio.
properties.identities	UserIdentityContract[]		Coleção de identidades de utilizador.
properties.lastName	string		Apelido.
properties.note	string		Nota opcional sobre um utilizador definido pelo administrador.
properties.password	string		Palavra-passe de Utilizador. Se não for fornecido nenhum valor, é gerada uma palavra-passe predefinida.
properties.state	UserState	active	Estado da conta. Especifica se o utilizador está ativo ou não. Os utilizadores bloqueados não conseguem iniciar sessão no portal do programador ou chamar quaisquer APIs de produtos subscritos. O estado predefinido é Ativo.

UserIdentityContract

Detalhes da identidade do utilizador.

Name	Tipo	Description
id	string	Valor do identificador no fornecedor.
provider	string	Nome do fornecedor de identidade.

UserState

Estado da conta. Especifica se o utilizador está ativo ou não. Os utilizadores bloqueados não conseguem iniciar sessão no portal do programador ou chamar quaisquer APIs de produtos subscritos. O estado predefinido é Ativo.

Name	Tipo	Description
active	string	O estado do utilizador está ativo.
blocked	string	O utilizador está bloqueado. Os utilizadores bloqueados não podem autenticar-se no portal do programador ou chamar a API.
deleted	string	A conta de utilizador está fechada. Todas as identidades e entidades relacionadas são removidas.
pending	string	A conta de utilizador está pendente. Requer a confirmação de identidade antes de poder ser ativada.