Microsoft.DataMovement.Powershell.Commands.DataGateway.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-DataGatewayClusterDatasourceUser</command:name> <command:verb>Add</command:verb> <command:noun>DataGatewayClusterDatasourceUser</command:noun> <maml:description> <maml:para>Grants the permissions required to use the specified Power BI datasource for the specified user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Grants the permissions required to use the specified Power BI datasource for the specified user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-DataGatewayClusterDatasourceUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DatasourceUserAccessRight</maml:name> <maml:Description> <maml:para>User permissions for this data source. It could either be Read or ReadOverrideEffectiveIdentity. Read permissions provides read access to the data source. ReadOverrideEffectiveIdentity indicates that the user can override effective identity for Power BI Embedded. For more information https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/adddatasourceuser#datasourceuseraccessright</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Read</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Write</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReadWrite</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Admin</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OverrideEffectiveIdentity</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReadOverrideEffectiveIdentity</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">DatasourceUserAccessRight</command:parameterValue> <dev:type> <maml:name>DatasourceUserAccessRight</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:Description> <maml:para>Display name of the user to be added</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DatasourceId, Datasource"> <maml:name>GatewayClusterDatasourceId</maml:name> <maml:Description> <maml:para>Data source to which the user is to be added</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster to which the data source belongs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="User, EmailAddress"> <maml:name>UserEmailAddress</maml:name> <maml:Description> <maml:para>Email address of the user to be added</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DatasourceUserAccessRight</maml:name> <maml:Description> <maml:para>User permissions for this data source. It could either be Read or ReadOverrideEffectiveIdentity. Read permissions provides read access to the data source. ReadOverrideEffectiveIdentity indicates that the user can override effective identity for Power BI Embedded. For more information https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/adddatasourceuser#datasourceuseraccessright</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DatasourceUserAccessRight</command:parameterValue> <dev:type> <maml:name>DatasourceUserAccessRight</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:Description> <maml:para>Display name of the user to be added</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DatasourceId, Datasource"> <maml:name>GatewayClusterDatasourceId</maml:name> <maml:Description> <maml:para>Data source to which the user is to be added</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster to which the data source belongs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="User, EmailAddress"> <maml:name>UserEmailAddress</maml:name> <maml:Description> <maml:para>Email address of the user to be added</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayClusterDatasourceStatus -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -GatewayClusterDatasourceId 64C574B7-86C6-4560-B710-40AC18990804 -DatasourceUserAccessRight Read -UserEmailAddress testEmail@tenant.com</dev:code> <dev:remarks> <maml:para>Grants read access to 'testUpn@tenant.com' for the datasource.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-DataGatewayClusterUser</command:name> <command:verb>Add</command:verb> <command:noun>DataGatewayClusterUser</command:noun> <maml:description> <maml:para>Add user and associated permissions to cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add user and associated permissions to cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-DataGatewayClusterUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowedDataSourceTypes</maml:name> <maml:Description> <maml:para>Datasource types that are allowed for this user/role combination. This must be null if the role is admin(implying all datasource types are allowed). The list of data source type may change based on supported data sources. Note: This parameter applies only for PowerApps and Flow.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Sql</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AnalysisServices</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SAPHana</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">File</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Folder</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Oracle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Teradata</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SharePointList</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Web</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DB2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MySql</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PostgreSql</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Sybase</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Extension</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SAPBW</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureTables</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureBlobs</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Informix</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ODBC</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Excel</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SharePoint</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PubNub</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MQ</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BizTalk</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GoogleAnalytics</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomHttpApi</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Exchange</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Facebook</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">HDInsight</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureMarketplace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ActiveDirectory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Hdfs</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SharePointDocLib</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerQueryMashup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OleDb</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AdoDotNet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">R</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LOB</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Salesforce</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomConnector</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SAPBWMessageServer</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AdobeAnalytics</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Essbase</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Unknown</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.DatasourceType]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.DatasourceType]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster to which the user should be added</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="User"> <maml:name>PrincipalObjectId</maml:name> <maml:Description> <maml:para>Azure Active Directory (AAD) principal object ID (i.e. user ID) to add to the gateway cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RegionKey</maml:name> <maml:Description> <maml:para>The region in which this command has to run in. Not providing a RegionKey will run the command in the default region for your tenant. To get the list of available region parameters run the Get-DataGatewayRegion command</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Role to apply to this user on the cluster. Users can be added as admins, connection creators(Can Use) or Connection Creators with sharing(Can use + Share) capability. Connection creators(Can Use) and Connection Creators with sharing(Can use + Share) capability apply only for PowerApps and Flow. Accepted values for this paramater include: "Admin", "ConnectionCreatorWithReshare", and "ConnectionCreator"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Individual</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowedDataSourceTypes</maml:name> <maml:Description> <maml:para>Datasource types that are allowed for this user/role combination. This must be null if the role is admin(implying all datasource types are allowed). The list of data source type may change based on supported data sources. Note: This parameter applies only for PowerApps and Flow.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.DatasourceType]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.DatasourceType]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster to which the user should be added</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="User"> <maml:name>PrincipalObjectId</maml:name> <maml:Description> <maml:para>Azure Active Directory (AAD) principal object ID (i.e. user ID) to add to the gateway cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RegionKey</maml:name> <maml:Description> <maml:para>The region in which this command has to run in. Not providing a RegionKey will run the command in the default region for your tenant. To get the list of available region parameters run the Get-DataGatewayRegion command</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Role</maml:name> <maml:Description> <maml:para>Role to apply to this user on the cluster. Users can be added as admins, connection creators(Can Use) or Connection Creators with sharing(Can use + Share) capability. Connection creators(Can Use) and Connection Creators with sharing(Can use + Share) capability apply only for PowerApps and Flow. Accepted values for this paramater include: "Admin", "ConnectionCreatorWithReshare", and "ConnectionCreator"</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Individual</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $userToAdd = $(Get-AzADUser -ObjectId "testUpn@tenant.com").Id PS C:\> $dsTypes = New-Object 'System.Collections.Generic.List[Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.DataSourceType]' PS C:\> $dsTypes.Add([Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.DataSourceType]::Sql) PS C:\> Add-DataGatewayClusterUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -PrincipalObjectId $userToAdd -AllowedDataSourceTypes $dsTypes -Role ConnectionCreatorWithReshare</dev:code> <dev:remarks> <maml:para>This example adds the user "testUpn@tenant.com" in the role of ConnectionCreatorWithReshare to the gateway cluster for SQL datasource types.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $userToAdd = $(Get-AzADUser -ObjectId "testUpn@tenant.com").Id PS C:\> Add-DataGatewayClusterUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -PrincipalObjectId $userToAdd -AllowedDataSourceTypes $null -Role Admin</dev:code> <dev:remarks> <maml:para>This example adds the user "adminTestUpn@tenant.com" in the role of Admin to the gateway cluster for all datasource types. Note, the AllowedDataSourceTypes must be null when the role is admin (implying all datasource types are allowed).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> $userToAdd = $(Get-AzADUser -ObjectId "testUpn@tenant.com").Id PS C:\> Add-DataGatewayClusterUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -PrincipalObjectId $userToAdd -AllowedDataSourceTypes $null -Role Admin -RegionKey brazilsouth</dev:code> <dev:remarks> <maml:para>This example adds the user "adminTestUpn@tenant.com" in the role of Admin to the gateway cluster for all datasource types. Note, the AllowedDataSourceTypes must be null when the role is admin (implying all datasource types are allowed). This command is run in the Brazil south region, so the gateway cluster ID provided should be in that region.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DataGatewayCluster</command:name> <command:verb>Get</command:verb> <command:noun>DataGatewayCluster</command:noun> <maml:description> <maml:para>Get clusters for the current user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get clusters that match the cluster ID for the current user. If no cluster ID is specified, all clusters will be returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DataGatewayCluster</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Get a specific gateway cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RegionKey</maml:name> <maml:Description> <maml:para>The region associated to the gateway. When a RegionKey isn't provided, the default Power BI region for your tenant is used. To get the list of available region parameters run the Get-DataGatewayRegion cmdlet</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Individual</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Get a specific gateway cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RegionKey</maml:name> <maml:Description> <maml:para>The region associated to the gateway. When a RegionKey isn't provided, the default Power BI region for your tenant is used. To get the list of available region parameters run the Get-DataGatewayRegion cmdlet</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Individual</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.GatewayCluster</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayCluster</dev:code> <dev:remarks> <maml:para>Get all clusters details for the current user</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayCluster -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77</dev:code> <dev:remarks> <maml:para>Get cluster details for the specific cluster "DC8F2C49-5731-4B27-966B-3DB5094C2E77"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayCluster -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 | Select -ExpandProperty MemberGateways</dev:code> <dev:remarks> <maml:para>Get details of each member gateway in the specific cluster "DC8F2C49-5731-4B27-966B-3DB5094C2E77".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayCluster -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 | Select -ExpandProperty Permissions</dev:code> <dev:remarks> <maml:para>Get a list of users with permissions to administer or use the gateway cluster "DC8F2C49-5731-4B27-966B-3DB5094C2E77".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayCluster -Scope Organization</dev:code> <dev:remarks> <maml:para>Gets cluster details for all clusters across the tenant. NOTE: You must be a Power BI admin for the -Scope Organization option to work.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayCluster -RegionKey brazilsouth</dev:code> <dev:remarks> <maml:para>Gets details for gateway clusters in Brazil south region.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DataGatewayClusterDatasource</command:name> <command:verb>Get</command:verb> <command:noun>DataGatewayClusterDatasource</command:noun> <maml:description> <maml:para>Returns the specified Power BI datasource from the specified cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the specified Power BI datasource from the specified cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DataGatewayClusterDatasource</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DatasourceId, Datasource"> <maml:name>GatewayClusterDatasourceId</maml:name> <maml:Description> <maml:para>Data source for which additional information is being fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster for which a specific data source or all data sources are being fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DatasourceId, Datasource"> <maml:name>GatewayClusterDatasourceId</maml:name> <maml:Description> <maml:para>Data source for which additional information is being fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster for which a specific data source or all data sources are being fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.GatewayClusterDatasource</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayClusterDatasource -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77</dev:code> <dev:remarks> <maml:para>Get all datasources on the cluster</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayClusterDatasource -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -GatewayClusterDatasourceId 64C574B7-86C6-4560-B710-40AC18990804</dev:code> <dev:remarks> <maml:para>Gets a single datasource on the cluster</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayCluster | Get-DataGatewayClusterDatasource</dev:code> <dev:remarks> <maml:para>Gets a list of all datasources across all gateway clusters which the user has access to</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DataGatewayClusterDatasourceStatus</command:name> <command:verb>Get</command:verb> <command:noun>DataGatewayClusterDatasourceStatus</command:noun> <maml:description> <maml:para>Checks the connectivity status of the specified datasource from the specified cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Checks the connectivity status of the specified datasource from the specified cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DataGatewayClusterDatasourceStatus</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DatasourceId, Datasource"> <maml:name>GatewayClusterDatasourceId</maml:name> <maml:Description> <maml:para>Power BI Data source for which status is being fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster where the specific data source exists</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DatasourceId, Datasource"> <maml:name>GatewayClusterDatasourceId</maml:name> <maml:Description> <maml:para>Power BI Data source for which status is being fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster where the specific data source exists</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.PowerBI.DataMovement.ExternalContracts.API.ClusterDatasourceStatus</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayClusterDatasourceStatus -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -GatewayClusterDatasourceId 64C574B7-86C6-4560-B710-40AC18990804</dev:code> <dev:remarks> <maml:para>Gets the status of a Power BI single datasource on the cluster</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DataGatewayClusterDatasourceUser</command:name> <command:verb>Get</command:verb> <command:noun>DataGatewayClusterDatasourceUser</command:noun> <maml:description> <maml:para>Returns a list of users who have access to the specified Power BI datasource from the specified cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a list of users who have access to the specified Power BI datasource from the specified cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DataGatewayClusterDatasourceUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="DatasourceId, Datasource, Id"> <maml:name>GatewayClusterDatasourceId</maml:name> <maml:Description> <maml:para>Data source for which users are being fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Cluster, ClusterId"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster where the specific data source exists</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="DatasourceId, Datasource, Id"> <maml:name>GatewayClusterDatasourceId</maml:name> <maml:Description> <maml:para>Data source for which users are being fetched</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Cluster, ClusterId"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster where the specific data source exists</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.UserAccessRightEntry</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayClusterDatasourceUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -GatewayClusterDatasourceId 64C574B7-86C6-4560-B710-40AC18990804</dev:code> <dev:remarks> <maml:para>Gets the datasource users</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DataGatewayClusterStatus</command:name> <command:verb>Get</command:verb> <command:noun>DataGatewayClusterStatus</command:noun> <maml:description> <maml:para>Get cluster status</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get cluster status of a particular cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DataGatewayClusterStatus</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Cluster to get status of</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RegionKey</maml:name> <maml:Description> <maml:para>The region in which this command has to run in. Not providing a RegionKey will run the command in the default region for your tenant. To get the list of available region parameters run the Get-DataGatewayRegion command</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Individual</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Cluster to get status of</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RegionKey</maml:name> <maml:Description> <maml:para>The region in which this command has to run in. Not providing a RegionKey will run the command in the default region for your tenant. To get the list of available region parameters run the Get-DataGatewayRegion command</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Individual</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.GatewayClusterStatusResponse</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayClusterStatus -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77</dev:code> <dev:remarks> <maml:para>Get the status of the gateway cluster with ID DC8F2C49-5731-4B27-966B-3DB5094C2E77.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayClusterStatus -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -RegionKey brazilsouth</dev:code> <dev:remarks> <maml:para>Get the status of the gateway cluster with ID DC8F2C49-5731-4B27-966B-3DB5094C2E77. This command is run in the Brazil south region, so the gateway cluster ID provided should be in that region.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DataGatewayInstaller</command:name> <command:verb>Get</command:verb> <command:noun>DataGatewayInstaller</command:noun> <maml:description> <maml:para>Get users authorized to install and register gateways on the tenant</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get users authorized to install and register gateways on the current user's tenant. This command is availble only for Tenant/service admins.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DataGatewayInstaller</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GatewayTypeParameter</maml:name> <maml:Description> <maml:para>Filter the authorized user list by gateway type. The value of "Resource" below would list all On-premises data gateways running in the standard mode.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Resource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Personal</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">GatewayType</command:parameterValue> <dev:type> <maml:name>GatewayType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GatewayTypeParameter</maml:name> <maml:Description> <maml:para>Filter the authorized user list by gateway type. The value of "Resource" below would list all On-premises data gateways running in the standard mode.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">GatewayType</command:parameterValue> <dev:type> <maml:name>GatewayType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.InstallerPrincipal</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayInstaller</dev:code> <dev:remarks> <maml:para>Get a list of users authorized to install and register gateways on the tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DataGatewayRegion</command:name> <command:verb>Get</command:verb> <command:noun>DataGatewayRegion</command:noun> <maml:description> <maml:para>Get gateway regions</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists all gateway regions and also indicates the default Power BI region for your tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DataGatewayRegion</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.GatewayRegion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayRegion</dev:code> <dev:remarks> <maml:para>Get all gateway regions along with an identification of the default Power BI region for your tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DataGatewayTenantPolicy</command:name> <command:verb>Get</command:verb> <command:noun>DataGatewayTenantPolicy</command:noun> <maml:description> <maml:para>Get the gateway installation and registration policy for the tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the gateway installation and registration policy for the tenant. This command is availble only for Tenant/service admins.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DataGatewayTenantPolicy</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.GatewayTenant</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DataGatewayTenantPolicy</dev:code> <dev:remarks> <maml:para>Get the gateway installation and registration policy for the tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-DataGatewayCluster</command:name> <command:verb>Remove</command:verb> <command:noun>DataGatewayCluster</command:noun> <maml:description> <maml:para>Remove a gateway cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a gateway cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DataGatewayCluster</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>The cluster ID of the gateway to remove</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RegionKey</maml:name> <maml:Description> <maml:para>The region in which this command has to run in. Not providing a RegionKey will run the command in the default region for your tenant. To get the list of available region parameters run the Get-DataGatewayRegion command</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>The cluster ID of the gateway to remove</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RegionKey</maml:name> <maml:Description> <maml:para>The region in which this command has to run in. Not providing a RegionKey will run the command in the default region for your tenant. To get the list of available region parameters run the Get-DataGatewayRegion command</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-DataGatewayCluster -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77</dev:code> <dev:remarks> <maml:para>Remove the cluster with ID DC8F2C49-5731-4B27-966B-3DB5094C2E77</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Remove-DataGatewayCluster -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -RegionKey brailsouth</dev:code> <dev:remarks> <maml:para>Remove the cluster with ID DC8F2C49-5731-4B27-966B-3DB5094C2E77 This command is run in the Brazil south region, so the gateway cluster ID provided should be in that region.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-DataGatewayClusterDatasource</command:name> <command:verb>Remove</command:verb> <command:noun>DataGatewayClusterDatasource</command:noun> <maml:description> <maml:para>Removes the specified Power BI datasource from the specified cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes the specified Power BI datasource from the specified cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DataGatewayClusterDatasource</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DatasourceId, Datasource"> <maml:name>GatewayClusterDatasourceId</maml:name> <maml:Description> <maml:para>Data source which needs to be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster where the specific data source exists</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DatasourceId, Datasource"> <maml:name>GatewayClusterDatasourceId</maml:name> <maml:Description> <maml:para>Data source which needs to be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster where the specific data source exists</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-DataGatewayClusterDatasource -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -GatewayClusterDatasourceId 64C574B7-86C6-4560-B710-40AC18990804</dev:code> <dev:remarks> <maml:para>Removes the Power BI datasource from the cluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-DataGatewayClusterDatasourceUser</command:name> <command:verb>Remove</command:verb> <command:noun>DataGatewayClusterDatasourceUser</command:noun> <maml:description> <maml:para>Removes the specified user from the specified Power BI datasource of the specified cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes the specified user from the specified Power BI datasource of the specified cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DataGatewayClusterDatasourceUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DatasourceId, Datasource"> <maml:name>GatewayClusterDatasourceId</maml:name> <maml:Description> <maml:para>Data source for which the user needs to be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster where the specific data source exists</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="UserEmailAddress, EmailAddress, PrincipalObjectId, User"> <maml:name>UserId</maml:name> <maml:Description> <maml:para>The user to remove. This should be either a PrincipalObjectId (GUID type) or match the Identifier/UserEmailAddress value from Get-DataGatewayClusterDatasourceUser</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DatasourceId, Datasource"> <maml:name>GatewayClusterDatasourceId</maml:name> <maml:Description> <maml:para>Data source for which the user needs to be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster where the specific data source exists</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="UserEmailAddress, EmailAddress, PrincipalObjectId, User"> <maml:name>UserId</maml:name> <maml:Description> <maml:para>The user to remove. This should be either a PrincipalObjectId (GUID type) or match the Identifier/UserEmailAddress value from Get-DataGatewayClusterDatasourceUser</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-DataGatewayClusterDatasourceUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -GatewayClusterDatasourceId 64C574B7-86C6-4560-B710-40AC18990804 -UserId testEmail@tenant.com</dev:code> <dev:remarks> <maml:para>Removes access of 'testUpn@tenant.com' for the datasource.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-DataGatewayClusterMember</command:name> <command:verb>Remove</command:verb> <command:noun>DataGatewayClusterMember</command:noun> <maml:description> <maml:para>Remove gateway from gateway cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove gateway from gateway cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DataGatewayClusterMember</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>The cluster where the gateway to be removed is a member</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MemberGatewayId</maml:name> <maml:Description> <maml:para>The gateway to remove from the cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RegionKey</maml:name> <maml:Description> <maml:para>The region in which this command has to run in. Not providing a RegionKey will run the command in the default region for your tenant. To get the list of available region parameters run the Get-DataGatewayRegion command</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>The cluster where the gateway to be removed is a member</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MemberGatewayId</maml:name> <maml:Description> <maml:para>The gateway to remove from the cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RegionKey</maml:name> <maml:Description> <maml:para>The region in which this command has to run in. Not providing a RegionKey will run the command in the default region for your tenant. To get the list of available region parameters run the Get-DataGatewayRegion command</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-DataGatewayClusterMember -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -MemberGatewayId E407A364-3A89-4E21-8791-C108DB41E75A</dev:code> <dev:remarks> <maml:para>Remove the gateway with ID E407A364-3A89-4E21-8791-C108DB41E75A from the cluster with ID DC8F2C49-5731-4B27-966B-3DB5094C2E77</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Remove-DataGatewayClusterMember -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -MemberGatewayId E407A364-3A89-4E21-8791-C108DB41E75A -RegionKey brazilsouth</dev:code> <dev:remarks> <maml:para>Remove the gateway with ID E407A364-3A89-4E21-8791-C108DB41E75A from the cluster with ID DC8F2C49-5731-4B27-966B-3DB5094C2E77 This command is run in the Brazil south region, so the gateway cluster ID provided should be in that region.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-DataGatewayClusterUser</command:name> <command:verb>Remove</command:verb> <command:noun>DataGatewayClusterUser</command:noun> <maml:description> <maml:para>Remove user from gateway cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove user from gateway cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DataGatewayClusterUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster where the user should be removed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="User"> <maml:name>PrincipalObjectId</maml:name> <maml:Description> <maml:para>Azure Active Directory (AAD) principal object ID (i.e. user ID) to add to the gateway cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RegionKey</maml:name> <maml:Description> <maml:para>The region in which this command has to run in. Not providing a RegionKey will run the command in the default region for your tenant. To get the list of available region parameters run the Get-DataGatewayRegion command</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Individual</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster where the user should be removed</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="User"> <maml:name>PrincipalObjectId</maml:name> <maml:Description> <maml:para>Azure Active Directory (AAD) principal object ID (i.e. user ID) to add to the gateway cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RegionKey</maml:name> <maml:Description> <maml:para>The region in which this command has to run in. Not providing a RegionKey will run the command in the default region for your tenant. To get the list of available region parameters run the Get-DataGatewayRegion command</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Individual</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $userToRemove = $(Get-AzADUser -ObjectId "testUpn@tenant.com").Id PS C:\> Remove-DataGatewayClusterUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -PrincipalObjectId $userToRemove</dev:code> <dev:remarks> <maml:para>Removes the user "testUpn@tenant.com" from the gateway cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $userToRemove = $(Get-AzADUser -ObjectId "testUpn@tenant.com").Id PS C:\> Remove-DataGatewayClusterUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -PrincipalObjectId $userToRemove -RegionKey brazilsouth</dev:code> <dev:remarks> <maml:para>Removes the user "testUpn@tenant.com" from the gateway cluster. This command is run in the Brazil south region, so the gateway cluster ID provided should be in that region.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-DataGatewayCluster</command:name> <command:verb>Set</command:verb> <command:noun>DataGatewayCluster</command:noun> <maml:description> <maml:para>Set attributes of an existing gateway cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set attributes of an existing gateway cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DataGatewayCluster</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowCloudDatasourceRefresh</maml:name> <maml:Description> <maml:para>If set to true, Power BI cloud datasource refresh is allowed on this cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowCustomConnectors</maml:name> <maml:Description> <maml:para>If set to true, Power BI custom connector based refreshes are allowed on this cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContactInformation</maml:name> <maml:Description> <maml:para>Contact information for this cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Department</maml:name> <maml:Description> <maml:para>Department information for this cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of this cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoadBalancingSelectorType</maml:name> <maml:Description> <maml:para>Load-balancing type for this cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of this cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RegionKey</maml:name> <maml:Description> <maml:para>The region in which this command has to run in. Not providing a RegionKey will run the command in the default region for your tenant. To get the list of available region parameters run the Get-DataGatewayRegion command</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Individual</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowCloudDatasourceRefresh</maml:name> <maml:Description> <maml:para>If set to true, Power BI cloud datasource refresh is allowed on this cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowCustomConnectors</maml:name> <maml:Description> <maml:para>If set to true, Power BI custom connector based refreshes are allowed on this cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContactInformation</maml:name> <maml:Description> <maml:para>Contact information for this cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Department</maml:name> <maml:Description> <maml:para>Department information for this cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>Description of this cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LoadBalancingSelectorType</maml:name> <maml:Description> <maml:para>Load-balancing type for this cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of this cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RegionKey</maml:name> <maml:Description> <maml:para>The region in which this command has to run in. Not providing a RegionKey will run the command in the default region for your tenant. To get the list of available region parameters run the Get-DataGatewayRegion command</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Individual</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-DataGatewayCluster -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -AllowCloudDatasourceRefresh $true</dev:code> <dev:remarks> <maml:para>Allow Power BI cloud datasource refresh on the cluster with ID DC8F2C49-5731-4B27-966B-3DB5094C2E77</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-DataGatewayCluster -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -AllowCloudDatasourceRefresh $true -RegionKey brazilsouth</dev:code> <dev:remarks> <maml:para>Allow Power BI cloud datasource refresh on the cluster with ID DC8F2C49-5731-4B27-966B-3DB5094C2E77 This command is run in the Brazil south region, so the gateway cluster ID provided should be in that region.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-DataGatewayClusterDatasource</command:name> <command:verb>Set</command:verb> <command:noun>DataGatewayClusterDatasource</command:noun> <maml:description> <maml:para>Set the properties of the specified Power BI datasource from the specified cluster</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set the properties of the specified Power BI datasource from the specified cluster</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DataGatewayClusterDatasource</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Annotation</maml:name> <maml:Description> <maml:para>Data source description or comments for the data source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DatasourceName</maml:name> <maml:Description> <maml:para>The new name to be set for the data source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DatasourceId, Datasource"> <maml:name>GatewayClusterDatasourceId</maml:name> <maml:Description> <maml:para>The data source ID for which properties are to be set up.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster on which the data source exists</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SingleSignOnType</maml:name> <maml:Description> <maml:para>Enables single sign-on for supported data sources. For more information see https://docs.microsoft.com/en-us/power-bi/service-gateway-sso-overview</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Annotation</maml:name> <maml:Description> <maml:para>Data source description or comments for the data source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DatasourceName</maml:name> <maml:Description> <maml:para>The new name to be set for the data source</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DatasourceId, Datasource"> <maml:name>GatewayClusterDatasourceId</maml:name> <maml:Description> <maml:para>The data source ID for which properties are to be set up.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Cluster, Id"> <maml:name>GatewayClusterId</maml:name> <maml:Description> <maml:para>Gateway cluster on which the data source exists</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin. PowerShell for data sources only support the "Individual" value currently.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SingleSignOnType</maml:name> <maml:Description> <maml:para>Enables single sign-on for supported data sources. For more information see https://docs.microsoft.com/en-us/power-bi/service-gateway-sso-overview</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-DataGatewayClusterDatasource -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -GatewayClusterDatasourceId 64C574B7-86C6-4560-B710-40AC18990804 -DatasourceName "New datasource name"</dev:code> <dev:remarks> <maml:para>Update the name of the datasource to "New datasource name"</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-DataGatewayInstaller</command:name> <command:verb>Set</command:verb> <command:noun>DataGatewayInstaller</command:noun> <maml:description> <maml:para>Modify list of users who can install and register new gateways on the tenant</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set which users can install and register new gateways on the tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DataGatewayInstaller</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GatewayType</maml:name> <maml:Description> <maml:para>Gateway type the command takes effect on. The value "Resource" below would mean the On-premises data gateway running in a standard mode.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Resource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Personal</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">GatewayType</command:parameterValue> <dev:type> <maml:name>GatewayType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Operation</maml:name> <maml:Description> <maml:para>The operation to preform on the permission list.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Add</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Remove</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OperationType</command:parameterValue> <dev:type> <maml:name>OperationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Users"> <maml:name>PrincipalObjectIds</maml:name> <maml:Description> <maml:para>List of Azure Active Directory (AAD) principal object IDs (i.e. user IDs) that can configure gateways on the tenant.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GatewayType</maml:name> <maml:Description> <maml:para>Gateway type the command takes effect on. The value "Resource" below would mean the On-premises data gateway running in a standard mode.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">GatewayType</command:parameterValue> <dev:type> <maml:name>GatewayType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Operation</maml:name> <maml:Description> <maml:para>The operation to preform on the permission list.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OperationType</command:parameterValue> <dev:type> <maml:name>OperationType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Users"> <maml:name>PrincipalObjectIds</maml:name> <maml:Description> <maml:para>List of Azure Active Directory (AAD) principal object IDs (i.e. user IDs) that can configure gateways on the tenant.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $user1 = $(Get-AzADUser -ObjectId "testUpn@tenant.com").Id PS C:\> $user2 = $(Get-AzADUser -ObjectId "testUpn@tenant.com").Id PS C:\> Set-DataGatewayInstaller -PrincipalObjectIds $user1,$user2 -Operation Add -GatewayType Resource</dev:code> <dev:remarks> <maml:para>Allow users testUpn1@tenant.com, and testUpn2@tenant.com to register and install an On-premises data gateway in a standard mode.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $user1 = $(Get-AzADUser -ObjectId "testUpn@tenant.com").Id PS C:\> $user2 = $(Get-AzADUser -ObjectId "testUpn@tenant.com").Id PS C:\> Set-DataGatewayInstaller -PrincipalObjectIds $user1,$user2 -Operation Remove -GatewayType Resource</dev:code> <dev:remarks> <maml:para>Users testUpn1@tenant.com, and testUpn2@tenant.com are no longer allowed to register and install an On-premises data gateway in a standard mode.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-DataGatewayTenantPolicy</command:name> <command:verb>Set</command:verb> <command:noun>DataGatewayTenantPolicy</command:noun> <maml:description> <maml:para>Set the gateway installation and registration policy for the tenant</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set the gateway installation and registration policy for the tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-DataGatewayTenantPolicy</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovHigh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGovMil</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PersonalGatewayInstallPolicy</maml:name> <maml:Description> <maml:para>Tenant policy for Personal gateway installation and registration</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Open</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Restricted</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PolicyType</command:parameterValue> <dev:type> <maml:name>PolicyType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGatewayInstallPolicy</maml:name> <maml:Description> <maml:para>The on-premises data gateway in a standard mode installation and registration tenant policy. Setting it to "Open" would enable all users to install and register gateways while setting it to "Restricted" would restrict users.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Open</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Restricted</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PolicyType</command:parameterValue> <dev:type> <maml:name>PolicyType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to use. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PersonalGatewayInstallPolicy</maml:name> <maml:Description> <maml:para>Tenant policy for Personal gateway installation and registration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PolicyType</command:parameterValue> <dev:type> <maml:name>PolicyType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGatewayInstallPolicy</maml:name> <maml:Description> <maml:para>The on-premises data gateway in a standard mode installation and registration tenant policy. Setting it to "Open" would enable all users to install and register gateways while setting it to "Restricted" would restrict users.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PolicyType</command:parameterValue> <dev:type> <maml:name>PolicyType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-DataGatewayTenantPolicy -ResourceGatewayInstallPolicy Open</dev:code> <dev:remarks> <maml:para>Allow users to install and register on-premises data gateways on the user's tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |