Set-DataGatewayInstaller
Modify list of users who can install and register new gateways in your organization You need to login as a Tenant Admin to run this command.
Syntax
Set-DataGatewayInstaller
[-PrincipalObjectIds <String[]>]
-Operation <OperationType>
-GatewayType <GatewayType>
[<CommonParameters>] Description
Set which users can install and register new gateways in your organization.
Examples
Example 1
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 ResourceAllow users testUpn1@tenant.com, and testUpn2@tenant.com to register and install an On-premises data gateway in a standard mode.
Example 2
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 ResourceUsers testUpn1@tenant.com, and testUpn2@tenant.com are no longer allowed to register and install an On-premises data gateway in a standard mode.
Parameters
-GatewayType
Gateway type the command takes effect on. The value Resource below would mean the On-premises data gateway running in a standard mode.
| Type: | GatewayType |
| Accepted values: | Resource, Personal, VirtualNetwork |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Operation
The operation to perform for the specified user.
| Type: | OperationType |
| Accepted values: | None, Add, Remove |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrincipalObjectIds
List of Azure Active Directory (AAD) principal object IDs (i.e. user IDs) that can configure gateways in your organization.
| Type: | String[] |
| Aliases: | Users |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
Outputs
System.Void