Environment Fields¶
Reference for every field of the Add Power BI Environment and Edit Power BI Environment dialogs in MMA.
Both dialogs have the same fields. MMA stores them in the pbiInfos section of server\config\config.json; secrets are stored encrypted.
Image of the Edit Power BI Environment dialog with all fields labelled: Display name, Endpoint Set, Tenant ID, Client ID, Client Secret, Username, Password, FCM Datasets & Capacities tree, Ignore FCM at this time, Add, Remove, Load Capacities, Test Connection
../../images/admin/edit-pbi-environment-fields.png
Power BI System Configuration¶
| Label | Required | What to enter |
|---|---|---|
| Display name: | Yes | The name shown in the MetaMiner Client (MMC) and in MMA |
| Endpoint Set | Yes (default Commercial) | The Microsoft cloud of the tenant; see Endpoint sets |
| Tenant ID | Yes | The Directory (tenant) ID from the app registration overview, a GUID. Must not already be used by another environment. |
| Client ID | Yes | The Application (client) ID of the app registration |
| Client Secret | Yes | The client secret Value (not the secret ID). Stored encrypted. See Client Secret. |
| Username: | No | Optional delegated user; see Delegated user |
| Password: | Only when Username: is filled | Password of the delegated user. Stored encrypted. |
MMA marks an empty required field with a warning icon and keeps Apply disabled until Display name:, Tenant ID, Client ID and Client Secret are filled, and Password: too when Username: is filled.
Endpoint sets¶
| Value | Sign-in | Power BI API | Fabric API | Microsoft Graph |
|---|---|---|---|---|
| Commercial | login.microsoftonline.com |
api.powerbi.com |
api.fabric.microsoft.com |
graph.microsoft.com |
| US Government | login.microsoftonline.com |
api.powerbigov.us |
api.fabric.microsoft.us |
graph.microsoft.us |
| US Government High | login.microsoftonline.us |
api.high.powerbigov.us |
api.fabric.high.microsoft.us |
graph.microsoft.us |
| US Government Military | login.microsoftonline.us |
api.mil.powerbigov.us |
api.fabric.mil.microsoft.us |
dod-graph.microsoft.us |
All hosts use HTTPS. Allow them through your proxy and firewall. See Sovereign Clouds.
Delegated user¶
Username: and Password: are optional. Collection and validation use only the service principal (tenant ID, client ID and client secret). The user name is stored with the environment and shown in the Username column of the main window.
TODO: confirm what the delegated Username and Password are used for
In this release no collection or validation step reads the password. Product to confirm whether the fields should be documented for a feature (see Delegated User Sign-In) or hidden.
FCM Datasets & Capacities¶
| Element | What it does |
|---|---|
| Ignore FCM at this time | Turns off capacity metrics collection for this environment. Datasets stay in the list but are not collected or validated. |
| Tree | Each Fabric Capacity Metrics semantic model ID (bold), with its capacities as check boxes underneath. A DISCONNECTED group lists tenant capacities that no dataset reports. |
| Add | Prompts "Enter FCM Dataset UUID:" and adds the ID. Loads its capacities when tenant ID, client ID and secret are filled. |
| Remove | Removes the selected dataset and its capacity choices |
| Load Capacities | Reads the capacities of every listed dataset from Microsoft |
Details, input format and rules: Capacity Metrics Datasets.
Buttons¶
| Button | What it does |
|---|---|
| Test Connection | Runs the full validation with the values typed so far and shows the results. Saves nothing. |
| Apply | Validates, then saves. In the Add dialog it is enabled once the required fields are filled. |
| Close | Closes the dialog without saving |
Stored but not shown¶
| Value | Meaning |
|---|---|
| Enabled | The Enabled check box in the main window |
| Version | Set by a successful validation. MMS starts collecting an environment only once it has this value. |
| Status | Last validation result, for example Validated or Failed |