GroupUser interface
Interfejs reprezentujący grupęużytkownika.
Metody
check |
Sprawdza, czy jednostka użytkownika określona przez identyfikator jest skojarzona z jednostką grupy. |
create(string, string, string, string, Group |
Dodawanie istniejącego użytkownika do istniejącej grupy |
delete(string, string, string, string, Group |
Usuń istniejącego użytkownika z istniejącej grupy. |
list(string, string, string, Group |
Wyświetla listę kolekcji jednostek użytkowników skojarzonych z grupą. |
Szczegóły metody
checkEntityExists(string, string, string, string, GroupUserCheckEntityExistsOptionalParams)
Sprawdza, czy jednostka użytkownika określona przez identyfikator jest skojarzona z jednostką grupy.
function checkEntityExists(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCheckEntityExistsOptionalParams): Promise<GroupUserCheckEntityExistsResponse>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- groupId
-
string
Identyfikator grupy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- userId
-
string
Identyfikator użytkownika. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.
Zwraca
Promise<GroupUserCheckEntityExistsResponse>
create(string, string, string, string, GroupUserCreateOptionalParams)
Dodawanie istniejącego użytkownika do istniejącej grupy
function create(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCreateOptionalParams): Promise<UserContract>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- groupId
-
string
Identyfikator grupy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- userId
-
string
Identyfikator użytkownika. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- options
- GroupUserCreateOptionalParams
Parametry opcji.
Zwraca
Promise<UserContract>
delete(string, string, string, string, GroupUserDeleteOptionalParams)
Usuń istniejącego użytkownika z istniejącej grupy.
function delete(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserDeleteOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- groupId
-
string
Identyfikator grupy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- userId
-
string
Identyfikator użytkownika. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- options
- GroupUserDeleteOptionalParams
Parametry opcji.
Zwraca
Promise<void>
list(string, string, string, GroupUserListOptionalParams)
Wyświetla listę kolekcji jednostek użytkowników skojarzonych z grupą.
function list(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupUserListOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- groupId
-
string
Identyfikator grupy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- options
- GroupUserListOptionalParams
Parametry opcji.