App Service Environments - Get

服务:

App Service

API 版本:

2024-11-01

获取应用服务环境的属性的说明。

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

URI 参数

名称	在	必需	类型	说明
name	path	True	string	应用服务环境的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	资源所属的资源组的名称。
subscriptionId	path	True	string	Azure 订阅 ID。 这是 GUID 格式的字符串（例如 000000000-0000-0000-0000-00000000000000）。
api-version	query	True	string	API 版本

响应

名称	类型	说明
200 OK	AppServiceEnvironmentResource	好的
Other Status Codes	DefaultErrorResponse	应用服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get the properties of an App Service Environment.

示例请求

HTTP

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

Java

/**
 * Samples for AppServiceEnvironments GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_Get.json
     */
    /**
     * Sample code: Get the properties of an App Service Environment.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getThePropertiesOfAnAppServiceEnvironment(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getAppServiceEnvironments().getByResourceGroupWithResponse("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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python app_service_environments_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.app_service_environments.get(
        resource_group_name="test-rg",
        name="test-ase",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_Get.json
if __name__ == "__main__":
    main()

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_Get.json
func ExampleEnvironmentsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewEnvironmentsClient().Get(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.EnvironmentResource = armappservice.EnvironmentResource{
	// 	Name: to.Ptr("test-ase"),
	// 	Type: to.Ptr("Microsoft.Web/hostingEnvironments"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase"),
	// 	Kind: to.Ptr("ASEV3"),
	// 	Location: to.Ptr("South Central US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armappservice.Environment{
	// 		DedicatedHostCount: to.Ptr[int32](0),
	// 		DNSSuffix: to.Ptr("test-ase.p.azurewebsites.net"),
	// 		FrontEndScaleFactor: to.Ptr[int32](15),
	// 		HasLinuxWorkers: to.Ptr(true),
	// 		InternalLoadBalancingMode: to.Ptr(armappservice.LoadBalancingModeNone),
	// 		IpsslAddressCount: to.Ptr[int32](0),
	// 		MaximumNumberOfMachines: to.Ptr[int32](250),
	// 		MultiSize: to.Ptr("Standard_D2d_v4"),
	// 		NetworkingConfiguration: &armappservice.AseV3NetworkingConfiguration{
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking"),
	// 			Properties: &armappservice.AseV3NetworkingConfigurationProperties{
	// 				AllowNewPrivateEndpointConnections: to.Ptr(false),
	// 				ExternalInboundIPAddresses: []*string{
	// 					to.Ptr("52.153.248.36")},
	// 					FtpEnabled: to.Ptr(false),
	// 					InternalInboundIPAddresses: []*string{
	// 					},
	// 					LinuxOutboundIPAddresses: []*string{
	// 						to.Ptr("20.88.241.56"),
	// 						to.Ptr("20.88.241.9")},
	// 						RemoteDebugEnabled: to.Ptr(false),
	// 						WindowsOutboundIPAddresses: []*string{
	// 							to.Ptr("20.88.241.56"),
	// 							to.Ptr("20.88.241.9")},
	// 						},
	// 					},
	// 					ProvisioningState: to.Ptr(armappservice.ProvisioningStateSucceeded),
	// 					Status: to.Ptr(armappservice.HostingEnvironmentStatusReady),
	// 					Suspended: to.Ptr(false),
	// 					VirtualNetwork: &armappservice.VirtualNetworkProfile{
	// 						Name: to.Ptr("delegated"),
	// 						Type: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
	// 						ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated"),
	// 						Subnet: to.Ptr(""),
	// 					},
	// 					ZoneRedundant: to.Ptr(false),
	// 				},
	// 			}
}

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

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Get the properties of an App Service Environment.
 *
 * @summary Description for Get the properties of an App Service Environment.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_Get.json
 */
async function getThePropertiesOfAnAppServiceEnvironment() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "test-rg";
  const name = "test-ase";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.appServiceEnvironments.get(resourceGroupName, name);
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_Get.json
// this example is just showing the usage of "AppServiceEnvironments_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "test-rg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this AppServiceEnvironmentResource
AppServiceEnvironmentCollection collection = resourceGroupResource.GetAppServiceEnvironments();

// invoke the operation
string name = "test-ase";
NullableResponse<AppServiceEnvironmentResource> response = await collection.GetIfExistsAsync(name);
AppServiceEnvironmentResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    AppServiceEnvironmentData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

示例响应

状态代码:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
  "name": "test-ase",
  "type": "Microsoft.Web/hostingEnvironments",
  "kind": "ASEV3",
  "location": "South Central US",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "status": "Ready",
    "virtualNetwork": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
      "name": "delegated",
      "type": "Microsoft.Network/virtualNetworks/subnets",
      "subnet": ""
    },
    "internalLoadBalancingMode": "None",
    "multiSize": "Standard_D2d_v4",
    "multiRoleCount": null,
    "ipsslAddressCount": 0,
    "dnsSuffix": "test-ase.p.azurewebsites.net",
    "maximumNumberOfMachines": 250,
    "frontEndScaleFactor": 15,
    "suspended": false,
    "clusterSettings": null,
    "userWhitelistedIpRanges": null,
    "hasLinuxWorkers": true,
    "dedicatedHostCount": 0,
    "zoneRedundant": false,
    "networkingConfiguration": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
      "properties": {
        "windowsOutboundIpAddresses": [
          "20.88.241.56",
          "20.88.241.9"
        ],
        "linuxOutboundIpAddresses": [
          "20.88.241.56",
          "20.88.241.9"
        ],
        "externalInboundIpAddresses": [
          "52.153.248.36"
        ],
        "internalInboundIpAddresses": [],
        "allowNewPrivateEndpointConnections": false,
        "ftpEnabled": false,
        "remoteDebugEnabled": false,
        "inboundIpAddressOverride": null
      }
    }
  }
}

定义

名称	说明
AppServiceEnvironmentResource	应用服务环境 ARM 资源。
AseV3NetworkingConfiguration	ASE 的网络配置的完整视图。
CustomDnsSuffixConfiguration	ASEv3 的自定义域后缀配置的完整视图。
CustomDnsSuffixProvisioningState
DefaultErrorResponse	应用服务错误响应。
Details
Error	错误模型。
HostingEnvironmentStatus	应用服务环境的当前状态。
LoadBalancingMode	指定要在应用服务环境的虚拟网络中内部提供服务的终结点。
NameValuePair	名称值对。
ProvisioningState	应用服务环境的预配状态。
UpgradeAvailability	升级是否可用于此应用服务环境。
UpgradePreference	升级首选项
VirtualNetworkProfile	使用虚拟网络的规范。

AppServiceEnvironmentResource

Object

应用服务环境 ARM 资源。

名称	类型	默认值	说明
id	string		资源 ID。
kind	string		资源类型。 如果资源是应用，可以参考 https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference 了解类型支持的详细信息值。
location	string		资源位置。
name	string		资源名称。
properties.clusterSettings	NameValuePair[]		用于更改应用服务环境的行为的自定义设置。
properties.customDnsSuffixConfiguration	CustomDnsSuffixConfiguration		ASEv3 的自定义域后缀配置的完整视图。
properties.dedicatedHostCount	integer (int32)		专用主机计数
properties.dnsSuffix	string		应用服务环境的 DNS 后缀。
properties.frontEndScaleFactor	integer (int32)		前端的缩放因子。
properties.hasLinuxWorkers	boolean		显示 ASE 是否具有 Linux 辅助角色的标志
properties.internalLoadBalancingMode	LoadBalancingMode		指定要在应用服务环境的虚拟网络中内部提供服务的终结点。
properties.ipsslAddressCount	integer (int32)		为应用服务环境保留的 IP SSL 地址数。
properties.maximumNumberOfMachines	integer (int32)		应用服务环境中的最大 VM 数。
properties.multiRoleCount	integer (int32)		前端实例数。
properties.multiSize	string		前端 VM 大小，例如“中型”、“大型”。
properties.networkingConfiguration	AseV3NetworkingConfiguration		ASE 的网络配置的完整视图。
properties.provisioningState	ProvisioningState		应用服务环境的预配状态。
properties.status	HostingEnvironmentStatus		应用服务环境的当前状态。
properties.suspended	boolean		如果应用服务环境暂停，则 true;否则，false。 可以暂停环境，例如，当管理终结点不再可用时（很可能是因为 NSG 阻止了传入流量）。
properties.upgradeAvailability	UpgradeAvailability		升级是否可用于此应用服务环境。
properties.upgradePreference	UpgradePreference	None	升级首选项
properties.userWhitelistedIpRanges	string[]		用户向 ASE db 上的允许列表添加了 IP 范围
properties.virtualNetwork	VirtualNetworkProfile		虚拟网络的说明。
properties.zoneRedundant	boolean		此应用服务环境是否为区域冗余。
tags	object		资源标记。
type	string		资源类型。

AseV3NetworkingConfiguration

Object

ASE 的网络配置的完整视图。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
name	string	资源名称。
properties.allowNewPrivateEndpointConnections	boolean	用于在 ASE 上启用和禁用新的专用终结点连接创建的属性
properties.externalInboundIpAddresses	string[]
properties.ftpEnabled	boolean	在 ASEV3 上启用或禁用 FTP 的属性
properties.inboundIpAddressOverride	string	客户提供入站 IP 地址。 只能在 Ase create 上设置。
properties.internalInboundIpAddresses	string[]
properties.linuxOutboundIpAddresses	string[]
properties.remoteDebugEnabled	boolean	在 ASEV3 上启用或禁用远程调试的属性
properties.windowsOutboundIpAddresses	string[]
type	string	资源类型。

CustomDnsSuffixConfiguration

Object

ASEv3 的自定义域后缀配置的完整视图。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
name	string	资源名称。
properties.certificateUrl	string	引用 Azure Key Vault 证书机密的 URL，该机密应用作具有自定义域后缀的网站的默认 SSL/TLS 证书。
properties.dnsSuffix	string	用于 ASE 上部署的所有站点的默认自定义域后缀。
properties.keyVaultReferenceIdentity	string	用于解析密钥保管库证书引用的用户分配标识。 如果未指定，将使用系统分配的 ASE 标识（如果可用）。
properties.provisioningDetails	string
properties.provisioningState	CustomDnsSuffixProvisioningState
type	string	资源类型。

CustomDnsSuffixProvisioningState

枚举

值	说明
Degraded
Failed
InProgress
Succeeded

DefaultErrorResponse

Object

应用服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

Object

名称	类型	说明
code	string	标准化字符串，以编程方式标识错误。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Error

Object

错误模型。

名称	类型	说明
code	string	标准化字符串，以编程方式标识错误。
details	Details[]	详细错误。
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

HostingEnvironmentStatus

枚举

应用服务环境的当前状态。

值	说明
Deleting
Preparing
Ready
Scaling

LoadBalancingMode

枚举

指定要在应用服务环境的虚拟网络中内部提供服务的终结点。

值	说明
None
Publishing
Web
Web, Publishing

NameValuePair

Object

名称值对。

名称	类型	说明
name	string	配对名称。
value	string	对值。

ProvisioningState

枚举

应用服务环境的预配状态。

值	说明
Canceled
Deleting
Failed
InProgress
Succeeded

UpgradeAvailability

枚举

升级是否可用于此应用服务环境。

值	说明
None	此应用服务环境当前没有可用的升级
Ready	升级已准备好在此应用服务环境中手动启动

UpgradePreference

枚举

升级首选项

值	说明
Early	此应用服务环境将在具有升级首选项“延迟”的同一区域中的其他人之前升级
Late	此应用服务环境将在具有升级首选项“早期”的同一区域中的其他人升级
Manual	仅 ASEv3。 升级可用后，此应用服务环境将等待 10 天才能手动启动升级。 10 天后，升级将自动开始
None	此应用服务环境何时升级时没有首选项

VirtualNetworkProfile

Object

使用虚拟网络的规范。

名称	类型	说明
id	string	虚拟网络的资源 ID。
name	string	虚拟网络的名称（只读）。
subnet	string	虚拟网络中的子网。
type	string	虚拟网络的资源类型（只读）。