User interface
Schnittstelle, die einen Benutzer darstellt.
Methoden
Details zur Methode
beginDelete(string, string, string, string, UserDeleteOptionalParams)
Löscht einen bestimmten Benutzer.
function beginDelete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<SimplePollerLike<OperationState<UserDeleteHeaders>, UserDeleteHeaders>>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API-Verwaltungsdiensts.
- userId
-
string
Benutzer-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz 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 bedingungslose Aktualisierung sein.
- options
- UserDeleteOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<UserDeleteHeaders>, UserDeleteHeaders>>
beginDeleteAndWait(string, string, string, string, UserDeleteOptionalParams)
Löscht einen bestimmten Benutzer.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<UserDeleteHeaders>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API-Verwaltungsdiensts.
- userId
-
string
Benutzer-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz 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 bedingungslose Aktualisierung sein.
- options
- UserDeleteOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<UserDeleteHeaders>
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. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API-Verwaltungsdiensts.
- userId
-
string
Benutzer-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
- parameters
- UserCreateParameters
Erstellen oder Aktualisieren von Parametern.
- options
- UserCreateOrUpdateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<UserCreateOrUpdateResponse>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
Ruft eine Umleitungs-URL ab, die ein Authentifizierungstoken zum Signieren eines bestimmten Benutzers im Entwicklerportal enthält.
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API-Verwaltungsdiensts.
- userId
-
string
Benutzer-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz 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 wurde.
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API-Verwaltungsdiensts.
- userId
-
string
Benutzer-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
- options
- UserGetOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
Ruft die Entitätsstatusversion (Etag) des Benutzers ab, der durch seinen Bezeichner angegeben wurde.
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API-Verwaltungsdiensts.
- userId
-
string
Benutzer-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
- options
- UserGetEntityTagOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
Ruft das Autorisierungstoken für den freigegebenen Zugriff 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. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API-Verwaltungsdiensts.
- userId
-
string
Benutzer-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
- parameters
- UserTokenParameters
Erstellen Sie Autorisierungstokenparameter.
Die Optionsparameter.
Gibt zurück
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
Listet eine Auflistung registrierter Benutzer in der angegebenen Dienstinstanz auf.
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API-Verwaltungsdiensts.
- options
- UserListByServiceOptionalParams
Die Optionsparameter.
Gibt zurück
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
Aktualisiert die Details des benutzers, der durch seinen Bezeichner angegeben wurde.
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API-Verwaltungsdiensts.
- userId
-
string
Benutzer-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz 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 bedingungslose Aktualisierung sein.
- parameters
- UserUpdateParameters
Aktualisieren von Parametern.
- options
- UserUpdateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<UserUpdateResponse>