User - Create Or Update

Referência

Service:: API Management

API Version:: 2022-08-01

Cria ou atualiza um usuário.

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

With optional parameters:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
serviceName	path	True	string	O nome do serviço Gerenciamento de API. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	A ID da assinatura de destino.
userId	path	True	string	Identificador do usuário. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
api-version	query	True	string	A versão da API a ser usada para esta operação.
notify	query		boolean	Envie uma notificação de Email para o Usuário.

Cabeçalho da solicitação

Nome	Obrigató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 da solicitação

Nome	Obrigatório	Tipo	Description
properties.email	True	string	Endereço de email. Não deve estar vazio e deve ser exclusivo dentro da instância do serviço.
properties.firstName	True	string	Nome.
properties.lastName	True	string	Sobrenome.
properties.appType		AppType	Determina o tipo de aplicativo que envia a solicitação criar usuário. O padrão é o portal herdado.
properties.confirmation		Confirmation	Determina o tipo de email de confirmação que será enviado ao usuário recém-criado.
properties.identities		UserIdentityContract[]	Coleção de identidades de usuário.
properties.note		string	Observação opcional sobre um usuário definido pelo administrador.
properties.password		string	Senha do usuário. Se nenhum valor for fornecido, uma senha padrão será gerada.
properties.state		UserState	Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não podem acessar o portal do desenvolvedor ou chamar quaisquer APIs dos produtos assinados. O estado padrão é Ativo.

Respostas

Nome	Tipo	Description
200 OK	UserContract	O usuário foi atualizado com êxito. Headers ETag: string
201 Created	UserContract	O usuário foi criado com êxito. Headers ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Nome

Tipo

Description

200 OK

UserContract

O usuário foi atualizado com êxito.

Headers

ETag: string

201 Created

UserContract

O usuário foi criado com êxito.

Headers

ETag: string

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementCreateUser

Sample Request

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

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

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

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

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

Sample Response

Status code:: 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"
      }
    ]
  }
}

Status code:: 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

Nome	Description
AppType	Determina o tipo de aplicativo que envia a solicitação criar usuário. O padrão é o portal herdado.
Confirmation	Determina o tipo de email de confirmação que será enviado ao usuário recém-criado.
ErrorFieldContract	Contrato de campo de erro.
ErrorResponse	Resposta de erro.
GroupContractProperties	Propriedades do contrato de grupo.
GroupType	Tipo de grupo.
UserContract	Detalhes do usuário.
UserCreateParameters	Detalhes de criação do usuário.
UserIdentityContract	Detalhes de identidade do usuário.
UserState	Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não podem acessar o portal do desenvolvedor ou chamar quaisquer APIs dos produtos assinados. O estado padrão é Ativo.

AppType

Determina o tipo de aplicativo que envia a solicitação criar usuário. O padrão é o portal herdado.

Nome	Tipo	Description
developerPortal	string	A solicitação de criação de usuário foi enviada pelo novo portal do desenvolvedor.
portal	string	A solicitação de criação de usuário foi enviada pelo portal do desenvolvedor herdado.

Confirmation

Determina o tipo de email de confirmação que será enviado ao usuário recém-criado.

Nome	Tipo	Description
invite	string	Envie um email convidando o usuário a se inscrever e concluir o registro.
signup	string	Envie um email para o usuário confirmando que ele se inscreveu com êxito.

ErrorFieldContract

Contrato de campo de erro.

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

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados na solicitação, em caso de erro de validação.
error.message	string	Representação legível ao olho humano do erro.

GroupContractProperties

Propriedades do contrato de grupo.

Nome	Tipo	Description
builtIn	boolean	true se o grupo for um dos três grupos do sistema (Administradores, Desenvolvedores ou Convidados); caso contrário, false.
description	string	Descrição do grupo. Pode conter marcas de formatação HTML.
displayName	string	Nome do grupo.
externalId	string	Para grupos externos, essa propriedade contém a ID do grupo do provedor 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.

Nome	Tipo	Description
custom	string
external	string
system	string

UserContract

Detalhes do usuário.

Nome	Tipo	Valor padrão	Description
id	string		ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		O nome do recurso
properties.email	string		Endereço de email.
properties.firstName	string		Nome.
properties.groups	GroupContractProperties[]		A coleção de grupos do qual o usuário faz parte.
properties.identities	UserIdentityContract[]		Coleção de identidades de usuário.
properties.lastName	string		Sobrenome.
properties.note	string		Observação opcional sobre um usuário definido pelo administrador.
properties.registrationDate	string		Data do registro do usuário. A data está em conformidade com o seguinte formato: `yyyy-MM-ddTHH:mm:ssZ` conforme especificado pelo padrão ISO 8601.
properties.state	UserState	active	Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não podem acessar o portal do desenvolvedor ou chamar quaisquer APIs dos produtos assinados. O estado padrão é Ativo.
type	string		Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

UserCreateParameters

Detalhes de criação do usuário.

Nome	Tipo	Valor padrão	Description
properties.appType	AppType		Determina o tipo de aplicativo que envia a solicitação criar usuário. O padrão é o portal herdado.
properties.confirmation	Confirmation		Determina o tipo de email de confirmação que será enviado ao usuário recém-criado.
properties.email	string		Endereço de email. Não deve estar vazio e deve ser exclusivo dentro da instância do serviço.
properties.firstName	string		Nome.
properties.identities	UserIdentityContract[]		Coleção de identidades de usuário.
properties.lastName	string		Sobrenome.
properties.note	string		Observação opcional sobre um usuário definido pelo administrador.
properties.password	string		Senha do usuário. Se nenhum valor for fornecido, uma senha padrão será gerada.
properties.state	UserState	active	Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não podem acessar o portal do desenvolvedor ou chamar quaisquer APIs dos produtos assinados. O estado padrão é Ativo.

UserIdentityContract

Detalhes de identidade do usuário.

Nome	Tipo	Description
id	string	Valor do identificador dentro do provedor.
provider	string	Nome do provedor de identidade.

UserState

Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não podem acessar o portal do desenvolvedor ou chamar quaisquer APIs dos produtos assinados. O estado padrão é Ativo.

Nome	Tipo	Description
active	string	O estado do usuário está ativo.
blocked	string	O usuário está bloqueado. Os usuários bloqueados não podem se autenticar no portal do desenvolvedor ou chamar a API.
deleted	string	A conta de usuário está fechada. Todas as identidades e entidades relacionadas são removidas.
pending	string	A conta de usuário está pendente. Requer confirmação de identidade antes que ela possa ser ativada.

Share via

User - Create Or Update

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

azure_auth

Scopes

Exemplos

ApiManagementCreateUser

Sample Request

Sample Response

Definições

AppType

Confirmation

ErrorFieldContract

ErrorResponse

GroupContractProperties

GroupType

UserContract

UserCreateParameters

UserIdentityContract

UserState

Recursos adicionais