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

Microsoft.Web 容器应用程序 2023-01-01

言论

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

有关迁移的信息,请参阅 操作必需:Namespace从 Microsoft.Web 迁移到 2022 年 3 月的 Microsoft.App

Bicep 资源定义

可以使用目标操作部署 containerApps 资源类型:

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

资源格式

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

resource symbolicname 'Microsoft.Web/containerApps@2023-01-01' = {
  kind: 'string'
  location: 'string'
  name: '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: {
                {customized property}: 'string'
              }
              type: 'string'
            }
            http: {
              auth: [
                {
                  secretRef: 'string'
                  triggerParameter: 'string'
                }
              ]
              metadata: {
                {customized property}: 'string'
              }
            }
            name: 'string'
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

Microsoft.Web/containerApps

名字 描述 价值
资源类型。 字符串
位置 资源位置。 string (必需)
名字 资源名称 string (必需)
性能 ContainerApp 资源特定属性 ContainerApp属性
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

配置

名字 描述 价值
activeRevisionsMode ActiveRevisionsMode 控制如何处理容器应用的活动修订:
<列表><项>多个:多个修订可以处于活动状态。 如果未提供任何值,则这是默认</item><项>单个:一次只能有一个修订处于活动状态。 无法在此模式下使用此模式的修订权重</item></list>
“multiple”
“single”
入口 入口配置。 入口
登记处 容器应用使用的容器的专用容器注册表凭据的集合 RegistryCredentials[]
秘密 容器应用使用的机密集合 机密[]

容器

名字 描述 价值
参数 容器启动命令参数。 字符串[]
命令 容器启动命令。 字符串[]
环境 容器环境变量。 EnvironmentVar (环境变量
图像 容器映像标记。 字符串
名字 自定义容器名称。 字符串
资源 容器资源要求。 容器资源

ContainerApp属性

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

容器资源

名字 描述 价值
中央处理器 核心中所需的 CPU,例如 0.5 整数 (int)
记忆 所需的内存,例如“250Mb” 字符串

CustomScaleRule

名字 描述 价值
认证 自定义缩放规则的身份验证机密。 ScaleRuleAuth []
元数据 用于描述自定义缩放规则的元数据属性。 CustomScaleRuleMetadata
类型 自定义缩放规则的类型
例如:azure-servicebus、redis 等。
字符串

CustomScaleRuleMetadata

名字 描述 价值

Dapr

名字 描述 价值
应用程序ID Dapr 应用程序标识符 字符串
appPort 达普侧车的端口 整数 (int)
组件 Dapr 组件的集合 DaprComponent[]
启用 指示 Dapr 侧车是否已启用的布尔值 布尔

Dapr组件

名字 描述 价值
元数据 组件元数据 Dapr元数据
名字 组件名称 字符串
类型 组件类型 字符串
版本 组件版本 字符串

Dapr元数据

名字 描述 价值
名字 元数据属性名称。 字符串
secretRef 的 要从中拉取元数据属性值的容器应用机密的名称。 字符串
价值 元数据属性值。 字符串

EnvironmentVar

名字 描述 价值
名字 环境变量名称。 字符串
secretRef 的 要从中拉取环境变量值的容器应用机密的名称。 字符串
价值 非机密环境变量值。 字符串

HttpScaleRule

名字 描述 价值
认证 自定义缩放规则的身份验证机密。 ScaleRuleAuth []
元数据 描述 http 缩放规则的元数据属性。 HttpScaleRuleMetadata

HttpScaleRuleMetadata

名字 描述 价值

入口

名字 描述 价值
allowInsecure(允许不安全) 指示是否允许与 HTTP 连接的布尔值。 如果设置为 false HTTP 连接,则会自动重定向到 HTTPS 连接 布尔
外部 指示应用是否公开外部 http 终结点的布尔值 布尔
目标端口 用于来自入口的流量的容器中的目标端口 整数 (int)
交通 TrafficWeight []
运输 入口传输协议 “auto”
“http”
“http2”

QueueScaleRule

名字 描述 价值
认证 队列缩放规则的身份验证机密。 ScaleRuleAuth []
queueLength 队列长度。 整数 (int)
队列名称 队列名称。 字符串

注册表凭据

名字 描述 价值
密码SecretRef 包含注册表登录密码的机密的名称 字符串
服务器 容器注册表服务器 字符串
用户名 容器注册表用户名 字符串

资源标签

名字 描述 价值

规模

名字 描述 价值
最大副本数 自选。 容器副本的最大数目。 如果未设置,则默认为 10。 整数 (int)
最小副本数 自选。 容器副本的最小数量。 整数 (int)
规则 缩放规则。 ScaleRule[]

ScaleRule

名字 描述 价值
azureQueue 基于 Azure 队列的缩放。 QueueScaleRule
习惯 自定义缩放规则。 CustomScaleRule
http 基于 HTTP 请求的缩放。 HttpScaleRule
名字 缩放规则名称 字符串

ScaleRuleAuth 的

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

秘密

名字 描述 价值
名字 机密名称。 字符串
价值 机密值。 字符串

约束:
敏感值。 以安全参数的形式传入。

模板

名字 描述 价值
器皿 容器应用的容器定义列表。 容器[]
dapr(分布式应用程序运行时) 容器应用的 Dapr 配置。 Dapr
revisionSuffix 追加到修订名称的用户友好后缀 字符串
规模 缩放容器应用的属性。 缩放

TrafficWeight (流量权重)

名字 描述 价值
latestRevision 版本 指示流量权重属于最新的稳定修订 布尔
修订名称 修订的名称 字符串
重量 分配给修订的流量权重 整数 (int)

ARM 模板资源定义

可以使用目标操作部署 containerApps 资源类型:

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

资源格式

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

{
  "type": "Microsoft.Web/containerApps",
  "apiVersion": "2023-01-01",
  "name": "string",
  "kind": "string",
  "location": "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": {
                "{customized property}": "string"
              },
              "type": "string"
            },
            "http": {
              "auth": [
                {
                  "secretRef": "string",
                  "triggerParameter": "string"
                }
              ],
              "metadata": {
                "{customized property}": "string"
              }
            },
            "name": "string"
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

Microsoft.Web/containerApps

名字 描述 价值
apiVersion API 版本 '2023-01-01'
资源类型。 字符串
位置 资源位置。 string (必需)
名字 资源名称 string (必需)
性能 ContainerApp 资源特定属性 ContainerApp属性
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Web/containerApps”

配置

名字 描述 价值
activeRevisionsMode ActiveRevisionsMode 控制如何处理容器应用的活动修订:
<列表><项>多个:多个修订可以处于活动状态。 如果未提供任何值,则这是默认</item><项>单个:一次只能有一个修订处于活动状态。 无法在此模式下使用此模式的修订权重</item></list>
“multiple”
“single”
入口 入口配置。 入口
登记处 容器应用使用的容器的专用容器注册表凭据的集合 RegistryCredentials[]
秘密 容器应用使用的机密集合 机密[]

容器

名字 描述 价值
参数 容器启动命令参数。 字符串[]
命令 容器启动命令。 字符串[]
环境 容器环境变量。 EnvironmentVar (环境变量
图像 容器映像标记。 字符串
名字 自定义容器名称。 字符串
资源 容器资源要求。 容器资源

ContainerApp属性

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

容器资源

名字 描述 价值
中央处理器 核心中所需的 CPU,例如 0.5 整数 (int)
记忆 所需的内存,例如“250Mb” 字符串

CustomScaleRule

名字 描述 价值
认证 自定义缩放规则的身份验证机密。 ScaleRuleAuth []
元数据 用于描述自定义缩放规则的元数据属性。 CustomScaleRuleMetadata
类型 自定义缩放规则的类型
例如:azure-servicebus、redis 等。
字符串

CustomScaleRuleMetadata

名字 描述 价值

Dapr

名字 描述 价值
应用程序ID Dapr 应用程序标识符 字符串
appPort 达普侧车的端口 整数 (int)
组件 Dapr 组件的集合 DaprComponent[]
启用 指示 Dapr 侧车是否已启用的布尔值 布尔

Dapr组件

名字 描述 价值
元数据 组件元数据 Dapr元数据
名字 组件名称 字符串
类型 组件类型 字符串
版本 组件版本 字符串

Dapr元数据

名字 描述 价值
名字 元数据属性名称。 字符串
secretRef 的 要从中拉取元数据属性值的容器应用机密的名称。 字符串
价值 元数据属性值。 字符串

EnvironmentVar

名字 描述 价值
名字 环境变量名称。 字符串
secretRef 的 要从中拉取环境变量值的容器应用机密的名称。 字符串
价值 非机密环境变量值。 字符串

HttpScaleRule

名字 描述 价值
认证 自定义缩放规则的身份验证机密。 ScaleRuleAuth []
元数据 描述 http 缩放规则的元数据属性。 HttpScaleRuleMetadata

HttpScaleRuleMetadata

名字 描述 价值

入口

名字 描述 价值
allowInsecure(允许不安全) 指示是否允许与 HTTP 连接的布尔值。 如果设置为 false HTTP 连接,则会自动重定向到 HTTPS 连接 布尔
外部 指示应用是否公开外部 http 终结点的布尔值 布尔
目标端口 用于来自入口的流量的容器中的目标端口 整数 (int)
交通 TrafficWeight []
运输 入口传输协议 “auto”
“http”
“http2”

QueueScaleRule

名字 描述 价值
认证 队列缩放规则的身份验证机密。 ScaleRuleAuth []
queueLength 队列长度。 整数 (int)
队列名称 队列名称。 字符串

注册表凭据

名字 描述 价值
密码SecretRef 包含注册表登录密码的机密的名称 字符串
服务器 容器注册表服务器 字符串
用户名 容器注册表用户名 字符串

资源标签

名字 描述 价值

规模

名字 描述 价值
最大副本数 自选。 容器副本的最大数目。 如果未设置,则默认为 10。 整数 (int)
最小副本数 自选。 容器副本的最小数量。 整数 (int)
规则 缩放规则。 ScaleRule[]

ScaleRule

名字 描述 价值
azureQueue 基于 Azure 队列的缩放。 QueueScaleRule
习惯 自定义缩放规则。 CustomScaleRule
http 基于 HTTP 请求的缩放。 HttpScaleRule
名字 缩放规则名称 字符串

ScaleRuleAuth 的

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

秘密

名字 描述 价值
名字 机密名称。 字符串
价值 机密值。 字符串

约束:
敏感值。 以安全参数的形式传入。

模板

名字 描述 价值
器皿 容器应用的容器定义列表。 容器[]
dapr(分布式应用程序运行时) 容器应用的 Dapr 配置。 Dapr
revisionSuffix 追加到修订名称的用户友好后缀 字符串
规模 缩放容器应用的属性。 缩放

TrafficWeight (流量权重)

名字 描述 价值
latestRevision 版本 指示流量权重属于最新的稳定修订 布尔
修订名称 修订的名称 字符串
重量 分配给修订的流量权重 整数 (int)

用法示例

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

可以使用目标操作部署 containerApps 资源类型:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/containerApps@2023-01-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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 = {
                  {customized property} = "string"
                }
                type = "string"
              }
              http = {
                auth = [
                  {
                    secretRef = "string"
                    triggerParameter = "string"
                  }
                ]
                metadata = {
                  {customized property} = "string"
                }
              }
              name = "string"
            }
          ]
        }
      }
    }
  }
}

属性值

Microsoft.Web/containerApps

名字 描述 价值
资源类型。 字符串
位置 资源位置。 string (必需)
名字 资源名称 string (必需)
性能 ContainerApp 资源特定属性 ContainerApp属性
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Web/containerApps@2023-01-01”

配置

名字 描述 价值
activeRevisionsMode ActiveRevisionsMode 控制如何处理容器应用的活动修订:
<列表><项>多个:多个修订可以处于活动状态。 如果未提供任何值,则这是默认</item><项>单个:一次只能有一个修订处于活动状态。 无法在此模式下使用此模式的修订权重</item></list>
“multiple”
“single”
入口 入口配置。 入口
登记处 容器应用使用的容器的专用容器注册表凭据的集合 RegistryCredentials[]
秘密 容器应用使用的机密集合 机密[]

容器

名字 描述 价值
参数 容器启动命令参数。 字符串[]
命令 容器启动命令。 字符串[]
环境 容器环境变量。 EnvironmentVar (环境变量
图像 容器映像标记。 字符串
名字 自定义容器名称。 字符串
资源 容器资源要求。 容器资源

ContainerApp属性

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

容器资源

名字 描述 价值
中央处理器 核心中所需的 CPU,例如 0.5 整数 (int)
记忆 所需的内存,例如“250Mb” 字符串

CustomScaleRule

名字 描述 价值
认证 自定义缩放规则的身份验证机密。 ScaleRuleAuth []
元数据 用于描述自定义缩放规则的元数据属性。 CustomScaleRuleMetadata
类型 自定义缩放规则的类型
例如:azure-servicebus、redis 等。
字符串

CustomScaleRuleMetadata

名字 描述 价值

Dapr

名字 描述 价值
应用程序ID Dapr 应用程序标识符 字符串
appPort 达普侧车的端口 整数 (int)
组件 Dapr 组件的集合 DaprComponent[]
启用 指示 Dapr 侧车是否已启用的布尔值 布尔

Dapr组件

名字 描述 价值
元数据 组件元数据 Dapr元数据
名字 组件名称 字符串
类型 组件类型 字符串
版本 组件版本 字符串

Dapr元数据

名字 描述 价值
名字 元数据属性名称。 字符串
secretRef 的 要从中拉取元数据属性值的容器应用机密的名称。 字符串
价值 元数据属性值。 字符串

EnvironmentVar

名字 描述 价值
名字 环境变量名称。 字符串
secretRef 的 要从中拉取环境变量值的容器应用机密的名称。 字符串
价值 非机密环境变量值。 字符串

HttpScaleRule

名字 描述 价值
认证 自定义缩放规则的身份验证机密。 ScaleRuleAuth []
元数据 描述 http 缩放规则的元数据属性。 HttpScaleRuleMetadata

HttpScaleRuleMetadata

名字 描述 价值

入口

名字 描述 价值
allowInsecure(允许不安全) 指示是否允许与 HTTP 连接的布尔值。 如果设置为 false HTTP 连接,则会自动重定向到 HTTPS 连接 布尔
外部 指示应用是否公开外部 http 终结点的布尔值 布尔
目标端口 用于来自入口的流量的容器中的目标端口 整数 (int)
交通 TrafficWeight []
运输 入口传输协议 “auto”
“http”
“http2”

QueueScaleRule

名字 描述 价值
认证 队列缩放规则的身份验证机密。 ScaleRuleAuth []
queueLength 队列长度。 整数 (int)
队列名称 队列名称。 字符串

注册表凭据

名字 描述 价值
密码SecretRef 包含注册表登录密码的机密的名称 字符串
服务器 容器注册表服务器 字符串
用户名 容器注册表用户名 字符串

资源标签

名字 描述 价值

规模

名字 描述 价值
最大副本数 自选。 容器副本的最大数目。 如果未设置,则默认为 10。 整数 (int)
最小副本数 自选。 容器副本的最小数量。 整数 (int)
规则 缩放规则。 ScaleRule[]

ScaleRule

名字 描述 价值
azureQueue 基于 Azure 队列的缩放。 QueueScaleRule
习惯 自定义缩放规则。 CustomScaleRule
http 基于 HTTP 请求的缩放。 HttpScaleRule
名字 缩放规则名称 字符串

ScaleRuleAuth 的

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

秘密

名字 描述 价值
名字 机密名称。 字符串
价值 机密值。 字符串

约束:
敏感值。 以安全参数的形式传入。

模板

名字 描述 价值
器皿 容器应用的容器定义列表。 容器[]
dapr(分布式应用程序运行时) 容器应用的 Dapr 配置。 Dapr
revisionSuffix 追加到修订名称的用户友好后缀 字符串
规模 缩放容器应用的属性。 缩放

TrafficWeight (流量权重)

名字 描述 价值
latestRevision 版本 指示流量权重属于最新的稳定修订 布尔
修订名称 修订的名称 字符串
重量 分配给修订的流量权重 整数 (int)