共用方式為


Managed Environments - List By Resource Group

取得資源群組中的所有環境。
取得資源群組中的所有受管理環境。

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

URI 參數

名稱 位於 必要 類型 Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

資源群組的名稱。 名稱不區分大小寫。

subscriptionId
path True

string

minLength: 1

目標訂用帳戶的標識碼。

api-version
query True

string

minLength: 1

用於此作業的 API 版本。

回應

名稱 類型 Description
200 OK

ManagedEnvironmentsCollection

OK

Other Status Codes

ErrorResponse

常見錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

List environments by resource group

範例要求

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

範例回覆

{
  "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"
          }
        ],
        "ingressConfiguration": {
          "workloadProfileName": "My-GP-01",
          "terminationGracePeriodSeconds": 600,
          "headerCountLimit": 50,
          "requestIdleTimeout": null
        },
        "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"
        },
        "ingressConfiguration": null,
        "infrastructureResourceGroup": "capp-svc-demo1-northcentralus"
      }
    }
  ]
}

定義

名稱 Description
AppLogsConfiguration

應用程式記錄的設定

CertificateKeyVaultProperties

儲存在 Key Vault 中的憑證屬性。

createdByType

建立資源的身分識別類型。

CustomDomainConfiguration

應用程式環境自定義網域的設定屬性

DaprConfiguration

組態屬性 Dapr 元件

Encryption

受控環境的對等流量加密設定

EnvironmentProvisioningState

環境布建狀態。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

IngressConfiguration

輸入元件的設定,包括工作負載設定檔、擴展和連線處理。

KedaConfiguration

組態屬性 Keda 元件

LogAnalyticsConfiguration

只有在目的地設定為 「log-analytics」 時,才提供 Log Analytics 組態

ManagedEnvironment

裝載容器應用程式的環境

ManagedEnvironmentsCollection

環境集合

ManagedServiceIdentity

受控服務識別(系統指派和/或使用者指派的身分識別)

ManagedServiceIdentityType

受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。

Mtls

相互 TLS 驗證的組態屬性

PeerAuthentication

受控環境的對等驗證設定

PeerTrafficConfiguration

受控環境的對等流量設定

PrivateEndpoint

私人端點資源。

PrivateEndpointConnection

私人端點聯機資源。

PrivateEndpointConnectionProvisioningState

目前的布建狀態。

PrivateEndpointServiceConnectionStatus

私人端點連線狀態。

PrivateLinkServiceConnectionState

服務取用者與提供者之間連線狀態的相關信息集合。

PublicNetworkAccess

允許或封鎖所有公用流量的屬性。 允許的值:『Enabled』、『Disabled』。

systemData

與建立和上次修改資源相關的元數據。

UserAssignedIdentity

使用者指派的身分識別屬性

VnetConfiguration

應用程式環境的設定屬性以加入虛擬網路

WorkloadProfile

將容器應用程式執行的範圍設定為工作負載配置檔。

AppLogsConfiguration

應用程式記錄的設定

名稱 類型 Description
destination

string

記錄目的地可以是 'log-analytics'、'azure-monitor' 或 'none'

logAnalyticsConfiguration

LogAnalyticsConfiguration

只有在目的地設定為 「log-analytics」 時,才提供 Log Analytics 組態

CertificateKeyVaultProperties

儲存在 Key Vault 中的憑證屬性。

名稱 類型 Description
identity

string

管理身份的資源 ID,用來與 Azure Key Vault 認證,或系統用來使用系統指派的身份。

keyVaultUrl

string (uri)

指向保存憑證之 Azure Key Vault 秘密的 URL。

createdByType

建立資源的身分識別類型。

Description
User
Application
ManagedIdentity
Key

CustomDomainConfiguration

應用程式環境自定義網域的設定屬性

名稱 類型 Description
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 元件

名稱 類型 Description
version

string

Dapr 的版本

Encryption

受控環境的對等流量加密設定

名稱 類型 Description
enabled

boolean

布爾值,指出是否啟用對等流量加密

EnvironmentProvisioningState

環境布建狀態。

Description
Succeeded
Failed
Canceled
Waiting
InitializationInProgress
InfrastructureSetupInProgress
InfrastructureSetupComplete
ScheduledForDelete
UpgradeRequested
UpgradeFailed

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳情

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

IngressConfiguration

輸入元件的設定,包括工作負載設定檔、擴展和連線處理。

名稱 類型 Description
headerCountLimit

integer (int32)

入口允許的每個請求的最大標頭數。 必須至少為 1。 預設為 100。

requestIdleTimeout

integer (int32)

閒置要求逾時之前的持續時間 (以分鐘為單位)。必須介於 4 到 30 歲之間。 預設為4分鐘。

terminationGracePeriodSeconds

integer (int32)

允許活動連接在終止時完成的時間(以秒為單位)。 必須介於 0 和 3600 之間。 預設為 480 秒。

workloadProfileName

string

Ingress 元件使用的工作負載配置檔的名稱。 必須的。

KedaConfiguration

組態屬性 Keda 元件

名稱 類型 Description
version

string

科達版本

LogAnalyticsConfiguration

只有在目的地設定為 「log-analytics」 時,才提供 Log Analytics 組態

名稱 類型 Description
customerId

string

Log Analytics 客戶標識碼

sharedKey

string

Log Analytics 客戶金鑰

ManagedEnvironment

裝載容器應用程式的環境

名稱 類型 Description
id

string (arm-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

Application Insights 的 connection string 由 Dapr 用來匯出服務對服務的通訊遙測資料

properties.daprAIInstrumentationKey

string

Azure Monitor instrumentation key by Dapr 用於匯出服務對服務通訊遙測

properties.daprConfiguration

DaprConfiguration

Dapr 元件的組態。

properties.defaultDomain

string

叢集的預設網域名稱

properties.deploymentErrors

string

部署或部署驗證期間發生的任何錯誤

properties.eventStreamEndpoint

string

環境之 eventstream 的端點。

properties.infrastructureResourceGroup

string

為受控環境建立的平臺管理資源群組名稱,以裝載基礎結構資源。 如果提供子網標識碼,此資源群組將會建立在與子網相同的訂用帳戶中。

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 Resource Manager 元數據。

tags

object

資源標籤。

type

string

資源的類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ManagedEnvironmentsCollection

環境集合

名稱 類型 Description
nextLink

string

連結至下一頁的資源。

value

ManagedEnvironment[]

資源的收集。

ManagedServiceIdentity

受控服務識別(系統指派和/或使用者指派的身分識別)

名稱 類型 Description
principalId

string (uuid)

系統指派身分識別的服務主體標識碼。 此屬性只會針對系統指派的身分識別提供。

tenantId

string (uuid)

系統指派身分識別的租用戶標識碼。 此屬性只會針對系統指派的身分識別提供。

type

ManagedServiceIdentityType

受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned 身分識別
與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件({})。

ManagedServiceIdentityType

受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。

Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Mtls

相互 TLS 驗證的組態屬性

名稱 類型 Description
enabled

boolean

布爾值,指出是否啟用相互 TLS 驗證

PeerAuthentication

受控環境的對等驗證設定

名稱 類型 Description
mtls

Mtls

受控環境的相互 TLS 驗證設定

PeerTrafficConfiguration

受控環境的對等流量設定

名稱 類型 Description
encryption

Encryption

受控環境的對等流量加密設定

PrivateEndpoint

私人端點資源。

名稱 類型 Description
id

string (arm-id)

私人端點的 ARM 識別碼

PrivateEndpointConnection

私人端點聯機資源。

名稱 類型 Description
id

string (arm-id)

資源的完整資源標識碼。 例如,“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

name

string

資源的名稱

properties.groupIds

string[]

私人端點資源的群組標識碼。

properties.privateEndpoint

PrivateEndpoint

私人端點的資源。

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

服務取用者與提供者之間連線狀態的相關信息集合。

properties.provisioningState

PrivateEndpointConnectionProvisioningState

私人端點聯機資源的布建狀態。

systemData

systemData

包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。

type

string

資源的類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProvisioningState

目前的布建狀態。

Description
Succeeded
Failed
Canceled
Waiting
Updating
Deleting
Pending

PrivateEndpointServiceConnectionStatus

私人端點連線狀態。

Description
Pending
Approved
Rejected
Disconnected

PrivateLinkServiceConnectionState

服務取用者與提供者之間連線狀態的相關信息集合。

名稱 類型 Description
actionsRequired

string

訊息,指出服務提供者上的變更是否需要取用者的任何更新。

description

string

核准/拒絕連線的原因。

status

PrivateEndpointServiceConnectionStatus

指出服務擁有者是否已核准/拒絕/移除連線。

PublicNetworkAccess

允許或封鎖所有公用流量的屬性。 允許的值:『Enabled』、『Disabled』。

Description
Enabled
Disabled

systemData

與建立和上次修改資源相關的元數據。

名稱 類型 Description
createdAt

string (date-time)

資源建立的時間戳(UTC)。

createdBy

string

建立資源的身分識別。

createdByType

createdByType

建立資源的身分識別類型。

lastModifiedAt

string (date-time)

上次修改的資源時間戳 (UTC)

lastModifiedBy

string

上次修改資源的身分識別。

lastModifiedByType

createdByType

上次修改資源的身分識別類型。

UserAssignedIdentity

使用者指派的身分識別屬性

名稱 類型 Description
clientId

string (uuid)

指派之身分識別的用戶端標識碼。

principalId

string (uuid)

指派之身分識別的主體標識碼。

VnetConfiguration

應用程式環境的設定屬性以加入虛擬網路

名稱 類型 Description
dockerBridgeCidr

string

指派給 Docker 網橋網路之 CIDR 表示法 IP 範圍。 不得與任何其他提供的IP範圍重疊。

infrastructureSubnetId

string

基礎結構元件子網的資源標識符。 不得與任何其他提供的IP範圍重疊。

internal

boolean

布爾值,表示環境只有內部負載平衡器。 這些環境沒有公用靜態 IP 資源。 如果啟用此屬性,則必須提供 infrastructureSubnetId

platformReservedCidr

string

CIDR 表示法中的IP範圍,可以保留給環境基礎結構IP位址。 不得與任何其他提供的IP範圍重疊。

platformReservedDnsIP

string

由 platformReservedCidr 定義的 IP 位址,將保留給內部 DNS 伺服器。

WorkloadProfile

將容器應用程式執行的範圍設定為工作負載配置檔。

名稱 類型 Description
maximumCount

integer (int32)

最大容量。

minimumCount

integer (int32)

最小容量。

name

string

要執行之工作負載的工作負載配置檔類型。

workloadProfileType

string

要執行之工作負載的工作負載配置檔類型。