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

Managed Environments - Get

服务:: Azure Container Apps

API 版本:: 2026-01-01

获取用于托管容器应用的托管环境的属性。

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

URI 参数

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

响应

名称	类型	说明
200 OK	ManagedEnvironment	好的
Other Status Codes	ErrorResponse	常见错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get environments by name

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "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",
    "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"
      }
    ],
    "kedaConfiguration": {
      "version": "2.8.1"
    },
    "daprConfiguration": {
      "version": "1.9"
    },
    "infrastructureResourceGroup": "capp-svc-jlaw-demo1-northcentralus",
    "peerAuthentication": {
      "mtls": {
        "enabled": true
      }
    },
    "peerTrafficConfiguration": {
      "encryption": {
        "enabled": true
      }
    },
    "ingressConfiguration": {
      "workloadProfileName": "My-CO-01",
      "terminationGracePeriodSeconds": 3600,
      "headerCountLimit": 30,
      "requestIdleTimeout": 5
    }
  }
}

定义

名称	说明
AppLogsConfiguration	应用程序日志的配置
CertificateKeyVaultProperties	存储在 Key Vault 中的证书的属性。
createdByType	创建资源的标识的类型。
CustomDomainConfiguration	应用环境自定义域的配置属性
DaprConfiguration	配置属性 Dapr 组件
Encryption	托管环境的对等流量加密设置
EnvironmentProvisioningState	环境的预配状态。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
IngressConfiguration	入口组件的设置，包括工作负载配置文件、缩放和连接处理。
KedaConfiguration	配置属性 Keda 组件
LogAnalyticsConfiguration	仅当目标配置为“log-analytics”时，才必须提供 Log Analytics 配置
ManagedEnvironment	用于托管容器应用的环境
ManagedServiceIdentity	托管服务标识（系统分配和/或用户分配的标识）
ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
Mtls	相互 TLS 身份验证的配置属性
PeerAuthentication	托管环境的对等身份验证设置
PeerTrafficConfiguration	托管环境的对等流量设置
PrivateEndpoint	专用终结点资源。
PrivateEndpointConnection	专用终结点连接资源。
PrivateEndpointConnectionProvisioningState	当前预配状态。
PrivateEndpointServiceConnectionStatus	专用终结点连接状态。
PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
PublicNetworkAccess	允许或阻止所有公共流量的属性。允许的值：“Enabled”、“Disabled”。
systemData	与创建和上次修改资源相关的元数据。
UserAssignedIdentity	用户分配的标识属性
VnetConfiguration	用于加入虚拟网络的应用环境的配置属性
WorkloadProfile	用于限定容器应用执行的工作负荷配置文件。

AppLogsConfiguration

对象

应用程序日志的配置

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

CertificateKeyVaultProperties

对象

存储在 Key Vault 中的证书的属性。

名称	类型	说明
identity	string	使用Azure Key Vault进行身份验证的托管标识的资源 ID，或使用系统分配的标识。
keyVaultUrl	string (uri)	指向保存证书的 Azure Key Vault 机密的 URL。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

CustomDomainConfiguration

对象

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

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

DaprConfiguration

对象

配置属性 Dapr 组件

名称	类型	说明
version	string	Dapr 版本

Encryption

对象

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

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

EnvironmentProvisioningState

枚举

环境的预配状态。

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

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

IngressConfiguration

对象

入口组件的设置，包括工作负载配置文件、缩放和连接处理。

名称	类型	说明
headerCountLimit	integer (int32)	入口允许的每个请求的最大标头数。必须至少为 1。默认为 100。
requestIdleTimeout	integer (int32)	空闲请求超时之前的持续时间（以分钟为单位）。必须在 4 到 30 之间（含）。默认为 4 分钟。
terminationGracePeriodSeconds	integer (int32)	允许活动连接在终止时完成的时间（以秒为单位）。必须介于 0 和 3600 之间。默认为 480 秒。
workloadProfileName	string	Ingress 组件使用的工作负载配置文件的名称。必填。

KedaConfiguration

对象

配置属性 Keda 组件

名称	类型	说明
version	string	科达版本

LogAnalyticsConfiguration

对象

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

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

ManagedEnvironment

对象

用于托管容器应用的环境

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
identity	ManagedServiceIdentity	托管环境的托管标识可以与其他 Azure 服务交互，而无需在代码中维护任何机密或凭据。
kind	string	环境类型。
location	string	资源所在的地理位置
name	string	资源的名称
properties.appLogsConfiguration	AppLogsConfiguration	群集配置，使日志守护程序能够将应用日志导出到配置的目标。
properties.customDomainConfiguration	CustomDomainConfiguration	环境的自定义域配置
properties.daprAIConnectionString	string	Dapr 用于将服务导出到服务通信遥测的 Application Insights connection string
properties.daprAIInstrumentationKey	string	Azure Monitor Dapr 用于将服务导出到服务通信遥测的检测密钥
properties.daprConfiguration	DaprConfiguration	Dapr 组件的配置。
properties.defaultDomain	string	集群的默认域名
properties.deploymentErrors	string	部署或部署验证期间发生的任何错误
properties.eventStreamEndpoint	string	环境的事件流的终结点。
properties.infrastructureResourceGroup	string	为托管环境创建的用于托管基础结构资源的平台托管资源组的名称。如果提供了子网 ID，则会在子网所在的同一订阅中创建此资源组。
properties.ingressConfiguration	IngressConfiguration	Managed Environment 的 Ingress 配置。
properties.kedaConfiguration	KedaConfiguration	Keda 组件的配置。
properties.peerAuthentication	PeerAuthentication	托管环境的对等身份验证设置
properties.peerTrafficConfiguration	PeerTrafficConfiguration	托管环境的对等流量设置
properties.privateEndpointConnections	PrivateEndpointConnection[]	与资源的专用终结点连接。
properties.provisioningState	EnvironmentProvisioningState	环境的预配状态。
properties.publicNetworkAccess	PublicNetworkAccess	允许或阻止所有公共流量的属性。允许的值：“Enabled”、“Disabled”。
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”

ManagedServiceIdentity

对象

托管服务标识（系统分配和/或用户分配的标识）

名称	类型	说明
principalId	string (uuid)	系统分配标识的服务主体 ID。此属性仅针对系统分配的标识提供。
tenantId	string (uuid)	系统分配标识的租户 ID。此属性仅针对系统分配的标识提供。
type	ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned 标识与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。字典值可以是请求中的空对象（{}）。

ManagedServiceIdentityType

枚举

托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。

值	说明
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Mtls

对象

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

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

PeerAuthentication

对象

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

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

PeerTrafficConfiguration

对象

托管环境的对等流量设置

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

PrivateEndpoint

对象

专用终结点资源。

名称	类型	说明
id	string (arm-id)	专用终结点的 ARM 标识符

PrivateEndpointConnection

对象

专用终结点连接资源。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.groupIds	string[]	专用终结点资源的组 ID。
properties.privateEndpoint	PrivateEndpoint	专用终结点的资源。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	专用终结点连接资源的预配状态。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProvisioningState

枚举

当前预配状态。

值	说明
Succeeded
Failed
Canceled
Waiting
Updating
Deleting
Pending

PrivateEndpointServiceConnectionStatus

枚举

专用终结点连接状态。

值	说明
Pending
Approved
Rejected
Disconnected

PrivateLinkServiceConnectionState

对象

有关服务使用者与提供程序之间的连接状态的信息集合。

名称	类型	说明
actionsRequired	string	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。
description	string	批准/拒绝连接的原因。
status	PrivateEndpointServiceConnectionStatus	指示连接是否已被服务的所有者批准/拒绝/删除。

PublicNetworkAccess

枚举

允许或阻止所有公共流量的属性。允许的值：“Enabled”、“Disabled”。

值	说明
Enabled
Disabled

systemData

对象

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

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

UserAssignedIdentity

对象

用户分配的标识属性

名称	类型	说明
clientId	string (uuid)	分配的标识的客户端 ID。
principalId	string (uuid)	已分配标识的主体 ID。

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 地址，将为内部 DNS 服务器保留。

WorkloadProfile

对象

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

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

通过