PowerBI On-premises data gateway PowerShell Public Preview. You can manage:

• On-premises data gateways
• Power BI Data sources

NOTE: These cmdlets require PowerShell core 6.2.2 or higher

The cmdlets can be installed in an elevated PowerShell session:

Install-Module -Name DataGateway

Gateway Management:

Following are PowerShell cmdlets that can be used for administering gateway clusters and members:

• Lists all gateway clusters for the current user or a specific one based on the passed parameters

Get-DataGatewayCluster

• Returns the cluster status along with additional properties

Get-DataGatewayClusterStatus

• Lists users authorized to install and register gateways within the tenant

Get-DataGatewayInstaller

• Returns the gateway installation and registration policy for the tenant

Get-DataGatewayTenantPolicy

• Add a specific user to a gateway cluster for specific permissions

Add-DataGatewayClusterUser

• Set properties of an existing gateway cluster

Set-DataGatewayCluster

• Modify the list of users who can install and register new gateways on the tenant

Set-DataGatewayInstaller

• Set the gateway installation and registration policy for the tenant

Set-DataGatewayTenantPolicy

• Remove a gateway cluster

Remove-DataGatewayCluster

• Remove a gateway member from the corresponding gateway cluster

Remove-DataGatewayClusterMember

• Remove a user from a gateway cluster

Remove-DataGatewayClusterUser

These cmdlets can be run under a tenant evel scope. This would require the user to be a global Office 365 admin or a Power BI service admin. For instance, the following cmdlet would return all gateways within your tenant.

Get-DataGatewayCluster -Scope Organization

Running the same command without the scope parameter or with the “Individual” scope would return the list of gateways, you are the administrator of.

Get-DataGatewayCluster -Scope Individual

The new cmdlet, which allows tenant admins to restrict the installation of on-premises data gateway ins standard mode is as follows. The tenant admin can then allow specific users to install using the Set-DataGatewayInstaller cmdlet.

Set-DataGatewayTenantPolicy -ResourceGatewayInstallPolicy Restricted

Data source (Power BI) management:

Following are PowerShell cmdlets that can be used for managing Power BI data sources:

• Add a user with the required permissions for a Power BI data source

Add-DataGatewayClusterDatasourceUser

• Lists all Power BI data sources on a gateway cluster or a specific one based on the passed parameters

Get-DataGatewayClusterDatasource 

• Returns the connectivity status of a data source in a gateway cluster

Get-DataGatewayClusterDatasourceStatus

• Lists users who have access to the specific Power BI data source in a gateway cluster

Get-DataGatewayClusterDatasourceUser

• Removes a Power BI data source from a gateway cluster

Remove-DataGatewayClusterDatasource

• Removes a user from a Power BI data source

Remove-DataGatewayClusterDatasourceUser

• Set properties of an existing Power BI data source

Set-DataGatewayClusterDatasource