User - Update

Referenz

Dienst:: API Management

API-Version:: 2021-08-01

Updates die Details des Benutzers, der durch seinen Bezeichner angegeben wird.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
serviceName	path	True	string	Der Name des API Management-Diensts. RegEx-Muster: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
userId	path	True	string	Benutzer-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match	True	string	ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.

Anforderungstext

Name	Typ	Beschreibung
properties.email	string	E-Mail-Adresse. Darf nicht leer sein und muss innerhalb der Dienstinstanz eindeutig sein.
properties.firstName	string	Vorname.
properties.identities	UserIdentityContract[]	Sammlung von Benutzeridentitäten.
properties.lastName	string	Nachname.
properties.note	string	Optionale, vom Administrator eingegebene Notiz über einen Benutzer.
properties.password	string	Benutzerkennwort.
properties.state	UserState	Kontostatus. Gibt an, ob der Benutzer aktiv ist. Gesperrte Benutzer können sich nicht im Entwicklerportal anmelden und keine APIs von abonnierten Produkten aufrufen. Der Standardzustand ist Aktiv.

Antworten

Name

Typ

Beschreibung

200 OK

Der Benutzer wurde erfolgreich aktualisiert.

Header

ETag: string

Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementUpdateUser

Beispielanforderung

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b?api-version=2021-08-01


{
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com"
  }
}

import com.azure.core.util.Context;
import com.azure.resourcemanager.apimanagement.models.UserContract;

/** Samples for User Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateUser.json
     */
    /**
     * Sample code: ApiManagementUpdateUser.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateUser(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        UserContract resource =
            manager.users().getWithResponse("rg1", "apimService1", "5931a75ae4bbd512a88c680b", Context.NONE).getValue();
        resource
            .update()
            .withEmail("foobar@outlook.com")
            .withFirstName("foo")
            .withLastName("bar")
            .withIfMatch("*")
            .apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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_update_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.update(
        resource_group_name="rg1",
        service_name="apimService1",
        user_id="5931a75ae4bbd512a88c680b",
        if_match="*",
        parameters={"properties": {"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/ApiManagementUpdateUser.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"
)

// 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/ApiManagementUpdateUser.json
func ExampleUserClient_Update() {
	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().Update(ctx, "rg1", "apimService1", "5931a75ae4bbd512a88c680b", "*", armapimanagement.UserUpdateParameters{
		Properties: &armapimanagement.UserUpdateParametersProperties{
			Email:     to.Ptr("foobar@outlook.com"),
			FirstName: to.Ptr("foo"),
			LastName:  to.Ptr("bar"),
		},
	}, 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("5931a75ae4bbd512a88c680b"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/users"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b"),
	// 	Properties: &armapimanagement.UserContractProperties{
	// 		Identities: []*armapimanagement.UserIdentityContract{
	// 			{
	// 				ID: to.Ptr("*************"),
	// 				Provider: to.Ptr("Microsoft"),
	// 		}},
	// 		State: to.Ptr(armapimanagement.UserStateActive),
	// 		Email: to.Ptr("foobar@outlook.com"),
	// 		FirstName: to.Ptr("foo"),
	// 		LastName: to.Ptr("bar"),
	// 		RegistrationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-02T17:58:50.357Z"); 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 Updates the details of the user specified by its identifier.
 *
 * @summary Updates the details of the user specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateUser.json
 */
async function apiManagementUpdateUser() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const userId = "5931a75ae4bbd512a88c680b";
  const ifMatch = "*";
  const parameters = {
    email: "foobar@outlook.com",
    firstName: "foo",
    lastName: "bar",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.user.update(
    resourceGroupName,
    serviceName,
    userId,
    ifMatch,
    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

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/ApiManagementUpdateUser.json
// this example is just showing the usage of "User_Update" 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://video2.skills-academy.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 ApiManagementUserResource created on azure
// for more information of creating ApiManagementUserResource, please refer to the document of ApiManagementUserResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string userId = "5931a75ae4bbd512a88c680b";
ResourceIdentifier apiManagementUserResourceId = ApiManagementUserResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, userId);
ApiManagementUserResource apiManagementUser = client.GetApiManagementUserResource(apiManagementUserResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
ApiManagementUserPatch patch = new ApiManagementUserPatch()
{
    Email = "foobar@outlook.com",
    FirstName = "foo",
    LastName = "bar",
};
ApiManagementUserResource result = await apiManagementUser.UpdateAsync(ifMatch, patch);

// 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

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
  "type": "Microsoft.ApiManagement/service/users",
  "name": "5931a75ae4bbd512a88c680b",
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "state": "active",
    "registrationDate": "2017-06-02T17:58:50.357Z",
    "identities": [
      {
        "provider": "Microsoft",
        "id": "*************"
      }
    ]
  }
}

Definitionen

Name	Beschreibung
ErrorFieldContract	Fehler Feldvertrag.
ErrorResponse	Fehlerantwort.
GroupContractProperties	Eigenschaften des Gruppenvertrags.
GroupType	Gruppentyp.
UserContract	Benutzerdetails.
UserIdentityContract	Details zur Benutzeridentität.
UserState	Kontostatus. Gibt an, ob der Benutzer aktiv ist. Gesperrte Benutzer können sich nicht im Entwicklerportal anmelden und keine APIs von abonnierten Produkten aufrufen. Der Standardzustand ist Aktiv.
UserUpdateParameters	Benutzerupdateparameter.

ErrorFieldContract

Fehler Feldvertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target	string	Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die in der Anforderung gesendet werden, im Falle eines Validierungsfehlers.
error.message	string	Lesbare Darstellung des Fehlers.

GroupContractProperties

Eigenschaften des Gruppenvertrags.

Name	Typ	Beschreibung
builtIn	boolean	true, wenn die Gruppe eine der drei Systemgruppen ist (Administratoren, Entwickler oder Gäste); andernfalls false.
description	string	Beschreibung der Gruppe. Darf HTML-Formatierungstags enthalten.
displayName	string	Gruppenname.
externalId	string	Für externe Gruppen enthält diese Eigenschaft die ID der Gruppe aus dem externen Identitätsanbieter, z. B. für Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`. Andernfalls ist der Wert NULL.
type	GroupType	Gruppentyp.

GroupType

Gruppentyp.

Name	Typ	Beschreibung
custom	string
external	string
system	string

UserContract

Benutzerdetails.

Name	Typ	Standardwert	Beschreibung
id	string		Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Der Name der Ressource
properties.email	string		E-Mail-Adresse.
properties.firstName	string		Vorname.
properties.groups	GroupContractProperties[]		Die Sammlung von Gruppen, zu der der Benutzer gehört.
properties.identities	UserIdentityContract[]		Sammlung von Benutzeridentitäten.
properties.lastName	string		Nachname.
properties.note	string		Optionale, vom Administrator eingegebene Notiz über einen Benutzer.
properties.registrationDate	string		Datum der Benutzerregistrierung. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.state	UserState	active	Kontostatus. Gibt an, ob der Benutzer aktiv ist. Gesperrte Benutzer können sich nicht im Entwicklerportal anmelden und keine APIs von abonnierten Produkten aufrufen. Der Standardzustand ist Aktiv.
type	string		Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

UserIdentityContract

Details zur Benutzeridentität.

Name	Typ	Beschreibung
id	string	Bezeichnerwert innerhalb des Anbieters.
provider	string	Name des Identitätsanbieters.

UserState

Kontostatus. Gibt an, ob der Benutzer aktiv ist. Gesperrte Benutzer können sich nicht im Entwicklerportal anmelden und keine APIs von abonnierten Produkten aufrufen. Der Standardzustand ist Aktiv.

Name	Typ	Beschreibung
active	string	Der Benutzerstatus ist aktiv.
blocked	string	Der Benutzer ist blockiert. Blockierte Benutzer können sich nicht im Entwicklerportal authentifizieren oder die API aufrufen.
deleted	string	Das Benutzerkonto ist geschlossen. Alle Identitäten und zugehörigen Entitäten werden entfernt.
pending	string	Das Benutzerkonto steht aus. Erfordert eine Identitätsbestätigung, bevor sie aktiviert werden kann.

UserUpdateParameters

Benutzerupdateparameter.

Name	Typ	Standardwert	Beschreibung
properties.email	string		E-Mail-Adresse. Darf nicht leer sein und muss innerhalb der Dienstinstanz eindeutig sein.
properties.firstName	string		Vorname.
properties.identities	UserIdentityContract[]		Sammlung von Benutzeridentitäten.
properties.lastName	string		Nachname.
properties.note	string		Optionale, vom Administrator eingegebene Notiz über einen Benutzer.
properties.password	string		Benutzerkennwort.
properties.state	UserState	active	Kontostatus. Gibt an, ob der Benutzer aktiv ist. Gesperrte Benutzer können sich nicht im Entwicklerportal anmelden und keine APIs von abonnierten Produkten aufrufen. Der Standardzustand ist Aktiv.