App Service Environments - Get Vip Info

Reference

Service:: App Service

API Version:: 2023-12-01

Description for Get IP addresses assigned to an App Service Environment.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip?api-version=2023-12-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the App Service Environment.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	AddressResponse	OK
Other Status Codes	DefaultErrorResponse	App Service error response.

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 your user account

Examples

Get IP addresses assigned to an App Service Environment.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/capacities/virtualip?api-version=2023-12-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/Microsoft.Web/hostingEnvironments/test-ase/capacities/virtualip",
  "name": "test-ase",
  "type": "Microsoft.Web/hostingEnvironments/capacities",
  "properties": {
    "serviceIpAddress": "20.112.141.120",
    "internalIpAddress": null,
    "outboundIpAddresses": [
      "20.112.141.120"
    ],
    "vipMappings": [
      {
        "virtualIP": "20.112.141.135",
        "internalHttpPort": 20003,
        "internalHttpsPort": 20001,
        "inUse": false,
        "serviceName": null
      },
      {
        "virtualIP": "20.112.141.150",
        "internalHttpPort": 20004,
        "internalHttpsPort": 20002,
        "inUse": false,
        "serviceName": null
      }
    ]
  }
}

Definitions

Name	Description
AddressResponse	Describes main public IP address and any extra virtual IPs.
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
VirtualIPMapping	Virtual IP mapping.

AddressResponse

Describes main public IP address and any extra virtual IPs.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.internalIpAddress	string	Virtual Network internal IP address of the App Service Environment if it is in internal load-balancing mode.
properties.outboundIpAddresses	string[]	IP addresses appearing on outbound connections.
properties.serviceIpAddress	string	Main public virtual IP.
properties.vipMappings	VirtualIPMapping[]	Additional virtual IPs.
type	string	Resource type.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

VirtualIPMapping

Virtual IP mapping.

Name	Type	Description
inUse	boolean	Is virtual IP mapping in use.
internalHttpPort	integer	Internal HTTP port.
internalHttpsPort	integer	Internal HTTPS port.
serviceName	string	name of the service that virtual IP is assigned to
virtualIP	string	Virtual IP address.

Share via