GroupUser interface
Rozhraní představující uživatele GroupUser.
Metody
check |
Kontroluje, že entita uživatele zadaná identifikátorem je přidružena k entitě skupiny. |
create(string, string, string, string, Group |
Přidání existujícího uživatele do existující skupiny |
delete(string, string, string, string, Group |
Odeberte existujícího uživatele z existující skupiny. |
list(string, string, string, Group |
Zobrazí kolekci entit uživatelů přidružených ke skupině. |
Podrobnosti metody
checkEntityExists(string, string, string, string, GroupUserCheckEntityExistsOptionalParams)
Kontroluje, že entita uživatele zadaná identifikátorem je přidružena k entitě skupiny.
function checkEntityExists(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCheckEntityExistsOptionalParams): Promise<GroupUserCheckEntityExistsResponse>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- groupId
-
string
Identifikátor skupiny. V aktuální instanci služby API Management musí být jedinečné.
- userId
-
string
Identifikátor uživatele. V aktuální instanci služby API Management musí být jedinečné.
Parametry možností.
Návraty
Promise<GroupUserCheckEntityExistsResponse>
create(string, string, string, string, GroupUserCreateOptionalParams)
Přidání existujícího uživatele do existující skupiny
function create(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCreateOptionalParams): Promise<UserContract>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- groupId
-
string
Identifikátor skupiny. V aktuální instanci služby API Management musí být jedinečné.
- userId
-
string
Identifikátor uživatele. V aktuální instanci služby API Management musí být jedinečné.
- options
- GroupUserCreateOptionalParams
Parametry možností.
Návraty
Promise<UserContract>
delete(string, string, string, string, GroupUserDeleteOptionalParams)
Odeberte existujícího uživatele z existující skupiny.
function delete(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserDeleteOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- groupId
-
string
Identifikátor skupiny. V aktuální instanci služby API Management musí být jedinečné.
- userId
-
string
Identifikátor uživatele. V aktuální instanci služby API Management musí být jedinečné.
- options
- GroupUserDeleteOptionalParams
Parametry možností.
Návraty
Promise<void>
list(string, string, string, GroupUserListOptionalParams)
Zobrazí kolekci entit uživatelů přidružených ke skupině.
function list(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupUserListOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- groupId
-
string
Identifikátor skupiny. V aktuální instanci služby API Management musí být jedinečné.
- options
- GroupUserListOptionalParams
Parametry možností.