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

Container Apps - List By Resource Group

参考

服务:: Azure Container Apps

API 版本:: 2024-03-01

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

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

URI 参数

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

响应

名称	类型	说明
200 OK	ContainerAppCollection	确定
Other Status Codes	DefaultErrorResponse	常见错误响应。

安全性

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.App/containerApps?api-version=2024-03-01


/**
 * Samples for ContainerApps ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ContainerApps_ListByResourceGroup.
     * json
     */
    /**
     * Sample code: List Container Apps by resource group.
     * 
     * @param manager Entry point to ContainerAppsApiManager.
     */
    public static void
        listContainerAppsByResourceGroup(com.azure.resourcemanager.appcontainers.ContainerAppsApiManager manager) {
        manager.containerApps().listByResourceGroup("rg", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.appcontainers import ContainerAppsAPIClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appcontainers
# USAGE
    python container_apps_list_by_resource_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerAppsAPIClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.container_apps.list_by_resource_group(
        resource_group_name="rg",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ContainerApps_ListByResourceGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappcontainers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/edf14cc0a577f6b9c4e3ce018cec0c383e64b7b0/specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ContainerApps_ListByResourceGroup.json
func ExampleContainerAppsClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewContainerAppsClient().NewListByResourceGroupPager("rg", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ContainerAppCollection = armappcontainers.ContainerAppCollection{
		// 	Value: []*armappcontainers.ContainerApp{
		// 		{
		// 			Name: to.Ptr("testcontainerapp0"),
		// 			Type: to.Ptr("Microsoft.App/containerApps"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0"),
		// 			Location: to.Ptr("East US"),
		// 			Properties: &armappcontainers.ContainerAppProperties{
		// 				Configuration: &armappcontainers.Configuration{
		// 					Dapr: &armappcontainers.Dapr{
		// 						AppPort: to.Ptr[int32](3000),
		// 						AppProtocol: to.Ptr(armappcontainers.AppProtocolHTTP),
		// 						EnableAPILogging: to.Ptr(true),
		// 						Enabled: to.Ptr(true),
		// 						HTTPMaxRequestSize: to.Ptr[int32](10),
		// 						HTTPReadBufferSize: to.Ptr[int32](30),
		// 						LogLevel: to.Ptr(armappcontainers.LogLevelDebug),
		// 					},
		// 					Ingress: &armappcontainers.Ingress{
		// 						CustomDomains: []*armappcontainers.CustomDomain{
		// 							{
		// 								Name: to.Ptr("www.my-name.com"),
		// 								BindingType: to.Ptr(armappcontainers.BindingTypeSniEnabled),
		// 								CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com"),
		// 							},
		// 							{
		// 								Name: to.Ptr("www.my--other-name.com"),
		// 								BindingType: to.Ptr(armappcontainers.BindingTypeSniEnabled),
		// 								CertificateID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"),
		// 						}},
		// 						External: to.Ptr(true),
		// 						Fqdn: to.Ptr("testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
		// 						IPSecurityRestrictions: []*armappcontainers.IPSecurityRestrictionRule{
		// 							{
		// 								Name: to.Ptr("Allow work IP A subnet"),
		// 								Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
		// 								Action: to.Ptr(armappcontainers.ActionAllow),
		// 								IPAddressRange: to.Ptr("192.168.1.1/32"),
		// 							},
		// 							{
		// 								Name: to.Ptr("Allow work IP B subnet"),
		// 								Description: to.Ptr("Allowing all IP's within the subnet below to access containerapp"),
		// 								Action: to.Ptr(armappcontainers.ActionAllow),
		// 								IPAddressRange: to.Ptr("192.168.1.1/8"),
		// 						}},
		// 						StickySessions: &armappcontainers.IngressStickySessions{
		// 							Affinity: to.Ptr(armappcontainers.AffinitySticky),
		// 						},
		// 						TargetPort: to.Ptr[int32](3000),
		// 						Traffic: []*armappcontainers.TrafficWeight{
		// 							{
		// 								RevisionName: to.Ptr("testcontainerapp0-ab1234"),
		// 								Weight: to.Ptr[int32](80),
		// 							},
		// 							{
		// 								Label: to.Ptr("staging"),
		// 								RevisionName: to.Ptr("testcontainerapp0-ab4321"),
		// 								Weight: to.Ptr[int32](20),
		// 						}},
		// 						Transport: to.Ptr(armappcontainers.IngressTransportMethodAuto),
		// 					},
		// 					MaxInactiveRevisions: to.Ptr[int32](10),
		// 				},
		// 				EventStreamEndpoint: to.Ptr("testEndpoint"),
		// 				LatestReadyRevisionName: to.Ptr("testcontainerapp0-pjxhsye"),
		// 				LatestRevisionFqdn: to.Ptr("testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io"),
		// 				ManagedEnvironmentID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube"),
		// 				ProvisioningState: to.Ptr(armappcontainers.ContainerAppProvisioningStateSucceeded),
		// 				Template: &armappcontainers.Template{
		// 					Containers: []*armappcontainers.Container{
		// 						{
		// 							Name: to.Ptr("testcontainerapp0"),
		// 							Image: to.Ptr("repo/testcontainerapp0:v4"),
		// 							Resources: &armappcontainers.ContainerResources{
		// 								CPU: to.Ptr[float64](0.5),
		// 								Memory: to.Ptr("1Gi"),
		// 							},
		// 					}},
		// 					InitContainers: []*armappcontainers.InitContainer{
		// 						{
		// 							Name: to.Ptr("testinitcontainerApp0"),
		// 							Image: to.Ptr("repo/testcontainerapp0:v4"),
		// 							Resources: &armappcontainers.ContainerResources{
		// 								CPU: to.Ptr[float64](0.5),
		// 								Memory: to.Ptr("1Gi"),
		// 							},
		// 					}},
		// 					Scale: &armappcontainers.Scale{
		// 						MaxReplicas: to.Ptr[int32](5),
		// 						MinReplicas: to.Ptr[int32](1),
		// 						Rules: []*armappcontainers.ScaleRule{
		// 							{
		// 								Name: to.Ptr("httpscalingrule"),
		// 								HTTP: &armappcontainers.HTTPScaleRule{
		// 									Metadata: map[string]*string{
		// 										"concurrentRequests": to.Ptr("50"),
		// 									},
		// 								},
		// 						}},
		// 					},
		// 				},
		// 				WorkloadProfileName: to.Ptr("My-GP-01"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ContainerAppsAPIClient } = require("@azure/arm-appcontainers");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the Container Apps in a given resource group.
 *
 * @summary Get the Container Apps in a given resource group.
 * x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ContainerApps_ListByResourceGroup.json
 */
async function listContainerAppsByResourceGroup() {
  const subscriptionId =
    process.env["APPCONTAINERS_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPCONTAINERS_RESOURCE_GROUP"] || "rg";
  const credential = new DefaultAzureCredential();
  const client = new ContainerAppsAPIClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.containerApps.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppContainers.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppContainers;

// Generated from example definition: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ContainerApps_ListByResourceGroup.json
// this example is just showing the usage of "ContainerApps_ListByResourceGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ContainerAppResource
ContainerAppCollection collection = resourceGroupResource.GetContainerApps();

// invoke the operation and iterate over the result
await foreach (ContainerAppResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ContainerAppData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0",
      "name": "testcontainerapp0",
      "type": "Microsoft.App/containerApps",
      "location": "East US",
      "properties": {
        "provisioningState": "Succeeded",
        "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube",
        "workloadProfileName": "My-GP-01",
        "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io",
        "latestReadyRevisionName": "testcontainerapp0-pjxhsye",
        "configuration": {
          "ingress": {
            "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io",
            "external": true,
            "targetPort": 3000,
            "transport": "auto",
            "customDomains": [
              {
                "name": "www.my-name.com",
                "bindingType": "SniEnabled",
                "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com"
              },
              {
                "name": "www.my--other-name.com",
                "bindingType": "SniEnabled",
                "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com"
              }
            ],
            "traffic": [
              {
                "weight": 80,
                "revisionName": "testcontainerapp0-ab1234"
              },
              {
                "weight": 20,
                "revisionName": "testcontainerapp0-ab4321",
                "label": "staging"
              }
            ],
            "ipSecurityRestrictions": [
              {
                "name": "Allow work IP A subnet",
                "description": "Allowing all IP's within the subnet below to access containerapp",
                "ipAddressRange": "192.168.1.1/32",
                "action": "Allow"
              },
              {
                "name": "Allow work IP B subnet",
                "description": "Allowing all IP's within the subnet below to access containerapp",
                "ipAddressRange": "192.168.1.1/8",
                "action": "Allow"
              }
            ],
            "stickySessions": {
              "affinity": "sticky"
            }
          },
          "dapr": {
            "enabled": true,
            "appPort": 3000,
            "appProtocol": "http",
            "httpReadBufferSize": 30,
            "httpMaxRequestSize": 10,
            "logLevel": "debug",
            "enableApiLogging": true
          },
          "maxInactiveRevisions": 10
        },
        "template": {
          "containers": [
            {
              "image": "repo/testcontainerapp0:v4",
              "name": "testcontainerapp0",
              "resources": {
                "cpu": 0.5,
                "memory": "1Gi"
              }
            }
          ],
          "initContainers": [
            {
              "image": "repo/testcontainerapp0:v4",
              "name": "testinitcontainerApp0",
              "resources": {
                "cpu": 0.5,
                "memory": "1Gi"
              }
            }
          ],
          "scale": {
            "minReplicas": 1,
            "maxReplicas": 5,
            "rules": [
              {
                "name": "httpscalingrule",
                "http": {
                  "metadata": {
                    "concurrentRequests": "50"
                  }
                }
              }
            ]
          }
        },
        "eventStreamEndpoint": "testEndpoint"
      }
    }
  ],
  "nextLink": null
}

定义

名称	说明
action	允许或拒绝规则来确定传入 IP。注意：规则只能包含“所有允许”或“全部拒绝”
ActiveRevisionsMode	ActiveRevisionsMode 控制如何处理容器应用的活动修订：多个修订可以处于活动状态。单一：一次只能有一个修订处于活动状态。修订权重不能在此模式下使用。如果未提供任何值，则为默认值。
affinity	粘滞会话相关性
appProtocol	告知 Dapr 你的应用程序所使用的协议。有效选项为 http 和 grpc。默认值为 http
bindingType	Custom Domain绑定类型。
Configuration	用于定义容器应用的可变设置的非版本控制容器应用配置属性
Container	容器应用容器定义
ContainerApp	容器应用。
ContainerAppCollection	容器应用集合 ARM 资源。
ContainerAppProbe	探测描述要对容器执行的运行状况检查，以确定容器是处于活动状态还是已准备好接收流量。
ContainerAppProvisioningState	容器应用的预配状态。
ContainerResources	容器应用容器资源要求。
CorsPolicy	跨源资源共享策略
createdByType	创建资源的标识类型。
CustomDomain	容器应用的Custom Domain
CustomScaleRule	容器应用容器自定义缩放规则。
Dapr	容器应用 Dapr 配置。
DefaultErrorResponse	App 服务错误响应。
Details	详细信息或错误
EnvironmentVar	容器应用容器环境变量。
Error	错误模型。
ExtendedLocation	扩展位置的复杂类型。
ExtendedLocationTypes	扩展位置的类型。
HttpGet	HTTPGet 指定要执行的 http 请求。
HttpHeaders	在请求中设置的自定义标头。 HTTP 允许重复标头。
HttpScaleRule	容器应用容器 Http 缩放规则。
Ingress	容器应用入口配置。
IngressClientCertificateMode	用于 mTLS 身份验证的客户端证书模式。 Ignore 表示服务器在转发时丢弃客户端证书。接受指示服务器转发客户端证书，但不需要客户端证书。 Require 表示服务器需要客户端证书。
IngressPortMapping	容器应用入口的端口映射
IngressTransportMethod	入口传输协议
InitContainer	容器应用初始化容器定义
IpSecurityRestrictionRule	限制传入 IP 地址的规则。
logLevel	设置 Dapr 挎斗的日志级别。允许的值为 debug、info、warn、error。默认值为 info。
ManagedServiceIdentity	托管服务标识 (系统分配的标识和/或用户分配的标识)
ManagedServiceIdentityType	) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。
QueueScaleRule	容器应用容器基于 Azure 队列的缩放规则。
RegistryCredentials	容器应用专用注册表
Scale	容器应用缩放配置。
ScaleRule	容器应用容器缩放规则。
ScaleRuleAuth	缩放规则的身份验证机密
Scheme	用于连接到主机的方案。默认为 HTTP。
Secret	机密定义。
SecretVolumeItem	要添加到卷的机密。
Service	要成为开发服务的容器应用
ServiceBind	用于将 ContainerApp 绑定到开发 ContainerApp 服务的配置
StickySessions	单修订模式的粘滞会话
StorageType	卷的存储类型。如果未提供，请使用 EmptyDir。
systemData	与资源的创建和上次修改相关的元数据。
TcpScaleRule	容器应用容器 Tcp 缩放规则。
TcpSocket	TCPSocket 指定涉及 TCP 端口的操作。尚不支持 TCP 挂钩。
Template	容器应用版本控制的应用程序定义。定义不可变修订的所需状态。对此部分所做的任何更改都将导致创建新的修订
TrafficWeight	分配给修订的流量权重
Type	探测的类型。
UserAssignedIdentity	用户分配的标识属性
Volume	容器应用的卷定义。
VolumeMount	容器应用的卷装载。

action

允许或拒绝规则来确定传入 IP。注意：规则只能包含“所有允许”或“全部拒绝”

名称	类型	说明
Allow	string
Deny	string

ActiveRevisionsMode

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

名称	类型	说明
Multiple	string
Single	string

affinity

粘滞会话相关性

名称	类型	说明
none	string
sticky	string

appProtocol

告知 Dapr 你的应用程序所使用的协议。有效选项为 http 和 grpc。默认值为 http

名称	类型	说明
grpc	string
http	string

bindingType

Custom Domain绑定类型。

名称	类型	说明
Disabled	string
SniEnabled	string

Configuration

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

名称	类型	默认值	说明
activeRevisionsMode	ActiveRevisionsMode	Single	ActiveRevisionsMode 控制如何处理容器应用的活动修订：多个修订可以处于活动状态。单个：一次只能有一个修订处于活动状态。修订权重不能在此模式下使用。如果未提供任何值，则这是默认值。
dapr	Dapr		容器应用的 Dapr 配置。
ingress	Ingress		入口配置。
maxInactiveRevisions	integer		可选。容器应用可以具有的最大非活动修订数。
registries	RegistryCredentials[]		容器应用使用的容器的专用容器注册表凭据集合
secrets	Secret[]		容器应用使用的机密集合
service	Service		容器应用成为开发容器App 服务

Container

容器应用容器定义

名称	类型	说明
args	string[]	容器启动命令参数。
command	string[]	容器启动命令。
env	EnvironmentVar[]	容器环境变量。
image	string	容器映像标记。
name	string	自定义容器名称。
probes	ContainerAppProbe[]	容器的探测列表。
resources	ContainerResources	容器资源要求。
volumeMounts	VolumeMount[]	容器卷装载。

ContainerApp

容器应用。

名称	类型	说明
extendedLocation	ExtendedLocation	扩展位置的复杂类型。
id	string	资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	容器应用的托管标识，用于与其他 Azure 服务交互，而无需在代码中维护任何机密或凭据。
location	string	资源所在的地理位置
managedBy	string	管理此资源的资源的完全限定的资源 ID。指示此资源是否由另一个 Azure 资源管理。如果存在这种情况，如果从模板中删除资源，则完整模式部署不会删除该资源，因为它由另一个资源管理。
name	string	资源的名称
properties.configuration	Configuration	非版本控制容器应用配置属性。
properties.customDomainVerificationId	string	用于验证域名所有权的 ID
properties.environmentId	string	环境的资源 ID。
properties.eventStreamEndpoint	string	容器应用的事件流的终结点。
properties.latestReadyRevisionName	string	容器应用的最新就绪修订版的名称。
properties.latestRevisionFqdn	string	容器应用最新修订版的完全限定域名。
properties.latestRevisionName	string	容器应用的最新修订版的名称。
properties.managedEnvironmentId	string	已弃用。容器应用环境的资源 ID。
properties.outboundIpAddresses	string[]	容器应用的出站 IP 地址。
properties.provisioningState	ContainerAppProvisioningState	容器应用的预配状态。
properties.template	Template	容器应用版本控制的应用程序定义。
properties.workloadProfileName	string	要固定的工作负载配置文件名称，以便执行容器应用。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ContainerAppCollection

容器应用集合 ARM 资源。

名称	类型	说明
nextLink	string	链接到下一页资源。
value	ContainerApp[]	资源集合。

ContainerAppProbe

探测描述要对容器执行的运行状况检查，以确定容器是处于活动状态还是已准备好接收流量。

名称	类型	说明
failureThreshold	integer	在成功后，要被视为失败的探测的最小连续失败次数。默认值为 3。最小值为 1。最大值为 10。
httpGet	HttpGet	HTTPGet 指定要执行的 http 请求。
initialDelaySeconds	integer	启动容器后，启动运行情况探测前的秒数。最小值为 1。最大值为 60。
periodSeconds	integer	执行探测的频率（以秒为单位）。默认值为 10 秒。最小值为 1。最大值为 240。
successThreshold	integer	失败后，要被视为成功的探测的最小连续成功。默认值为 1。对于运行和启动，必须为 1。最小值为 1。最大值为 10。
tcpSocket	TcpSocket	TCPSocket 指定涉及 TCP 端口的操作。尚不支持 TCP 挂钩。
terminationGracePeriodSeconds	integer	探测失败时 Pod 需要正常终止的可选持续时间（以秒为单位）。宽限期是向 Pod 中运行的进程发送终止信号之后的持续时间（以秒为单位）以及用终止信号强行停止进程的时间。请将此值设置为大于你的进程的预期清理时间。如果此值为 nil，将使用 Pod 的 terminationGracePeriodSeconds。否则，此值将替代 Pod 规范提供的值。值必须是非负整数。值 0 指示通过终止信号立即停止， (没有机会关闭) 。这是一个 alpha 字段，需要启用 ProbeTerminationGracePeriod 功能门。最大值为 3600 秒 (1 小时)
timeoutSeconds	integer	探测超时的秒数。默认为 1 秒。最小值为 1。最大值为 240。
type	Type	探测的类型。

ContainerAppProvisioningState

容器应用的预配状态。

名称	类型	说明
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

ContainerResources

容器应用容器资源要求。

名称	类型	说明
cpu	number	核心中所需的 CPU，例如 0.5
ephemeralStorage	string	临时存储，例如“1Gi”
memory	string	所需内存，例如“250Mb”

CorsPolicy

跨源资源共享策略

名称	类型	说明
allowCredentials	boolean	指定资源是否允许凭据
allowedHeaders	string[]	指定 access-control-allow-headers 标头的内容
allowedMethods	string[]	指定 access-control-allow-methods 标头的内容
allowedOrigins	string[]	指定 access-control-allow-origins 标头的内容
exposeHeaders	string[]	指定 access-control-expose-headers 标头的内容
maxAge	integer	指定 access-control-max-age 标头的内容

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

CustomDomain

容器应用的Custom Domain

名称	类型	说明
bindingType	bindingType	Custom Domain绑定类型。
certificateId	string	要绑定到此主机名的证书的资源 ID。必须存在于托管环境中。
name	string	主机名

CustomScaleRule

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

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

Dapr

容器应用 Dapr 配置。

名称	类型	默认值	说明
appId	string		Dapr 应用程序标识符
appPort	integer		告知 Dapr 应用程序正在侦听哪个端口
appProtocol	appProtocol	http	告知 Dapr 你的应用程序所使用的协议。有效选项为 http 和 grpc。默认值为 http
enableApiLogging	boolean		为 Dapr 挎斗启用 API 日志记录
enabled	boolean	False	指示是否启用 Dapr 侧车的布尔值
httpMaxRequestSize	integer		增加请求正文 http 和 grpc 服务器参数的最大大小（以 MB 为单位）以处理大文件的上传。默认值为 4 MB。
httpReadBufferSize	integer		发送多 KB 标头时要处理的 http 标头读取缓冲区的最大 Dapr 大小（以 KB 为单位）。默认值为 65KB。
logLevel	logLevel		设置 Dapr 挎斗的日志级别。允许的值为 debug、info、warn、error。默认值为信息。

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	详细的错误说明和调试信息。

ExtendedLocation

扩展位置的复杂类型。

名称	类型	说明
name	string	扩展位置的名称。
type	ExtendedLocationTypes	扩展位置的类型。

ExtendedLocationTypes

扩展位置的类型。

名称	类型	说明
CustomLocation	string

HttpGet

HTTPGet 指定要执行的 http 请求。

名称	类型	说明
host	string	要连接到的主机名，默认为 Pod IP。你可能想要改为在 httpHeaders 中设置“主机”。
httpHeaders	HttpHeaders[]	在请求中设置的自定义标头。 HTTP 允许重复标头。
path	string	HTTP 服务器上的访问路径。
port	integer	要在容器上访问的端口的名称或编号。数字必须在 1 到 65535 的范围内。名称必须是IANA_SVC_NAME。
scheme	Scheme	用于连接到主机的方案。默认为 HTTP。

HttpHeaders

在请求中设置的自定义标头。 HTTP 允许重复标头。

名称	类型	说明
name	string	标头字段名称
value	string	标头字段值

HttpScaleRule

容器应用容器 Http 缩放规则。

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

Ingress

容器应用入口配置。

名称	类型	默认值	说明
additionalPortMappings	IngressPortMapping[]		用于在容器应用上公开其他端口的设置
allowInsecure	boolean	False	Bool 指示是否允许与的 HTTP 连接。如果设置为 false，则 HTTP 连接会自动重定向到 HTTPS 连接
clientCertificateMode	IngressClientCertificateMode		用于 mTLS 身份验证的客户端证书模式。 Ignore 表示服务器在转发时丢弃客户端证书。接受指示服务器转发客户端证书，但不需要客户端证书。 Require 表示服务器需要客户端证书。
corsPolicy	CorsPolicy		容器应用的 CORS 策略
customDomains	CustomDomain[]		容器应用的主机名的自定义域绑定。
exposedPort	integer		容器中为来自入口的 TCP 流量公开的端口
external	boolean	False	指示应用是否公开外部 http 终结点的布尔值
fqdn	string		主机名
ipSecurityRestrictions	IpSecurityRestrictionRule[]		限制传入 IP 地址的规则。
stickySessions	StickySessions		单修订模式的粘滞会话
targetPort	integer		容器中来自入口的流量的目标端口
traffic	TrafficWeight[]		应用修订的流量权重
transport	IngressTransportMethod	auto	入口传输协议

IngressClientCertificateMode

用于 mTLS 身份验证的客户端证书模式。 Ignore 表示服务器在转发时丢弃客户端证书。接受指示服务器转发客户端证书，但不需要客户端证书。 Require 表示服务器需要客户端证书。

名称	类型	说明
accept	string
ignore	string
require	string

IngressPortMapping

容器应用入口的端口映射

名称	类型	说明
exposedPort	integer	指定目标端口的公开端口。如果未指定，则默认为目标端口
external	boolean	指定是否可在环境外部访问应用端口
targetPort	integer	指定端口用户的容器侦听

IngressTransportMethod

入口传输协议

名称	类型	说明
auto	string
http	string
http2	string
tcp	string

InitContainer

容器应用初始化容器定义

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

IpSecurityRestrictionRule

限制传入 IP 地址的规则。

名称	类型	说明
action	action	允许或拒绝规则来确定传入 IP。注意：规则只能包含“所有允许”或“全部拒绝”
description	string	描述要发送到 container-app 的 IP 限制规则。这是一个可选字段。
ipAddressRange	string	用于匹配传入 IP 地址的 CIDR 表示法
name	string	IP 限制规则的名称。

logLevel

设置 Dapr 挎斗的日志级别。允许的值为 debug、info、warn、error。默认值为 info。

名称	类型	说明
debug	string
error	string
info	string
warn	string

ManagedServiceIdentity

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

名称	类型	说明
principalId	string	系统分配的标识的服务主体 ID。此属性仅针对系统分配的标识提供。
tenantId	string	系统分配的标识的租户 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	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

QueueScaleRule

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

名称	类型	说明
auth	ScaleRuleAuth[]	队列缩放规则的身份验证机密。
queueLength	integer	队列长度。
queueName	string	队列名称。

RegistryCredentials

容器应用专用注册表

名称	类型	说明
identity	string	用于对Azure 容器注册表进行身份验证的托管标识。对于用户分配的标识，请使用完整的用户分配标识资源 ID。对于系统分配的标识，请使用“system”
passwordSecretRef	string	包含注册表登录密码的机密的名称
server	string	容器注册表服务器
username	string	容器注册表用户名

Scale

容器应用缩放配置。

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

ScaleRule

容器应用容器缩放规则。

名称	类型	说明
azureQueue	QueueScaleRule	基于 Azure 队列的缩放。
custom	CustomScaleRule	自定义缩放规则。
http	HttpScaleRule	基于 HTTP 请求的缩放。
name	string	缩放规则名称
tcp	TcpScaleRule	基于 Tcp 请求的缩放。

ScaleRuleAuth

缩放规则的身份验证机密

名称	类型	说明
secretRef	string	要从中提取身份验证参数的机密的名称。
triggerParameter	string	使用机密的触发器参数

Scheme

用于连接到主机的方案。默认为 HTTP。

名称	类型	说明
HTTP	string
HTTPS	string

Secret

机密定义。

名称	类型	说明
identity	string	使用 Azure 密钥保管库进行身份验证的托管标识的资源 ID，或者使用系统分配的标识。
keyVaultUrl	string	Azure 密钥保管库指向容器应用引用的机密的 URL。
name	string	机密名称。
value	string	机密值。

SecretVolumeItem

要添加到卷的机密。

名称	类型	说明
path	string	项目机密的路径。如果未提供路径，则 path 默认为 secretRef 中列出的机密名称。
secretRef	string	要从中提取机密值的容器应用机密的名称。

Service

要成为开发服务的容器应用

名称	类型	说明
type	string	Dev ContainerApp 服务类型

ServiceBind

用于将 ContainerApp 绑定到开发 ContainerApp 服务的配置

名称	类型	说明
name	string	服务绑定的名称
serviceId	string	目标服务的资源 ID

StickySessions

单修订模式的粘滞会话

名称	类型	说明
affinity	affinity	粘滞会话相关性

StorageType

卷的存储类型。如果未提供，请使用 EmptyDir。

名称	类型	说明
AzureFile	string
EmptyDir	string
Secret	string

systemData

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

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

TcpScaleRule

容器应用容器 Tcp 缩放规则。

名称	类型	说明
auth	ScaleRuleAuth[]	tcp 缩放规则的身份验证机密。
metadata	object	描述 tcp 缩放规则的元数据属性。

TcpSocket

TCPSocket 指定涉及 TCP 端口的操作。尚不支持 TCP 挂钩。

名称	类型	说明
host	string	可选：要连接到的主机名，默认为 Pod IP。
port	integer	要在容器上访问的端口的编号或名称。数字必须在 1 到 65535 的范围内。名称必须是IANA_SVC_NAME。

Template

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

名称	类型	说明
containers	Container[]	容器应用的容器定义列表。
initContainers	InitContainer[]	在应用容器之前运行的专用容器列表。
revisionSuffix	string	追加到修订名称的用户友好后缀
scale	Scale	容器应用的缩放属性。
serviceBinds	ServiceBind[]	绑定到应用的容器应用服务列表
terminationGracePeriodSeconds	integer	容器应用实例需要正常终止的可选持续时间（以秒为单位）。值必须是非负整数。值 0 指示通过终止信号立即停止， (没有机会关闭) 。如果此值为 nil，则将改用默认宽限期。请将此值设置为大于你的进程的预期清理时间。默认值为 30 秒。
volumes	Volume[]	容器应用的卷定义列表。

TrafficWeight

分配给修订的流量权重

名称	类型	默认值	说明
label	string		将流量标签与修订相关联
latestRevision	boolean	False	指示流量权重属于最新的稳定修订
revisionName	string		修订的名称
weight	integer		分配给修订的流量权重

Type

探测的类型。

名称	类型	说明
Liveness	string
Readiness	string
Startup	string

UserAssignedIdentity

用户分配的标识属性

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

Volume

容器应用的卷定义。

名称	类型	说明
mountOptions	string	装载 AzureFile 时使用的装载选项。必须是逗号分隔的字符串。
name	string	卷名称。
secrets	SecretVolumeItem[]	要添加到卷中的机密列表。如果未提供机密，集合中的所有机密都将添加到卷中。
storageName	string	存储资源的名称。无需提供 EmptyDir 和 Secret。
storageType	StorageType	卷的存储类型。如果未提供，请使用 EmptyDir。

VolumeMount

容器应用的卷装载。

名称	类型	说明
mountPath	string	容器中应装载卷的路径。不得包含“：”。
subPath	string	应从中装载容器卷的卷中的路径。默认为“” (卷的根) 。
volumeName	string	这必须与卷的名称匹配。