PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/containerApps/{name}/?api-version=2023-01-01
Description for Create or update a Container App.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
Name of the Container App. |
subscriptionId |
String | Yes |
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
resourceGroupName |
String | Yes |
Name of the resource group to which the resource belongs. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
String | No |
The name of the resource |
systemData |
Object | No |
Metadata pertaining to creation and last modification of the resource. |
systemData.createdByType |
String | No |
The type of identity that created the resource. Possible values:
|
systemData.lastModifiedAt |
String | No |
The timestamp of resource last modification (UTC) |
systemData.createdAt |
String | No |
The timestamp of resource creation (UTC). |
systemData.lastModifiedBy |
String | No |
The identity that last modified the resource. |
systemData.lastModifiedByType |
String | No |
The type of identity that last modified the resource. Possible values:
|
systemData.createdBy |
String | No |
The identity that created the resource. |
properties |
Object | No |
ContainerApp resource specific properties |
properties.latestRevisionName |
String | No |
Name of the latest revision of the Container App. |
properties.latestRevisionFqdn |
String | No |
Fully Qualified Domain Name of the latest revision of the Container App. |
properties.kubeEnvironmentId |
String | No |
Resource ID of the Container App's KubeEnvironment. |
properties.template |
Object | No |
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 |
properties.template.revisionSuffix |
String | No |
User friendly suffix that is appended to the revision name |
properties.template.dapr |
Object | No |
Container App Dapr configuration. |
properties.template.dapr.enabled |
Boolean | No |
Boolean indicating if the Dapr side car is enabled |
properties.template.dapr.appId |
String | No |
Dapr application identifier |
properties.template.dapr.appPort |
Integer | No |
Port on which the Dapr side car |
properties.template.dapr.components[] |
Array | No |
Collection of Dapr components |
properties.template.dapr.components[].name |
String | No |
Component name |
properties.template.dapr.components[].version |
String | No |
Component version |
properties.template.dapr.components[].type |
String | No |
Component type |
properties.template.dapr.components[].metadata[] |
Array | No |
Component metadata |
properties.template.dapr.components[].metadata[].name |
String | No |
Metadata property name. |
properties.template.dapr.components[].metadata[].secretRef |
String | No |
Name of the Container App secret from which to pull the metadata property value. |
properties.template.dapr.components[].metadata[].value |
String | No |
Metadata property value. |
properties.template.scale |
Object | No |
Container App scaling configurations. |
properties.template.scale.rules[] |
Array | No |
Scaling rules. |
properties.template.scale.rules[].custom |
Object | No |
Container App container Custom scaling rule. |
properties.template.scale.rules[].custom.auth[] |
Array | No |
Authentication secrets for the custom scale rule. |
properties.template.scale.rules[].custom.auth[].triggerParameter |
String | No |
Trigger Parameter that uses the secret |
properties.template.scale.rules[].custom.auth[].secretRef |
String | No |
Name of the Container App secret from which to pull the auth params. |
properties.template.scale.rules[].custom.type |
String | No |
Type of the custom scale rule eg: azure-servicebus, redis etc. |
properties.template.scale.rules[].custom.metadata |
Object | No |
Metadata properties to describe custom scale rule. |
properties.template.scale.rules[].azureQueue |
Object | No |
Container App container Azure Queue based scaling rule. |
properties.template.scale.rules[].azureQueue.auth[] |
Array | No |
Authentication secrets for the queue scale rule. |
properties.template.scale.rules[].azureQueue.auth[].triggerParameter |
String | No |
Trigger Parameter that uses the secret |
properties.template.scale.rules[].azureQueue.auth[].secretRef |
String | No |
Name of the Container App secret from which to pull the auth params. |
properties.template.scale.rules[].azureQueue.queueLength |
Integer | No |
Queue length. |
properties.template.scale.rules[].azureQueue.queueName |
String | No |
Queue name. |
properties.template.scale.rules[].name |
String | No |
Scale Rule Name |
properties.template.scale.rules[].http |
Object | No |
Container App container Custom scaling rule. |
properties.template.scale.rules[].http.auth[] |
Array | No |
Authentication secrets for the custom scale rule. |
properties.template.scale.rules[].http.auth[].triggerParameter |
String | No |
Trigger Parameter that uses the secret |
properties.template.scale.rules[].http.auth[].secretRef |
String | No |
Name of the Container App secret from which to pull the auth params. |
properties.template.scale.rules[].http.metadata |
Object | No |
Metadata properties to describe http scale rule. |
properties.template.scale.maxReplicas |
Integer | No |
Optional. Maximum number of container replicas. Defaults to 10 if not set. |
properties.template.scale.minReplicas |
Integer | No |
Optional. Minimum number of container replicas. |
properties.template.containers[] |
Array | No |
List of container definitions for the Container App. |
properties.template.containers[].name |
String | No |
Custom container name. |
properties.template.containers[].env[] |
Array | No |
Container environment variables. |
properties.template.containers[].env[].name |
String | No |
Environment variable name. |
properties.template.containers[].env[].secretRef |
String | No |
Name of the Container App secret from which to pull the environment variable value. |
properties.template.containers[].env[].value |
String | No |
Non-secret environment variable value. |
properties.template.containers[].command[] |
Array | No |
Container start command. |
properties.template.containers[].resources |
Object | No |
Container App container resource requirements. |
properties.template.containers[].resources.memory |
String | No |
Required memory, e.g. "250Mb" |
properties.template.containers[].resources.cpu |
Number | No |
Required CPU in cores, e.g. 0.5 |
properties.template.containers[].image |
String | No |
Container image tag. |
properties.template.containers[].args[] |
Array | No |
Container start command arguments. |
properties.provisioningState |
String | No |
Provisioning state of the Container App. Possible values:
|
properties.configuration |
Object | No |
Non versioned Container App configuration properties that define the mutable settings of a Container app |
properties.configuration.registries[] |
Array | No |
Collection of private container registry credentials for containers used by the Container app |
properties.configuration.registries[].passwordSecretRef |
String | No |
The name of the Secret that contains the registry login password |
properties.configuration.registries[].username |
String | No |
Container Registry Username |
properties.configuration.registries[].server |
String | No |
Container Registry Server |
properties.configuration.secrets[] |
Array | No |
Collection of secrets used by a Container app |
properties.configuration.secrets[].name |
String | No |
Secret Name. |
properties.configuration.secrets[].value |
String | No |
Secret Value. |
properties.configuration.activeRevisionsMode |
String | No |
ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode Possible values:
|
properties.configuration.ingress |
Object | No |
Container App Ingress configuration. |
properties.configuration.ingress.traffic[] |
Array | No | |
properties.configuration.ingress.traffic[].latestRevision |
Boolean | No |
Indicates that the traffic weight belongs to a latest stable revision Default value: false |
properties.configuration.ingress.traffic[].weight |
Integer | No |
Traffic weight assigned to a revision |
properties.configuration.ingress.traffic[].revisionName |
String | No |
Name of a revision |
properties.configuration.ingress.allowInsecure |
Boolean | No |
Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections |
properties.configuration.ingress.targetPort |
Integer | No |
Target Port in containers for traffic from ingress |
properties.configuration.ingress.external |
Boolean | No |
Bool indicating if app exposes an external http endpoint Default value: false |
properties.configuration.ingress.fqdn |
String | No |
Hostname. |
properties.configuration.ingress.transport |
String | No |
Ingress transport protocol Possible values:
|
type |
String | No |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.