你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

WorkspaceCollections interface

包:

@azure/arm-powerbiembedded

表示 WorkspaceCollections 的接口。

方法

beginDelete(string, string, WorkspaceCollectionsDeleteOptionalParams)	删除 Power BI 工作区集合。
beginDeleteAndWait(string, string, WorkspaceCollectionsDeleteOptionalParams)	删除 Power BI 工作区集合。
checkNameAvailability(string, CheckNameRequest, WorkspaceCollectionsCheckNameAvailabilityOptionalParams)	验证指定的 Power BI 工作区集合名称是否有效且尚未使用。
create(string, string, CreateWorkspaceCollectionRequest, WorkspaceCollectionsCreateOptionalParams)	使用指定的属性创建新的 Power BI 工作区集合。 Power BI 工作区集合包含一个或多个工作区，可用于预配提供对这些工作区的 API 访问权限的密钥。
getAccessKeys(string, string, WorkspaceCollectionsGetAccessKeysOptionalParams)	检索指定 Power BI 工作区集合的主访问密钥和辅助访问密钥。
getByName(string, string, WorkspaceCollectionsGetByNameOptionalParams)	检索现有的 Power BI 工作区集合。
listByResourceGroup(string, WorkspaceCollectionsListByResourceGroupOptionalParams)	检索指定资源组中的所有现有 Power BI 工作区集合。
listBySubscription(WorkspaceCollectionsListBySubscriptionOptionalParams)	检索指定订阅中的所有现有 Power BI 工作区集合。
migrate(string, MigrateWorkspaceCollectionRequest, WorkspaceCollectionsMigrateOptionalParams)	将现有 Power BI 工作区集合迁移到其他资源组和/或订阅。
regenerateKey(string, string, WorkspaceCollectionAccessKey, WorkspaceCollectionsRegenerateKeyOptionalParams)	为指定的 Power BI 工作区集合重新生成主访问密钥或辅助访问密钥。
update(string, string, UpdateWorkspaceCollectionRequest, WorkspaceCollectionsUpdateOptionalParams)	使用指定的属性更新现有的 Power BI 工作区集合。

方法详细信息

beginDelete(string, string, WorkspaceCollectionsDeleteOptionalParams)

删除 Power BI 工作区集合。

function beginDelete(resourceGroupName: string, workspaceCollectionName: string, options?: WorkspaceCollectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

参数

resourceGroupName

string

Azure 资源组

workspaceCollectionName

string

Power BI Embedded 工作区集合名称

options

WorkspaceCollectionsDeleteOptionalParams

选项参数。

返回

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, WorkspaceCollectionsDeleteOptionalParams)

删除 Power BI 工作区集合。

function beginDeleteAndWait(resourceGroupName: string, workspaceCollectionName: string, options?: WorkspaceCollectionsDeleteOptionalParams): Promise<void>

参数

resourceGroupName

string

Azure 资源组

workspaceCollectionName

string

Power BI Embedded 工作区集合名称

options

WorkspaceCollectionsDeleteOptionalParams

选项参数。

返回

Promise<void>

checkNameAvailability(string, CheckNameRequest, WorkspaceCollectionsCheckNameAvailabilityOptionalParams)

验证指定的 Power BI 工作区集合名称是否有效且尚未使用。

function checkNameAvailability(location: string, body: CheckNameRequest, options?: WorkspaceCollectionsCheckNameAvailabilityOptionalParams): Promise<CheckNameResponse>

参数

location

string

Azure 位置

body

CheckNameRequest

检查名称可用性请求

options

WorkspaceCollectionsCheckNameAvailabilityOptionalParams

选项参数。

返回

Promise<CheckNameResponse>

create(string, string, CreateWorkspaceCollectionRequest, WorkspaceCollectionsCreateOptionalParams)

使用指定的属性创建新的 Power BI 工作区集合。 Power BI 工作区集合包含一个或多个工作区，可用于预配提供对这些工作区的 API 访问权限的密钥。

function create(resourceGroupName: string, workspaceCollectionName: string, body: CreateWorkspaceCollectionRequest, options?: WorkspaceCollectionsCreateOptionalParams): Promise<WorkspaceCollection>

参数

resourceGroupName

string

Azure 资源组

workspaceCollectionName

string

Power BI Embedded 工作区集合名称

body

CreateWorkspaceCollectionRequest

创建工作区集合请求

options

WorkspaceCollectionsCreateOptionalParams

选项参数。

返回

Promise<WorkspaceCollection>

getAccessKeys(string, string, WorkspaceCollectionsGetAccessKeysOptionalParams)

检索指定 Power BI 工作区集合的主访问密钥和辅助访问密钥。

function getAccessKeys(resourceGroupName: string, workspaceCollectionName: string, options?: WorkspaceCollectionsGetAccessKeysOptionalParams): Promise<WorkspaceCollectionAccessKeys>

参数

resourceGroupName

string

Azure 资源组

workspaceCollectionName

string

Power BI Embedded 工作区集合名称

options

WorkspaceCollectionsGetAccessKeysOptionalParams

选项参数。

返回

Promise<WorkspaceCollectionAccessKeys>

getByName(string, string, WorkspaceCollectionsGetByNameOptionalParams)

检索现有的 Power BI 工作区集合。

function getByName(resourceGroupName: string, workspaceCollectionName: string, options?: WorkspaceCollectionsGetByNameOptionalParams): Promise<WorkspaceCollection>

参数

resourceGroupName

string

Azure 资源组

workspaceCollectionName

string

Power BI Embedded 工作区集合名称

options

WorkspaceCollectionsGetByNameOptionalParams

选项参数。

返回

Promise<WorkspaceCollection>

listByResourceGroup(string, WorkspaceCollectionsListByResourceGroupOptionalParams)

检索指定资源组中的所有现有 Power BI 工作区集合。

function listByResourceGroup(resourceGroupName: string, options?: WorkspaceCollectionsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<WorkspaceCollection, WorkspaceCollection[], PageSettings>

参数

resourceGroupName

string

Azure 资源组

options

WorkspaceCollectionsListByResourceGroupOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<WorkspaceCollection, WorkspaceCollection[], PageSettings>

listBySubscription(WorkspaceCollectionsListBySubscriptionOptionalParams)

检索指定订阅中的所有现有 Power BI 工作区集合。

function listBySubscription(options?: WorkspaceCollectionsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<WorkspaceCollection, WorkspaceCollection[], PageSettings>

参数

options

WorkspaceCollectionsListBySubscriptionOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<WorkspaceCollection, WorkspaceCollection[], PageSettings>

migrate(string, MigrateWorkspaceCollectionRequest, WorkspaceCollectionsMigrateOptionalParams)

将现有 Power BI 工作区集合迁移到其他资源组和/或订阅。

function migrate(resourceGroupName: string, body: MigrateWorkspaceCollectionRequest, options?: WorkspaceCollectionsMigrateOptionalParams): Promise<void>

参数

resourceGroupName

string

Azure 资源组

body

MigrateWorkspaceCollectionRequest

工作区迁移请求

options

WorkspaceCollectionsMigrateOptionalParams

选项参数。

返回

Promise<void>

regenerateKey(string, string, WorkspaceCollectionAccessKey, WorkspaceCollectionsRegenerateKeyOptionalParams)

为指定的 Power BI 工作区集合重新生成主访问密钥或辅助访问密钥。

function regenerateKey(resourceGroupName: string, workspaceCollectionName: string, body: WorkspaceCollectionAccessKey, options?: WorkspaceCollectionsRegenerateKeyOptionalParams): Promise<WorkspaceCollectionAccessKeys>

参数

resourceGroupName

string

Azure 资源组

workspaceCollectionName

string

Power BI Embedded 工作区集合名称

body

WorkspaceCollectionAccessKey

用于重新生成的访问密钥

options

WorkspaceCollectionsRegenerateKeyOptionalParams

选项参数。

返回

Promise<WorkspaceCollectionAccessKeys>

update(string, string, UpdateWorkspaceCollectionRequest, WorkspaceCollectionsUpdateOptionalParams)

使用指定的属性更新现有的 Power BI 工作区集合。

function update(resourceGroupName: string, workspaceCollectionName: string, body: UpdateWorkspaceCollectionRequest, options?: WorkspaceCollectionsUpdateOptionalParams): Promise<WorkspaceCollection>

参数

resourceGroupName

string

Azure 资源组

workspaceCollectionName

string

Power BI Embedded 工作区集合名称

body

UpdateWorkspaceCollectionRequest

更新工作区集合请求

options

WorkspaceCollectionsUpdateOptionalParams

选项参数。

返回

Promise<WorkspaceCollection>