你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Managed Environments - List By Subscription

参考

服务:: Azure Container Apps

API 版本:: 2024-03-01

获取订阅的所有环境。
获取订阅的所有托管环境。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.App/managedEnvironments?api-version=2024-03-01

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	ManagedEnvironmentsCollection	还行
Other Status Codes	DefaultErrorResponse	常见的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

List environments by subscription

示例请求

GET https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/providers/Microsoft.App/managedEnvironments?api-version=2024-03-01


/**
 * Samples for ManagedEnvironments List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/
     * ManagedEnvironments_ListBySubscription.json
     */
    /**
     * Sample code: List environments by subscription.
     * 
     * @param manager Entry point to ContainerAppsApiManager.
     */
    public static void
        listEnvironmentsBySubscription(com.azure.resourcemanager.appcontainers.ContainerAppsApiManager manager) {
        manager.managedEnvironments().list(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

from azure.identity import DefaultAzureCredential

from azure.mgmt.appcontainers import ContainerAppsAPIClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appcontainers
# USAGE
    python managed_environments_list_by_subscription.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 = ContainerAppsAPIClient(
        credential=DefaultAzureCredential(),
        subscription_id="8efdecc5-919e-44eb-b179-915dca89ebf9",
    )

    response = client.managed_environments.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ManagedEnvironments_ListBySubscription.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

package armappcontainers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/edf14cc0a577f6b9c4e3ce018cec0c383e64b7b0/specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ManagedEnvironments_ListBySubscription.json
func ExampleManagedEnvironmentsClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewManagedEnvironmentsClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ManagedEnvironmentsCollection = armappcontainers.ManagedEnvironmentsCollection{
		// 	Value: []*armappcontainers.ManagedEnvironment{
		// 		{
		// 			Name: to.Ptr("jlaw-demo1"),
		// 			Type: to.Ptr("Microsoft.App/managedEnvironments"),
		// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1"),
		// 			Location: to.Ptr("North Central US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armappcontainers.ManagedEnvironmentProperties{
		// 				CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
		// 					CustomDomainVerificationID: to.Ptr("custom domain verification id"),
		// 					DNSSuffix: to.Ptr("www.my-name.com"),
		// 					ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
		// 					SubjectName: to.Ptr("CN=www.my-name.com"),
		// 					Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
		// 				},
		// 				DefaultDomain: to.Ptr("jlaw-demo1.k4apps.io"),
		// 				EventStreamEndpoint: to.Ptr("testEndpoint"),
		// 				InfrastructureResourceGroup: to.Ptr("capp-svc-jlaw-demo1-northcentralus"),
		// 				ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
		// 				StaticIP: to.Ptr("20.42.33.145"),
		// 				VnetConfiguration: &armappcontainers.VnetConfiguration{
		// 					InfrastructureSubnetID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"),
		// 				},
		// 				WorkloadProfiles: []*armappcontainers.WorkloadProfile{
		// 					{
		// 						Name: to.Ptr("My-GP-01"),
		// 						MaximumCount: to.Ptr[int32](12),
		// 						MinimumCount: to.Ptr[int32](3),
		// 						WorkloadProfileType: to.Ptr("GeneralPurpose"),
		// 					},
		// 					{
		// 						Name: to.Ptr("My-MO-01"),
		// 						MaximumCount: to.Ptr[int32](6),
		// 						MinimumCount: to.Ptr[int32](3),
		// 						WorkloadProfileType: to.Ptr("MemoryOptimized"),
		// 					},
		// 					{
		// 						Name: to.Ptr("My-CO-01"),
		// 						MaximumCount: to.Ptr[int32](6),
		// 						MinimumCount: to.Ptr[int32](3),
		// 						WorkloadProfileType: to.Ptr("ComputeOptimized"),
		// 					},
		// 					{
		// 						Name: to.Ptr("My-consumption-01"),
		// 						WorkloadProfileType: to.Ptr("Consumption"),
		// 				}},
		// 				ZoneRedundant: to.Ptr(true),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("demo1"),
		// 			Type: to.Ptr("Microsoft.App/managedEnvironments"),
		// 			ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/DemoRG/providers/Microsoft.App/managedEnvironments/demo1"),
		// 			Location: to.Ptr("North Central US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armappcontainers.ManagedEnvironmentProperties{
		// 				CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
		// 					CustomDomainVerificationID: to.Ptr("custom domain verification id"),
		// 					DNSSuffix: to.Ptr("www.my-name2.com"),
		// 					ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
		// 					SubjectName: to.Ptr("CN=www.my-name2.com"),
		// 					Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
		// 				},
		// 				DefaultDomain: to.Ptr("demo1.k4apps.io"),
		// 				EventStreamEndpoint: to.Ptr("testEndpoint"),
		// 				InfrastructureResourceGroup: to.Ptr("capp-svc-demo1-northcentralus"),
		// 				ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
		// 				StaticIP: to.Ptr("52.142.21.61"),
		// 				VnetConfiguration: &armappcontainers.VnetConfiguration{
		// 					InfrastructureSubnetID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"),
		// 				},
		// 				ZoneRedundant: to.Ptr(true),
		// 			},
		// 	}},
		// }
	}
}

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

const { ContainerAppsAPIClient } = require("@azure/arm-appcontainers");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get all Managed Environments for a subscription.
 *
 * @summary Get all Managed Environments for a subscription.
 * x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ManagedEnvironments_ListBySubscription.json
 */
async function listEnvironmentsBySubscription() {
  const subscriptionId =
    process.env["APPCONTAINERS_SUBSCRIPTION_ID"] || "8efdecc5-919e-44eb-b179-915dca89ebf9";
  const credential = new DefaultAzureCredential();
  const client = new ContainerAppsAPIClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.managedEnvironments.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

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

// Generated from example definition: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ManagedEnvironments_ListBySubscription.json
// this example is just showing the usage of "ManagedEnvironments_ListBySubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "8efdecc5-919e-44eb-b179-915dca89ebf9";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (ContainerAppManagedEnvironmentResource item in subscriptionResource.GetContainerAppManagedEnvironmentsAsync())
{
    // the variable item 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
    ContainerAppManagedEnvironmentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1",
      "name": "jlaw-demo1",
      "type": "Microsoft.App/managedEnvironments",
      "location": "North Central US",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "deploymentErrors": null,
        "defaultDomain": "jlaw-demo1.k4apps.io",
        "staticIp": "20.42.33.145",
        "appLogsConfiguration": null,
        "zoneRedundant": true,
        "vnetConfiguration": {
          "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"
        },
        "customDomainConfiguration": {
          "customDomainVerificationId": "custom domain verification id",
          "dnsSuffix": "www.my-name.com",
          "subjectName": "CN=www.my-name.com",
          "expirationDate": "2022-11-06T04:00:00Z",
          "thumbprint": "CERTIFICATE_THUMBPRINT"
        },
        "eventStreamEndpoint": "testEndpoint",
        "workloadProfiles": [
          {
            "name": "My-GP-01",
            "workloadProfileType": "GeneralPurpose",
            "minimumCount": 3,
            "maximumCount": 12
          },
          {
            "name": "My-MO-01",
            "workloadProfileType": "MemoryOptimized",
            "minimumCount": 3,
            "maximumCount": 6
          },
          {
            "name": "My-CO-01",
            "workloadProfileType": "ComputeOptimized",
            "minimumCount": 3,
            "maximumCount": 6
          },
          {
            "name": "My-consumption-01",
            "workloadProfileType": "Consumption"
          }
        ],
        "infrastructureResourceGroup": "capp-svc-jlaw-demo1-northcentralus"
      }
    },
    {
      "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/DemoRG/providers/Microsoft.App/managedEnvironments/demo1",
      "name": "demo1",
      "type": "Microsoft.App/managedEnvironments",
      "location": "North Central US",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "deploymentErrors": null,
        "defaultDomain": "demo1.k4apps.io",
        "staticIp": "52.142.21.61",
        "appLogsConfiguration": null,
        "zoneRedundant": true,
        "vnetConfiguration": {
          "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"
        },
        "customDomainConfiguration": {
          "customDomainVerificationId": "custom domain verification id",
          "dnsSuffix": "www.my-name2.com",
          "subjectName": "CN=www.my-name2.com",
          "expirationDate": "2022-11-06T04:00:00Z",
          "thumbprint": "CERTIFICATE_THUMBPRINT"
        },
        "eventStreamEndpoint": "testEndpoint",
        "infrastructureResourceGroup": "capp-svc-demo1-northcentralus"
      }
    }
  ]
}

定义

名称	说明
AppLogsConfiguration	应用程序日志的配置
createdByType	创建资源的标识的类型。
CustomDomainConfiguration	应用环境自定义域的配置属性
DaprConfiguration	配置属性 Dapr 组件
DefaultErrorResponse	应用服务错误响应。
Details	详细信息或错误
Encryption	托管环境的对等流量加密设置
EnvironmentProvisioningState	环境的预配状态。
Error	错误模型。
KedaConfiguration	配置属性 Keda 组件
LogAnalyticsConfiguration	仅当目标配置为“log-analytics”时，才必须提供 Log Analytics 配置
ManagedEnvironment	用于托管容器应用的环境
ManagedEnvironmentsCollection	环境集合
Mtls	相互 TLS 身份验证的配置属性
PeerAuthentication	托管环境的对等身份验证设置
PeerTrafficConfiguration	托管环境的对等流量设置
systemData	与创建和上次修改资源相关的元数据。
VnetConfiguration	用于加入虚拟网络的应用环境的配置属性
WorkloadProfile	用于限定容器应用执行的工作负荷配置文件。

AppLogsConfiguration

Object

应用程序日志的配置

名称	类型	说明
destination	string	日志目标可以是“log-analytics”、“azure-monitor”或“none”
logAnalyticsConfiguration	LogAnalyticsConfiguration	仅当目标配置为“log-analytics”时，才必须提供 Log Analytics 配置

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

CustomDomainConfiguration

Object

应用环境自定义域的配置属性

名称	类型	说明
certificatePassword	string	证书密码
certificateValue	string (byte)	PFX 或 PEM Blob
customDomainVerificationId	string	用于验证域名所有权的 ID
dnsSuffix	string	环境域的 Dns 后缀
expirationDate	string (date-time)	证书到期日期。
subjectName	string	证书的使用者名称。
thumbprint	string	证书指纹。

DaprConfiguration

Object

配置属性 Dapr 组件

名称	类型	说明
version	string	Dapr 的版本

DefaultErrorResponse

Object

应用服务错误响应。

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

Details

Object

详细信息或错误

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

Encryption

Object

托管环境的对等流量加密设置

名称	类型	说明
enabled	boolean	指示是否启用对等流量加密的布尔值

EnvironmentProvisioningState

枚举

环境的预配状态。

值	说明
Canceled
Failed
InfrastructureSetupComplete
InfrastructureSetupInProgress
InitializationInProgress
ScheduledForDelete
Succeeded
UpgradeFailed
UpgradeRequested
Waiting

Error

Object

错误模型。

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

KedaConfiguration

Object

配置属性 Keda 组件

名称	类型	说明
version	string	Keda 的版本

LogAnalyticsConfiguration

Object

仅当目标配置为“log-analytics”时，才必须提供 Log Analytics 配置

名称	类型	说明
customerId	string	Log Analytics 客户 ID
sharedKey	string	Log Analytics 客户密钥

ManagedEnvironment

Object

用于托管容器应用的环境

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	环境类型。
location	string	资源所在的地理位置
name	string	资源的名称
properties.appLogsConfiguration	AppLogsConfiguration	群集配置，使日志守护程序能够将应用日志导出到配置的目标。
properties.customDomainConfiguration	CustomDomainConfiguration	环境的自定义域配置
properties.daprAIConnectionString	string	Dapr 用于将服务导出到服务通信遥测的 Application Insights 连接字符串
properties.daprAIInstrumentationKey	string	Dapr 用于将服务导出到服务通信遥测的 Azure Monitor 检测密钥
properties.daprConfiguration	DaprConfiguration	Dapr 组件的配置。
properties.defaultDomain	string	群集的默认域名
properties.deploymentErrors	string	部署或部署验证期间发生的任何错误
properties.eventStreamEndpoint	string	环境的事件流的终结点。
properties.infrastructureResourceGroup	string	为托管环境创建的用于托管基础结构资源的平台托管资源组的名称。如果提供了子网 ID，则会在子网所在的同一订阅中创建此资源组。
properties.kedaConfiguration	KedaConfiguration	Keda 组件的配置。
properties.peerAuthentication	PeerAuthentication	托管环境的对等身份验证设置
properties.peerTrafficConfiguration	PeerTrafficConfiguration	托管环境的对等流量设置
properties.provisioningState	EnvironmentProvisioningState	环境的预配状态。
properties.staticIp	string	环境的静态 IP
properties.vnetConfiguration	VnetConfiguration	环境的 Vnet 配置
properties.workloadProfiles	WorkloadProfile[]	为托管环境配置的工作负荷配置文件。
properties.zoneRedundant	boolean	此托管环境是否为区域冗余。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ManagedEnvironmentsCollection

Object

环境集合

名称	类型	说明
nextLink	string	链接到下一页的资源。
value	ManagedEnvironment[]	资源集合。

Mtls

Object

相互 TLS 身份验证的配置属性

名称	类型	说明
enabled	boolean	指示是否启用相互 TLS 身份验证的布尔值

PeerAuthentication

Object

托管环境的对等身份验证设置

名称	类型	说明
mtls	Mtls	托管环境的相互 TLS 身份验证设置

PeerTrafficConfiguration

Object

托管环境的对等流量设置

名称	类型	说明
encryption	Encryption	托管环境的对等流量加密设置

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

VnetConfiguration

Object

用于加入虚拟网络的应用环境的配置属性

名称	类型	说明
dockerBridgeCidr	string	分配给 Docker 网桥的 CIDR 表示法 IP 范围。不得与任何其他提供的 IP 范围重叠。
infrastructureSubnetId	string	基础结构组件的子网的资源 ID。不得与任何其他提供的 IP 范围重叠。
internal	boolean	指示环境只有内部负载均衡器的布尔值。这些环境没有公共静态 IP 资源。如果启用此属性，它们必须提供 infrastructureSubnetId
platformReservedCidr	string	CIDR 表示法中的 IP 范围，可为环境基础结构 IP 地址保留。不得与任何其他提供的 IP 范围重叠。
platformReservedDnsIP	string	由 platformReservedCidr 定义的 IP 地址，将为内部 DNS 服务器保留。

WorkloadProfile

Object

用于限定容器应用执行的工作负荷配置文件。

名称	类型	说明
maximumCount	integer (int32)	最大容量。
minimumCount	integer (int32)	最小容量。
name	string	要运行的工作负荷的工作负荷配置文件类型。
workloadProfileType	string	要运行的工作负荷的工作负荷配置文件类型。