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

Microsoft.Web containerApps 2021-03-01

项目
09/03/2023

Bicep 资源定义

containerApps 资源类型可以使用面向以下对象的操作进行部署：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中更改的属性的列表，请参阅更改日志。

备注

此资源类型已迁移到 Microsoft.App 命名空间。有关新资源类型，请参阅 Microsoft.App containerApps。

有关迁移的信息，请参阅所需的操作：2022 年 3 月将命名空间从 Microsoft.Web 迁移到 Microsoft.App。

资源格式

若要创建 Microsoft.Web/containerApps 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Web/containerApps@2021-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  properties: {
    configuration: {
      activeRevisionsMode: 'string'
      ingress: {
        allowInsecure: bool
        external: bool
        targetPort: int
        traffic: [
          {
            latestRevision: bool
            revisionName: 'string'
            weight: int
          }
        ]
        transport: 'string'
      }
      registries: [
        {
          passwordSecretRef: 'string'
          server: 'string'
          username: 'string'
        }
      ]
      secrets: [
        {
          name: 'string'
          value: 'string'
        }
      ]
    }
    kubeEnvironmentId: 'string'
    template: {
      containers: [
        {
          args: [
            'string'
          ]
          command: [
            'string'
          ]
          env: [
            {
              name: 'string'
              secretRef: 'string'
              value: 'string'
            }
          ]
          image: 'string'
          name: 'string'
          resources: {
            cpu: int
            memory: 'string'
          }
        }
      ]
      dapr: {
        appId: 'string'
        appPort: int
        components: [
          {
            metadata: [
              {
                name: 'string'
                secretRef: 'string'
                value: 'string'
              }
            ]
            name: 'string'
            type: 'string'
            version: 'string'
          }
        ]
        enabled: bool
      }
      revisionSuffix: 'string'
      scale: {
        maxReplicas: int
        minReplicas: int
        rules: [
          {
            azureQueue: {
              auth: [
                {
                  secretRef: 'string'
                  triggerParameter: 'string'
                }
              ]
              queueLength: int
              queueName: 'string'
            }
            custom: {
              auth: [
                {
                  secretRef: 'string'
                  triggerParameter: 'string'
                }
              ]
              metadata: {}
              type: 'string'
            }
            http: {
              auth: [
                {
                  secretRef: 'string'
                  triggerParameter: 'string'
                }
              ]
              metadata: {}
            }
            name: 'string'
          }
        ]
      }
    }
  }
}

属性值

containerApps

名称	说明	值
name	资源名称	字符串 (必需)
location	资源位置。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。请参阅模板中的标记
kind	资源类型。	string
properties	ContainerApp 资源特定的属性	ContainerAppProperties

ContainerAppProperties

名称	说明	值
配置	非版本控制容器应用配置属性。	配置
kubeEnvironmentId	容器应用的 KubeEnvironment 的资源 ID。	string
template	容器应用版本控制的应用程序定义。	模板

配置

名称	说明	值
activeRevisionsMode	ActiveRevisionsMode 控制如何处理容器应用的活动修订： {list}{item}多个：多个修订可以处于活动状态。如果未提供任何值，则默认为{/item}{item}Single：一次只能激活一个修订。修订权重不能在此模式下使用{/item}{/list}	“multiple” “single”
入口	入口配置。	流入量
registries	容器应用使用的容器专用容器注册表凭据的集合	RegistryCredentials[]
机密	容器应用使用的机密集合	机密[]

流入量

名称	说明	值
allowInsecure	Bool 指示是否允许与的 HTTP 连接。如果设置为 false，则 HTTP 连接会自动重定向到 HTTPS 连接	bool
external	指示应用是否公开外部 http 终结点的布尔值	bool
targetPort	容器中来自入口的流量的目标端口	int
traffic		TrafficWeight[]
运输	入口传输协议	'auto' “http” “http2”

TrafficWeight

名称	说明	值
latestRevision	指示流量权重属于最新的稳定修订	bool
revisionName	修订的名称	字符串
重量	分配给修订的流量权重	int

RegistryCredentials

名称	说明	值
passwordSecretRef	包含注册表登录密码的机密的名称	字符串
server	容器注册表服务器	字符串
username	容器注册表用户名	字符串

Secret

名称	说明	值
name	机密名称。	string
value	机密值。	string

模板

名称	说明	Value
containers	容器应用的容器定义列表。	Container[]
dapr	容器应用的 Dapr 配置。	Dapr
revisionSuffix	追加到修订名称的用户友好后缀	string
scale	容器应用的缩放属性。	可伸缩

容器

名称	说明	值
args	容器启动命令参数。	string[]
command	容器启动命令。	string[]
env	容器环境变量。	EnvironmentVar[]
image	容器映像标记。	string
name	自定义容器名称。	string
resources	容器资源要求。	ContainerResources

EnvironmentVar

名称	说明	值
name	环境变量名称。	string
secretRef	要从中提取环境变量值的容器应用机密的名称。	string
value	非机密环境变量值。	string

ContainerResources

名称	说明	值
cpu	核心中所需的 CPU，例如 0.5	int
内存	所需内存，例如“250Mb”	string

Dapr

名称	说明	值
appId	Dapr 应用程序标识符	string
appPort	Dapr 侧车的端口	int
components	Dapr 组件的集合	DaprComponent[]
enabled	指示是否启用 Dapr 侧车的布尔值	bool

DaprComponent

名称	说明	值
metadata	组件元数据	DaprMetadata[]
name	组件名称	string
type	组件类型	string
版本	组件版本	string

DaprMetadata

名称	说明	值
name	元数据属性名称。	字符串
secretRef	要从中提取元数据属性值的容器应用机密的名称。	string
value	元数据属性值。	字符串

缩放

名称	说明	值
maxReplicas	可选。容器副本的最大数目。如果未设置，则默认为 10。	int
minReplicas	可选。最小容器副本数。	int
规则	缩放规则。	ScaleRule[]

ScaleRule

名称	说明	值
azureQueue	基于 Azure 队列的缩放。	QueueScaleRule
自定义	自定义缩放规则。	CustomScaleRule
http	基于 HTTP 请求的缩放。	HttpScaleRule
name	缩放规则名称	字符串

QueueScaleRule

名称	说明	值
auth	队列缩放规则的身份验证机密。	ScaleRuleAuth[]
queueLength	队列长度。	int
queueName	队列名称。	字符串

ScaleRuleAuth

名称	说明	值
secretRef	要从中提取身份验证参数的容器应用机密的名称。	字符串
triggerParameter	使用机密的触发器参数	字符串

CustomScaleRule

名称	说明	值
auth	自定义缩放规则的身份验证机密。	ScaleRuleAuth[]
metadata	用于描述自定义缩放规则的元数据属性。	对象 (object)
type	自定义缩放规则的类型例如：azure-servicebus、redis 等。	字符串

HttpScaleRule

名称	说明	值
auth	自定义缩放规则的身份验证机密。	ScaleRuleAuth[]
metadata	用于描述 http 缩放规则的元数据属性。	对象 (object)

ARM 模板资源定义

可以使用面向以下操作部署 containerApps 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

备注

此资源类型已迁移到 Microsoft.App 命名空间。有关新资源类型，请参阅 Microsoft.App containerApps。

有关迁移的信息，请参阅所需操作：命名空间从 Microsoft.Web 迁移到 2022 年 3 月 Microsoft.App。

资源格式

若要创建 Microsoft.Web/containerApps 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Web/containerApps",
  "apiVersion": "2021-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "properties": {
    "configuration": {
      "activeRevisionsMode": "string",
      "ingress": {
        "allowInsecure": "bool",
        "external": "bool",
        "targetPort": "int",
        "traffic": [
          {
            "latestRevision": "bool",
            "revisionName": "string",
            "weight": "int"
          }
        ],
        "transport": "string"
      },
      "registries": [
        {
          "passwordSecretRef": "string",
          "server": "string",
          "username": "string"
        }
      ],
      "secrets": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    },
    "kubeEnvironmentId": "string",
    "template": {
      "containers": [
        {
          "args": [ "string" ],
          "command": [ "string" ],
          "env": [
            {
              "name": "string",
              "secretRef": "string",
              "value": "string"
            }
          ],
          "image": "string",
          "name": "string",
          "resources": {
            "cpu": "int",
            "memory": "string"
          }
        }
      ],
      "dapr": {
        "appId": "string",
        "appPort": "int",
        "components": [
          {
            "metadata": [
              {
                "name": "string",
                "secretRef": "string",
                "value": "string"
              }
            ],
            "name": "string",
            "type": "string",
            "version": "string"
          }
        ],
        "enabled": "bool"
      },
      "revisionSuffix": "string",
      "scale": {
        "maxReplicas": "int",
        "minReplicas": "int",
        "rules": [
          {
            "azureQueue": {
              "auth": [
                {
                  "secretRef": "string",
                  "triggerParameter": "string"
                }
              ],
              "queueLength": "int",
              "queueName": "string"
            },
            "custom": {
              "auth": [
                {
                  "secretRef": "string",
                  "triggerParameter": "string"
                }
              ],
              "metadata": {},
              "type": "string"
            },
            "http": {
              "auth": [
                {
                  "secretRef": "string",
                  "triggerParameter": "string"
                }
              ],
              "metadata": {}
            },
            "name": "string"
          }
        ]
      }
    }
  }
}

属性值

containerApps

名称	说明	Value
type	资源类型	'Microsoft.Web/containerApps'
apiVersion	资源 API 版本	'2021-03-01'
name	资源名称	字符串 (必需)
location	资源位置。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。请参阅模板中的标记
kind	资源类型。	string
properties	ContainerApp 资源特定的属性	ContainerAppProperties

ContainerAppProperties

名称	说明	值
配置	非版本控制容器应用配置属性。	配置
kubeEnvironmentId	容器应用的 KubeEnvironment 的资源 ID。	字符串
template	容器应用版本控制的应用程序定义。	模板

配置

名称	说明	值
activeRevisionsMode	ActiveRevisionsMode 控制如何处理容器应用的活动修订： {list}{item}多个：多个修订可以处于活动状态。如果未提供任何值，则默认为{/item}{item}Single：一次只能有一个修订处于活动状态。修订权重不能在此模式下使用{/item}{/list}	“multiple” “single”
入口	入口配置。	流入量
registries	容器应用使用的容器的专用容器注册表凭据集合	RegistryCredentials[]
机密	容器应用使用的机密集合	机密[]

流入量

名称	说明	值
allowInsecure	指示是否允许 HTTP 连接到的布尔值。如果设置为 false，则 HTTP 连接会自动重定向到 HTTPS 连接	bool
external	指示应用是否公开外部 http 终结点的布尔值	bool
targetPort	容器中来自入口的流量的目标端口	int
traffic		TrafficWeight[]
运输	入口传输协议	'auto' “http” “http2”

TrafficWeight

名称	说明	值
latestRevision	指示流量权重属于最新的稳定修订	bool
revisionName	修订的名称	字符串
重量	分配给修订的流量权重	int

RegistryCredentials

名称	说明	值
passwordSecretRef	包含注册表登录密码的机密的名称	字符串
server	容器注册表服务器	字符串
username	容器注册表用户名	string

Secret

名称	说明	值
name	机密名称。	string
value	机密值。	字符串

模板

名称	说明	Value
containers	容器应用的容器定义列表。	Container[]
dapr	容器应用的 Dapr 配置。	Dapr
revisionSuffix	追加到修订名称的用户友好后缀	字符串
scale	容器应用的缩放属性。	可伸缩

容器

名称	说明	值
args	容器启动命令参数。	string[]
command	容器启动命令。	string[]
env	容器环境变量。	EnvironmentVar[]
image	容器映像标记。	字符串
name	自定义容器名称。	字符串
resources	容器资源要求。	ContainerResources

EnvironmentVar

名称	说明	值
name	环境变量名称。	字符串
secretRef	要从中提取环境变量值的容器应用机密的名称。	string
value	非机密环境变量值。	字符串

ContainerResources

名称	说明	值
cpu	核心中所需的 CPU，例如 0.5	int
内存	所需内存，例如“250Mb”	字符串

Dapr

名称	说明	值
appId	Dapr 应用程序标识符	string
appPort	Dapr 侧车的端口	int
components	Dapr 组件的集合	DaprComponent[]
enabled	指示是否启用 Dapr 侧车的布尔值	bool

DaprComponent

名称	说明	值
metadata	组件元数据	DaprMetadata[]
name	组件名称	字符串
type	组件类型	字符串
版本	组件版本	string

DaprMetadata

名称	说明	值
name	元数据属性名称。	字符串
secretRef	要从中提取元数据属性值的容器应用机密的名称。	string
value	元数据属性值。	string

缩放

名称	说明	值
maxReplicas	可选。容器副本的最大数目。如果未设置，则默认为 10。	int
minReplicas	可选。最小容器副本数。	int
规则	缩放规则。	ScaleRule[]

ScaleRule

名称	说明	值
azureQueue	基于 Azure 队列的缩放。	QueueScaleRule
自定义	自定义缩放规则。	CustomScaleRule
http	基于 HTTP 请求的缩放。	HttpScaleRule
name	缩放规则名称	字符串

QueueScaleRule

名称	说明	值
auth	队列缩放规则的身份验证机密。	ScaleRuleAuth[]
queueLength	队列长度。	int
queueName	队列名称。	字符串

ScaleRuleAuth

名称	说明	值
secretRef	要从中提取身份验证参数的容器应用机密的名称。	字符串
triggerParameter	使用机密的触发器参数	字符串

CustomScaleRule

名称	说明	值
auth	自定义缩放规则的身份验证机密。	ScaleRuleAuth[]
metadata	用于描述自定义缩放规则的元数据属性。	对象 (object)
type	自定义缩放规则的类型例如：azure-servicebus、redis 等。	字符串

HttpScaleRule

名称	说明	值
auth	自定义缩放规则的身份验证机密。	ScaleRuleAuth[]
metadata	用于描述 http 缩放规则的元数据属性。	对象 (object)

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 containerApps 资源类型：

资源组

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Web/containerApps 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/containerApps@2021-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      configuration = {
        activeRevisionsMode = "string"
        ingress = {
          allowInsecure = bool
          external = bool
          targetPort = int
          traffic = [
            {
              latestRevision = bool
              revisionName = "string"
              weight = int
            }
          ]
          transport = "string"
        }
        registries = [
          {
            passwordSecretRef = "string"
            server = "string"
            username = "string"
          }
        ]
        secrets = [
          {
            name = "string"
            value = "string"
          }
        ]
      }
      kubeEnvironmentId = "string"
      template = {
        containers = [
          {
            args = [
              "string"
            ]
            command = [
              "string"
            ]
            env = [
              {
                name = "string"
                secretRef = "string"
                value = "string"
              }
            ]
            image = "string"
            name = "string"
            resources = {
              cpu = int
              memory = "string"
            }
          }
        ]
        dapr = {
          appId = "string"
          appPort = int
          components = [
            {
              metadata = [
                {
                  name = "string"
                  secretRef = "string"
                  value = "string"
                }
              ]
              name = "string"
              type = "string"
              version = "string"
            }
          ]
          enabled = bool
        }
        revisionSuffix = "string"
        scale = {
          maxReplicas = int
          minReplicas = int
          rules = [
            {
              azureQueue = {
                auth = [
                  {
                    secretRef = "string"
                    triggerParameter = "string"
                  }
                ]
                queueLength = int
                queueName = "string"
              }
              custom = {
                auth = [
                  {
                    secretRef = "string"
                    triggerParameter = "string"
                  }
                ]
                metadata = {}
                type = "string"
              }
              http = {
                auth = [
                  {
                    secretRef = "string"
                    triggerParameter = "string"
                  }
                ]
                metadata = {}
              }
              name = "string"
            }
          ]
        }
      }
    }
    kind = "string"
  })
}

属性值

containerApps

名称	说明	Value
type	资源类型	“Microsoft.Web/containerApps@2021-03-01”
name	资源名称	字符串 (必需)
location	资源位置。	字符串 (必需)
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。
kind	资源类型。	string
properties	ContainerApp 资源特定的属性	ContainerAppProperties

ContainerAppProperties

名称	说明	值
配置	非版本控制容器应用配置属性。	配置
kubeEnvironmentId	容器应用的 KubeEnvironment 的资源 ID。	字符串
template	容器应用版本控制的应用程序定义。	模板

配置

名称	说明	值
activeRevisionsMode	ActiveRevisionsMode 控制如何处理容器应用的活动修订： {list}{item}多个：多个修订可以处于活动状态。如果未提供任何值，则默认为{/item}{item}Single：一次只能有一个修订处于活动状态。修订权重不能在此模式下使用{/item}{/list}	“multiple” “single”
入口	入口配置。	流入量
registries	容器应用使用的容器的专用容器注册表凭据集合	RegistryCredentials[]
机密	容器应用使用的机密集合	机密[]

流入量

名称	说明	值
allowInsecure	指示是否允许 HTTP 连接到的布尔值。如果设置为 false，则 HTTP 连接会自动重定向到 HTTPS 连接	bool
external	指示应用是否公开外部 http 终结点的布尔值	bool
targetPort	容器中来自入口的流量的目标端口	int
traffic		TrafficWeight[]
运输	入口传输协议	“auto” “http” “http2”

TrafficWeight

名称	说明	值
latestRevision	指示流量权重属于最新的稳定修订	bool
revisionName	修订的名称	string
重量	分配给修订的流量权重	int

RegistryCredentials

名称	说明	值
passwordSecretRef	包含注册表登录密码的机密的名称	string
server	容器注册表服务器	字符串
username	容器注册表用户名	字符串

Secret

名称	说明	值
name	机密名称。	string
value	机密值。	字符串

模板

名称	说明	Value
containers	容器应用的容器定义列表。	Container[]
dapr	容器应用的 Dapr 配置。	Dapr
revisionSuffix	追加到修订名称的用户友好后缀	string
scale	容器应用的缩放属性。	可伸缩

容器

名称	说明	值
args	容器启动命令参数。	string[]
command	容器启动命令。	string[]
env	容器环境变量。	EnvironmentVar[]
image	容器映像标记。	string
name	自定义容器名称。	string
resources	容器资源要求。	ContainerResources

EnvironmentVar

名称	说明	值
name	环境变量名称。	字符串
secretRef	要从中提取环境变量值的容器应用机密的名称。	string
value	非机密环境变量值。	string

ContainerResources

名称	说明	值
cpu	核心中所需的 CPU，例如 0.5	int
内存	所需的内存，例如“250Mb”	字符串

Dapr

名称	说明	值
appId	Dapr 应用程序标识符	string
appPort	达普侧车的港口	int
components	Dapr 组件的集合	DaprComponent[]
enabled	指示是否启用 Dapr 侧车的布尔值	bool

DaprComponent

名称	说明	值
metadata	组件元数据	DaprMetadata[]
name	组件名称	string
type	组件类型	字符串
版本	组件版本	字符串

DaprMetadata

名称	说明	值
name	元数据属性名称。	字符串
secretRef	要从中提取元数据属性值的容器应用机密的名称。	string
value	元数据属性值。	字符串

缩放

名称	说明	值
maxReplicas	可选。容器副本的最大数目。如果未设置，则默认为 10。	int
minReplicas	可选。最小容器副本数。	int
规则	缩放规则。	ScaleRule[]

ScaleRule

名称	说明	值
azureQueue	基于 Azure 队列的缩放。	QueueScaleRule
自定义	自定义缩放规则。	CustomScaleRule
http	基于 HTTP 请求的缩放。	HttpScaleRule
name	缩放规则名称	字符串

QueueScaleRule

名称	说明	值
auth	队列缩放规则的身份验证机密。	ScaleRuleAuth[]
queueLength	队列长度。	int
queueName	队列名称。	字符串

ScaleRuleAuth

名称	说明	值
secretRef	要从中提取身份验证参数的容器应用机密的名称。	string
triggerParameter	使用机密的触发器参数	字符串

CustomScaleRule

名称	说明	值
auth	自定义缩放规则的身份验证机密。	ScaleRuleAuth[]
metadata	描述自定义缩放规则的元数据属性。	对象 (object)
type	自定义缩放规则的类型例如：azure-servicebus、redis 等。	字符串

HttpScaleRule

名称	说明	值
auth	自定义缩放规则的身份验证机密。	ScaleRuleAuth[]
metadata	用于描述 http 缩放规则的元数据属性。	对象 (object)

Share via

Microsoft.Web containerApps 2021-03-01

Bicep 资源定义

备注

资源格式

属性值

containerApps

ContainerAppProperties

配置

流入量

TrafficWeight

RegistryCredentials

Secret

模板

容器

EnvironmentVar

ContainerResources

Dapr

DaprComponent

DaprMetadata

缩放

ScaleRule

QueueScaleRule

ScaleRuleAuth

CustomScaleRule

HttpScaleRule

ARM 模板资源定义

备注

资源格式

属性值

containerApps

ContainerAppProperties

配置

流入量

TrafficWeight

RegistryCredentials

Secret

模板

容器

EnvironmentVar

ContainerResources

Dapr

DaprComponent

DaprMetadata

缩放

ScaleRule

QueueScaleRule

ScaleRuleAuth

CustomScaleRule

HttpScaleRule

Terraform (AzAPI 提供程序) 资源定义

资源格式

属性值

containerApps

ContainerAppProperties

配置

流入量

TrafficWeight

RegistryCredentials

Secret

模板

容器

EnvironmentVar

ContainerResources

Dapr

DaprComponent

DaprMetadata

缩放

ScaleRule

QueueScaleRule

ScaleRuleAuth

CustomScaleRule

HttpScaleRule

反馈

反馈

其他资源