App Service Environments - Get Vip Info

Dienst:: App Service

API-Version:: 2025-05-01

Beschreibung zum Abrufen von IP-Adressen, die einer App Service-Umgebung zugewiesen sind.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Name der App-Dienstumgebung.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	AddressResponse	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	DefaultErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get IP addresses assigned to an App Service Environment.

Beispielanforderung

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


/**
 * 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

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

Beispiel für eine Antwort

Statuscode:: 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"
      }
    ]
  }
}

Definitionen

Name	Beschreibung
AddressResponse	Beschreibt die öffentliche Haupt-IP-Adresse und alle zusätzlichen virtuellen IP-Adressen.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DefaultErrorResponse	Fehlerantwort des App-Diensts.
DefaultErrorResponseError	Fehlermodell.
DefaultErrorResponseErrorDetailsItem	Detaillierte Fehler.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
VirtualIPMapping	Virtuelle IP-Zuordnung.

AddressResponse

Objekt

Beschreibt die öffentliche Haupt-IP-Adresse und alle zusätzlichen virtuellen IP-Adressen.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Art der Ressource.
name	string	Der Name der Ressource
properties.internalIpAddress	string	Interne IP-Adresse des virtuellen Netzwerks der App Service-Umgebung, wenn sie sich im internen Lastenausgleichsmodus befindet.
properties.outboundIpAddresses	string[]	IP-Adressen, die bei ausgehenden Verbindungen angezeigt werden.
properties.serviceIpAddress	string	Wichtigste öffentliche virtuelle IP-Adresse.
properties.vipMappings	VirtualIPMapping[]	Zusätzliche virtuelle IPs.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Objekt

Fehlerantwort des App-Diensts.

Name	Typ	Beschreibung
error	DefaultErrorResponseError	Fehlermodell.

DefaultErrorResponseError

Objekt

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zur programmgesteuerten Identifizierung des Fehlers.
details	DefaultErrorResponseErrorDetailsItem[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen von Fehlern.
message	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.
target	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.

DefaultErrorResponseErrorDetailsItem

Objekt

Detaillierte Fehler.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zur programmgesteuerten Identifizierung des Fehlers.
message	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.
target	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

VirtualIPMapping

Objekt

Virtuelle IP-Zuordnung.

Name	Typ	Beschreibung
inUse	boolean	Wird die virtuelle IP-Zuordnung verwendet.
internalHttpPort	integer (int32)	Interner HTTP-Port.
internalHttpsPort	integer (int32)	Interner HTTPS-Port.
serviceName	string	Name des Diensts, dem die virtuelle IP zugewiesen ist
virtualIP	string	Virtuelle IP-Adresse.

Freigeben über

App Service Environments - Get Vip Info

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Get IP addresses assigned to an App Service Environment.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AddressResponse

createdByType

DefaultErrorResponse

DefaultErrorResponseError

DefaultErrorResponseErrorDetailsItem

systemData

VirtualIPMapping