User - Create Or Update

Referenz

Dienst:: API Management

API-Version:: 2024-05-01

Erstellt oder aktualisiert einen Benutzer.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
userId	path	True	string minLength: 1 maxLength: 80	Benutzer-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
notify	query		boolean	Senden Sie eine E-Mail-Benachrichtigung an den Benutzer.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match		string	ETag der Entität. Beim Erstellen einer Entität nicht erforderlich, aber beim Aktualisieren einer Entität erforderlich.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.email	True	string minLength: 1 maxLength: 254	E-Mail-Adresse. Darf nicht leer sein und muss innerhalb der Dienstinstanz eindeutig sein.
properties.firstName	True	string minLength: 1 maxLength: 100	Vorname.
properties.lastName	True	string minLength: 1 maxLength: 100	Nachname.
properties.appType		AppType	Bestimmt den Typ der Anwendung, die die Benutzeranforderung zum Erstellen sendet. Der Standardwert ist das Legacyportal.
properties.confirmation		Confirmation	Bestimmt den Typ der Bestätigungs-E-Mail, die an den neu erstellten Benutzer gesendet wird.
properties.identities		UserIdentityContract[]	Sammlung von Benutzeridentitäten.
properties.note		string	Optionaler Hinweis zu einem vom Administrator festgelegten Benutzer.
properties.password		string	Benutzerkennwort. Wenn kein Wert angegeben wird, wird ein Standardkennwort generiert.
properties.state		UserState	Kontostatus. Gibt an, ob der Benutzer aktiv ist oder nicht. Blockierte Benutzer können sich nicht beim Entwicklerportal anmelden oder APIs von abonnierten Produkten aufrufen. Der Standardstatus ist "Aktiv".

Antworten

Name	Typ	Beschreibung
200 OK	UserContract	Der Benutzer wurde erfolgreich aktualisiert. Header ETag: string
201 Created	UserContract	Der Benutzer wurde erfolgreich erstellt. Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

UserContract

Der Benutzer wurde erfolgreich aktualisiert.

Header

ETag: string

201 Created

UserContract

Der Benutzer wurde erfolgreich erstellt.

Header

ETag: string

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementCreateUser

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2024-05-01

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

Beispiel für eine Antwort

Statuscode:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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"
      }
    ]
  }
}

Statuscode:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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"
      }
    ]
  }
}

Definitionen

Name	Beschreibung
AppType	Bestimmt den Typ der Anwendung, die die Benutzeranforderung zum Erstellen sendet. Der Standardwert ist das Legacyportal.
Confirmation	Bestimmt den Typ der Bestätigungs-E-Mail, die an den neu erstellten Benutzer gesendet wird.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
GroupContractProperties	Gruppenvertragseigenschaften.
GroupType	Gruppentyp.
UserContract	Benutzerdetails.
UserCreateParameters	Benutzer erstellen Details.
UserIdentityContract	Benutzeridentitätsdetails.
UserState	Kontostatus. Gibt an, ob der Benutzer aktiv ist oder nicht. Blockierte Benutzer können sich nicht beim Entwicklerportal anmelden oder APIs von abonnierten Produkten aufrufen. Der Standardstatus ist "Aktiv".

AppType

Enumeration

Bestimmt den Typ der Anwendung, die die Benutzeranforderung zum Erstellen sendet. Der Standardwert ist das Legacyportal.

Wert	Beschreibung
developerPortal	Benutzererstellungsanforderung wurde vom neuen Entwicklerportal gesendet.
portal	Benutzererstellungsanforderung wurde vom älteren Entwicklerportal gesendet.

Confirmation

Enumeration

Bestimmt den Typ der Bestätigungs-E-Mail, die an den neu erstellten Benutzer gesendet wird.

Wert	Beschreibung
invite	Senden Sie eine E-Mail, die den Benutzer einlädt, sich anzumelden und die Registrierung abzuschließen.
signup	Senden Sie eine E-Mail an den Benutzer, der bestätigt, dass er sich erfolgreich registriert hat.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GroupContractProperties

Objekt

Gruppenvertragseigenschaften.

Name	Typ	Beschreibung
builtIn	boolean	true, wenn die Gruppe eine der drei Systemgruppen ist (Administratoren, Entwickler oder Gäste); andernfalls "false".
description	string maxLength: 1000	Gruppenbeschreibung. Kann HTML-Formatierungstags enthalten.
displayName	string minLength: 1 maxLength: 300	Gruppenname.
externalId	string	Bei externen Gruppen enthält diese Eigenschaft die ID der Gruppe vom 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

Enumeration

Gruppentyp.

Wert	Beschreibung
custom
external
system

UserContract

Objekt

Benutzerdetails.

Name	Typ	Standardwert	Beschreibung
id	string		Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /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 Gruppenbenutzern ist Teil des Benutzers.
properties.identities	UserIdentityContract[]		Sammlung von Benutzeridentitäten.
properties.lastName	string		Nachname.
properties.note	string		Optionaler Hinweis zu einem vom Administrator festgelegten Benutzer.
properties.registrationDate	string (date-time)		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 oder nicht. Blockierte Benutzer können sich nicht beim Entwicklerportal anmelden oder APIs von abonnierten Produkten aufrufen. Der Standardstatus ist "Aktiv".
type	string		Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

UserCreateParameters

Objekt

Benutzer erstellen Details.

Name	Typ	Standardwert	Beschreibung
properties.appType	AppType		Bestimmt den Typ der Anwendung, die die Benutzeranforderung zum Erstellen sendet. Der Standardwert ist das Legacyportal.
properties.confirmation	Confirmation		Bestimmt den Typ der Bestätigungs-E-Mail, die an den neu erstellten Benutzer gesendet wird.
properties.email	string minLength: 1 maxLength: 254		E-Mail-Adresse. Darf nicht leer sein und muss innerhalb der Dienstinstanz eindeutig sein.
properties.firstName	string minLength: 1 maxLength: 100		Vorname.
properties.identities	UserIdentityContract[]		Sammlung von Benutzeridentitäten.
properties.lastName	string minLength: 1 maxLength: 100		Nachname.
properties.note	string		Optionaler Hinweis zu einem vom Administrator festgelegten Benutzer.
properties.password	string		Benutzerkennwort. Wenn kein Wert angegeben wird, wird ein Standardkennwort generiert.
properties.state	UserState	active	Kontostatus. Gibt an, ob der Benutzer aktiv ist oder nicht. Blockierte Benutzer können sich nicht beim Entwicklerportal anmelden oder APIs von abonnierten Produkten aufrufen. Der Standardstatus ist "Aktiv".

UserIdentityContract

Objekt

Benutzeridentitätsdetails.

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

UserState

Enumeration

Kontostatus. Gibt an, ob der Benutzer aktiv ist oder nicht. Blockierte Benutzer können sich nicht beim Entwicklerportal anmelden oder APIs von abonnierten Produkten aufrufen. Der Standardstatus ist "Aktiv".

Wert	Beschreibung
active	Der Benutzerstatus ist aktiv.
blocked	Der Benutzer wird blockiert. Blockierte Benutzer können sich nicht im Entwicklerportal oder in der Anruf-API authentifizieren.
deleted	Das Benutzerkonto wird geschlossen. Alle Identitäten und zugehörigen Entitäten werden entfernt.
pending	Das Benutzerkonto steht aus. Erfordert eine Identitätsbestätigung, bevor sie aktiv werden kann.

Freigeben über

User - Create Or Update

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementCreateUser

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AppType

Confirmation

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GroupContractProperties

GroupType

UserContract

UserCreateParameters

UserIdentityContract

UserState

Zusätzliche Ressourcen