DataGateway Module

PowerShell Cmdlets,用于启用网关安装、配置、管理安全性和其他网关功能。

注释

适用于 Power BI 数据源的 PowerShell 仅支持该值 Individual

本模块包括一些示例,这些示例旨在作为典型网关管理员方案的起点。 我们鼓励您将脚本复制到其他位置,并对其进行修改以满足您的需要。

可以使用以下 PowerShell Code Pattern 调用各个示例: &(Join-Path ((Get-Module -ListAvailable DataGateway).ModuleBase) Samples\<sample name>) <argument1> <argument2> ...

示例 InstallAndAddDataGateway-Sample.ps1 脚本可自动执行安装网关、配置网关和添加其他用户作为网关管理员(创建网关的帐户是默认管理员)的过程。

DataGateway 命令

Cmdlet 说明
Add-DataGatewayCluster

Creates a new data gateway cluster once the gateway has been installed on a machine

Add-DataGatewayClusterDatasourceUser

Grants a user permission to use the specified Power BI datasource.

Add-DataGatewayClusterMember

Creates a new data gateway cluster member in an existing cluster once the gateway has been installed on a machine

To use this cmdlet, your gateway version must be 3000.162.9 (Feb 2023) or higher. These cmdlets require Powershell 7 or higher. For more information, see the online documentation for installation guidelines.

Add-DataGatewayClusterUser

Add user and associated permissions to cluster

Get-DataGatewayCluster

Get gateway clusters for the current user

Get-DataGatewayClusterDatasource

Gets Power BI data sources for gateway clusters the user is an admin of.

Get-DataGatewayClusterDatasourceStatus

Checks the connectivity status of the specified Power BI datasource from the specified gateway cluster

Get-DataGatewayClusterDatasourceUser

Gets a list of users who have access to the specified Power BI datasource on the specified gateway cluster

Get-DataGatewayClusterStatus

Gets gateway cluster status

Get-DataGatewayDatasource

Gets the list of datasources that the user has access to

Get-DataGatewayInstaller

Get list of users who are authorized to install and register gateways in the organization. This command would be available only for Tenant/Service admin or a Gateway Admin.

Get-DataGatewayRegion

Gets all gateway Azure regions

Get-DataGatewayTenantPolicy

Gets the gateway installation and registration policy for the tenant.

Install-DataGateway

Downloads and installs the gateway on a machine

Remove-DataGatewayCluster

Removes a gateway cluster. This does not uninstall the gateway from the gateway member machine(s).

Remove-DataGatewayClusterDatasource

Removes the specified Power BI datasource from the specified cluster

Remove-DataGatewayClusterDatasourceUser

Removes the specified user from the specified Power BI datasource of the specified gateway cluster

Remove-DataGatewayClusterMember

Remove gateway from gateway cluster. This does not uninstall the gateway from the machine.

Remove-DataGatewayClusterUser

Removes users (including admins) from a gateway cluster

Set-DataGatewayCluster

Set attributes of an existing gateway cluster

Set-DataGatewayClusterDatasource

Set the properties of the specified Power BI datasource from the specified cluster

Set-DataGatewayInstaller

Modify list of users who can install and register new gateways in your organization You need to login as a Tenant Admin to run this command.

Set-DataGatewayTenantPolicy

Set the gateway installation and registration policy for the tenant. You need to login as a Tenant Admin to run this command.