User - Create Or Update

Reference

Service:: API Management

API Version:: 2022-08-01

Vytvoří nebo Aktualizace uživatele.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
serviceName	path	True	string	Název služby API Management. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ID cílového předplatného.
userId	path	True	string	Identifikátor uživatele. Musí být jedinečný v aktuální instanci služby API Management.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
notify	query		boolean	Pošlete uživateli oznámení o Email.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match		string	Značka ETag entity. Nevyžaduje se při vytváření entity, ale vyžaduje se při aktualizaci entity.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.email	True	string	E-mailovou adresu Nesmí být prázdné a musí být jedinečné v rámci instance služby.
properties.firstName	True	string	Jméno.
properties.lastName	True	string	Příjmení.
properties.appType		AppType	Určuje typ aplikace, která odesílá žádost uživatele o vytvoření. Výchozí je starší verze portálu.
properties.confirmation		Confirmation	Určuje typ potvrzovací e-mailu, který se odešle nově vytvořenému uživateli.
properties.identities		UserIdentityContract[]	Kolekce identit uživatelů.
properties.note		string	Volitelná poznámka o uživateli nastaveném správcem
properties.password		string	Uživatelské heslo. Pokud není zadaná žádná hodnota, vygeneruje se výchozí heslo.
properties.state		UserState	Stav účtu. Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API odebíraných produktů. Výchozí stav je Aktivní.

Odpovědi

Name	Typ	Description
200 OK	UserContract	Uživatel byl úspěšně aktualizován. Headers ETag: string
201 Created	UserContract	Uživatel byl úspěšně vytvořen. Headers ETag: string
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Name

Typ

Description

200 OK

UserContract

Uživatel byl úspěšně aktualizován.

Headers

ETag: string

201 Created

UserContract

Uživatel byl úspěšně vytvořen.

Headers

ETag: string

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
AppType	Určuje typ aplikace, která odesílá žádost uživatele o vytvoření. Výchozí je starší verze portálu.
Confirmation	Určuje typ potvrzovací e-mailu, který se odešle nově vytvořenému uživateli.
ErrorFieldContract	Chyba Kontrakt pole.
ErrorResponse	Odpověď na chybu.
GroupContractProperties	Vlastnosti smlouvy skupiny.
GroupType	Typ skupiny.
UserContract	Podrobnosti o uživateli.
UserCreateParameters	Podrobnosti o vytvoření uživatele
UserIdentityContract	Podrobnosti o identitě uživatele
UserState	Stav účtu. Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API odebíraných produktů. Výchozí stav je Aktivní.

AppType

Určuje typ aplikace, která odesílá žádost uživatele o vytvoření. Výchozí je starší verze portálu.

Name	Typ	Description
developerPortal	string	Žádost o vytvoření uživatele byla odeslána novým portálem pro vývojáře.
portal	string	Starší verze portálu pro vývojáře odeslala žádost o vytvoření uživatele.

Confirmation

Určuje typ potvrzovací e-mailu, který se odešle nově vytvořenému uživateli.

Name	Typ	Description
invite	string	Pošlete uživateli e-mail s pozvánkou k registraci a dokončení registrace.
signup	string	Odešlete uživateli e-mail s potvrzením, že se úspěšně zaregistroval.

ErrorFieldContract

Chyba Kontrakt pole.

Name	Typ	Description
code	string	Kód chyby na úrovni vlastnosti.
message	string	Čitelné znázornění chyby na úrovni vlastností.
target	string	Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name	Typ	Description
error.code	string	Kód chyby definované službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.
error.details	ErrorFieldContract[]	Seznam neplatných polí se odešle v žádosti v případě chyby ověření.
error.message	string	Znázornění chyby čitelné pro člověka

GroupContractProperties

Vlastnosti smlouvy skupiny.

Name	Typ	Description
builtIn	boolean	true, pokud je skupina jednou ze tří systémových skupin (Správci, Vývojáři nebo Hosté); jinak false.
description	string	Popis skupiny. Může obsahovat značky formátování HTML.
displayName	string	Název skupiny.
externalId	string	U externích skupin obsahuje tato vlastnost ID skupiny od externího zprostředkovatele identity, například pro Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`, jinak je hodnota null.
type	GroupType	Typ skupiny.

GroupType

Typ skupiny.

Name	Typ	Description
custom	string
external	string
system	string

UserContract

Podrobnosti o uživateli.

Name	Typ	Výchozí hodnota	Description
id	string		Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Název prostředku
properties.email	string		E-mailovou adresu
properties.firstName	string		Jméno.
properties.groups	GroupContractProperties[]		Součástí je kolekce skupin, do které uživatel patří.
properties.identities	UserIdentityContract[]		Kolekce identit uživatelů.
properties.lastName	string		Příjmení.
properties.note	string		Volitelná poznámka o uživateli nastaveném správcem
properties.registrationDate	string		Datum registrace uživatele. Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.
properties.state	UserState	active	Stav účtu. Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API odebíraných produktů. Výchozí stav je Aktivní.
type	string		Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

UserCreateParameters

Podrobnosti o vytvoření uživatele

Name	Typ	Výchozí hodnota	Description
properties.appType	AppType		Určuje typ aplikace, která odesílá žádost uživatele o vytvoření. Výchozí je starší verze portálu.
properties.confirmation	Confirmation		Určuje typ potvrzovací e-mailu, který se odešle nově vytvořenému uživateli.
properties.email	string		E-mailovou adresu Nesmí být prázdné a musí být jedinečné v rámci instance služby.
properties.firstName	string		Jméno.
properties.identities	UserIdentityContract[]		Kolekce identit uživatelů.
properties.lastName	string		Příjmení.
properties.note	string		Volitelná poznámka o uživateli nastaveném správcem
properties.password	string		Uživatelské heslo. Pokud není zadaná žádná hodnota, vygeneruje se výchozí heslo.
properties.state	UserState	active	Stav účtu. Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API odebíraných produktů. Výchozí stav je Aktivní.

UserIdentityContract

Podrobnosti o identitě uživatele

Name	Typ	Description
id	string	Hodnota identifikátoru v rámci zprostředkovatele.
provider	string	Název zprostředkovatele identity.

UserState

Stav účtu. Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API odebíraných produktů. Výchozí stav je Aktivní.

Name	Typ	Description
active	string	Stav uživatele je aktivní.
blocked	string	Uživatel je zablokovaný. Blokovaní uživatelé se nemůžou ověřit na portálu pro vývojáře nebo volat rozhraní API.
deleted	string	Uživatelský účet je uzavřen. Odeberou se všechny identity a související entity.
pending	string	Uživatelský účet čeká na vyřízení. Před aktivací vyžaduje potvrzení identity.

Share via

User - Create Or Update

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

ApiManagementCreateUser

Sample Request

Sample Response

Definice

AppType

Confirmation

ErrorFieldContract

ErrorResponse

GroupContractProperties

GroupType

UserContract

UserCreateParameters

UserIdentityContract

UserState

Další materiály