App Service Environments - Get Vip Info

Služba:

App Service

Verze rozhraní API:

2025-05-01

Popis pro Získání IP adres přiřazených k App Service Environment.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
name	path	True	string	Název služby App Service Environment
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	AddressResponse	Operace Azure byla úspěšně dokončena.
Other Status Codes	DefaultErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get IP addresses assigned to an App Service Environment.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
AddressResponse	Popisuje hlavní veřejnou IP adresu a všechny další virtuální IP adresy.
createdByType	Typ identity, která prostředek vytvořila.
DefaultErrorResponse	Odpověď na chybu služby App Service
DefaultErrorResponseError	Chybový model
DefaultErrorResponseErrorDetailsItem	Podrobné chyby.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
VirtualIPMapping	Mapování virtuálních IP adres.

AddressResponse

Objekt

Popisuje hlavní veřejnou IP adresu a všechny další virtuální IP adresy.

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Druh prostředku.
name	string	Název prostředku
properties.internalIpAddress	string	Interní IP adresa Virtual Network App Service Environment, pokud je v režimu interního vyrovnávání zátěže.
properties.outboundIpAddresses	string[]	IP adresy zobrazující se na odchozích připojeních.
properties.serviceIpAddress	string	Hlavní veřejná virtuální IP adresa.
properties.vipMappings	VirtualIPMapping[]	Další virtuální IP adresy.
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
type	string	Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Objekt

Odpověď na chybu služby App Service

Name	Typ	Description
error	DefaultErrorResponseError	Chybový model

DefaultErrorResponseError

Objekt

Chybový model

Name	Typ	Description
code	string	Standardizovaný řetězec pro programovou identifikaci chyby.
details	DefaultErrorResponseErrorDetailsItem[]	Podrobné chyby.
innererror	string	Další informace k chybě ladění.
message	string	Podrobný popis chyby a informace o ladění.
target	string	Podrobný popis chyby a informace o ladění.

DefaultErrorResponseErrorDetailsItem

Objekt

Podrobné chyby.

Name	Typ	Description
code	string	Standardizovaný řetězec pro programovou identifikaci chyby.
message	string	Podrobný popis chyby a informace o ladění.
target	string	Podrobný popis chyby a informace o ladění.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

VirtualIPMapping

Objekt

Mapování virtuálních IP adres.

Name	Typ	Description
inUse	boolean	Používá se virtuální mapování IP.
internalHttpPort	integer (int32)	Interní port HTTP.
internalHttpsPort	integer (int32)	Interní port HTTPS.
serviceName	string	název služby, ke které je virtuální IP přiřazena
virtualIP	string	Virtuální IP adresa.