GroupUser interface
Schnittstelle, die einen GroupUser darstellt.
Methoden
check |
Überprüft, ob die durch den Bezeichner angegebene Benutzerentität der Gruppenentität zugeordnet ist. |
create(string, string, string, string, Group |
Dient zum Hinzufügen von vorhandenen Benutzern zu vorhandenen Gruppen. |
delete(string, string, string, string, Group |
Entfernt vorhandene Benutzer aus vorhandenen Gruppen |
list(string, string, string, Group |
Listet eine Auflistung der der Gruppe zugeordneten Benutzerentitäten auf |
Details zur Methode
checkEntityExists(string, string, string, string, GroupUserCheckEntityExistsOptionalParams)
Überprüft, ob die durch den Bezeichner angegebene Benutzerentität der Gruppenentität zugeordnet ist.
function checkEntityExists(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCheckEntityExistsOptionalParams): Promise<GroupUserCheckEntityExistsResponse>
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.
- groupId
-
string
Gruppen-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- userId
-
string
Benutzer-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
Die Optionsparameter.
Gibt zurück
Promise<GroupUserCheckEntityExistsResponse>
create(string, string, string, string, GroupUserCreateOptionalParams)
Dient zum Hinzufügen von vorhandenen Benutzern zu vorhandenen Gruppen.
function create(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCreateOptionalParams): Promise<UserContract>
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.
- groupId
-
string
Gruppen-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- userId
-
string
Benutzer-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- options
- GroupUserCreateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<UserContract>
delete(string, string, string, string, GroupUserDeleteOptionalParams)
Entfernt vorhandene Benutzer aus vorhandenen Gruppen
function delete(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserDeleteOptionalParams): 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.
- groupId
-
string
Gruppen-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- userId
-
string
Benutzer-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- options
- GroupUserDeleteOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<void>
list(string, string, string, GroupUserListOptionalParams)
Listet eine Auflistung der der Gruppe zugeordneten Benutzerentitäten auf
function list(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupUserListOptionalParams): 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.
- groupId
-
string
Gruppen-ID. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- options
- GroupUserListOptionalParams
Die Optionsparameter.