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

Container Apps - List By Resource Group

获取给定资源组中的容器应用。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps?api-version=2023-12-01

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

资源所属的资源组的名称。

正则表达式模式: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Azure 订阅 ID。 这是一个 GUID 格式的字符串, (例如 00000000-0000-0000-0000-0000000000000) 。

api-version
query True

string

API 版本

响应

名称 类型 说明
200 OK

ContainerAppCollection

确定

Other Status Codes

DefaultErrorResponse

App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

List Container Apps by resource group

示例请求

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/containerApps?api-version=2023-12-01

示例响应

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/containerApps/testcontainerApp0",
      "name": "testcontainerApp0",
      "type": "Microsoft.Web/containerApps",
      "kind": "containerApp",
      "location": "East US",
      "properties": {
        "provisioningState": "Succeeded",
        "kubeEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/kubeEnvironments/demokube",
        "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io",
        "configuration": {
          "ingress": {
            "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io",
            "external": true,
            "targetPort": 3000,
            "transport": "auto"
          }
        },
        "template": {
          "containers": [
            {
              "image": "repo/testcontainerApp0:v4",
              "name": "testcontainerApp0",
              "resources": {
                "cpu": 0.2,
                "memory": "100Mi"
              }
            }
          ],
          "scale": {
            "minReplicas": 1,
            "maxReplicas": 5,
            "rules": [
              {
                "name": "httpscalingrule",
                "http": {
                  "metadata": {
                    "concurrentRequests": "50"
                  }
                }
              }
            ]
          },
          "dapr": {
            "enabled": true,
            "appPort": 3000
          }
        }
      }
    }
  ],
  "nextLink": null
}

定义

名称 说明
ActiveRevisionsMode

ActiveRevisionsMode 控制如何处理容器应用的活动修订:多个修订可以处于活动状态。 如果未提供任何值,则为默认的 Single:一次只能激活一个修订。 修订权重不能在此模式下使用

Configuration

用于定义容器应用的可变设置的非版本控制容器应用配置属性

Container

容器应用容器定义。

ContainerApp

容器应用。

ContainerAppCollection

容器应用集合 ARM 资源。

ContainerAppProvisioningState

容器应用的预配状态。

ContainerResources

容器应用容器资源要求。

CustomScaleRule

容器应用容器自定义缩放规则。

Dapr

容器应用 Dapr 配置。

DaprComponent

Dapr 组件配置

DaprMetadata

容器应用 Dapr 组件元数据。

DefaultErrorResponse

App 服务错误响应。

Details
EnvironmentVar

容器应用容器环境变量。

Error

错误模型。

HttpScaleRule

容器应用容器自定义缩放规则。

Ingress

容器应用入口配置。

IngressTransportMethod

入口传输协议

QueueScaleRule

容器应用容器基于 Azure 队列的缩放规则。

RegistryCredentials

容器应用专用注册表

Scale

容器应用缩放配置。

ScaleRule

容器应用容器缩放规则。

ScaleRuleAuth

容器应用缩放规则的身份验证机密

Secret

容器应用机密。

Template

容器应用版本控制的应用程序定义。 定义不可变修订的所需状态。 对此部分所做的任何更改都将导致创建新修订

TrafficWeight

分配给修订的流量权重

ActiveRevisionsMode

ActiveRevisionsMode 控制如何处理容器应用的活动修订:多个修订可以处于活动状态。 如果未提供任何值,则为默认的 Single:一次只能激活一个修订。 修订权重不能在此模式下使用

名称 类型 说明
multiple

string

single

string

Configuration

用于定义容器应用的可变设置的非版本控制容器应用配置属性

名称 类型 说明
activeRevisionsMode

ActiveRevisionsMode

ActiveRevisionsMode 控制如何处理容器应用的活动修订:多个修订可以处于活动状态。 如果未提供任何值,则为默认的 Single:一次只能激活一个修订。 修订权重不能在此模式下使用

ingress

Ingress

入口配置。

registries

RegistryCredentials[]

容器应用使用的容器专用容器注册表凭据的集合

secrets

Secret[]

容器应用使用的机密集合

Container

容器应用容器定义。

名称 类型 说明
args

string[]

容器启动命令参数。

command

string[]

容器启动命令。

env

EnvironmentVar[]

容器环境变量。

image

string

容器映像标记。

name

string

自定义容器名称。

resources

ContainerResources

容器资源要求。

ContainerApp

容器应用。

名称 类型 说明
id

string

资源 ID。

kind

string

资源类型。

location

string

资源位置。

name

string

资源名称。

properties.configuration

Configuration

非版本控制容器应用配置属性。

properties.kubeEnvironmentId

string

容器应用的 KubeEnvironment 的资源 ID。

properties.latestRevisionFqdn

string

容器应用最新版本的完全限定域名。

properties.latestRevisionName

string

容器应用最新版本的名称。

properties.provisioningState

ContainerAppProvisioningState

容器应用的预配状态。

properties.template

Template

容器应用版本控制的应用程序定义。

tags

object

资源标记。

type

string

资源类型。

ContainerAppCollection

容器应用集合 ARM 资源。

名称 类型 说明
nextLink

string

指向下一页资源的链接。

value

ContainerApp[]

资源的集合。

ContainerAppProvisioningState

容器应用的预配状态。

名称 类型 说明
Canceled

string

Failed

string

InProgress

string

Succeeded

string

ContainerResources

容器应用容器资源要求。

名称 类型 说明
cpu

number

核心中所需的 CPU,例如 0.5

memory

string

所需的内存,例如“250Mb”

CustomScaleRule

容器应用容器自定义缩放规则。

名称 类型 说明
auth

ScaleRuleAuth[]

自定义缩放规则的身份验证机密。

metadata

object

用于描述自定义缩放规则的元数据属性。

type

string

自定义缩放规则的类型,例如:azure-servicebus、redis 等。

Dapr

容器应用 Dapr 配置。

名称 类型 说明
appId

string

Dapr 应用程序标识符

appPort

integer

达普侧车的港口

components

DaprComponent[]

Dapr 组件的集合

enabled

boolean

指示是否启用 Dapr 侧车的布尔值

DaprComponent

Dapr 组件配置

名称 类型 说明
metadata

DaprMetadata[]

组件元数据

name

string

组件名称

type

string

组件类型

version

string

组件版本

DaprMetadata

容器应用 Dapr 组件元数据。

名称 类型 说明
name

string

元数据属性名称。

secretRef

string

要从中提取元数据属性值的容器应用机密的名称。

value

string

元数据属性值。

DefaultErrorResponse

App 服务错误响应。

名称 类型 说明
error

Error

错误模型。

Details

名称 类型 说明
code

string

用于以编程方式识别错误的标准化字符串。

message

string

详细的错误说明和调试信息。

target

string

详细的错误说明和调试信息。

EnvironmentVar

容器应用容器环境变量。

名称 类型 说明
name

string

环境变量名称。

secretRef

string

要从中提取环境变量值的容器应用机密的名称。

value

string

非机密环境变量值。

Error

错误模型。

名称 类型 说明
code

string

用于以编程方式识别错误的标准化字符串。

details

Details[]

详细错误。

innererror

string

调试错误的详细信息。

message

string

详细的错误说明和调试信息。

target

string

详细的错误说明和调试信息。

HttpScaleRule

容器应用容器自定义缩放规则。

名称 类型 说明
auth

ScaleRuleAuth[]

自定义缩放规则的身份验证机密。

metadata

object

用于描述 http 缩放规则的元数据属性。

Ingress

容器应用入口配置。

名称 类型 默认值 说明
allowInsecure

boolean

Bool 指示是否允许与 的 HTTP 连接。 如果设置为 false,则 HTTP 连接会自动重定向到 HTTPS 连接

external

boolean

False

指示应用是否公开外部 http 终结点的布尔值

fqdn

string

主机名

targetPort

integer

容器中来自入口的流量的目标端口

traffic

TrafficWeight[]

分配给修订的流量权重

transport

IngressTransportMethod

入口传输协议

IngressTransportMethod

入口传输协议

名称 类型 说明
auto

string

http

string

http2

string

QueueScaleRule

容器应用容器基于 Azure 队列的缩放规则。

名称 类型 说明
auth

ScaleRuleAuth[]

队列缩放规则的身份验证机密。

queueLength

integer

队列长度。

queueName

string

队列名称。

RegistryCredentials

容器应用专用注册表

名称 类型 说明
passwordSecretRef

string

包含注册表登录密码的机密的名称

server

string

容器注册表服务器

username

string

容器注册表用户名

Scale

容器应用缩放配置。

名称 类型 说明
maxReplicas

integer

可选。 容器副本的最大数目。 如果未设置,则默认为 10。

minReplicas

integer

可选。 最小容器副本数。

rules

ScaleRule[]

缩放规则。

ScaleRule

容器应用容器缩放规则。

名称 类型 说明
azureQueue

QueueScaleRule

基于 Azure 队列的缩放。

custom

CustomScaleRule

自定义缩放规则。

http

HttpScaleRule

基于 HTTP 请求的缩放。

name

string

缩放规则名称

ScaleRuleAuth

容器应用缩放规则的身份验证机密

名称 类型 说明
secretRef

string

要从中提取身份验证参数的容器应用机密的名称。

triggerParameter

string

使用机密的触发器参数

Secret

容器应用机密。

名称 类型 说明
name

string

机密名称。

value

string

机密值。

Template

容器应用版本控制的应用程序定义。 定义不可变修订的所需状态。 对此部分所做的任何更改都将导致创建新修订

名称 类型 说明
containers

Container[]

容器应用的容器定义列表。

dapr

Dapr

容器应用的 Dapr 配置。

revisionSuffix

string

追加到修订名称的用户友好后缀

scale

Scale

容器应用的缩放属性。

TrafficWeight

分配给修订的流量权重

名称 类型 默认值 说明
latestRevision

boolean

False

指示流量权重属于最新的稳定修订

revisionName

string

修订的名称

weight

integer

分配给修订的流量权重