Gateways

Operations

Add Datasource User

Grants or updates the permissions required to use the specified data source for the specified user.

Permissions

The user must have gateway admin permissions.

Required scope

Dataset.ReadWrite.All

Limitations

Virtual network (VNet) gateways aren't supported.

Create Datasource

Creates a new data source on the specified gateway.

To encrypt credentials, see Configure credentials programmatically.

Permissions

The user must have gateway admin permissions.

Required scope

Dataset.ReadWrite.All

Limitations

Virtual network (VNet) gateways aren't supported.

Delete Datasource

Deletes the specified data source from the specified gateway.

Permissions

The user must have gateway admin permissions.

Required scope

Dataset.ReadWrite.All

Limitations

Virtual network (VNet) gateways aren't supported.

Delete Datasource User

Removes the specified user from the specified data source.

Permissions

The user must have gateway admin permissions.

Required scope

Dataset.ReadWrite.All

Limitations

Virtual network (VNet) gateways aren't supported.

Get Datasource

Returns the specified data source from the specified gateway.

Permissions

The user must have gateway admin permissions.

Required scope

Dataset.ReadWrite.All or Dataset.Read.All

Limitations

Virtual network (VNet) gateways aren't supported.

Get Datasources

Returns a list of data sources from the specified gateway.

Permissions

The user must have gateway admin permissions.

Required scope

Dataset.ReadWrite.All or Dataset.Read.All

Limitations

Virtual network (VNet) gateways aren't supported.

Get Datasource Status

Checks the connectivity status of the specified data source from the specified gateway.

Permissions

The user must have gateway admin permissions.

Required scope

Dataset.ReadWrite.All

Limitations

Virtual network (VNet) gateways aren't supported.

Get Datasource Users

Returns a list of users who have access to the specified data source.

Permissions

The user must have gateway admin permissions.

Required scope

Dataset.ReadWrite.All or Dataset.Read.All

Limitations

Virtual network (VNet) gateways aren't supported.

Get Gateway

Returns the specified gateway.

Permissions

The user must have gateway admin permissions.

Required scope

Dataset.ReadWrite.All or Dataset.Read.All

Limitations

Virtual network (VNet) gateways aren't supported.

Get Gateways

Returns a list of gateways for which the user is an admin.

Permissions

The user must have gateway admin permissions.

Required scope

Dataset.ReadWrite.All or Dataset.Read.All

Limitations

Virtual network (VNet) gateways aren't supported.

Update Datasource

Updates the credentials of the specified data source from the specified gateway.

  • Set the parameter useEndUserOAuth2Credentials to False when changing from single sign-on to other credential types, such as Basic or OAuth2. See the Basic credentials example.
  • To encrypt credentials, see Configure credentials programmatically.
  • For the OAuth2 credential type, make sure the generated OAuth2 token audience was set correctly according to the data source type.
  • For Extension data sources, don't set useCallerAADIdentity to true. To set OAuth2 credentials for other data sources, send the OAuth2 token in the payload as shown in the OAuth2 credentials example.

Permissions

The user must have gateway admin permissions.

Required scope

Dataset.ReadWrite.All

Limitations

Virtual network (VNet) gateways aren't supported.