DataGateway Module

PowerShell Cmdlet untuk mengaktifkan penginstalan gateway, konfigurasi, mengelola keamanan, dan fitur gateway lainnya.

Nota

Sumber data PowerShell untuk Power BI hanya mendukung nilai.Individual

Modul ini mencakup sampel yang dimaksudkan untuk menjadi titik awal untuk skenario administrator gateway yang khas. Kami mendorong Anda menyalin skrip ke lokasi lain dan memodifikasinya agar sesuai dengan kebutuhan Anda.

Sampel individual dapat dipanggil dengan pola kode PowerShell berikut: &(Join-Path ((Get-Module -ListAvailable DataGateway).ModuleBase) Samples\<sample name>) <argument1> <argument2> ...

Skrip InstallAndAddDataGateway-Sample.ps1 sampel mengotomatiskan proses penginstalan gateway, mengonfigurasi gateway, dan menambahkan pengguna tambahan sebagai admin gateway (akun yang membuat gateway adalah administrator default).

Perintah DataGateway

Cmdlet Deskripsi
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-DataGatewayAvailableUpdates

Get latest 6 available gateway versions, or the supported versions for specified gateways to update to

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.

To use -TargetDirectory parameter, your gateway version must be 3000.278.4 (July 2025) or higher.

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

Restore-DataGatewayClusterMember

Restores an existing data gateway member in a gateway cluster after the gateway has been installed on a machine.

To use this cmdlet, your gateway version must be 3000.270.3 or higher. These cmdlets require PowerShell 7 or higher. For more information, see the online documentation for installation guidelines.

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.

Update-DataGatewayClusterMember

Start a update when newer version available or check the last update status on the specified gateway member in the cluster.

To use this cmdlet, your gateway version must be 3000.294.7 (Nov 2025) or higher.