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

Managed Environments - List By Resource Group

参考

Service:: Azure Container Apps

API Version:: 2024-03-01

获取资源组中的所有环境。
获取资源组中的所有托管环境。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

响应

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

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

List environments by resource group

Sample Request

HTTP

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

Sample Response

Status code:: 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/examplerg/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,
        "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",
        "vnetConfiguration": {
          "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"
        },
        "infrastructureResourceGroup": "capp-svc-demo1-northcentralus"
      }
    }
  ]
}

定义

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

AppLogsConfiguration

应用程序日志的配置

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

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

CustomDomainConfiguration

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

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

DaprConfiguration

配置属性 Dapr 组件

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

DefaultErrorResponse

App 服务错误响应。

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

Details

详细信息或错误

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

Encryption

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

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

EnvironmentProvisioningState

环境的预配状态。

名称	类型	说明
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
UpgradeFailed	string
UpgradeRequested	string
Waiting	string

Error

错误模型。

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

KedaConfiguration

配置属性 Keda 组件

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

LogAnalyticsConfiguration

Log Analytics 配置，仅在目标配置为“log-analytics”时提供

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

ManagedEnvironment

用于托管容器应用的环境

名称	类型	说明
id	string	资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	环境的种类。
location	string	资源所在的地理位置
name	string	资源的名称
properties.appLogsConfiguration	AppLogsConfiguration	群集配置，使日志守护程序能够将应用日志导出到目标。目前仅支持“log-analytics”
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

环境集合

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

Mtls

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

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

PeerAuthentication

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

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

PeerTrafficConfiguration

托管环境的对等流量设置

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

systemData

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

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

VnetConfiguration

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

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

WorkloadProfile

工作负载配置文件，用于确定容器应用执行的范围。

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