Get Application Gateway Configuration  

  • Article

 

Returns configuration settings of an Application Gateway.

HTTP REQUEST

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/services/networking/applicationGateways/<applicationGatewayName>/configuration

URI PARAMETERS

URI Parameter

Description

api-version=<api-version>

Version of the API, set to 2015-04-01

REQUEST HEADERS

The following table describes the request headers.

URI Parameter

Description

x-ms-version

Version of the API, set to 2015-04-01

REQUEST BODY

None.

STATUS CODE

If successful, the operation returns HTTP status code of 200 (OK).

RESPONSE BODY

<?xml version="1.0" encoding="UTF-8" ?>
<ApplicationGatewayConfiguration xmlns=”https://schemas.microsoft.com/windowsazure”>
      <FrontendIPConfigurations>
            <FrontendIPConfiguration>
                  <Name>ILB1</Name>
                  <Type>Private</Type>
                  <StaticIPAddress>10.0.0.10</StaticIPAddress>
            </FrontendIPConfiguration>
      </FrontendIPConfigurations>
      <FrontendPorts>
            <FrontendPort>
                  <Name>Port1</Name>
                  <Port>443</Port>
            </FrontendPort>
      </FrontendPorts>
      <BackendAddressPools>
            <BackendAddressPool>
                  <Name>pool1</Name>
                  <IpAddresses>
                        <IpAddress>10.0.0.1</IpAddress>
                        <IpAddress>10.0.0.2</IpAddress>
                  </IpAddresses>
            </BackendAddressPool>
      </BackendAddressPools>
      <BackendHttpSettingsList>
            <BackendHttpSettings>
                  <Name>Setting1</Name>
                  <Port>80</Port>
                  <Protocol>Http</Protocol>
                  <CookieBasedAffinity>Disabled</CookieBasedAffinity>
            </BackendHttpSettings>
      </BackendHttpSettingsList>
      <HttpListeners>
            <HttpListener>
                  <Name>Listener1</Name>
                  <FrontendIP>ILB1</FrontendIP>
                  <FrontendPort>Port1</FrontendPort>
                  <Protocol>Https</Protocol>
                  <SslCert>mySslCert1</SslCert>
            </HttpListener>
      </HttpListeners>
      <HttpLoadbalancingRules>
            <HttpLoadbalancingRule>
                  <Name>rule1</Name>
                  <Type>Basic</Type>
                  <BackendHttpSettings>setting1</BackendHttpSettings>
                  <Listener>listener1</Listener>
                  <BackendAddressPool>pool1</BackendAddressPool>
            </HttpLoadbalancingRule>
      </HttpLoadbalancingRules>
</ApplicationGatewayConfiguration>

Element name

Description

FrontendIPConfigurations

List of IP configurations. Optional.

FrontendIPConfigurations.FrontendIPConfiguration

Represents one IP Configuration

FrontendIPConfigurations.FrontendIPConfiguration.Name

Name of the IP Configuration

FrontendIPConfigurations.FrontendIPConfiguration.Type

Only supported value Private

FrontendIPConfigurations.FrontendIPConfiguration.StaticIPAddress

Static IP Address from the gateways subnet. If not specified, an IP is dynamically allocated from the subnet.

FrontendPorts

List of frontend ports

FrontendPorts.FrontendPort

Represents one frontend port

FrontendPorts.FrontendPort.Name

Name for the frontend port

FrontendPorts.FrontendPort.Port

Port

BackendAddressPools

List of backend address pools

BackendAddressPools.BackendAddressPool

Represents one backend address pool

BackendAddressPools.BackendAddressPool.Name

Name for a backend address pool

BackendAddressPools.BackendAddressPool.IpAddresses

List of IP Addresses

BackendAddressPools.BackendAddressPool.IpAddresses.IpAddress

IP Address of a server in a backend address pool

BackendHttpSettingsList

List of HTTP settings for the backend pool

BackendHttpSettingsList.BackendHttpSettings

Represents one set of HTTP pool settings

BackendHttpSettingsList.BackendHttpSettings.Name

Name of the HTTP pool settings

BackendHttpSettingsList.BackendHttpSettings.Port

Port on which backend servers listen

BackendHttpSettingsList.BackendHttpSettings.Protocol

Protocol. Http

BackendHttpSettingsList.BackendHttpSettings.CookieBasedAffinity

Cookie based affinity. Enabled | Disabled

HttpListeners

List of HTTP Listeners

HttpListeners.HttpListener

Represents one HTTP Listener

HttpListeners.HttpListener.Name

Name of the HTTP listener

HttpListeners.HttpListener.FrontendIP

Refers to the associated FrontendIPConfiguration, Optional.

HttpListeners.HttpListener.FrontendPort

Refers to the associated Frontend Port

HttpListeners.HttpListener.Protocol

Protocol of the listener. Http| Https 

HttpListeners.HttpListener.Cert

Name of the cert associated with the listener. Name is defined in Add/Update Applicate Gateway Certificate API. Valid only if protocol is HTTPS.

HttpLoadbalancingRules

List of HTTP Loadbalancing Rules

HttpLoadbalancingRules.HttpLoadbalancingRule

Represents one rule

HttpLoadbalancingRules.HttpLoadbalancingRule.Name

Name of the rule

HttpLoadbalancingRules.HttpLoadbalancingRule.Type

Rule Type. The only supported type is Basic.

HttpLoadbalancingRules.HttpLoadbalancingRule.BackendHttpSettings

Specifies the name of an HTTP server pool settings

HttpLoadbalancingRules.HttpLoadbalancingRule.Listener

Specifies the name of a listener

HttpLoadbalancingRules.HttpLoadbalancingRule.BackendAddressPool

Specifies the name of an HTTP server pool