Gateway entity

 

Updated: June 12, 2017

A Gateway entity is a JSON representation of a registered gateway within the Power BI service.

application/json

ParameterTypeDescription
gatewayIdRead-onlyGlobally unique gateway identifier
NameRead-onlyGateway friendly name, unique within tenant
TypeRead-onlyType of gateway
publicKeyRead-only; OptionalPublic key for credential encryption
gatewayAnnotationRead-only; OptionalAdditional metadata for the gateway
{
  "gatewayId": "575effbc-4542-4def-8012-2d2a3a17d211",
  "name": "Contoso Gateway",
  "type": "Personal|Resource|…",
  "publicKey": {"exponent":"AQAB", "modulus":"ABEF=="}
  "gatewayAnnotation": "{
    "gatewayContactInformation":["contoso@microsoft.com"],
    "gatewayVersion":"1.15.0.0",
    "gatewayWitnessString":"{\"EncryptedResult\":\"PNQA==\",\"IV\":\"jejD==\",\"Signature\ ":\"dO3x =\"}",
    "gatewayMachine":"Contoso-DEV"}",
  "gatewayStatus": "Live|NotInstalled|NotReachable|Installed"
}

Show: