共用方式為

GroupUser interface

  • 參考
套件:
@azure/arm-apimanagement

代表 GroupUser 的介面。

方法

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

檢查標識子所指定的用戶實體是否與群組實體相關聯。
create(string, string, string, string, GroupUserCreateOptionalParams)

將現有的使用者新增至現有的群組
delete(string, string, string, string, GroupUserDeleteOptionalParams)

拿掉現有群組中的現有使用者。
list(string, string, string, GroupUserListOptionalParams)

列出與群組相關聯的用戶實體集合。

方法詳細資料

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

檢查標識子所指定的用戶實體是否與群組實體相關聯。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

groupId

string

群組標識碼。 目前 API 管理服務實例中必須是唯一的。

userId

string

用戶標識碼。 目前 API 管理服務實例中必須是唯一的。

options
GroupUserCheckEntityExistsOptionalParams

選項參數。

傳回

Promise<GroupUserCheckEntityExistsResponse>

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

將現有的使用者新增至現有的群組

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

groupId

string

群組標識碼。 目前 API 管理服務實例中必須是唯一的。

userId

string

用戶標識碼。 目前 API 管理服務實例中必須是唯一的。

options
GroupUserCreateOptionalParams

選項參數。

傳回

Promise<UserContract>

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

拿掉現有群組中的現有使用者。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

groupId

string

群組標識碼。 目前 API 管理服務實例中必須是唯一的。

userId

string

用戶標識碼。 目前 API 管理服務實例中必須是唯一的。

options
GroupUserDeleteOptionalParams

選項參數。

傳回

Promise<void>

list(string, string, string, GroupUserListOptionalParams)

列出與群組相關聯的用戶實體集合。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

groupId

string

群組標識碼。 目前 API 管理服務實例中必須是唯一的。

options
GroupUserListOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>