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

Container Apps - List By Subscription

Reference

Service:: Azure Container Apps

API Version:: 2023-05-01

Get the Container Apps in a given subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.App/containerApps?api-version=2023-05-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ContainerAppCollection	OK
Other Status Codes	DefaultErrorResponse	Error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List Container Apps by subscription

Sample Request

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

/** Samples for ContainerApps List. */
public final class Main {
    /*
     * x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListBySubscription.json
     */
    /**
     * Sample code: List Container Apps by subscription.
     *
     * @param manager Entry point to ContainerAppsApiManager.
     */
    public static void listContainerAppsBySubscription(
        com.azure.resourcemanager.appcontainers.ContainerAppsApiManager manager) {
        manager.containerApps().list(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_subscription.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_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListBySubscription.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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/58be094c6b365f8d4d73a91e293dfb4818e57cf6/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListBySubscription.json
func ExampleContainerAppsClient_NewListBySubscriptionPager() {
	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().NewListBySubscriptionPager(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),
		// 					Service: &armappcontainers.Service{
		// 						Type: to.Ptr("redis"),
		// 					},
		// 				},
		// 				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.2),
		// 								Memory: to.Ptr("100Mi"),
		// 							},
		// 					}},
		// 					InitContainers: []*armappcontainers.InitContainer{
		// 						{
		// 							Name: to.Ptr("testinitcontainerApp0"),
		// 							Image: to.Ptr("repo/testcontainerApp0:v4"),
		// 							Resources: &armappcontainers.ContainerResources{
		// 								CPU: to.Ptr[float64](0.2),
		// 								Memory: to.Ptr("100Mi"),
		// 							},
		// 					}},
		// 					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"),
		// 									},
		// 								},
		// 						}},
		// 					},
		// 					ServiceBinds: []*armappcontainers.ServiceBind{
		// 						{
		// 							Name: to.Ptr("service"),
		// 							ServiceID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/service"),
		// 					}},
		// 				},
		// 				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 subscription.
 *
 * @summary Get the Container Apps in a given subscription.
 * x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListBySubscription.json
 */
async function listContainerAppsBySubscription() {
  const subscriptionId =
    process.env["APPCONTAINERS_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const credential = new DefaultAzureCredential();
  const client = new ContainerAppsAPIClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.containerApps.listBySubscription()) {
    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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.AppContainers;
using Azure.ResourceManager.AppContainers.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListBySubscription.json
// this example is just showing the usage of "ContainerApps_ListBySubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (ContainerAppResource item in subscriptionResource.GetContainerAppsAsync())
{
    // 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

Sample Response

Status code:: 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,
          "service": {
            "type": "redis"
          }
        },
        "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"
                  }
                }
              }
            ]
          },
          "serviceBinds": [
            {
              "serviceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/service",
              "name": "service"
            }
          ]
        },
        "eventStreamEndpoint": "testEndpoint"
      }
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
action	Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny
ActiveRevisionsMode	ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default.
affinity	Sticky Session Affinity
appProtocol	Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http
bindingType	Custom Domain binding type.
Configuration	Non versioned Container App configuration properties that define the mutable settings of a Container app
Container	Container App container definition
ContainerApp	Container App.
ContainerAppCollection	Container App collection ARM resource.
ContainerAppProbe	Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
ContainerAppProvisioningState	Provisioning state of the Container App.
ContainerResources	Container App container resource requirements.
CorsPolicy	Cross-Origin-Resource-Sharing policy
createdByType	The type of identity that created the resource.
CustomDomain	Custom Domain of a Container App
CustomScaleRule	Container App container Custom scaling rule.
Dapr	Container App Dapr configuration.
DefaultErrorResponse	App Service error response.
Details	Details or the error
EnvironmentVar	Container App container environment variable.
Error	Error model.
ExtendedLocation	The complex type of the extended location.
ExtendedLocationTypes	The type of the extended location.
HttpGet	HTTPGet specifies the http request to perform.
HttpHeaders	Custom headers to set in the request. HTTP allows repeated headers.
HttpScaleRule	Container App container Http scaling rule.
Ingress	Container App Ingress configuration.
IngressClientCertificateMode	Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate.
IngressTransportMethod	Ingress transport protocol
InitContainer	Container App init container definition
IpSecurityRestrictionRule	Rule to restrict incoming IP address.
logLevel	Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
QueueScaleRule	Container App container Azure Queue based scaling rule.
RegistryCredentials	Container App Private Registry
Scale	Container App scaling configurations.
ScaleRule	Container App container scaling rule.
ScaleRuleAuth	Auth Secrets for Scale Rule
Scheme	Scheme to use for connecting to the host. Defaults to HTTP.
Secret	Secret definition.
SecretVolumeItem	Secret to be added to volume.
Service	Container App to be a dev service
ServiceBind	Configuration to bind a ContainerApp to a dev ContainerApp Service
StickySessions	Sticky Sessions for Single Revision Mode
StorageType	Storage type for the volume. If not provided, use EmptyDir.
systemData	Metadata pertaining to creation and last modification of the resource.
TcpScaleRule	Container App container Tcp scaling rule.
TcpSocket	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.
Template	Container App versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created
TrafficWeight	Traffic weight assigned to a revision
Type	The type of probe.
UserAssignedIdentity	User assigned identity properties
Volume	Volume definitions for the Container App.
VolumeMount	Volume mount for the Container App.

action

Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny

Name	Type	Description
Allow	string
Deny	string

ActiveRevisionsMode

ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default.

Name	Type	Description
Multiple	string
Single	string

affinity

Sticky Session Affinity

Name	Type	Description
none	string
sticky	string

appProtocol

Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http

Name	Type	Description
grpc	string
http	string

bindingType

Custom Domain binding type.

Name	Type	Description
Disabled	string
SniEnabled	string

Configuration

Non versioned Container App configuration properties that define the mutable settings of a Container app

Name	Type	Default Value	Description
activeRevisionsMode	ActiveRevisionsMode	Single	ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default.
dapr	Dapr		Dapr configuration for the Container App.
ingress	Ingress		Ingress configurations.
maxInactiveRevisions	integer		Optional. Max inactive revisions a Container App can have.
registries	RegistryCredentials[]		Collection of private container registry credentials for containers used by the Container app
secrets	Secret[]		Collection of secrets used by a Container app
service	Service		Container App to be a dev Container App Service

Container

Container App container definition

Name	Type	Description
args	string[]	Container start command arguments.
command	string[]	Container start command.
env	EnvironmentVar[]	Container environment variables.
image	string	Container image tag.
name	string	Custom container name.
probes	ContainerAppProbe[]	List of probes for the container.
resources	ContainerResources	Container resource requirements.
volumeMounts	VolumeMount[]	Container volume mounts.

ContainerApp

Container App.

Name	Type	Description
extendedLocation	ExtendedLocation	The complex type of the extended location.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code.
location	string	The geo-location where the resource lives
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
name	string	The name of the resource
properties.configuration	Configuration	Non versioned Container App configuration properties.
properties.customDomainVerificationId	string	Id used to verify domain name ownership
properties.environmentId	string	Resource ID of environment.
properties.eventStreamEndpoint	string	The endpoint of the eventstream of the container app.
properties.latestReadyRevisionName	string	Name of the latest ready revision of the Container App.
properties.latestRevisionFqdn	string	Fully Qualified Domain Name of the latest revision of the Container App.
properties.latestRevisionName	string	Name of the latest revision of the Container App.
properties.managedEnvironmentId	string	Deprecated. Resource ID of the Container App's environment.
properties.outboundIpAddresses	string[]	Outbound IP Addresses for container app.
properties.provisioningState	ContainerAppProvisioningState	Provisioning state of the Container App.
properties.template	Template	Container App versioned application definition.
properties.workloadProfileName	string	Workload profile name to pin for container app execution.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ContainerAppCollection

Container App collection ARM resource.

Name	Type	Description
nextLink	string	Link to next page of resources.
value	ContainerApp[]	Collection of resources.

ContainerAppProbe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Name	Type	Description
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.
httpGet	HttpGet	HTTPGet specifies the http request to perform.
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10.
tcpSocket	TcpSocket	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour)
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.
type	Type	The type of probe.

ContainerAppProvisioningState

Provisioning state of the Container App.

Name	Type	Description
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

ContainerResources

Container App container resource requirements.

Name	Type	Description
cpu	number	Required CPU in cores, e.g. 0.5
ephemeralStorage	string	Ephemeral Storage, e.g. "1Gi"
memory	string	Required memory, e.g. "250Mb"

CorsPolicy

Cross-Origin-Resource-Sharing policy

Name	Type	Description
allowCredentials	boolean	Specifies whether the resource allows credentials
allowedHeaders	string[]	Specifies the content for the access-control-allow-headers header
allowedMethods	string[]	Specifies the content for the access-control-allow-methods header
allowedOrigins	string[]	Specifies the content for the access-control-allow-origins header
exposeHeaders	string[]	Specifies the content for the access-control-expose-headers header
maxAge	integer	Specifies the content for the access-control-max-age header

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CustomDomain

Custom Domain of a Container App

Name	Type	Description
bindingType	bindingType	Custom Domain binding type.
certificateId	string	Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.
name	string	Hostname.

CustomScaleRule

Container App container Custom scaling rule.

Name	Type	Description
auth	ScaleRuleAuth[]	Authentication secrets for the custom scale rule.
metadata	object	Metadata properties to describe custom scale rule.
type	string	Type of the custom scale rule eg: azure-servicebus, redis etc.

Dapr

Container App Dapr configuration.

Name	Type	Default Value	Description
appId	string		Dapr application identifier
appPort	integer		Tells Dapr which port your application is listening on
appProtocol	appProtocol	http	Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http
enableApiLogging	boolean		Enables API logging for the Dapr sidecar
enabled	boolean	False	Boolean indicating if the Dapr side car is enabled
httpMaxRequestSize	integer		Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB.
httpReadBufferSize	integer		Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB.
logLevel	logLevel		Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Details or the error

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

EnvironmentVar

Container App container environment variable.

Name	Type	Description
name	string	Environment variable name.
secretRef	string	Name of the Container App secret from which to pull the environment variable value.
value	string	Non-secret environment variable value.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Details or the error
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

ExtendedLocation

The complex type of the extended location.

Name	Type	Description
name	string	The name of the extended location.
type	ExtendedLocationTypes	The type of the extended location.

ExtendedLocationTypes

The type of the extended location.

Name	Type	Description
CustomLocation	string

HttpGet

HTTPGet specifies the http request to perform.

Name	Type	Description
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
httpHeaders	HttpHeaders[]	Custom headers to set in the request. HTTP allows repeated headers.
path	string	Path to access on the HTTP server.
port	integer	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme	Scheme	Scheme to use for connecting to the host. Defaults to HTTP.

HttpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

Name	Type	Description
name	string	The header field name
value	string	The header field value

HttpScaleRule

Container App container Http scaling rule.

Name	Type	Description
auth	ScaleRuleAuth[]	Authentication secrets for the custom scale rule.
metadata	object	Metadata properties to describe http scale rule.

Ingress

Container App Ingress configuration.

Name	Type	Default Value	Description
allowInsecure	boolean	False	Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections
clientCertificateMode	IngressClientCertificateMode		Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate.
corsPolicy	CorsPolicy		CORS policy for container app
customDomains	CustomDomain[]		custom domain bindings for Container Apps' hostnames.
exposedPort	integer		Exposed Port in containers for TCP traffic from ingress
external	boolean	False	Bool indicating if app exposes an external http endpoint
fqdn	string		Hostname.
ipSecurityRestrictions	IpSecurityRestrictionRule[]		Rules to restrict incoming IP address.
stickySessions	StickySessions		Sticky Sessions for Single Revision Mode
targetPort	integer		Target Port in containers for traffic from ingress
traffic	TrafficWeight[]		Traffic weights for app's revisions
transport	IngressTransportMethod	auto	Ingress transport protocol

IngressClientCertificateMode

Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate.

Name	Type	Description
accept	string
ignore	string
require	string

IngressTransportMethod

Ingress transport protocol

Name	Type	Description
auto	string
http	string
http2	string
tcp	string

InitContainer

Container App init container definition

Name	Type	Description
args	string[]	Container start command arguments.
command	string[]	Container start command.
env	EnvironmentVar[]	Container environment variables.
image	string	Container image tag.
name	string	Custom container name.
resources	ContainerResources	Container resource requirements.
volumeMounts	VolumeMount[]	Container volume mounts.

IpSecurityRestrictionRule

Rule to restrict incoming IP address.

Name	Type	Description
action	action	Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny
description	string	Describe the IP restriction rule that is being sent to the container-app. This is an optional field.
ipAddressRange	string	CIDR notation to match incoming IP address
name	string	Name for the IP restriction rule.

logLevel

Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.

Name	Type	Description
debug	string
error	string
info	string
warn	string

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

QueueScaleRule

Container App container Azure Queue based scaling rule.

Name	Type	Description
auth	ScaleRuleAuth[]	Authentication secrets for the queue scale rule.
queueLength	integer	Queue length.
queueName	string	Queue name.

RegistryCredentials

Container App Private Registry

Name	Type	Description
identity	string	A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system'
passwordSecretRef	string	The name of the Secret that contains the registry login password
server	string	Container Registry Server
username	string	Container Registry Username

Scale

Container App scaling configurations.

Name	Type	Default Value	Description
maxReplicas	integer	10	Optional. Maximum number of container replicas. Defaults to 10 if not set.
minReplicas	integer		Optional. Minimum number of container replicas.
rules	ScaleRule[]		Scaling rules.

ScaleRule

Container App container scaling rule.

Name	Type	Description
azureQueue	QueueScaleRule	Azure Queue based scaling.
custom	CustomScaleRule	Custom scale rule.
http	HttpScaleRule	HTTP requests based scaling.
name	string	Scale Rule Name
tcp	TcpScaleRule	Tcp requests based scaling.

ScaleRuleAuth

Auth Secrets for Scale Rule

Name	Type	Description
secretRef	string	Name of the secret from which to pull the auth params.
triggerParameter	string	Trigger Parameter that uses the secret

Scheme

Scheme to use for connecting to the host. Defaults to HTTP.

Name	Type	Description
HTTP	string
HTTPS	string

Secret

Secret definition.

Name	Type	Description
identity	string	Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.
keyVaultUrl	string	Azure Key Vault URL pointing to the secret referenced by the container app.
name	string	Secret Name.
value	string	Secret Value.

SecretVolumeItem

Secret to be added to volume.

Name	Type	Description
path	string	Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef.
secretRef	string	Name of the Container App secret from which to pull the secret value.

Service

Container App to be a dev service

Name	Type	Description
type	string	Dev ContainerApp service type

ServiceBind

Configuration to bind a ContainerApp to a dev ContainerApp Service

Name	Type	Description
name	string	Name of the service bind
serviceId	string	Resource id of the target service

StickySessions

Sticky Sessions for Single Revision Mode

Name	Type	Description
affinity	affinity	Sticky Session Affinity

StorageType

Storage type for the volume. If not provided, use EmptyDir.

Name	Type	Description
AzureFile	string
EmptyDir	string
Secret	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

TcpScaleRule

Container App container Tcp scaling rule.

Name	Type	Description
auth	ScaleRuleAuth[]	Authentication secrets for the tcp scale rule.
metadata	object	Metadata properties to describe tcp scale rule.

TcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.

Name	Type	Description
host	string	Optional: Host name to connect to, defaults to the pod IP.
port	integer	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

Template

Container App versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created

Name	Type	Description
containers	Container[]	List of container definitions for the Container App.
initContainers	InitContainer[]	List of specialized containers that run before app containers.
revisionSuffix	string	User friendly suffix that is appended to the revision name
scale	Scale	Scaling properties for the Container App.
serviceBinds	ServiceBind[]	List of container app services bound to the app
terminationGracePeriodSeconds	integer	Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
volumes	Volume[]	List of volume definitions for the Container App.

TrafficWeight

Traffic weight assigned to a revision

Name	Type	Default Value	Description
label	string		Associates a traffic label with a revision
latestRevision	boolean	False	Indicates that the traffic weight belongs to a latest stable revision
revisionName	string		Name of a revision
weight	integer		Traffic weight assigned to a revision

Type

The type of probe.

Name	Type	Description
Liveness	string
Readiness	string
Startup	string

UserAssignedIdentity

User assigned identity properties

Name	Type	Description
clientId	string	The client ID of the assigned identity.
principalId	string	The principal ID of the assigned identity.

Volume

Volume definitions for the Container App.

Name	Type	Description
mountOptions	string	Mount options used while mounting the AzureFile. Must be a comma-separated string.
name	string	Volume name.
secrets	SecretVolumeItem[]	List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume.
storageName	string	Name of storage resource. No need to provide for EmptyDir and Secret.
storageType	StorageType	Storage type for the volume. If not provided, use EmptyDir.

VolumeMount

Volume mount for the Container App.

Name	Type	Description
mountPath	string	Path within the container at which the volume should be mounted.Must not contain ':'.
subPath	string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
volumeName	string	This must match the Name of a Volume.