GroupUser interface

Paquet:

@azure/arm-apimanagement

Interface représentant un GroupUser.

Méthodes

checkEntityExists(string, string, string, string, GroupUserCheckEntityExistsOptionalParams)	Vérifie que l’entité utilisateur spécifiée par l’identificateur est associée à l’entité de groupe.
create(string, string, string, string, GroupUserCreateOptionalParams)	Ajouter un utilisateur existant à un groupe existant
delete(string, string, string, string, GroupUserDeleteOptionalParams)	Supprimez l’utilisateur existant du groupe existant.
list(string, string, string, GroupUserListOptionalParams)	Répertorie une collection d’entités utilisateur associées au groupe.

Détails de la méthode

checkEntityExists(string, string, string, string, GroupUserCheckEntityExistsOptionalParams)

Vérifie que l’entité utilisateur spécifiée par l’identificateur est associée à l’entité de groupe.

function checkEntityExists(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCheckEntityExistsOptionalParams): Promise<GroupUserCheckEntityExistsResponse>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

groupId

string

Identificateur de groupe. Doit être unique dans l’instance actuelle du service Gestion des API.

userId

string

Identificateur de l’utilisateur. Doit être unique dans l’instance actuelle du service Gestion des API.

options

GroupUserCheckEntityExistsOptionalParams

Paramètres d’options.

Retours

Promise<GroupUserCheckEntityExistsResponse>

create(string, string, string, string, GroupUserCreateOptionalParams)

Ajouter un utilisateur existant à un groupe existant

function create(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCreateOptionalParams): Promise<UserContract>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

groupId

string

Identificateur de groupe. Doit être unique dans l’instance actuelle du service Gestion des API.

userId

string

Identificateur de l’utilisateur. Doit être unique dans l’instance actuelle du service Gestion des API.

options

GroupUserCreateOptionalParams

Paramètres d’options.

Retours

Promise<UserContract>

delete(string, string, string, string, GroupUserDeleteOptionalParams)

Supprimez l’utilisateur existant du groupe existant.

function delete(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserDeleteOptionalParams): Promise<void>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

groupId

string

Identificateur de groupe. Doit être unique dans l’instance actuelle du service Gestion des API.

userId

string

Identificateur de l’utilisateur. Doit être unique dans l’instance actuelle du service Gestion des API.

options

GroupUserDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

list(string, string, string, GroupUserListOptionalParams)

Répertorie une collection d’entités utilisateur associées au groupe.

function list(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupUserListOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

groupId

string

Identificateur de groupe. Doit être unique dans l’instance actuelle du service Gestion des API.

options

GroupUserListOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>