knaveen's avatar
knaveen
Microsoft Employee
8 months ago
Status:
New

Include Azure Key Vault Reference Name in Gateway Data Source API Response

Currently, when retrieving gateway data source connection details via the Power BI/Fabric REST API, the Azure Key Vault reference name configured for credentials is not included in the API response. This creates challenges for administrators who need to programmatically manage gateway connections that use Azure Key Vault for credentials. It is needed to move the connection to a new gateway cluster when the 1000 connection limit hits.

 

Current Behavior
When calling the following API endpoints:

 

The response includes:
json
{
  "id": "datasource-id",
  "gatewayId": "gateway-id",
  "datasourceType": "Sql",
  "connectionDetails": "{\"server\":\"localhost\\\\SQLEXPRESS\",\"database\":\"demodb\"}",
  "credentialType": "Basic",
  "credentialDetails": {
    "privacyLevel": "Organizational",
    "useEndUserOAuth2Credentials": false
  },
  "datasourceName": "gateway-demo-conn"
}
 

 

Missing Information: When the data source credentials are configured to use an Azure Key Vault reference (e.g., "DemoKeyVaultReference"), this information is not exposed in the API response.

 

Requested Enhancement
Include Azure Key Vault reference details in the API response when applicable, such as:

 

json
{
  "id": "datasource-id",
  "gatewayId": "gateway-id",
  "datasourceType": "Sql",
  "connectionDetails": "{\"server\":\"localhost\\\\SQLEXPRESS\",\"database\":\"demodb\"}",
  "credentialType": "Basic",
  "credentialDetails": {
    "privacyLevel": "Organizational",
    "useEndUserOAuth2Credentials": false,
    "keyVaultReference": {
      "referenceName": "DemoKeyVaultReference",
      "isKeyVaultReference": true
    }
  },
  "datasourceName": "gateway-demo-conn"
}
 
No CommentsBe the first to comment

Recent ideas