アクセス許可のチェック API

[アーティクル]
06/06/2023

Power BI Visuals の開発者であれば、さまざまなリソースへのアクセス許可が必要な視覚化を開発することができます。これらのアクセス許可は、capabilities.json ファイルの privileges セクションで要求します。これらの特権には、次にアクセスする機能が含まれています。

リモートリソースまたは Web サイト
データをダウンロードするためのローカルストレージ

各組織の管理者は、これらのアクセス許可を許可またはブロックすることができます。 "アクセス許可のチェック API" を使うと、実行時にホストに対してクエリを実行し、付与されているアクセス許可を判断できます。この情報を使って、さまざまなアクセス許可設定で機能する視覚化を設計できます。

"アクセス許可のチェック API" は、各アクセス許可クエリ関数の状態を返します。

/**
 * Represents a return type for privilege status query methods
 */
export const enum PrivilegeStatus {
    /**
     * The privilege is allowed in the current environment
     */
    Allowed,

    /**
     * The privilege declaration is missing in visual capabilities section
     */
    NotDeclared,

    /**
     * The privilege is not supported in the current environment
     */
    NotSupported,

    /**
     * The privilege usage was denied by tenant administrator
     */
    DisabledByAdmin,
}

アクセス許可のチェック API の使用方法

各特権 API には、アクセス許可の状態を確認するための独自のクエリメソッドがあります。アクセス許可は、次のいずれかの状態になることがあります。

許可
宣言されていません
サポートされていません
管理者によって無効にされました

Web アクセス

export interface IWebAccessService {
    /**
     * Returns the availability status of the service for specified url.
     * 
     * @param url - the URL to check status for
     * @returns the promise that resolves to privilege status of the service
     */
    webAccessStatus(url: string): IPromise<PrivilegeStatus>;
}

コンテンツのエクスポート

export interface IDownloadService {
    /**
     * Returns the availability status of the service.
     * 
     * @returns the promise that resolves to privilege status of the service
     */
    exportStatus(): IPromise<PrivilegeStatus>;
}

次の手順

Power BI カスタムビジュアル API

Share via