App Service Environments - Get Vip Info

Servicio:

App Service

Versión de la API:

2025-05-01

Descripción de Obtener direcciones IP asignadas a un entorno de App Service.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
name	path	True	string	Nombre de App Service Environment.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	AddressResponse	La operación de Azure se completó correctamente.
Other Status Codes	DefaultErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get IP addresses assigned to an App Service Environment.

Solicitud de ejemplo

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=2025-05-01

Java

/**
 * Samples for AppServiceEnvironments GetVipInfo.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/AppServiceEnvironments_GetVipInfo.json
     */
    /**
     * Sample code: Get IP addresses assigned to an App Service Environment.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void getIPAddressesAssignedToAnAppServiceEnvironment(
        com.azure.resourcemanager.appservice.AppServiceManager manager) {
        manager.serviceClient().getAppServiceEnvironments().getVipInfoWithResponse("test-rg", "test-ase",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v6"
)

// Generated from example definition: 2025-05-01/AppServiceEnvironments_GetVipInfo.json
func ExampleEnvironmentsClient_GetVipInfo() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewEnvironmentsClient().GetVipInfo(ctx, "test-rg", "test-ase", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armappservice.EnvironmentsClientGetVipInfoResponse{
	// 	AddressResponse: &armappservice.AddressResponse{
	// 		Name: to.Ptr("test-ase"),
	// 		Type: to.Ptr("Microsoft.Web/hostingEnvironments/capacities"),
	// 		ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/capacities/virtualip"),
	// 		Properties: &armappservice.AddressResponseProperties{
	// 			OutboundIPAddresses: []*string{
	// 				to.Ptr("20.112.141.120"),
	// 			},
	// 			ServiceIPAddress: to.Ptr("20.112.141.120"),
	// 			VipMappings: []*armappservice.VirtualIPMapping{
	// 				{
	// 					InUse: to.Ptr(false),
	// 					InternalHTTPPort: to.Ptr[int32](20003),
	// 					InternalHTTPSPort: to.Ptr[int32](20001),
	// 					VirtualIP: to.Ptr("20.112.141.135"),
	// 				},
	// 				{
	// 					InUse: to.Ptr(false),
	// 					InternalHTTPPort: to.Ptr[int32](20004),
	// 					InternalHTTPSPort: to.Ptr[int32](20002),
	// 					VirtualIP: to.Ptr("20.112.141.150"),
	// 				},
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
AddressResponse	Describe la dirección IP pública principal y las direcciones IP virtuales adicionales.
createdByType	El tipo de identidad que creó el recurso.
DefaultErrorResponse	Respuesta de error de App Service.
DefaultErrorResponseError	Modelo de error.
DefaultErrorResponseErrorDetailsItem	Errores detallados.
systemData	Metadatos relativos a la creación y última modificación del recurso.
VirtualIPMapping	Asignación de IP virtual.

AddressResponse

Objeto

Describe la dirección IP pública principal y las direcciones IP virtuales adicionales.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo de recurso.
name	string	Nombre del recurso
properties.internalIpAddress	string	Dirección IP interna de Virtual Network de App Service Environment si está en modo de equilibrio de carga interno.
properties.outboundIpAddresses	string[]	Direcciones IP que aparecen en las conexiones salientes.
properties.serviceIpAddress	string	IP virtual pública principal.
properties.vipMappings	VirtualIPMapping[]	IPs virtuales adicionales.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

createdByType

Enumeración

El tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Objeto

Respuesta de error de App Service.

Nombre	Tipo	Description
error	DefaultErrorResponseError	Modelo de error.

DefaultErrorResponseError

Objeto

Modelo de error.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar el error mediante programación.
details	DefaultErrorResponseErrorDetailsItem[]	Errores detallados.
innererror	string	Más información para depurar el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

DefaultErrorResponseErrorDetailsItem

Objeto

Errores detallados.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar el error mediante programación.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	La marca de tiempo de la creación de recursos (UTC).
createdBy	string	La identidad que creó el recurso.
createdByType	createdByType	El tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	La marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	La identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	El tipo de identidad que modificó por última vez el recurso.

VirtualIPMapping

Objeto

Asignación de IP virtual.

Nombre	Tipo	Description
inUse	boolean	¿Se usa la asignación de IP virtual?
internalHttpPort	integer (int32)	Puerto HTTP interno.
internalHttpsPort	integer (int32)	Puerto HTTPS interno.
serviceName	string	nombre del servicio al que se asigna la IP virtual
virtualIP	string	Dirección IP virtual.