Connection Gateways - List

Service:

App Service

API Version:

2016-06-01

Lists all of the connection gateways
Gets a list of gateways under a subscription

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/connectionGateways?api-version=2016-06-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	Subscription Id
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	ConnectionGatewayDefinitionCollection	The gateway definitions

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate a user account

Examples

List all connection gateways

Sample request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/connectionGateways?api-version=2016-06-01

Sample response

Status code:

200

{
  "value": [
    {
      "properties": {
        "connectionGatewayInstallation": {
          "location": "westus",
          "name": "865dccd1-5d5c-45fe-b5a0-249d4de4134c",
          "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus/connectionGatewayInstallations/865dccd1-5d5c-45fe-b5a0-249d4de4134c",
          "type": "Microsoft.Web/locations/connectionGatewayInstallations"
        },
        "contactInformation": [
          "test123@microsoft.com"
        ],
        "displayName": "test123",
        "machineName": "TEST123",
        "status": "Installed",
        "backendUri": "https://WABI-WEST-US-redirect.analysis.windows.net"
      },
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Web/connectionGateways/test123",
      "name": "test123",
      "type": "Microsoft.Web/connectionGateways",
      "location": "westus"
    }
  ]
}

Definitions

Name	Description
ConnectionGatewayDefinition	The gateway definition
ConnectionGatewayDefinitionCollection	A list of connection gateway definitions
ConnectionGatewayReference	The gateway installation reference
Properties

ConnectionGatewayDefinition

Object

The gateway definition

Name	Type	Description
etag	string	Resource ETag
id	string	Resource id
location	string	Resource location
name	string	Resource name
properties	Properties
tags	object	Resource tags
type	string	Resource type

ConnectionGatewayDefinitionCollection

Object

A list of connection gateway definitions

Name	Type	Description
value	ConnectionGatewayDefinition[]	Collection of connection gateways

ConnectionGatewayReference

Object

The gateway installation reference

Name	Type	Description
id	string	Resource reference id
location	string	Resource reference location
name	string	Resource reference name
type	string	Resource reference type

Properties

Object

Name	Type	Description
backendUri	string	The URI of the backend
connectionGatewayInstallation	ConnectionGatewayReference	The gateway installation reference
contactInformation	string[]	The gateway admin
description	string	The gateway description
displayName	string	The gateway display name
machineName	string	The machine name of the gateway
status	object	The gateway status