User interface
Schnittstelle, die einen Benutzer darstellt.
Methoden
| create |
Erstellt oder aktualisiert einen Benutzer |
| delete(string, string, string, string, User |
Löscht den angegebenen Benutzer |
| generate |
Ruft eine Umleitungs-URL mit einem Authentifizierungstoken zum Anmelden des angegebenen Benutzers beim Entwicklerportal ab |
| get(string, string, string, User |
Ruft die Details des Benutzers ab, der durch seinen Bezeichner angegeben wird. |
| get |
Ruft die Etag-Version (Entity State) des Benutzers ab, der durch seinen Bezeichner angegeben wird. |
| get |
Ruft das SAS-Autorisierungstoken für den Benutzer ab |
| list |
Listet eine Auflistung der in der angegebenen Dienstinstanz registrierten Benutzer auf |
| update(string, string, string, string, User |
Updates die Details des Benutzers, der durch seinen Bezeichner angegeben wird. |
Details zur Methode
createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)
Erstellt oder aktualisiert einen Benutzer
function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- userId
-
string
Benutzer-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- parameters
- UserCreateParameters
Erstellen oder Aktualisieren von Parametern
- options
- UserCreateOrUpdateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<UserCreateOrUpdateResponse>
delete(string, string, string, string, UserDeleteOptionalParams)
Löscht den angegebenen Benutzer
function delete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<void>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- userId
-
string
Benutzer-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- ifMatch
-
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.
- options
- UserDeleteOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<void>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
Ruft eine Umleitungs-URL mit einem Authentifizierungstoken zum Anmelden des angegebenen Benutzers beim Entwicklerportal ab
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- userId
-
string
Benutzer-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- options
- UserGenerateSsoUrlOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<GenerateSsoUrlResult>
get(string, string, string, UserGetOptionalParams)
Ruft die Details des Benutzers ab, der durch seinen Bezeichner angegeben wird.
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- userId
-
string
Benutzer-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- options
- UserGetOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
Ruft die Etag-Version (Entity State) des Benutzers ab, der durch seinen Bezeichner angegeben wird.
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- userId
-
string
Benutzer-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- options
- UserGetEntityTagOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
Ruft das SAS-Autorisierungstoken für den Benutzer ab
function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- userId
-
string
Benutzer-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- parameters
- UserTokenParameters
Erstellen Sie Autorisierungstokenparameter.
Die Optionsparameter.
Gibt zurück
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
Listet eine Auflistung der in der angegebenen Dienstinstanz registrierten Benutzer auf
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- options
- UserListByServiceOptionalParams
Die Optionsparameter.
Gibt zurück
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
Updates die Details des Benutzers, der durch seinen Bezeichner angegeben wird.
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- userId
-
string
Benutzer-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- ifMatch
-
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.
- parameters
- UserUpdateParameters
Aktualisieren von Parametern.
- options
- UserUpdateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<UserUpdateResponse>