{
"swagger": "2.0",
"info": {
"title": "ContainerApps API Client",
"version": "2026-01-01",
"description": "Functions is an extension resource to revisions and the api listed is used to proxy the call from Web RP to the function app's host process, this api is not exposed to users and only Web RP is allowed to invoke functions extension resource.",
"x-typespec-generated": [
{
"emitter": "@azure-tools/typespec-autorest"
}
]
},
"schemes": [
"https"
],
"host": "management.azure.com",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"description": "Azure Active Directory OAuth2 Flow.",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"tags": [
{
"name": "Subscriptions"
},
{
"name": "Operations"
},
{
"name": "ContainerAppsSessionPools"
},
{
"name": "ContainerAppsSourceControls"
},
{
"name": "ContainerApps"
},
{
"name": "ContainerAppsRevisions"
},
{
"name": "ContainerAppsRevisionReplicas"
},
{
"name": "JavaComponents"
},
{
"name": "LogicApps"
},
{
"name": "ContainerAppsAuthConfigs"
},
{
"name": "ConnectedEnvironments"
},
{
"name": "Certificates"
},
{
"name": "ManagedEnvironments"
},
{
"name": "PrivateLinkResources"
},
{
"name": "DaprComponents"
},
{
"name": "ConnectedEnvironmentsStorages"
},
{
"name": "ManagedCertificates"
},
{
"name": "PrivateEndpointConnections"
},
{
"name": "HttpRouteConfig"
},
{
"name": "MaintenanceConfigurations"
},
{
"name": "ManagedEnvironmentsStorages"
},
{
"name": "Jobs"
},
{
"name": "Diagnostics"
},
{
"name": "AvailableWorkloadProfiles"
},
{
"name": "BillingMeters"
},
{
"name": "Usages"
}
],
"paths": {
"/providers/Microsoft.App/operations": {
"get": {
"operationId": "Operations_List",
"tags": [
"Operations"
],
"description": "Lists all of the available RP operations.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AvailableOperations"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List all operations": {
"$ref": "./examples/Operations_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.App/connectedEnvironments": {
"get": {
"operationId": "ConnectedEnvironments_ListBySubscription",
"tags": [
"ConnectedEnvironments"
],
"summary": "Get all connectedEnvironments for a subscription.",
"description": "Get all connectedEnvironments for a subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ConnectedEnvironmentCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List connected environments by subscription": {
"$ref": "./examples/ConnectedEnvironments_ListBySubscription.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.App/containerApps": {
"get": {
"operationId": "ContainerApps_ListBySubscription",
"tags": [
"ContainerApps"
],
"summary": "Get the Container Apps in a given subscription.",
"description": "Get the Container Apps in a given subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ContainerAppCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Container Apps by subscription": {
"$ref": "./examples/ContainerApps_ListBySubscription.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.App/getCustomDomainVerificationId": {
"post": {
"operationId": "GetCustomDomainVerificationId",
"tags": [
"Subscriptions"
],
"description": "Get the verification id of a subscription used for verifying custom domains",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/CustomDomainVerificationId"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List all operations": {
"$ref": "./examples/Subscriptions_GetCustomDomainVerificationId.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.App/jobs": {
"get": {
"operationId": "Jobs_ListBySubscription",
"tags": [
"Jobs"
],
"summary": "Get the Container Apps Jobs in a given subscription.",
"description": "Get the Container Apps Jobs in a given subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/JobsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Container Apps Jobs by subscription": {
"$ref": "./examples/Jobs_ListBySubscription.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/availableManagedEnvironmentsWorkloadProfileTypes": {
"get": {
"operationId": "AvailableWorkloadProfiles_Get",
"tags": [
"AvailableWorkloadProfiles"
],
"summary": "Get available workload profiles by location.",
"description": "Get all available workload profiles for a location.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AvailableWorkloadProfilesCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"BillingMeters_Get": {
"$ref": "./examples/AvailableWorkloadProfiles_Get.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/billingMeters": {
"get": {
"operationId": "BillingMeters_Get",
"tags": [
"BillingMeters"
],
"summary": "Get billing meters by location.",
"description": "Get all billingMeters for a location.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/BillingMeterCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"BillingMeters_Get": {
"$ref": "./examples/BillingMeters_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/usages": {
"get": {
"operationId": "Usages_List",
"tags": [
"Usages"
],
"description": "Gets, for the specified location, the current resource usage information as well as the limits under the subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "location",
"in": "path",
"description": "The location for which resource usage is queried.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._]+$"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/ListUsagesResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List usages": {
"$ref": "./examples/Usages_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.App/managedEnvironments": {
"get": {
"operationId": "ManagedEnvironments_ListBySubscription",
"tags": [
"ManagedEnvironments"
],
"summary": "Get all Environments for a subscription.",
"description": "Get all Managed Environments for a subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedEnvironmentsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List environments by subscription": {
"$ref": "./examples/ManagedEnvironments_ListBySubscription.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.App/sessionPools": {
"get": {
"operationId": "ContainerAppsSessionPools_ListBySubscription",
"tags": [
"ContainerAppsSessionPools"
],
"summary": "Get the session pools in a given subscription.",
"description": "Get the session pools in a given subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SessionPoolCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Session Pools by subscription": {
"$ref": "./examples/SessionPools_ListBySubscription.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments": {
"get": {
"operationId": "ConnectedEnvironments_ListByResourceGroup",
"tags": [
"ConnectedEnvironments"
],
"description": "Get all connectedEnvironments in a resource group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ConnectedEnvironmentCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List environments by resource group": {
"$ref": "./examples/ConnectedEnvironments_ListByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}": {
"get": {
"operationId": "ConnectedEnvironments_Get",
"tags": [
"ConnectedEnvironments"
],
"description": "Get the properties of an connectedEnvironment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the connectedEnvironment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ConnectedEnvironment"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get connected environment by connectedEnvironmentName": {
"$ref": "./examples/ConnectedEnvironments_Get.json"
}
}
},
"put": {
"operationId": "ConnectedEnvironments_CreateOrUpdate",
"tags": [
"ConnectedEnvironments"
],
"description": "Creates or updates an connectedEnvironment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the connectedEnvironment.",
"required": true,
"type": "string"
},
{
"name": "environmentEnvelope",
"in": "body",
"description": "Configuration details of the connectedEnvironment.",
"required": true,
"schema": {
"$ref": "#/definitions/ConnectedEnvironment"
}
}
],
"responses": {
"200": {
"description": "Resource 'ConnectedEnvironment' update operation succeeded",
"schema": {
"$ref": "#/definitions/ConnectedEnvironment"
}
},
"201": {
"description": "Resource 'ConnectedEnvironment' create operation succeeded",
"schema": {
"$ref": "#/definitions/ConnectedEnvironment"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create kube environments": {
"$ref": "./examples/ConnectedEnvironments_CreateOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation",
"final-state-schema": "#/definitions/ConnectedEnvironment"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "ConnectedEnvironments_Update",
"tags": [
"ConnectedEnvironments"
],
"summary": "Update connected Environment's properties.",
"description": "Patches a Managed Environment. Only patching of tags is supported currently",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the connectedEnvironment.",
"required": true,
"type": "string"
},
{
"name": "environmentEnvelope",
"in": "body",
"description": "Configuration details of the connectedEnvironment.",
"required": true,
"schema": {
"$ref": "#/definitions/ConnectedEnvironmentPatchResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ConnectedEnvironment"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Patch Managed Environment": {
"$ref": "./examples/ConnectedEnvironments_Patch.json"
}
}
},
"delete": {
"operationId": "ConnectedEnvironments_Delete",
"tags": [
"ConnectedEnvironments"
],
"summary": "Delete an connectedEnvironment.",
"description": "Delete an connectedEnvironment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the connectedEnvironment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete connected environment by connectedEnvironmentName": {
"$ref": "./examples/ConnectedEnvironments_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates": {
"get": {
"operationId": "ConnectedEnvironmentsCertificates_List",
"tags": [
"Certificates",
"ConnectedEnvironments"
],
"summary": "Get the Certificates in a given connected environment.",
"description": "Get the Certificates in a given connected environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the Connected Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CertificateCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Certificates by Connected Environment": {
"$ref": "./examples/ConnectedEnvironmentsCertificates_ListByConnectedEnvironment.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}": {
"get": {
"operationId": "ConnectedEnvironmentsCertificates_Get",
"tags": [
"Certificates",
"ConnectedEnvironments"
],
"summary": "Get the specified Certificate.",
"description": "Get the specified Certificate.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the Connected Environment.",
"required": true,
"type": "string"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the Certificate.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Certificate": {
"$ref": "./examples/ConnectedEnvironmentsCertificate_Get.json"
}
}
},
"put": {
"operationId": "ConnectedEnvironmentsCertificates_CreateOrUpdate",
"tags": [
"Certificates",
"ConnectedEnvironments"
],
"summary": "Create or Update a Certificate.",
"description": "Create or Update a Certificate.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the Connected Environment.",
"required": true,
"type": "string"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the Certificate.",
"required": true,
"type": "string"
},
{
"name": "certificateEnvelope",
"in": "body",
"description": "Certificate to be created or updated",
"required": false,
"schema": {
"$ref": "#/definitions/Certificate"
}
}
],
"responses": {
"200": {
"description": "Resource 'Certificate' update operation succeeded",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"201": {
"description": "Resource 'Certificate' create operation succeeded",
"schema": {
"$ref": "#/definitions/Certificate"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create or Update Certificate": {
"$ref": "./examples/ConnectedEnvironmentsCertificate_CreateOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation",
"final-state-schema": "#/definitions/Certificate"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "ConnectedEnvironmentsCertificates_Update",
"tags": [
"Certificates",
"ConnectedEnvironments"
],
"summary": "Update properties of a certificate",
"description": "Patches a certificate. Currently only patching of tags is supported",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the Connected Environment.",
"required": true,
"type": "string"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the Certificate.",
"required": true,
"type": "string"
},
{
"name": "certificateEnvelope",
"in": "body",
"description": "Properties of a certificate that need to be updated",
"required": true,
"schema": {
"$ref": "#/definitions/CertificatePatch"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"202": {
"description": "Resource update request accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Patch Certificate": {
"$ref": "./examples/ConnectedEnvironmentsCertificates_Patch.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/Certificate"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "ConnectedEnvironmentsCertificates_Delete",
"tags": [
"Certificates",
"ConnectedEnvironments"
],
"summary": "Deletes the specified Certificate.",
"description": "Deletes the specified Certificate.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the Connected Environment.",
"required": true,
"type": "string"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the Certificate.",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Certificate": {
"$ref": "./examples/ConnectedEnvironmentsCertificate_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/checkNameAvailability": {
"post": {
"operationId": "ConnectedEnvironments_CheckNameAvailability",
"tags": [
"ConnectedEnvironments"
],
"summary": "Checks the resource connectedEnvironmentName availability.",
"description": "Checks if resource connectedEnvironmentName is available.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the connectedEnvironment.",
"required": true,
"type": "string"
},
{
"name": "checkNameAvailabilityRequest",
"in": "body",
"description": "The check connectedEnvironmentName availability request.",
"required": true,
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Certificates_CheckNameAvailability": {
"$ref": "./examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents": {
"get": {
"operationId": "ConnectedEnvironmentsDaprComponents_List",
"tags": [
"DaprComponents"
],
"summary": "Get the Dapr Components for a connected environment.",
"description": "Get the Dapr Components for a connected environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the connected environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DaprComponentsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Dapr Components": {
"$ref": "./examples/ConnectedEnvironmentsDaprComponents_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}": {
"get": {
"operationId": "ConnectedEnvironmentsDaprComponents_Get",
"tags": [
"DaprComponents"
],
"summary": "Get a dapr component.",
"description": "Get a dapr component.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the connected environment.",
"required": true,
"type": "string"
},
{
"name": "componentName",
"in": "path",
"description": "Name of the Dapr Component.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DaprComponent"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Dapr Component": {
"$ref": "./examples/ConnectedEnvironmentsDaprComponents_Get.json"
}
}
},
"put": {
"operationId": "ConnectedEnvironmentsDaprComponents_CreateOrUpdate",
"tags": [
"DaprComponents"
],
"summary": "Creates or updates a Dapr Component.",
"description": "Creates or updates a Dapr Component in a connected environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the connectedEnvironment.",
"required": true,
"type": "string"
},
{
"name": "componentName",
"in": "path",
"description": "Name of the Dapr Component.",
"required": true,
"type": "string"
},
{
"name": "daprComponentEnvelope",
"in": "body",
"description": "Configuration details of the Dapr Component.",
"required": true,
"schema": {
"$ref": "#/definitions/DaprComponent"
}
}
],
"responses": {
"200": {
"description": "Resource 'DaprComponent' update operation succeeded",
"schema": {
"$ref": "#/definitions/DaprComponent"
}
},
"201": {
"description": "Resource 'DaprComponent' create operation succeeded",
"schema": {
"$ref": "#/definitions/DaprComponent"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create or update dapr component": {
"$ref": "./examples/ConnectedEnvironmentsDaprComponents_CreateOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation",
"final-state-schema": "#/definitions/DaprComponent"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "ConnectedEnvironmentsDaprComponents_Delete",
"tags": [
"DaprComponents"
],
"summary": "Delete a Dapr Component.",
"description": "Delete a Dapr Component from a connected environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the connected environment.",
"required": true,
"type": "string"
},
{
"name": "componentName",
"in": "path",
"description": "Name of the Dapr Component.",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete dapr component": {
"$ref": "./examples/ConnectedEnvironmentsDaprComponents_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}/listSecrets": {
"post": {
"operationId": "ConnectedEnvironmentsDaprComponents_ListSecrets",
"tags": [
"DaprComponents"
],
"summary": "List secrets for a dapr component",
"description": "List secrets for a dapr component",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the connected environment.",
"required": true,
"type": "string"
},
{
"name": "componentName",
"in": "path",
"description": "Name of the Dapr Component.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DaprSecretsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Container Apps Secrets": {
"$ref": "./examples/ConnectedEnvironmentsDaprComponents_ListSecrets.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages": {
"get": {
"operationId": "ConnectedEnvironmentsStorages_List",
"tags": [
"ConnectedEnvironmentsStorages"
],
"summary": "Get all storages for a connectedEnvironment.",
"description": "Get all storages for a connectedEnvironment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the connectedEnvironment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ConnectedEnvironmentStoragesCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List environments storages by subscription": {
"$ref": "./examples/ConnectedEnvironmentsStorages_List.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages/{storageName}": {
"get": {
"operationId": "ConnectedEnvironmentsStorages_Get",
"tags": [
"ConnectedEnvironmentsStorages"
],
"summary": "Get storage for a connectedEnvironment.",
"description": "Get storage for a connectedEnvironment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the connectedEnvironment.",
"required": true,
"type": "string"
},
{
"name": "storageName",
"in": "path",
"description": "Name of the storage.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ConnectedEnvironmentStorage"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"get a environments storage properties by subscription": {
"$ref": "./examples/ConnectedEnvironmentsStorages_Get.json"
}
}
},
"put": {
"operationId": "ConnectedEnvironmentsStorages_CreateOrUpdate",
"tags": [
"ConnectedEnvironmentsStorages"
],
"summary": "Create or update storage for a connectedEnvironment.",
"description": "Create or update storage for a connectedEnvironment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the connectedEnvironment.",
"required": true,
"type": "string"
},
{
"name": "storageName",
"in": "path",
"description": "Name of the storage.",
"required": true,
"type": "string"
},
{
"name": "storageEnvelope",
"in": "body",
"description": "Configuration details of storage.",
"required": true,
"schema": {
"$ref": "#/definitions/ConnectedEnvironmentStorage"
}
}
],
"responses": {
"200": {
"description": "Resource 'ConnectedEnvironmentStorage' update operation succeeded",
"schema": {
"$ref": "#/definitions/ConnectedEnvironmentStorage"
}
},
"201": {
"description": "Resource 'ConnectedEnvironmentStorage' create operation succeeded",
"schema": {
"$ref": "#/definitions/ConnectedEnvironmentStorage"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create or update environments storage": {
"$ref": "./examples/ConnectedEnvironmentsStorages_CreateOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation",
"final-state-schema": "#/definitions/ConnectedEnvironmentStorage"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "ConnectedEnvironmentsStorages_Delete",
"tags": [
"ConnectedEnvironmentsStorages"
],
"summary": "Delete storage for a connectedEnvironment.",
"description": "Delete storage for a connectedEnvironment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "connectedEnvironmentName",
"in": "path",
"description": "Name of the connectedEnvironment.",
"required": true,
"type": "string"
},
{
"name": "storageName",
"in": "path",
"description": "Name of the storage.",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List environments storages by subscription": {
"$ref": "./examples/ConnectedEnvironmentsStorages_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps": {
"get": {
"operationId": "ContainerApps_ListByResourceGroup",
"tags": [
"ContainerApps"
],
"summary": "Get the Container Apps in a given resource group.",
"description": "Get the Container Apps in a given resource group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ContainerAppCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Container Apps by resource group": {
"$ref": "./examples/ContainerApps_ListByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}": {
"get": {
"operationId": "ContainerApps_Get",
"tags": [
"ContainerApps"
],
"summary": "Get the properties of a Container App.",
"description": "Get the properties of a Container App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ContainerApp"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Container App": {
"$ref": "./examples/ContainerApps_Get.json"
}
}
},
"put": {
"operationId": "ContainerApps_CreateOrUpdate",
"tags": [
"ContainerApps"
],
"summary": "Create or update a Container App.",
"description": "Create or update a Container App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "containerAppEnvelope",
"in": "body",
"description": "Properties used to create a container app",
"required": true,
"schema": {
"$ref": "#/definitions/ContainerApp"
}
}
],
"responses": {
"200": {
"description": "Resource 'ContainerApp' update operation succeeded",
"schema": {
"$ref": "#/definitions/ContainerApp"
}
},
"201": {
"description": "Resource 'ContainerApp' create operation succeeded",
"schema": {
"$ref": "#/definitions/ContainerApp"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create or Update App On A Connected Environment": {
"$ref": "./examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json"
},
"Create or Update Container App": {
"$ref": "./examples/ContainerApps_CreateOrUpdate.json"
},
"Create or Update FunctionApp Kind": {
"$ref": "./examples/ContainerApps_Kind_FunctionApp_CreateOrUpdate.json"
},
"Create or Update ManagedBy App": {
"$ref": "./examples/ContainerApps_ManagedBy_CreateOrUpdate.json"
},
"Create or Update Tcp App": {
"$ref": "./examples/ContainerApps_TcpApp_CreateOrUpdate.json"
},
"Create or Update WorkflowApp Kind": {
"$ref": "./examples/ContainerApps_Kind_WorkflowApp_CreateOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation",
"final-state-schema": "#/definitions/ContainerApp"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "ContainerApps_Update",
"tags": [
"ContainerApps"
],
"summary": "Update properties of a Container App",
"description": "Patches a Container App using JSON Merge Patch",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "containerAppEnvelope",
"in": "body",
"description": "Properties of a Container App that need to be updated",
"required": true,
"schema": {
"$ref": "#/definitions/ContainerApp"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ContainerApp"
}
},
"202": {
"description": "Resource update request accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Patch Container App": {
"$ref": "./examples/ContainerApps_Patch.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/ContainerApp"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "ContainerApps_Delete",
"tags": [
"ContainerApps"
],
"summary": "Delete a Container App.",
"description": "Delete a Container App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Container App": {
"$ref": "./examples/ContainerApps_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs": {
"get": {
"operationId": "ContainerAppsAuthConfigs_ListByContainerApp",
"tags": [
"ContainerAppsAuthConfigs"
],
"summary": "Get the Container App AuthConfigs in a given resource group.",
"description": "Get the Container App AuthConfigs in a given resource group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AuthConfigCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Auth Configs by Container Apps": {
"$ref": "./examples/AuthConfigs_ListByContainer.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{authConfigName}": {
"get": {
"operationId": "ContainerAppsAuthConfigs_Get",
"tags": [
"ContainerAppsAuthConfigs"
],
"summary": "Get a AuthConfig of a Container App.",
"description": "Get a AuthConfig of a Container App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "authConfigName",
"in": "path",
"description": "Name of the Container App AuthConfig.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AuthConfig"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Container App's AuthConfig": {
"$ref": "./examples/AuthConfigs_Get.json"
}
}
},
"put": {
"operationId": "ContainerAppsAuthConfigs_CreateOrUpdate",
"tags": [
"ContainerAppsAuthConfigs"
],
"summary": "Create or update the AuthConfig for a Container App.",
"description": "Create or update the AuthConfig for a Container App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "authConfigName",
"in": "path",
"description": "Name of the Container App AuthConfig.",
"required": true,
"type": "string"
},
{
"name": "authConfigEnvelope",
"in": "body",
"description": "Properties used to create a Container App AuthConfig",
"required": true,
"schema": {
"$ref": "#/definitions/AuthConfig"
}
}
],
"responses": {
"200": {
"description": "Resource 'AuthConfig' update operation succeeded",
"schema": {
"$ref": "#/definitions/AuthConfig"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or Update Container App AuthConfig": {
"$ref": "./examples/AuthConfigs_CreateOrUpdate.json"
},
"Create or Update Container App AuthConfig with msi clientID blob storage token store": {
"$ref": "./examples/AuthConfigs_BlobStorageTokenStore_ClientId_CreateOrUpdate.json"
},
"Create or Update Container App AuthConfig with msi managedIdentityResourceId blob storage token store": {
"$ref": "./examples/AuthConfigs_BlobStorageTokenStore_CreateOrUpdate.json"
}
}
},
"delete": {
"operationId": "ContainerAppsAuthConfigs_Delete",
"tags": [
"ContainerAppsAuthConfigs"
],
"summary": "Delete a Container App AuthConfig.",
"description": "Delete a Container App AuthConfig.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "authConfigName",
"in": "path",
"description": "Name of the Container App AuthConfig.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Container App AuthConfig": {
"$ref": "./examples/AuthConfigs_Delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/revisionsApi/revisions/{revisionName}": {
"get": {
"operationId": "ContainerAppsDiagnostics_GetRevision",
"tags": [
"ContainerApps",
"Diagnostics"
],
"summary": "Get a revision of a Container App.",
"description": "Get a revision of a Container App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "revisionName",
"in": "path",
"description": "Name of the detector.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Revision"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Container App's revision": {
"$ref": "./examples/Revisions_Get1.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/revisionsApi/revisions/": {
"get": {
"operationId": "ContainerAppsDiagnostics_ListRevisions",
"tags": [
"ContainerApps",
"Diagnostics"
],
"summary": "Get the Revisions for a given Container App.",
"description": "A synchronous resource action.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "$filter",
"in": "query",
"description": "The filter to apply on the operation.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RevisionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Container App's revisions": {
"$ref": "./examples/Revisions_List1.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/rootApi/": {
"get": {
"operationId": "ContainerAppsDiagnostics_GetRoot",
"tags": [
"ContainerApps",
"Diagnostics"
],
"summary": "Get the properties of a Container App.",
"description": "Get the properties of a Container App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ContainerApp"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Container App": {
"$ref": "./examples/ContainerApps_Get1.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectors": {
"get": {
"operationId": "ContainerAppsDiagnostics_ListDetectors",
"tags": [
"ContainerApps",
"Diagnostics"
],
"summary": "Get the list of diagnostics for a given Container App.",
"description": "Get the list of diagnostics for a given Container App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get the list of available diagnostics for a given Container App": {
"$ref": "./examples/ContainerAppsDiagnostics_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectors/{detectorName}": {
"get": {
"operationId": "ContainerAppsDiagnostics_GetDetector",
"tags": [
"ContainerApps",
"Diagnostics"
],
"summary": "Get a diagnostics result of a Container App.",
"description": "Get a diagnostics result of a Container App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "detectorName",
"in": "path",
"description": "Name of the detector.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Diagnostics"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Container App's diagnostics info": {
"$ref": "./examples/ContainerAppsDiagnostics_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/getAuthtoken": {
"post": {
"operationId": "ContainerApps_GetAuthToken",
"tags": [
"ContainerApps"
],
"summary": "Get auth token for a container app",
"description": "Get auth token for a container app",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ContainerAppAuthToken"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Container App Auth Token": {
"$ref": "./examples/ContainerApps_GetAuthToken.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/listCustomHostNameAnalysis": {
"post": {
"operationId": "ContainerApps_ListCustomHostNameAnalysis",
"tags": [
"ContainerApps"
],
"summary": "Analyzes a custom hostname for a Container App",
"description": "Analyzes a custom hostname for a Container App",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "customHostname",
"in": "query",
"description": "Custom hostname.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CustomHostnameAnalysisResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Analyze Custom Hostname": {
"$ref": "./examples/ContainerApps_ListCustomHostNameAnalysis.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/listSecrets": {
"post": {
"operationId": "ContainerApps_ListSecrets",
"tags": [
"ContainerApps"
],
"summary": "List secrets for a container app",
"description": "List secrets for a container app",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SecretsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Container Apps Secrets": {
"$ref": "./examples/ContainerApps_ListSecrets.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}": {
"get": {
"operationId": "LogicApps_Get",
"tags": [
"LogicApps"
],
"summary": "Gets a logic app extension resource.",
"description": "Gets a logic app extension resource.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "logicAppName",
"in": "path",
"description": "Name of the Logic App, the extension resource.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/LogicApp"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get logic app extension by name ": {
"$ref": "./examples/LogicApps_Get.json"
}
}
},
"put": {
"operationId": "LogicApps_CreateOrUpdate",
"tags": [
"LogicApps"
],
"description": "Create or update a Logic App extension resource",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "logicAppName",
"in": "path",
"description": "Name of the Logic App, the extension resource.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "resource",
"in": "body",
"description": "Resource create parameters.",
"required": false,
"schema": {
"$ref": "#/definitions/LogicApp"
}
}
],
"responses": {
"200": {
"description": "Resource 'LogicApp' update operation succeeded",
"schema": {
"$ref": "#/definitions/LogicApp"
}
},
"201": {
"description": "Resource 'LogicApp' create operation succeeded",
"schema": {
"$ref": "#/definitions/LogicApp"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create logic app extension": {
"$ref": "./examples/LogicApps_Create.json"
}
}
},
"delete": {
"operationId": "LogicApps_Delete",
"tags": [
"LogicApps"
],
"description": "Deletes a Logic App extension resource",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "logicAppName",
"in": "path",
"description": "Name of the Logic App, the extension resource.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create logic app extension": {
"$ref": "./examples/LogicApps_Delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}/listWorkflowsConnections": {
"post": {
"operationId": "LogicApps_ListWorkflowsConnections",
"tags": [
"LogicApps"
],
"summary": "Gets logic app's connections.",
"description": "Gets logic app's connections.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "logicAppName",
"in": "path",
"description": "Name of the Logic App, the extension resource.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowEnvelope"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List the Workflows Configuration Connections": {
"$ref": "./examples/LogicApps_ListConnections.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}/workflows": {
"get": {
"operationId": "LogicApps_ListWorkflows",
"tags": [
"LogicApps"
],
"summary": "List the workflows for a logic app.",
"description": "List the workflows for a logic app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "logicAppName",
"in": "path",
"description": "Name of the Logic App, the extension resource.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowEnvelopeCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List the workflows": {
"$ref": "./examples/LogicApps_ListWorkflows.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}/workflows/{workflowName}": {
"get": {
"operationId": "LogicApps_GetWorkflow",
"tags": [
"LogicApps"
],
"summary": "Get workflow information by its name",
"description": "Get workflow information by its name",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "logicAppName",
"in": "path",
"description": "Name of the Logic App, the extension resource.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "workflowName",
"in": "path",
"description": "Workflow name.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 63,
"pattern": "^[a-z][a-z0-9]*$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowEnvelope"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"GET a workflow": {
"$ref": "./examples/LogicApps_GetWorkflow.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions": {
"get": {
"operationId": "ContainerAppsRevisions_ListRevisions",
"tags": [
"ContainerAppsRevisions"
],
"summary": "Get the Revisions for a given Container App.",
"description": "Get the Revisions for a given Container App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "$filter",
"in": "query",
"description": "The filter to apply on the operation.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RevisionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Container App's revisions": {
"$ref": "./examples/Revisions_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}": {
"get": {
"operationId": "ContainerAppsRevisions_GetRevision",
"tags": [
"ContainerAppsRevisions"
],
"summary": "Get a revision of a Container App.",
"description": "Get a revision of a Container App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "revisionName",
"in": "path",
"description": "Name of the Container App Revision.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Revision"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Container App's revision": {
"$ref": "./examples/Revisions_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/activate": {
"post": {
"operationId": "ContainerAppsRevisions_ActivateRevision",
"tags": [
"ContainerAppsRevisions"
],
"summary": "Activates a revision for a Container App",
"description": "Activates a revision for a Container App",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "revisionName",
"in": "path",
"description": "Name of the Container App Revision.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Activate Container App's revision": {
"$ref": "./examples/Revisions_Activate.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/deactivate": {
"post": {
"operationId": "ContainerAppsRevisions_DeactivateRevision",
"tags": [
"ContainerAppsRevisions"
],
"summary": "Deactivates a revision for a Container App",
"description": "Deactivates a revision for a Container App",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "revisionName",
"in": "path",
"description": "Name of the Container App Revision.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Deactivate Container App's revision": {
"$ref": "./examples/Revisions_Deactivate.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas": {
"get": {
"operationId": "ContainerAppsRevisionReplicas_ListReplicas",
"tags": [
"ContainerAppsRevisionReplicas"
],
"summary": "List replicas for a Container App Revision.",
"description": "List replicas for a Container App Revision.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "revisionName",
"in": "path",
"description": "Name of the Container App Revision.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ReplicaCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Container App's replicas": {
"$ref": "./examples/Replicas_List.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas/{replicaName}": {
"get": {
"operationId": "ContainerAppsRevisionReplicas_GetReplica",
"tags": [
"ContainerAppsRevisionReplicas"
],
"summary": "Get a replica for a Container App Revision.",
"description": "Get a replica for a Container App Revision.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "revisionName",
"in": "path",
"description": "Name of the Container App Revision.",
"required": true,
"type": "string"
},
{
"name": "replicaName",
"in": "path",
"description": "Name of the Container App Revision Replica.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Replica"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Container App's revision replica": {
"$ref": "./examples/Replicas_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/restart": {
"post": {
"operationId": "ContainerAppsRevisions_RestartRevision",
"tags": [
"ContainerAppsRevisions"
],
"summary": "Restarts a revision for a Container App",
"description": "Restarts a revision for a Container App",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "revisionName",
"in": "path",
"description": "Name of the Container App Revision.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Restart Container App's revision": {
"$ref": "./examples/Revisions_Restart.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols": {
"get": {
"operationId": "ContainerAppsSourceControls_ListByContainerApp",
"tags": [
"ContainerAppsSourceControls"
],
"summary": "Get the Container App SourceControls in a given resource group.",
"description": "Get the Container App SourceControls in a given resource group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SourceControlCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List App's Source Controls": {
"$ref": "./examples/SourceControls_ListByContainer.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{sourceControlName}": {
"get": {
"operationId": "ContainerAppsSourceControls_Get",
"tags": [
"ContainerAppsSourceControls"
],
"summary": "Get a SourceControl of a Container App.",
"description": "Get a SourceControl of a Container App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "sourceControlName",
"in": "path",
"description": "Name of the Container App SourceControl.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SourceControl"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Container App's SourceControl": {
"$ref": "./examples/SourceControls_Get.json"
}
}
},
"put": {
"operationId": "ContainerAppsSourceControls_CreateOrUpdate",
"tags": [
"ContainerAppsSourceControls"
],
"summary": "Create or update the SourceControl for a Container App.",
"description": "Create or update the SourceControl for a Container App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "sourceControlName",
"in": "path",
"description": "Name of the Container App SourceControl.",
"required": true,
"type": "string"
},
{
"name": "sourceControlEnvelope",
"in": "body",
"description": "Properties used to create a Container App SourceControl",
"required": true,
"schema": {
"$ref": "#/definitions/SourceControl"
}
}
],
"responses": {
"200": {
"description": "Resource 'SourceControl' update operation succeeded",
"schema": {
"$ref": "#/definitions/SourceControl"
}
},
"201": {
"description": "Resource 'SourceControl' create operation succeeded",
"schema": {
"$ref": "#/definitions/SourceControl"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or Update Container App SourceControl": {
"$ref": "./examples/SourceControls_CreateOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/SourceControl"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "ContainerAppsSourceControls_Delete",
"tags": [
"ContainerAppsSourceControls"
],
"summary": "Delete a Container App SourceControl.",
"description": "Delete a Container App SourceControl.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string"
},
{
"name": "sourceControlName",
"in": "path",
"description": "Name of the Container App SourceControl.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Container App SourceControl": {
"$ref": "./examples/SourceControls_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/start": {
"post": {
"operationId": "ContainerApps_Start",
"tags": [
"ContainerApps"
],
"summary": "Start a container app",
"description": "Start a container app",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ContainerApp"
}
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Start Container App": {
"$ref": "./examples/ContainerApps_Start.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/ContainerApp"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/stop": {
"post": {
"operationId": "ContainerApps_Stop",
"tags": [
"ContainerApps"
],
"summary": "Stop a container app",
"description": "Stop a container app",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "containerAppName",
"in": "path",
"description": "Name of the Container App.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ContainerApp"
}
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Stop Container App": {
"$ref": "./examples/ContainerApps_Stop.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/ContainerApp"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs": {
"get": {
"operationId": "Jobs_ListByResourceGroup",
"tags": [
"Jobs"
],
"summary": "Get the Container Apps Jobs in a given resource group.",
"description": "Get the Container Apps Jobs in a given resource group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/JobsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Container Apps Jobs by resource group": {
"$ref": "./examples/Jobs_ListByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}": {
"get": {
"operationId": "Jobs_Get",
"tags": [
"Jobs"
],
"summary": "Get the properties of a Container Apps Job.",
"description": "Get the properties of a Container Apps Job.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Job Name",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Job"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Container Apps Job": {
"$ref": "./examples/Job_Get.json"
}
}
},
"put": {
"operationId": "Jobs_CreateOrUpdate",
"tags": [
"Jobs"
],
"summary": "Create or Update a Container Apps Job.",
"description": "Create or Update a Container Apps Job.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Job Name",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "JobEnvelope",
"in": "body",
"description": "Properties used to create a container apps job",
"required": true,
"schema": {
"$ref": "#/definitions/Job"
}
}
],
"responses": {
"200": {
"description": "Resource 'Job' update operation succeeded",
"schema": {
"$ref": "#/definitions/Job"
}
},
"201": {
"description": "Resource 'Job' create operation succeeded",
"schema": {
"$ref": "#/definitions/Job"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or Update Container Apps Job": {
"$ref": "./examples/Job_CreateorUpdate.json"
},
"Create or Update Container Apps Job On A Connected Environment": {
"$ref": "./examples/Job_CreateorUpdate_ConnectedEnvironment.json"
},
"Create or Update Container Apps Job With Event Driven Trigger": {
"$ref": "./examples/Job_CreateorUpdate_EventTrigger.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation",
"final-state-schema": "#/definitions/Job"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "Jobs_Update",
"tags": [
"Jobs"
],
"summary": "Update properties of a Container Apps Job",
"description": "Patches a Container Apps Job using JSON Merge Patch",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Job Name",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "JobEnvelope",
"in": "body",
"description": "Properties used to create a container apps job",
"required": true,
"schema": {
"$ref": "#/definitions/JobPatchProperties"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Job"
}
},
"202": {
"description": "Resource update request accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Patch Container Apps Job": {
"$ref": "./examples/Job_Patch.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/Job"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "Jobs_Delete",
"tags": [
"Jobs"
],
"summary": "Delete a Container Apps Job.",
"description": "Delete a Container Apps Job.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Job Name",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Container Apps Job": {
"$ref": "./examples/Job_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectorProperties/{apiName}": {
"get": {
"operationId": "Jobs_ProxyGet",
"tags": [
"Jobs",
"Diagnostics"
],
"summary": "Get the properties of a Container App Job.",
"description": "Get the properties for a given Container App Job.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Job Name",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "apiName",
"in": "path",
"description": "Proxy API Name for Container App Job.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Job"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Container App Job by name": {
"$ref": "./examples/Job_ProxyGet.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectors": {
"get": {
"operationId": "Jobs_ListDetectors",
"tags": [
"Jobs",
"Diagnostics"
],
"summary": "Get the list of diagnostics for a given Container App Job.",
"description": "Get the list of diagnostics for a Container App Job.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Name of the Container App Job.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get the list of available diagnostic data for a Container App Job": {
"$ref": "./examples/Job_ListDetectors.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectors/{detectorName}": {
"get": {
"operationId": "Jobs_GetDetector",
"tags": [
"Jobs",
"Diagnostics"
],
"summary": "Get the diagnostics data for a given Container App Job.",
"description": "Get the diagnostics data for a Container App Job.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Name of the Container App Job.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "detectorName",
"in": "path",
"description": "Proxy API Name for Container App Job.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Diagnostics"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get diagnostic data for a Container App Job": {
"$ref": "./examples/Job_GetDetector.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions": {
"get": {
"operationId": "JobsExecutions_List",
"tags": [
"Jobs"
],
"summary": "Get a Container Apps Job's executions",
"description": "Get a Container Apps Job's executions",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Job Name",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "$filter",
"in": "query",
"description": "The filter to apply on the operation.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ContainerAppJobExecutions"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get a Container Apps Job Executions": {
"$ref": "./examples/Job_Executions_Get.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions/{jobExecutionName}": {
"get": {
"operationId": "JobExecution",
"tags": [
"Jobs"
],
"summary": "Get details of a single job execution",
"description": "Get details of a single job execution",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Job Name",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "jobExecutionName",
"in": "path",
"description": "Job execution name.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/JobExecution"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get a single Job Execution": {
"$ref": "./examples/Job_Execution_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions/{jobExecutionName}/stop": {
"post": {
"operationId": "Jobs_StopExecution",
"tags": [
"Jobs"
],
"summary": "Terminates execution of a running container apps job",
"description": "Terminates execution of a running container apps job",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Job Name",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "jobExecutionName",
"in": "path",
"description": "Job execution name.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "The request has succeeded."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Terminate a Container Apps Job": {
"$ref": "./examples/Job_Stop_Execution.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/listSecrets": {
"post": {
"operationId": "Jobs_ListSecrets",
"tags": [
"Jobs"
],
"summary": "List secrets for a container apps job",
"description": "List secrets for a container apps job",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Job Name",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/JobSecretsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Container Apps Job Secrets": {
"$ref": "./examples/Job_ListSecrets.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/start": {
"post": {
"operationId": "Jobs_Start",
"tags": [
"Jobs"
],
"summary": "Start a Container Apps Job",
"description": "Start a Container Apps Job",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Job Name",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "template",
"in": "body",
"description": "Properties used to start a job execution.",
"required": false,
"schema": {
"$ref": "#/definitions/JobExecutionTemplate"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/JobExecutionBase"
}
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Run a Container Apps Job": {
"$ref": "./examples/Job_Start.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/JobExecutionBase"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/stop": {
"post": {
"operationId": "Jobs_StopMultipleExecutions",
"tags": [
"Jobs"
],
"summary": "Terminates execution of a running container apps job",
"description": "Terminates execution of a running container apps job",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Job Name",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ContainerAppJobExecutions"
}
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Terminate Multiple Container Apps Job": {
"$ref": "./examples/Job_Stop_Multiple.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/ContainerAppJobExecutions"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments": {
"get": {
"operationId": "ManagedEnvironments_ListByResourceGroup",
"tags": [
"ManagedEnvironments"
],
"summary": "Get all the Environments in a resource group.",
"description": "Get all the Managed Environments in a resource group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedEnvironmentsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List environments by resource group": {
"$ref": "./examples/ManagedEnvironments_ListByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}": {
"get": {
"operationId": "ManagedEnvironments_Get",
"tags": [
"ManagedEnvironments"
],
"summary": "Get the properties of a Managed Environment.",
"description": "Get the properties of a Managed Environment used to host container apps.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedEnvironment"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get environments by name": {
"$ref": "./examples/ManagedEnvironments_Get.json"
}
}
},
"put": {
"operationId": "ManagedEnvironments_CreateOrUpdate",
"tags": [
"ManagedEnvironments"
],
"summary": "Creates or updates a Managed Environment.",
"description": "Creates or updates a Managed Environment used to host container apps.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "environmentEnvelope",
"in": "body",
"description": "Configuration details of the Environment.",
"required": true,
"schema": {
"$ref": "#/definitions/ManagedEnvironment"
}
}
],
"responses": {
"200": {
"description": "Resource 'ManagedEnvironment' update operation succeeded",
"schema": {
"$ref": "#/definitions/ManagedEnvironment"
}
},
"201": {
"description": "Resource 'ManagedEnvironment' create operation succeeded",
"schema": {
"$ref": "#/definitions/ManagedEnvironment"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create environment with custom infrastructureResourceGroup": {
"$ref": "./examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json"
},
"Create environments": {
"$ref": "./examples/ManagedEnvironments_CreateOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/ManagedEnvironment"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "ManagedEnvironments_Update",
"tags": [
"ManagedEnvironments"
],
"summary": "Update Managed Environment's properties.",
"description": "Patches a Managed Environment using JSON Merge Patch",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "environmentEnvelope",
"in": "body",
"description": "Configuration details of the Environment.",
"required": true,
"schema": {
"$ref": "#/definitions/ManagedEnvironment"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedEnvironment"
}
},
"202": {
"description": "Resource update request accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Patch Managed Environment": {
"$ref": "./examples/ManagedEnvironments_Patch.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/ManagedEnvironment"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "ManagedEnvironments_Delete",
"tags": [
"ManagedEnvironments"
],
"summary": "Delete a Managed Environment.",
"description": "Delete a Managed Environment if it does not have any container apps.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete environment by name": {
"$ref": "./examples/ManagedEnvironments_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates": {
"get": {
"operationId": "Certificates_List",
"tags": [
"Certificates",
"ManagedEnvironments"
],
"summary": "Get the Certificates in a given managed environment.",
"description": "Get the Certificates in a given managed environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CertificateCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Certificates by Managed Environment": {
"$ref": "./examples/Certificates_ListByManagedEnvironment.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates/{certificateName}": {
"get": {
"operationId": "Certificates_Get",
"tags": [
"Certificates",
"ManagedEnvironments"
],
"summary": "Get the specified Certificate.",
"description": "Get the specified Certificate.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the Certificate.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Certificate": {
"$ref": "./examples/Certificate_Get.json"
}
}
},
"put": {
"operationId": "Certificates_CreateOrUpdate",
"tags": [
"Certificates",
"ManagedEnvironments"
],
"summary": "Create or Update a Certificate.",
"description": "Create or Update a Certificate.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the Certificate.",
"required": true,
"type": "string"
},
{
"name": "certificateEnvelope",
"in": "body",
"description": "Certificate to be created or updated",
"required": false,
"schema": {
"$ref": "#/definitions/Certificate"
}
}
],
"responses": {
"200": {
"description": "Resource 'Certificate' update operation succeeded",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create or Update Certificate": {
"$ref": "./examples/Certificate_CreateOrUpdate.json"
},
"Create or Update Certificate using Managed Identity": {
"$ref": "./examples/Certificate_CreateOrUpdate_FromKeyVault.json"
}
}
},
"patch": {
"operationId": "Certificates_Update",
"tags": [
"Certificates",
"ManagedEnvironments"
],
"summary": "Update properties of a certificate",
"description": "Patches a certificate. Currently only patching of tags is supported",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the Certificate.",
"required": true,
"type": "string"
},
{
"name": "certificateEnvelope",
"in": "body",
"description": "Properties of a certificate that need to be updated",
"required": true,
"schema": {
"$ref": "#/definitions/CertificatePatch"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Patch Certificate": {
"$ref": "./examples/Certificates_Patch.json"
}
}
},
"delete": {
"operationId": "Certificates_Delete",
"tags": [
"Certificates",
"ManagedEnvironments"
],
"summary": "Deletes the specified Certificate.",
"description": "Deletes the specified Certificate.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the Certificate.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Certificate": {
"$ref": "./examples/Certificate_Delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/checkNameAvailability": {
"post": {
"operationId": "Namespaces_CheckNameAvailability",
"tags": [
"ManagedEnvironments"
],
"summary": "Checks the resource name availability.",
"description": "Checks if resource name is available.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "checkNameAvailabilityRequest",
"in": "body",
"description": "The check name availability request.",
"required": true,
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Certificates_CheckNameAvailability": {
"$ref": "./examples/Certificates_CheckNameAvailability.json"
},
"ContainerApps_CheckNameAvailability": {
"$ref": "./examples/ContainerApps_CheckNameAvailability.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents": {
"get": {
"operationId": "DaprComponents_List",
"tags": [
"DaprComponents"
],
"summary": "Get the Dapr Components for a managed environment.",
"description": "Get the Dapr Components for a managed environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DaprComponentsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Dapr Components": {
"$ref": "./examples/DaprComponents_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}": {
"get": {
"operationId": "DaprComponents_Get",
"tags": [
"DaprComponents"
],
"summary": "Get a dapr component.",
"description": "Get a dapr component.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
},
{
"name": "componentName",
"in": "path",
"description": "Name of the Dapr Component.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DaprComponent"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Dapr Component with secret store component": {
"$ref": "./examples/DaprComponents_Get_SecretStoreComponent.json"
},
"Get Dapr Component with secrets": {
"$ref": "./examples/DaprComponents_Get_Secrets.json"
}
}
},
"put": {
"operationId": "DaprComponents_CreateOrUpdate",
"tags": [
"DaprComponents"
],
"summary": "Creates or updates a Dapr Component.",
"description": "Creates or updates a Dapr Component in a Managed Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
},
{
"name": "componentName",
"in": "path",
"description": "Name of the Dapr Component.",
"required": true,
"type": "string"
},
{
"name": "daprComponentEnvelope",
"in": "body",
"description": "Configuration details of the Dapr Component.",
"required": true,
"schema": {
"$ref": "#/definitions/DaprComponent"
}
}
],
"responses": {
"200": {
"description": "Resource 'DaprComponent' update operation succeeded",
"schema": {
"$ref": "#/definitions/DaprComponent"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or update dapr component with secret store component": {
"$ref": "./examples/DaprComponents_CreateOrUpdate_SecretStoreComponent.json"
},
"Create or update dapr component with secrets": {
"$ref": "./examples/DaprComponents_CreateOrUpdate_Secrets.json"
}
}
},
"delete": {
"operationId": "DaprComponents_Delete",
"tags": [
"DaprComponents"
],
"summary": "Delete a Dapr Component.",
"description": "Delete a Dapr Component from a Managed Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
},
{
"name": "componentName",
"in": "path",
"description": "Name of the Dapr Component.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete dapr component": {
"$ref": "./examples/DaprComponents_Delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}/listSecrets": {
"post": {
"operationId": "DaprComponents_ListSecrets",
"tags": [
"DaprComponents"
],
"summary": "List secrets for a dapr component",
"description": "List secrets for a dapr component",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
},
{
"name": "componentName",
"in": "path",
"description": "Name of the Dapr Component.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DaprSecretsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Container Apps Secrets": {
"$ref": "./examples/DaprComponents_ListSecrets.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectorProperties/rootApi/": {
"get": {
"operationId": "ManagedEnvironmentsDiagnostics_GetRoot",
"tags": [
"ManagedEnvironments",
"Diagnostics"
],
"summary": "Get the properties of a Managed Environment.",
"description": "Get the properties of a Managed Environment used to host container apps.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedEnvironment"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get environments by name": {
"$ref": "./examples/ManagedEnvironments_Get1.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectors": {
"get": {
"operationId": "ManagedEnvironmentDiagnostics_ListDetectors",
"tags": [
"ManagedEnvironments",
"Diagnostics"
],
"summary": "Get the list of diagnostics for a given Managed Environment.",
"description": "Get the list of diagnostics for a Managed Environment used to host container apps.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get the list of available diagnostic data for a managed environments": {
"$ref": "./examples/ManagedEnvironmentDiagnostics_List.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectors/{detectorName}": {
"get": {
"operationId": "ManagedEnvironmentDiagnostics_GetDetector",
"tags": [
"ManagedEnvironments",
"Diagnostics"
],
"summary": "Get the diagnostics data for a given Managed Environment.",
"description": "Get the diagnostics data for a Managed Environment used to host container apps.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
},
{
"name": "detectorName",
"in": "path",
"description": "Name of the detector.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Diagnostics"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get diagnostic data for a managed environments": {
"$ref": "./examples/ManagedEnvironmentDiagnostics_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/getAuthtoken": {
"post": {
"operationId": "ManagedEnvironments_GetAuthToken",
"tags": [
"ManagedEnvironments"
],
"summary": "Get auth token for a managed environment",
"description": "Checks if resource name is available.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/EnvironmentAuthToken"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Managed Environment Auth Token": {
"$ref": "./examples/ManagedEnvironments_GetAuthToken.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/httpRouteConfigs": {
"get": {
"operationId": "HttpRouteConfig_List",
"tags": [
"HttpRouteConfig"
],
"summary": "List the Http Route Configs in a given managed environment.",
"description": "Get the Managed Http Routes in a given managed environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HttpRouteConfigCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Managed Http Routes by Managed Environment": {
"$ref": "./examples/HttpRouteConfig_ListByManagedEnvironment.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/httpRouteConfigs/{httpRouteName}": {
"get": {
"operationId": "HttpRouteConfig_Get",
"tags": [
"HttpRouteConfig"
],
"summary": "Get the specified Http Route Config.",
"description": "Get the specified Managed Http Route Config.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "httpRouteName",
"in": "path",
"description": "Name of the Http Route Config.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 63,
"pattern": "^[a-z][a-z0-9]*$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HttpRouteConfig"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get HttpRoute": {
"$ref": "./examples/HttpRouteConfig_Get.json"
}
}
},
"put": {
"operationId": "HttpRouteConfig_CreateOrUpdate",
"tags": [
"HttpRouteConfig"
],
"summary": "Create or Update a Http Route Config.",
"description": "Create or Update a Http Route Config.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "httpRouteName",
"in": "path",
"description": "Name of the Http Route Config.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 63,
"pattern": "^[a-z][a-z0-9]*$"
},
{
"name": "httpRouteConfigEnvelope",
"in": "body",
"description": "Http Route config to be created or updated",
"required": false,
"schema": {
"$ref": "#/definitions/HttpRouteConfig"
}
}
],
"responses": {
"200": {
"description": "Resource 'HttpRouteConfig' update operation succeeded",
"schema": {
"$ref": "#/definitions/HttpRouteConfig"
}
},
"201": {
"description": "Resource 'HttpRouteConfig' create operation succeeded",
"schema": {
"$ref": "#/definitions/HttpRouteConfig"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or Update Http Route": {
"$ref": "./examples/HttpRouteConfig_CreateOrUpdate.json"
},
"Create or Update Http Route Path Separated Prefix Rule": {
"$ref": "./examples/HttpRouteConfig_CreateOrUpdate_PathSepPrefix.json"
},
"Create or Update Http Route Prefix Rule": {
"$ref": "./examples/HttpRouteConfig_CreateOrUpdatePrefix.json"
}
}
},
"patch": {
"operationId": "HttpRouteConfig_Update",
"tags": [
"HttpRouteConfig"
],
"summary": "Update tags of a Http Route Config object",
"description": "Patches an http route config resource. Only patching of tags is supported",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "httpRouteName",
"in": "path",
"description": "Name of the Http Route Config Resource.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 63,
"pattern": "^[a-z][a-z0-9]*$"
},
{
"name": "httpRouteConfigEnvelope",
"in": "body",
"description": "Properties of http route config that need to be updated",
"required": true,
"schema": {
"$ref": "#/definitions/HttpRouteConfig"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HttpRouteConfig"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Patch Managed Http Route": {
"$ref": "./examples/HttpRouteConfig_Patch.json"
}
}
},
"delete": {
"operationId": "HttpRouteConfig_Delete",
"tags": [
"HttpRouteConfig"
],
"summary": "Deletes the specified Http Route Config.",
"description": "Deletes the specified Managed Http Route.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "httpRouteName",
"in": "path",
"description": "Name of the Http Route Config Resource.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 63,
"pattern": "^[a-z][a-z0-9]*$"
}
],
"responses": {
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Certificate": {
"$ref": "./examples/HttpRouteConfig_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/javaComponents": {
"get": {
"operationId": "JavaComponents_List",
"tags": [
"JavaComponents"
],
"summary": "Get the Java Components for a managed environment.",
"description": "Get the Java Components for a managed environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/JavaComponentsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Java Components": {
"$ref": "./examples/JavaComponents_List.json"
},
"List Java Components with ServiceBinds": {
"$ref": "./examples/JavaComponents_List_ServiceBind.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/javaComponents/{name}": {
"get": {
"operationId": "JavaComponents_Get",
"tags": [
"JavaComponents"
],
"summary": "Get a Java Component.",
"description": "Get a Java Component.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "name",
"in": "path",
"description": "Name of the Java Component.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/JavaComponent"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Java Component": {
"$ref": "./examples/JavaComponents_Get.json"
},
"Get Java Component with ServiceBinds": {
"$ref": "./examples/JavaComponents_Get_ServiceBind.json"
}
}
},
"put": {
"operationId": "JavaComponents_CreateOrUpdate",
"tags": [
"JavaComponents"
],
"summary": "Creates or updates a Java Component.",
"description": "Creates or updates a Java Component in a Managed Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "name",
"in": "path",
"description": "Name of the Java Component.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "javaComponentEnvelope",
"in": "body",
"description": "Configuration details of the Java Component.",
"required": true,
"schema": {
"$ref": "#/definitions/JavaComponent"
}
}
],
"responses": {
"200": {
"description": "Resource 'JavaComponent' update operation succeeded",
"schema": {
"$ref": "#/definitions/JavaComponent"
}
},
"201": {
"description": "Resource 'JavaComponent' create operation succeeded",
"schema": {
"$ref": "#/definitions/JavaComponent"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create or Update Java Component": {
"$ref": "./examples/JavaComponents_CreateOrUpdate.json"
},
"Create or Update Java Component with ServiceBinds": {
"$ref": "./examples/JavaComponents_CreateOrUpdate_ServiceBind.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation",
"final-state-schema": "#/definitions/JavaComponent"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "JavaComponents_Update",
"tags": [
"JavaComponents"
],
"summary": "Update properties of a Java Component",
"description": "Patches a Java Component using JSON Merge Patch",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "name",
"in": "path",
"description": "Name of the Java Component.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "javaComponentEnvelope",
"in": "body",
"description": "Configuration details of the Java Component.",
"required": true,
"schema": {
"$ref": "#/definitions/JavaComponent"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/JavaComponent"
}
},
"202": {
"description": "Resource update request accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Patch Java Component": {
"$ref": "./examples/JavaComponents_Patch.json"
},
"Patch Java Component with ServiceBinds": {
"$ref": "./examples/JavaComponents_Patch_ServiceBind.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/JavaComponent"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "JavaComponents_Delete",
"tags": [
"JavaComponents"
],
"summary": "Delete.",
"description": "Delete a Java Component.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "name",
"in": "path",
"description": "Name of the Java Component.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Java Component": {
"$ref": "./examples/JavaComponents_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/maintenanceConfigurations": {
"get": {
"operationId": "MaintenanceConfigurations_List",
"tags": [
"MaintenanceConfigurations"
],
"description": "Gets all maintenance configurations in the specified Managed Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/MaintenanceConfigurationCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"ManagedEnvironmentMaintenanceConfigurationsList": {
"$ref": "./examples/ManagedEnvironment_MaintenanceConfigurations_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/maintenanceConfigurations/{configName}": {
"get": {
"operationId": "MaintenanceConfigurations_Get",
"tags": [
"MaintenanceConfigurations"
],
"description": "Gets the maintenance configuration of a ManagedEnvironment .",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "configName",
"in": "path",
"description": "Name of the Maintenance Configuration.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/MaintenanceConfigurationResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"ManagedEnvironmentMaintenanceConfigurationsGet": {
"$ref": "./examples/ManagedEnvironment_MaintenanceConfigurations_Get.json"
}
}
},
"put": {
"operationId": "MaintenanceConfigurations_CreateOrUpdate",
"tags": [
"MaintenanceConfigurations"
],
"description": "Create or update the maintenance configuration for Managed Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "configName",
"in": "path",
"description": "Name of the Maintenance Configuration.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "maintenanceConfigurationEnvelope",
"in": "body",
"description": "Parameters to set the maintenance configuration for ManagedEnvironment .",
"required": true,
"schema": {
"$ref": "#/definitions/MaintenanceConfigurationResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'MaintenanceConfigurationResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/MaintenanceConfigurationResource"
}
},
"201": {
"description": "Resource 'MaintenanceConfigurationResource' create operation succeeded",
"schema": {
"$ref": "#/definitions/MaintenanceConfigurationResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"ManagedEnvironmentMaintenanceConfigurationsCreateOrUpdate": {
"$ref": "./examples/ManagedEnvironment_MaintenanceConfigurations_CreateOrUpdate.json"
}
}
},
"delete": {
"operationId": "MaintenanceConfigurations_Delete",
"tags": [
"MaintenanceConfigurations"
],
"description": "Deletes the maintenance configuration of a ManagedEnvironment .",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "configName",
"in": "path",
"description": "Name of the Maintenance Configuration.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"ManagedEnvironmentMaintenanceConfigurationsDelete": {
"$ref": "./examples/ManagedEnvironment_MaintenanceConfigurations_Delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates": {
"get": {
"operationId": "ManagedCertificates_List",
"tags": [
"ManagedEnvironments",
"ManagedCertificates"
],
"summary": "Get the Managed Certificates in a given managed environment.",
"description": "Get the Managed Certificates in a given managed environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedCertificateCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Managed Certificates by Managed Environment": {
"$ref": "./examples/ManagedCertificates_ListByManagedEnvironment.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}": {
"get": {
"operationId": "ManagedCertificates_Get",
"tags": [
"ManagedEnvironments",
"ManagedCertificates"
],
"summary": "Get the specified Managed Certificate.",
"description": "Get the specified Managed Certificate.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "managedCertificateName",
"in": "path",
"description": "Name of the Managed Certificate.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedCertificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Certificate": {
"$ref": "./examples/ManagedCertificate_Get.json"
}
}
},
"put": {
"operationId": "ManagedCertificates_CreateOrUpdate",
"tags": [
"ManagedEnvironments",
"ManagedCertificates"
],
"summary": "Create or Update a Managed Certificate.",
"description": "Create or Update a Managed Certificate.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
},
{
"name": "managedCertificateName",
"in": "path",
"description": "Name of the Managed Certificate.",
"required": true,
"type": "string"
},
{
"name": "managedCertificateEnvelope",
"in": "body",
"description": "Managed Certificate to be created or updated",
"required": false,
"schema": {
"$ref": "#/definitions/ManagedCertificate"
}
}
],
"responses": {
"200": {
"description": "Resource 'ManagedCertificate' update operation succeeded",
"schema": {
"$ref": "#/definitions/ManagedCertificate"
}
},
"201": {
"description": "Resource 'ManagedCertificate' create operation succeeded",
"schema": {
"$ref": "#/definitions/ManagedCertificate"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"400": {
"description": "The server could not understand the request due to invalid syntax.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create or Update Certificate": {
"$ref": "./examples/ManagedCertificate_CreateOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation",
"final-state-schema": "#/definitions/ManagedCertificate"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "ManagedCertificates_Update",
"tags": [
"ManagedEnvironments",
"ManagedCertificates"
],
"summary": "Update tags of a managed certificate",
"description": "Patches a managed certificate. Oly patching of tags is supported",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "managedCertificateName",
"in": "path",
"description": "Name of the Managed Certificate.",
"required": true,
"type": "string"
},
{
"name": "managedCertificateEnvelope",
"in": "body",
"description": "Properties of a managed certificate that need to be updated",
"required": true,
"schema": {
"$ref": "#/definitions/ManagedCertificatePatch"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedCertificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Patch Managed Certificate": {
"$ref": "./examples/ManagedCertificates_Patch.json"
}
}
},
"delete": {
"operationId": "ManagedCertificates_Delete",
"tags": [
"ManagedEnvironments",
"ManagedCertificates"
],
"summary": "Deletes the specified Managed Certificate.",
"description": "Deletes the specified Managed Certificate.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "managedCertificateName",
"in": "path",
"description": "Name of the Managed Certificate.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Certificate": {
"$ref": "./examples/ManagedCertificate_Delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/privateEndpointConnections": {
"get": {
"operationId": "ManagedEnvironmentPrivateEndpointConnections_List",
"tags": [
"ManagedEnvironments",
"PrivateEndpointConnections"
],
"summary": "List private endpoint connections for a given managed environment.",
"description": "List private endpoint connections for a given managed environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnectionListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Private Endpoint Connections by Managed Environment": {
"$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/privateEndpointConnections/{privateEndpointConnectionName}": {
"get": {
"operationId": "ManagedEnvironmentPrivateEndpointConnections_Get",
"tags": [
"ManagedEnvironments",
"PrivateEndpointConnections"
],
"summary": "Get a private endpoint connection for a given managed environment.",
"description": "Get a private endpoint connection for a given managed environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the Private Endpoint Connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get a Private Endpoint Connection by Managed Environment": {
"$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_Get.json"
}
}
},
"put": {
"operationId": "ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate",
"tags": [
"ManagedEnvironments",
"PrivateEndpointConnections"
],
"summary": "Update the state of a private endpoint connection for a given managed environment.",
"description": "Update the state of a private endpoint connection for a given managed environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the Private Endpoint Connection.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointConnectionEnvelope",
"in": "body",
"description": "The resource of private endpoint and its properties",
"required": true,
"schema": {
"$ref": "#/definitions/PrivateEndpointConnection"
}
}
],
"responses": {
"200": {
"description": "Resource 'PrivateEndpointConnection' update operation succeeded",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnection"
}
},
"201": {
"description": "Resource 'PrivateEndpointConnection' create operation succeeded",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnection"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update a Private Endpoint Connection by Managed Environment": {
"$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/PrivateEndpointConnection"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "ManagedEnvironmentPrivateEndpointConnections_Delete",
"tags": [
"ManagedEnvironments",
"PrivateEndpointConnections"
],
"summary": "Delete a private endpoint connection for a given managed environment.",
"description": "Delete a private endpoint connection for a given managed environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the Private Endpoint Connection.",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete a Private Endpoint Connection by Managed Environment": {
"$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/privateLinkResources": {
"get": {
"operationId": "ManagedEnvironmentPrivateLinkResources_List",
"tags": [
"ManagedEnvironments",
"PrivateLinkResources"
],
"summary": "List private link resources for a given managed environment.",
"description": "List private link resources for a given managed environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the managed environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateLinkResourceListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Private Link Resources by Managed Environment": {
"$ref": "./examples/ManagedEnvironmentPrivateLinkResources_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages": {
"get": {
"operationId": "ManagedEnvironmentsStorages_List",
"tags": [
"ManagedEnvironmentsStorages"
],
"summary": "Get all storages for a managedEnvironment.",
"description": "Get all storages for a managedEnvironment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedEnvironmentStoragesCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List environments storages by subscription": {
"$ref": "./examples/ManagedEnvironmentsStorages_List.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages/{storageName}": {
"get": {
"operationId": "ManagedEnvironmentsStorages_Get",
"tags": [
"ManagedEnvironmentsStorages"
],
"summary": "Get storage for a managedEnvironment.",
"description": "Get storage for a managedEnvironment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "storageName",
"in": "path",
"description": "Name of the storage.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedEnvironmentStorage"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"get a environments storage": {
"$ref": "./examples/ManagedEnvironmentsStorages_Get.json"
},
"get a environments storage for NFS Azure file": {
"$ref": "./examples/ManagedEnvironmentsStorages_Get_NfsAzureFile.json"
}
}
},
"put": {
"operationId": "ManagedEnvironmentsStorages_CreateOrUpdate",
"tags": [
"ManagedEnvironmentsStorages"
],
"summary": "Create or update storage for a managedEnvironment.",
"description": "Create or update storage for a managedEnvironment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "storageName",
"in": "path",
"description": "Name of the storage.",
"required": true,
"type": "string"
},
{
"name": "storageEnvelope",
"in": "body",
"description": "Configuration details of storage.",
"required": true,
"schema": {
"$ref": "#/definitions/ManagedEnvironmentStorage"
}
}
],
"responses": {
"200": {
"description": "Resource 'ManagedEnvironmentStorage' update operation succeeded",
"schema": {
"$ref": "#/definitions/ManagedEnvironmentStorage"
}
},
"201": {
"description": "Resource 'ManagedEnvironmentStorage' create operation succeeded",
"schema": {
"$ref": "#/definitions/ManagedEnvironmentStorage"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or update environments storage": {
"$ref": "./examples/ManagedEnvironmentsStorages_CreateOrUpdate.json"
},
"Create or update environments storage for NFS Azure file": {
"$ref": "./examples/ManagedEnvironmentsStorages_CreateOrUpdate_NfsAzureFile.json"
}
}
},
"delete": {
"operationId": "ManagedEnvironmentsStorages_Delete",
"tags": [
"ManagedEnvironmentsStorages"
],
"summary": "Delete storage for a managedEnvironment.",
"description": "Delete storage for a managedEnvironment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "storageName",
"in": "path",
"description": "Name of the storage.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List environments storages by subscription": {
"$ref": "./examples/ManagedEnvironmentsStorages_Delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/usages": {
"get": {
"operationId": "ManagedEnvironmentUsages_List",
"tags": [
"Usages"
],
"description": "Gets the current usage information as well as the limits for environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._]+$"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/ListUsagesResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List managed environment usages": {
"$ref": "./examples/ManagedEnvironmentUsages_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/workloadProfileStates": {
"get": {
"operationId": "ManagedEnvironments_ListWorkloadProfileStates",
"tags": [
"ManagedEnvironments"
],
"summary": "Get all workload Profile States for a Managed Environment..",
"description": "Get all workload Profile States for a Managed Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/workloadProfileStatesCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List environments by subscription": {
"$ref": "./examples/ManagedEnvironments_ListWorkloadProfileStates.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/sessionPools": {
"get": {
"operationId": "ContainerAppsSessionPools_ListByResourceGroup",
"tags": [
"ContainerAppsSessionPools"
],
"summary": "Get the session pools in a given resource group of a subscription.",
"description": "Get the session pools in a given resource group of a subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SessionPoolCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Session Pools by resource group": {
"$ref": "./examples/SessionPools_ListByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/sessionPools/{sessionPoolName}": {
"get": {
"operationId": "ContainerAppsSessionPools_Get",
"tags": [
"ContainerAppsSessionPools"
],
"summary": "Get the properties of a session pool.",
"description": "Get the properties of a session pool.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "sessionPoolName",
"in": "path",
"description": "Name of the session pool.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 63,
"pattern": "^[a-z][a-z0-9]*$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SessionPool"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Session Pool": {
"$ref": "./examples/SessionPools_Get.json"
},
"Get Session Pool during update": {
"$ref": "./examples/SessionPools_Get_InProgress.json"
}
}
},
"put": {
"operationId": "ContainerAppsSessionPools_CreateOrUpdate",
"tags": [
"ContainerAppsSessionPools"
],
"summary": "Create or update a session pool.",
"description": "Create or update a session pool with the given properties.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "sessionPoolName",
"in": "path",
"description": "Name of the session pool.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 63,
"pattern": "^[a-z][a-z0-9]*$"
},
{
"name": "sessionPoolEnvelope",
"in": "body",
"description": "Properties used to create a session pool",
"required": true,
"schema": {
"$ref": "#/definitions/SessionPool"
}
}
],
"responses": {
"200": {
"description": "Resource 'SessionPool' update operation succeeded",
"schema": {
"$ref": "#/definitions/SessionPool"
}
},
"201": {
"description": "Resource 'SessionPool' create operation succeeded",
"schema": {
"$ref": "#/definitions/SessionPool"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create or Update Session Pool with MCP server": {
"$ref": "./examples/SessionPools_McpServer_CreateOrUpdate.json"
},
"Create or Update Session Pool with lifecycle OnContainerExit Timed": {
"$ref": "./examples/SessionPools_LifecycleOnContainerExit_CreateOrUpdate.json"
},
"Create or Update Session Pool with lifecycle type Timed": {
"$ref": "./examples/SessionPools_LifecycleTimed_CreateOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation",
"final-state-schema": "#/definitions/SessionPool"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "ContainerAppsSessionPools_Update",
"tags": [
"ContainerAppsSessionPools"
],
"summary": "Update properties of a session pool",
"description": "Patches a session pool using JSON merge patch",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "sessionPoolName",
"in": "path",
"description": "Name of the session pool.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 63,
"pattern": "^[a-z][a-z0-9]*$"
},
{
"name": "sessionPoolEnvelope",
"in": "body",
"description": "Properties used to create a session pool",
"required": true,
"schema": {
"$ref": "#/definitions/SessionPoolUpdatableProperties"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SessionPool"
}
},
"202": {
"description": "Resource update request accepted.",
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Location": {
"type": "string"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update Session Pool": {
"$ref": "./examples/SessionPools_Patch.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation",
"final-state-schema": "#/definitions/SessionPool"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "ContainerAppsSessionPools_Delete",
"tags": [
"ContainerAppsSessionPools"
],
"summary": "Delete a session pool.",
"description": "Delete the session pool with the given name.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "sessionPoolName",
"in": "path",
"description": "Name of the session pool.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 63,
"pattern": "^[a-z][a-z0-9]*$"
}
],
"responses": {
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Session Pool": {
"$ref": "./examples/SessionPools_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
}
},
"definitions": {
"AccessMode": {
"type": "string",
"description": "Access mode for storage",
"enum": [
"ReadOnly",
"ReadWrite"
],
"x-ms-enum": {
"name": "AccessMode",
"modelAsString": true,
"values": [
{
"name": "ReadOnly",
"value": "ReadOnly",
"description": "ReadOnly"
},
{
"name": "ReadWrite",
"value": "ReadWrite",
"description": "ReadWrite"
}
]
}
},
"Action": {
"type": "string",
"description": "Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny",
"enum": [
"Allow",
"Deny"
],
"x-ms-enum": {
"name": "Action",
"modelAsString": true,
"values": [
{
"name": "Allow",
"value": "Allow",
"description": "Allow"
},
{
"name": "Deny",
"value": "Deny",
"description": "Deny"
}
]
}
},
"Affinity": {
"type": "string",
"description": "Sticky Session Affinity",
"enum": [
"sticky",
"none"
],
"x-ms-enum": {
"name": "Affinity",
"modelAsString": true,
"values": [
{
"name": "sticky",
"value": "sticky",
"description": "sticky"
},
{
"name": "none",
"value": "none",
"description": "none"
}
]
}
},
"AllowedAudiencesValidation": {
"type": "object",
"description": "The configuration settings of the Allowed Audiences validation flow.",
"properties": {
"allowedAudiences": {
"type": "array",
"description": "The configuration settings of the allowed list of audiences from which to validate the JWT token.",
"items": {
"type": "string"
}
}
}
},
"AllowedPrincipals": {
"type": "object",
"description": "The configuration settings of the Azure Active Directory allowed principals.",
"properties": {
"groups": {
"type": "array",
"description": "The list of the allowed groups.",
"items": {
"type": "string"
}
},
"identities": {
"type": "array",
"description": "The list of the allowed identities.",
"items": {
"type": "string"
}
}
}
},
"AppLogsConfiguration": {
"type": "object",
"description": "Configuration of application logs",
"properties": {
"destination": {
"type": "string",
"description": "Logs destination, can be 'log-analytics', 'azure-monitor' or 'none'"
},
"logAnalyticsConfiguration": {
"$ref": "#/definitions/LogAnalyticsConfiguration",
"description": "Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'"
}
}
},
"AppRegistration": {
"type": "object",
"description": "The configuration settings of the app registration for providers that have app ids and app secrets",
"properties": {
"appId": {
"type": "string",
"description": "The App ID of the app used for login."
},
"appSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the app secret."
}
}
},
"Apple": {
"type": "object",
"description": "The configuration settings of the Apple provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the Apple provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/AppleRegistration",
"description": "The configuration settings of the Apple registration."
},
"login": {
"$ref": "#/definitions/LoginScopes",
"description": "The configuration settings of the login flow."
}
}
},
"AppleRegistration": {
"type": "object",
"description": "The configuration settings of the registration for the Apple provider",
"properties": {
"clientId": {
"type": "string",
"description": "The Client ID of the app used for login."
},
"clientSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the client secret."
}
}
},
"Applicability": {
"type": "string",
"description": "indicates whether the profile is default for the location.",
"enum": [
"LocationDefault",
"Custom"
],
"x-ms-enum": {
"name": "Applicability",
"modelAsString": true,
"values": [
{
"name": "LocationDefault",
"value": "LocationDefault",
"description": "LocationDefault"
},
{
"name": "Custom",
"value": "Custom",
"description": "Custom"
}
]
}
},
"AuthConfig": {
"type": "object",
"description": "Configuration settings for the Azure ContainerApp Service Authentication / Authorization feature.",
"properties": {
"properties": {
"$ref": "#/definitions/AuthConfigProperties",
"description": "AuthConfig resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"AuthConfigCollection": {
"type": "object",
"description": "AuthConfig collection ARM resource.",
"properties": {
"value": {
"type": "array",
"description": "The AuthConfig items on this page",
"items": {
"$ref": "#/definitions/AuthConfig"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"AuthConfigProperties": {
"type": "object",
"description": "AuthConfig resource specific properties",
"properties": {
"platform": {
"$ref": "#/definitions/AuthPlatform",
"description": "The configuration settings of the platform of ContainerApp Service Authentication/Authorization."
},
"globalValidation": {
"$ref": "#/definitions/GlobalValidation",
"description": "The configuration settings that determines the validation flow of users using Service Authentication/Authorization."
},
"identityProviders": {
"$ref": "#/definitions/IdentityProviders",
"description": "The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization."
},
"login": {
"$ref": "#/definitions/Login",
"description": "The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization."
},
"httpSettings": {
"$ref": "#/definitions/HttpSettings",
"description": "The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization."
},
"encryptionSettings": {
"$ref": "#/definitions/EncryptionSettings",
"description": "The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization."
}
}
},
"AuthPlatform": {
"type": "object",
"description": "The configuration settings of the platform of ContainerApp Service Authentication/Authorization.",
"properties": {
"enabled": {
"type": "boolean",
"description": "true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."
},
"runtimeVersion": {
"type": "string",
"description": "The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."
}
}
},
"AvailableOperations": {
"type": "object",
"description": "Available operations of the service",
"properties": {
"value": {
"type": "array",
"description": "The OperationDetail items on this page",
"items": {
"$ref": "#/definitions/OperationDetail"
},
"x-ms-identifiers": [
"name"
]
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"AvailableWorkloadProfile": {
"type": "object",
"description": "A workload profile with specific hardware configure to run container apps.",
"properties": {
"location": {
"type": "string",
"description": "Region of the workload profile."
},
"properties": {
"$ref": "#/definitions/AvailableWorkloadProfileProperties",
"description": "Revision resource specific properties"
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"AvailableWorkloadProfileProperties": {
"type": "object",
"description": "Revision resource specific properties",
"properties": {
"category": {
"type": "string",
"description": "Used to categorize workload profiles."
},
"applicability": {
"$ref": "#/definitions/Applicability",
"description": "indicates whether the profile is default for the location."
},
"cores": {
"type": "integer",
"format": "int32",
"description": "Number of cores in CPU."
},
"memoryGiB": {
"type": "integer",
"format": "int32",
"description": "Memory in GiB."
},
"gpus": {
"type": "integer",
"format": "int32",
"description": "Number of GPUs."
},
"displayName": {
"type": "string",
"description": "The everyday name of the workload profile."
}
}
},
"AvailableWorkloadProfilesCollection": {
"type": "object",
"description": "Collection of available workload profiles in the location.",
"properties": {
"value": {
"type": "array",
"description": "The AvailableWorkloadProfile items on this page",
"items": {
"$ref": "#/definitions/AvailableWorkloadProfile"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"AzureActiveDirectory": {
"type": "object",
"description": "The configuration settings of the Azure Active directory provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/AzureActiveDirectoryRegistration",
"description": "The configuration settings of the Azure Active Directory app registration."
},
"login": {
"$ref": "#/definitions/AzureActiveDirectoryLogin",
"description": "The configuration settings of the Azure Active Directory login flow."
},
"validation": {
"$ref": "#/definitions/AzureActiveDirectoryValidation",
"description": "The configuration settings of the Azure Active Directory token validation flow."
},
"isAutoProvisioned": {
"type": "boolean",
"description": "Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property."
}
}
},
"AzureActiveDirectoryLogin": {
"type": "object",
"description": "The configuration settings of the Azure Active Directory login flow.",
"properties": {
"loginParameters": {
"type": "array",
"description": "Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\".",
"items": {
"type": "string"
}
},
"disableWWWAuthenticate": {
"type": "boolean",
"description": "true if the www-authenticate provider should be omitted from the request; otherwise, false."
}
}
},
"AzureActiveDirectoryRegistration": {
"type": "object",
"description": "The configuration settings of the Azure Active Directory app registration.",
"properties": {
"openIdIssuer": {
"type": "string",
"description": "The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"
},
"clientId": {
"type": "string",
"description": "The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or\nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"
},
"clientSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the client secret of the relying party application."
},
"clientSecretCertificateThumbprint": {
"type": "string",
"description": "An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."
},
"clientSecretCertificateSubjectAlternativeName": {
"type": "string",
"description": "An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."
},
"clientSecretCertificateIssuer": {
"type": "string",
"description": "An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."
}
}
},
"AzureActiveDirectoryValidation": {
"type": "object",
"description": "The configuration settings of the Azure Active Directory token validation flow.",
"properties": {
"jwtClaimChecks": {
"$ref": "#/definitions/JwtClaimChecks",
"description": "The configuration settings of the checks that should be made while validating the JWT Claims."
},
"allowedAudiences": {
"type": "array",
"description": "The list of audiences that can make successful authentication/authorization requests.",
"items": {
"type": "string"
}
},
"defaultAuthorizationPolicy": {
"$ref": "#/definitions/DefaultAuthorizationPolicy",
"description": "The configuration settings of the default authorization policy."
}
}
},
"AzureCredentials": {
"type": "object",
"description": "Container App credentials.",
"properties": {
"clientId": {
"type": "string",
"format": "password",
"description": "Client Id.",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
},
"clientSecret": {
"type": "string",
"format": "password",
"description": "Client Secret.",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
},
"tenantId": {
"type": "string",
"format": "password",
"description": "Tenant Id.",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
},
"kind": {
"type": "string",
"description": "Kind of auth github does for deploying the template",
"x-ms-mutability": [
"update",
"create"
]
},
"subscriptionId": {
"type": "string",
"description": "Subscription Id."
}
}
},
"AzureFileProperties": {
"type": "object",
"description": "Azure File Properties.",
"properties": {
"accountName": {
"type": "string",
"description": "Storage account name for azure file."
},
"accountKey": {
"type": "string",
"format": "password",
"description": "Storage account key for azure file.",
"x-ms-secret": true
},
"accountKeyVaultProperties": {
"$ref": "#/definitions/SecretKeyVaultProperties",
"description": "Storage account key stored as an Azure Key Vault secret."
},
"accessMode": {
"$ref": "#/definitions/AccessMode",
"description": "Access mode for storage"
},
"shareName": {
"type": "string",
"description": "Azure file share name."
}
}
},
"AzureStaticWebApps": {
"type": "object",
"description": "The configuration settings of the Azure Static Web Apps provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/AzureStaticWebAppsRegistration",
"description": "The configuration settings of the Azure Static Web Apps registration."
}
}
},
"AzureStaticWebAppsRegistration": {
"type": "object",
"description": "The configuration settings of the registration for the Azure Static Web Apps provider",
"properties": {
"clientId": {
"type": "string",
"description": "The Client ID of the app used for login."
}
}
},
"BaseContainer": {
"type": "object",
"description": "Container App base container definition.",
"properties": {
"image": {
"type": "string",
"description": "Container image tag."
},
"name": {
"type": "string",
"description": "Custom container name."
},
"command": {
"type": "array",
"description": "Container start command.",
"items": {
"type": "string"
}
},
"args": {
"type": "array",
"description": "Container start command arguments.",
"items": {
"type": "string"
}
},
"env": {
"type": "array",
"description": "Container environment variables.",
"items": {
"$ref": "#/definitions/EnvironmentVar"
},
"x-ms-identifiers": [
"name"
]
},
"resources": {
"$ref": "#/definitions/ContainerResources",
"description": "Container resource requirements."
},
"volumeMounts": {
"type": "array",
"description": "Container volume mounts.",
"items": {
"$ref": "#/definitions/VolumeMount"
},
"x-ms-identifiers": [
"volumeName"
]
}
}
},
"BillingMeter": {
"type": "object",
"description": "Billing meter.",
"properties": {
"location": {
"type": "string",
"description": "Region for the billing meter."
},
"properties": {
"$ref": "#/definitions/BillingMeterProperties",
"description": "Revision resource specific properties"
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"BillingMeterCollection": {
"type": "object",
"description": "Collection of billing meters.",
"properties": {
"value": {
"type": "array",
"description": "Collection of billing meters.",
"items": {
"$ref": "#/definitions/BillingMeter"
}
}
},
"required": [
"value"
]
},
"BillingMeterProperties": {
"type": "object",
"description": "Revision resource specific properties",
"properties": {
"category": {
"type": "string",
"description": "Used to categorize billing meters."
},
"meterType": {
"type": "string",
"description": "Billing meter type."
},
"displayName": {
"type": "string",
"description": "The everyday name of the billing meter."
}
}
},
"BindingType": {
"type": "string",
"description": "Custom Domain binding type.",
"enum": [
"Disabled",
"SniEnabled",
"Auto"
],
"x-ms-enum": {
"name": "BindingType",
"modelAsString": true,
"values": [
{
"name": "Disabled",
"value": "Disabled",
"description": "Disabled"
},
{
"name": "SniEnabled",
"value": "SniEnabled",
"description": "SniEnabled"
},
{
"name": "Auto",
"value": "Auto",
"description": "Auto"
}
]
}
},
"BlobStorageTokenStore": {
"type": "object",
"description": "The configuration settings of the storage of the tokens if blob storage is used.",
"properties": {
"sasUrlSettingName": {
"type": "string",
"description": "The name of the app secrets containing the SAS URL of the blob storage containing the tokens."
}
}
},
"Certificate": {
"type": "object",
"description": "Certificate used for Custom Domain bindings of Container Apps in a Managed Environment",
"properties": {
"properties": {
"$ref": "#/definitions/CertificateProperties",
"description": "Certificate resource specific properties"
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"CertificateCollection": {
"type": "object",
"description": "Collection of Certificates.",
"properties": {
"value": {
"type": "array",
"description": "The Certificate items on this page",
"items": {
"$ref": "#/definitions/Certificate"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"CertificateKeyVaultProperties": {
"type": "object",
"description": "Properties for a certificate stored in a Key Vault.",
"properties": {
"identity": {
"type": "string",
"description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity."
},
"keyVaultUrl": {
"type": "string",
"format": "uri",
"description": "URL pointing to the Azure Key Vault secret that holds the certificate."
}
}
},
"CertificatePatch": {
"type": "object",
"description": "A certificate to update",
"properties": {
"tags": {
"type": "object",
"description": "Application-specific metadata in the form of key-value pairs.",
"additionalProperties": {
"type": "string"
}
}
}
},
"CertificateProperties": {
"type": "object",
"description": "Certificate resource specific properties",
"properties": {
"provisioningState": {
"$ref": "#/definitions/CertificateProvisioningState",
"description": "Provisioning state of the certificate.",
"readOnly": true
},
"deploymentErrors": {
"type": "string",
"description": "Any errors that occurred during deployment or deployment validation",
"readOnly": true
},
"certificateKeyVaultProperties": {
"$ref": "#/definitions/CertificateKeyVaultProperties",
"description": "Properties for a certificate stored in a Key Vault."
},
"password": {
"type": "string",
"format": "password",
"description": "Certificate password.",
"x-ms-mutability": [
"create"
],
"x-ms-secret": true
},
"subjectName": {
"type": "string",
"description": "Subject name of the certificate.",
"readOnly": true
},
"subjectAlternativeNames": {
"type": "array",
"description": "Subject alternative names the certificate applies to.",
"items": {
"type": "string"
},
"readOnly": true
},
"value": {
"type": "string",
"format": "password",
"description": "PFX or PEM blob",
"x-ms-mutability": [
"create"
],
"x-ms-secret": true
},
"issuer": {
"type": "string",
"description": "Certificate issuer.",
"readOnly": true
},
"issueDate": {
"type": "string",
"format": "date-time",
"description": "Certificate issue Date.",
"readOnly": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"description": "Certificate expiration date.",
"readOnly": true
},
"thumbprint": {
"type": "string",
"description": "Certificate thumbprint.",
"readOnly": true
},
"valid": {
"type": "boolean",
"description": "Is the certificate valid?.",
"readOnly": true
},
"publicKeyHash": {
"type": "string",
"description": "Public key hash.",
"readOnly": true
}
}
},
"CertificateProvisioningState": {
"type": "string",
"description": "Provisioning state of the certificate.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"DeleteFailed",
"Pending",
"Deleting"
],
"x-ms-enum": {
"name": "CertificateProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Succeeded",
"value": "Succeeded",
"description": "Succeeded"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Canceled",
"value": "Canceled",
"description": "Canceled"
},
{
"name": "DeleteFailed",
"value": "DeleteFailed",
"description": "DeleteFailed"
},
{
"name": "Pending",
"value": "Pending",
"description": "Pending"
},
{
"name": "Deleting",
"value": "Deleting",
"description": "Deleting"
}
]
}
},
"ClientRegistration": {
"type": "object",
"description": "The configuration settings of the app registration for providers that have client ids and client secrets",
"properties": {
"clientId": {
"type": "string",
"description": "The Client ID of the app used for login."
},
"clientSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the client secret."
}
}
},
"Configuration": {
"type": "object",
"description": "Non versioned Container App configuration properties that define the mutable settings of a Container app",
"properties": {
"secrets": {
"type": "array",
"description": "Collection of secrets used by a Container app",
"items": {
"$ref": "#/definitions/Secret"
},
"x-ms-identifiers": [
"name"
]
},
"activeRevisionsMode": {
"type": "string",
"description": "ActiveRevisionsMode controls how active revisions are handled for the Container app:\n- 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.
",
"default": "Single",
"enum": [
"Multiple",
"Single"
],
"x-ms-enum": {
"name": "ActiveRevisionsMode",
"modelAsString": true,
"values": [
{
"name": "Multiple",
"value": "Multiple",
"description": "Multiple"
},
{
"name": "Single",
"value": "Single",
"description": "Single"
}
]
}
},
"ingress": {
"$ref": "#/definitions/Ingress",
"description": "Ingress configurations."
},
"registries": {
"type": "array",
"description": "Collection of private container registry credentials for containers used by the Container app",
"items": {
"$ref": "#/definitions/RegistryCredentials"
},
"x-ms-identifiers": [
"server"
]
},
"dapr": {
"$ref": "#/definitions/Dapr",
"description": "Dapr configuration for the Container App."
},
"runtime": {
"$ref": "#/definitions/Runtime",
"description": "App runtime configuration for the Container App."
},
"maxInactiveRevisions": {
"type": "integer",
"format": "int32",
"description": "Optional. Max inactive revisions a Container App can have."
},
"service": {
"$ref": "#/definitions/Service",
"description": "Container App to be a dev Container App Service"
},
"identitySettings": {
"type": "array",
"description": "Optional settings for Managed Identities that are assigned to the Container App. If a Managed Identity is not specified here, default settings will be used.",
"items": {
"$ref": "#/definitions/IdentitySettings"
},
"x-ms-identifiers": [
"identity"
]
}
}
},
"ConnectedEnvironment": {
"type": "object",
"description": "An environment for Kubernetes cluster specialized for web workloads by Azure App Service",
"properties": {
"properties": {
"$ref": "#/definitions/ConnectedEnvironmentProperties",
"description": "ConnectedEnvironment resource specific properties",
"x-ms-client-flatten": true
},
"extendedLocation": {
"$ref": "#/definitions/ExtendedLocation",
"description": "The complex type of the extended location."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"ConnectedEnvironmentCollection": {
"type": "object",
"description": "Collection of connectedEnvironments",
"properties": {
"value": {
"type": "array",
"description": "The ConnectedEnvironment items on this page",
"items": {
"$ref": "#/definitions/ConnectedEnvironment"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ConnectedEnvironmentPatchResource": {
"type": "object",
"description": "Connected environment patch properties",
"allOf": [
{
"$ref": "#/definitions/ResourceTags"
}
]
},
"ConnectedEnvironmentProperties": {
"type": "object",
"description": "ConnectedEnvironment resource specific properties",
"properties": {
"provisioningState": {
"$ref": "#/definitions/ConnectedEnvironmentProvisioningState",
"description": "Provisioning state of the Kubernetes Environment.",
"readOnly": true
},
"deploymentErrors": {
"type": "string",
"description": "Any errors that occurred during deployment or deployment validation",
"readOnly": true
},
"defaultDomain": {
"type": "string",
"description": "Default Domain Name for the cluster",
"readOnly": true
},
"staticIp": {
"type": "string",
"description": "Static IP of the connectedEnvironment"
},
"daprAIConnectionString": {
"type": "string",
"format": "password",
"description": "Application Insights connection string used by Dapr to export Service to Service communication telemetry",
"x-ms-secret": true
},
"customDomainConfiguration": {
"$ref": "#/definitions/CustomDomainConfiguration",
"description": "Custom domain configuration for the environment"
}
}
},
"ConnectedEnvironmentProvisioningState": {
"type": "string",
"description": "Provisioning state of the Kubernetes Environment.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"Waiting",
"InitializationInProgress",
"InfrastructureSetupInProgress",
"InfrastructureSetupComplete",
"ScheduledForDelete"
],
"x-ms-enum": {
"name": "ConnectedEnvironmentProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Succeeded",
"value": "Succeeded",
"description": "Succeeded"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Canceled",
"value": "Canceled",
"description": "Canceled"
},
{
"name": "Waiting",
"value": "Waiting",
"description": "Waiting"
},
{
"name": "InitializationInProgress",
"value": "InitializationInProgress",
"description": "InitializationInProgress"
},
{
"name": "InfrastructureSetupInProgress",
"value": "InfrastructureSetupInProgress",
"description": "InfrastructureSetupInProgress"
},
{
"name": "InfrastructureSetupComplete",
"value": "InfrastructureSetupComplete",
"description": "InfrastructureSetupComplete"
},
{
"name": "ScheduledForDelete",
"value": "ScheduledForDelete",
"description": "ScheduledForDelete"
}
]
}
},
"ConnectedEnvironmentStorage": {
"type": "object",
"description": "Storage resource for connectedEnvironment.",
"properties": {
"properties": {
"$ref": "#/definitions/ConnectedEnvironmentStorageProperties",
"description": "Storage properties"
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"ConnectedEnvironmentStorageProperties": {
"type": "object",
"description": "Storage properties",
"properties": {
"provisioningState": {
"$ref": "#/definitions/ConnectedEnvironmentStorageProvisioningState",
"description": "Provisioning state of the storage.",
"readOnly": true
},
"deploymentErrors": {
"type": "string",
"description": "Any errors that occurred during deployment or deployment validation",
"readOnly": true
},
"azureFile": {
"$ref": "#/definitions/AzureFileProperties",
"description": "Azure file properties"
}
}
},
"ConnectedEnvironmentStorageProvisioningState": {
"type": "string",
"description": "Provisioning state of the storage.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"InProgress",
"Deleting"
],
"x-ms-enum": {
"name": "ConnectedEnvironmentStorageProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Succeeded",
"value": "Succeeded",
"description": "Succeeded"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Canceled",
"value": "Canceled",
"description": "Canceled"
},
{
"name": "InProgress",
"value": "InProgress",
"description": "InProgress"
},
{
"name": "Deleting",
"value": "Deleting",
"description": "Deleting"
}
]
}
},
"ConnectedEnvironmentStoragesCollection": {
"type": "object",
"description": "Collection of Storage for Environments",
"properties": {
"value": {
"type": "array",
"description": "Collection of storage resources.",
"items": {
"$ref": "#/definitions/ConnectedEnvironmentStorage"
}
}
},
"required": [
"value"
]
},
"Container": {
"type": "object",
"description": "Container App container definition",
"properties": {
"probes": {
"type": "array",
"description": "List of probes for the container.",
"items": {
"$ref": "#/definitions/ContainerAppProbe"
},
"x-ms-identifiers": [
"type"
]
}
},
"allOf": [
{
"$ref": "#/definitions/BaseContainer"
}
]
},
"ContainerApp": {
"type": "object",
"description": "Container App.",
"properties": {
"properties": {
"$ref": "#/definitions/ContainerAppProperties",
"description": "ContainerApp resource specific properties",
"x-ms-client-flatten": true
},
"extendedLocation": {
"$ref": "#/definitions/ExtendedLocation",
"description": "The complex type of the extended location."
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code."
},
"managedBy": {
"type": "string",
"description": "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.",
"x-ms-mutability": [
"read",
"update",
"create"
]
},
"kind": {
"$ref": "#/definitions/Kind",
"description": "Metadata to represent the container app kind, representing if a container app is workflowapp or functionapp.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"ContainerAppAuthToken": {
"type": "object",
"description": "Container App Auth Token.",
"properties": {
"properties": {
"$ref": "#/definitions/ContainerAppAuthTokenProperties",
"description": "Container App auth token resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"ContainerAppAuthTokenProperties": {
"type": "object",
"description": "Container App auth token resource specific properties",
"properties": {
"token": {
"type": "string",
"format": "password",
"description": "Auth token value.",
"readOnly": true,
"x-ms-secret": true
},
"expires": {
"type": "string",
"format": "date-time",
"description": "Token expiration date.",
"readOnly": true
}
}
},
"ContainerAppCollection": {
"type": "object",
"description": "Container App collection ARM resource.",
"properties": {
"value": {
"type": "array",
"description": "The ContainerApp items on this page",
"items": {
"$ref": "#/definitions/ContainerApp"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ContainerAppContainerRunningState": {
"type": "string",
"description": "Current running state of the container",
"enum": [
"Running",
"Terminated",
"Waiting"
],
"x-ms-enum": {
"name": "ContainerAppContainerRunningState",
"modelAsString": true,
"values": [
{
"name": "Running",
"value": "Running",
"description": "Running"
},
{
"name": "Terminated",
"value": "Terminated",
"description": "Terminated"
},
{
"name": "Waiting",
"value": "Waiting",
"description": "Waiting"
}
]
}
},
"ContainerAppJobExecutions": {
"type": "object",
"description": "Container App executions collection ARM resource.",
"properties": {
"value": {
"type": "array",
"description": "The JobExecution items on this page",
"items": {
"$ref": "#/definitions/JobExecution"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ContainerAppProbe": {
"type": "object",
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"failureThreshold": {
"type": "integer",
"format": "int32",
"description": "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": {
"$ref": "#/definitions/ContainerAppProbeHttpGet",
"description": "HTTPGet specifies the http request to perform."
},
"initialDelaySeconds": {
"type": "integer",
"format": "int32",
"description": "Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60."
},
"periodSeconds": {
"type": "integer",
"format": "int32",
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240."
},
"successThreshold": {
"type": "integer",
"format": "int32",
"description": "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": {
"$ref": "#/definitions/ContainerAppProbeTcpSocket",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported."
},
"terminationGracePeriodSeconds": {
"type": "integer",
"format": "int64",
"description": "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": {
"type": "integer",
"format": "int32",
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240."
},
"type": {
"$ref": "#/definitions/Type",
"description": "The type of probe."
}
}
},
"ContainerAppProbeHttpGet": {
"type": "object",
"description": "HTTPGet specifies the http request to perform.",
"properties": {
"host": {
"type": "string",
"description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."
},
"httpHeaders": {
"type": "array",
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"items": {
"$ref": "#/definitions/ContainerAppProbeHttpGetHttpHeadersItem"
},
"x-ms-identifiers": [
"name"
]
},
"path": {
"type": "string",
"description": "Path to access on the HTTP server."
},
"port": {
"type": "integer",
"format": "int32",
"description": "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": {
"$ref": "#/definitions/Scheme",
"description": "Scheme to use for connecting to the host. Defaults to HTTP."
}
},
"required": [
"port"
]
},
"ContainerAppProbeHttpGetHttpHeadersItem": {
"type": "object",
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"type": "string",
"description": "The header field name"
},
"value": {
"type": "string",
"description": "The header field value"
}
},
"required": [
"name",
"value"
]
},
"ContainerAppProbeTcpSocket": {
"type": "object",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.",
"properties": {
"host": {
"type": "string",
"description": "Optional: Host name to connect to, defaults to the pod IP."
},
"port": {
"type": "integer",
"format": "int32",
"description": "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."
}
},
"required": [
"port"
]
},
"ContainerAppProperties": {
"type": "object",
"description": "ContainerApp resource specific properties",
"properties": {
"provisioningState": {
"$ref": "#/definitions/ContainerAppProvisioningState",
"description": "Provisioning state of the Container App.",
"readOnly": true
},
"runningStatus": {
"$ref": "#/definitions/ContainerAppRunningStatus",
"description": "Running status of the Container App.",
"readOnly": true
},
"managedEnvironmentId": {
"type": "string",
"description": "Deprecated. Resource ID of the Container App's environment.",
"x-ms-mutability": [
"read",
"create"
]
},
"environmentId": {
"type": "string",
"description": "Resource ID of environment.",
"x-ms-mutability": [
"read",
"create"
]
},
"workloadProfileName": {
"type": "string",
"description": "Workload profile name to pin for container app execution."
},
"latestRevisionName": {
"type": "string",
"description": "Name of the latest revision of the Container App.",
"readOnly": true
},
"latestReadyRevisionName": {
"type": "string",
"description": "Name of the latest ready revision of the Container App.",
"readOnly": true
},
"latestRevisionFqdn": {
"type": "string",
"description": "Fully Qualified Domain Name of the latest revision of the Container App.",
"readOnly": true
},
"customDomainVerificationId": {
"type": "string",
"description": "Id used to verify domain name ownership",
"readOnly": true
},
"configuration": {
"$ref": "#/definitions/Configuration",
"description": "Non versioned Container App configuration properties."
},
"template": {
"$ref": "#/definitions/Template",
"description": "Container App versioned application definition."
},
"outboundIpAddresses": {
"type": "array",
"description": "Outbound IP Addresses for container app.",
"items": {
"type": "string"
},
"readOnly": true
},
"eventStreamEndpoint": {
"type": "string",
"description": "The endpoint of the eventstream of the container app.",
"readOnly": true
}
}
},
"ContainerAppProvisioningState": {
"type": "string",
"description": "Provisioning state of the Container App.",
"enum": [
"InProgress",
"Succeeded",
"Failed",
"Canceled",
"Deleting"
],
"x-ms-enum": {
"name": "ContainerAppProvisioningState",
"modelAsString": true,
"values": [
{
"name": "InProgress",
"value": "InProgress",
"description": "InProgress"
},
{
"name": "Succeeded",
"value": "Succeeded",
"description": "Succeeded"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Canceled",
"value": "Canceled",
"description": "Canceled"
},
{
"name": "Deleting",
"value": "Deleting",
"description": "Deleting"
}
]
}
},
"ContainerAppReplicaRunningState": {
"type": "string",
"description": "Current running state of the replica",
"enum": [
"Running",
"NotRunning",
"Unknown"
],
"x-ms-enum": {
"name": "ContainerAppReplicaRunningState",
"modelAsString": true,
"values": [
{
"name": "Running",
"value": "Running",
"description": "Running"
},
{
"name": "NotRunning",
"value": "NotRunning",
"description": "NotRunning"
},
{
"name": "Unknown",
"value": "Unknown",
"description": "Unknown"
}
]
}
},
"ContainerAppRunningStatus": {
"type": "string",
"description": "Running status of the Container App.",
"enum": [
"Progressing",
"Running",
"Stopped",
"Suspended",
"Ready"
],
"x-ms-enum": {
"name": "ContainerAppRunningStatus",
"modelAsString": true,
"values": [
{
"name": "Progressing",
"value": "Progressing",
"description": "Container App is transitioning between Stopped and Running states."
},
{
"name": "Running",
"value": "Running",
"description": "Container App is in Running state."
},
{
"name": "Stopped",
"value": "Stopped",
"description": "Container App is in Stopped state."
},
{
"name": "Suspended",
"value": "Suspended",
"description": "Container App Job is in Suspended state."
},
{
"name": "Ready",
"value": "Ready",
"description": "Container App Job is in Ready state."
}
]
}
},
"ContainerAppSecret": {
"type": "object",
"description": "Container App Secret.",
"properties": {
"name": {
"type": "string",
"description": "Secret Name.",
"readOnly": true
},
"value": {
"type": "string",
"format": "password",
"description": "Secret Value.",
"readOnly": true,
"x-ms-secret": true
},
"identity": {
"type": "string",
"description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.",
"readOnly": true
},
"keyVaultUrl": {
"type": "string",
"description": "Azure Key Vault URL pointing to the secret referenced by the container app.",
"readOnly": true
}
}
},
"ContainerResources": {
"type": "object",
"description": "Container App container resource requirements.",
"properties": {
"cpu": {
"type": "number",
"format": "double",
"description": "Required CPU in cores, e.g. 0.5"
},
"memory": {
"type": "string",
"description": "Required memory, e.g. \"250Mb\""
},
"ephemeralStorage": {
"type": "string",
"description": "Ephemeral Storage, e.g. \"1Gi\"",
"readOnly": true
}
}
},
"ContainerType": {
"type": "string",
"description": "The container type of the sessions. You can use your own container to build the session pool, or you can use a predefined container to run workload with specific language.",
"enum": [
"CustomContainer",
"PythonLTS"
],
"x-ms-enum": {
"name": "ContainerType",
"modelAsString": true,
"values": [
{
"name": "CustomContainer",
"value": "CustomContainer",
"description": "CustomContainer"
},
{
"name": "PythonLTS",
"value": "PythonLTS",
"description": "PythonLTS"
}
]
}
},
"CookieExpiration": {
"type": "object",
"description": "The configuration settings of the session cookie's expiration.",
"properties": {
"convention": {
"$ref": "#/definitions/CookieExpirationConvention",
"description": "The convention used when determining the session cookie's expiration."
},
"timeToExpiration": {
"type": "string",
"description": "The time after the request is made when the session cookie should expire."
}
}
},
"CookieExpirationConvention": {
"type": "string",
"description": "The convention used when determining the session cookie's expiration.",
"enum": [
"FixedTime",
"IdentityProviderDerived"
],
"x-ms-enum": {
"name": "CookieExpirationConvention",
"modelAsString": false,
"values": [
{
"name": "FixedTime",
"value": "FixedTime",
"description": "FixedTime"
},
{
"name": "IdentityProviderDerived",
"value": "IdentityProviderDerived",
"description": "IdentityProviderDerived"
}
]
}
},
"CorsPolicy": {
"type": "object",
"description": "Cross-Origin-Resource-Sharing policy",
"properties": {
"allowedOrigins": {
"type": "array",
"description": "Specifies the content for the access-control-allow-origins header",
"items": {
"type": "string"
}
},
"allowedMethods": {
"type": "array",
"description": "Specifies the content for the access-control-allow-methods header",
"items": {
"type": "string"
}
},
"allowedHeaders": {
"type": "array",
"description": "Specifies the content for the access-control-allow-headers header",
"items": {
"type": "string"
}
},
"exposeHeaders": {
"type": "array",
"description": "Specifies the content for the access-control-expose-headers header",
"items": {
"type": "string"
}
},
"maxAge": {
"type": "integer",
"format": "int32",
"description": "Specifies the content for the access-control-max-age header"
},
"allowCredentials": {
"type": "boolean",
"description": "Specifies whether the resource allows credentials"
}
},
"required": [
"allowedOrigins"
]
},
"CustomContainerTemplate": {
"type": "object",
"description": "Custom container configuration.",
"properties": {
"registryCredentials": {
"$ref": "#/definitions/SessionRegistryCredentials",
"description": "Private container registry credentials for containers used by the sessions of the session pool."
},
"containers": {
"type": "array",
"description": "List of container definitions for the sessions of the session pool.",
"items": {
"$ref": "#/definitions/SessionContainer"
},
"x-ms-identifiers": [
"name"
]
},
"ingress": {
"$ref": "#/definitions/SessionIngress",
"description": "Session pool ingress configuration."
}
}
},
"CustomDomain": {
"type": "object",
"description": "Custom Domain of a Container App",
"properties": {
"name": {
"type": "string",
"description": "Hostname."
},
"bindingType": {
"$ref": "#/definitions/BindingType",
"description": "Custom Domain binding type."
},
"certificateId": {
"type": "string",
"description": "Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment."
}
},
"required": [
"name"
]
},
"CustomDomainConfiguration": {
"type": "object",
"description": "Configuration properties for apps environment custom domain",
"properties": {
"customDomainVerificationId": {
"type": "string",
"description": "Id used to verify domain name ownership",
"readOnly": true
},
"dnsSuffix": {
"type": "string",
"description": "Dns suffix for the environment domain",
"x-ms-mutability": [
"read",
"create"
]
},
"certificateKeyVaultProperties": {
"$ref": "#/definitions/CertificateKeyVaultProperties",
"description": "Certificate stored in Azure Key Vault."
},
"certificateValue": {
"type": "string",
"format": "password",
"description": "PFX or PEM blob",
"x-ms-secret": true
},
"certificatePassword": {
"type": "string",
"format": "password",
"description": "Certificate password",
"x-ms-secret": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"description": "Certificate expiration date.",
"readOnly": true
},
"thumbprint": {
"type": "string",
"description": "Certificate thumbprint.",
"readOnly": true
},
"subjectName": {
"type": "string",
"description": "Subject name of the certificate.",
"readOnly": true
}
}
},
"CustomDomainVerificationId": {
"type": "string",
"description": "Custom domain verification Id of a subscription"
},
"CustomHostnameAnalysisResult": {
"type": "object",
"description": "Custom domain analysis.",
"properties": {
"hostName": {
"type": "string",
"description": "Host name that was analyzed",
"readOnly": true
},
"isHostnameAlreadyVerified": {
"type": "boolean",
"description": "true if hostname is already verified; otherwise, false.",
"readOnly": true
},
"customDomainVerificationTest": {
"$ref": "#/definitions/DnsVerificationTestResult",
"description": "DNS verification test result.",
"readOnly": true
},
"customDomainVerificationFailureInfo": {
"$ref": "#/definitions/CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo",
"description": "Raw failure information if DNS verification fails.",
"readOnly": true
},
"hasConflictOnManagedEnvironment": {
"type": "boolean",
"description": "true if there is a conflict on the Container App's managed environment; otherwise, false.",
"readOnly": true
},
"conflictWithEnvironmentCustomDomain": {
"type": "boolean",
"description": "true if there is a conflict on the Container App's managed environment level custom domain; otherwise, false.",
"readOnly": true
},
"conflictingContainerAppResourceId": {
"type": "string",
"description": "Name of the conflicting Container App on the Managed Environment if it's within the same subscription.",
"readOnly": true
},
"cNameRecords": {
"type": "array",
"description": "CName records visible for this hostname.",
"items": {
"type": "string"
}
},
"txtRecords": {
"type": "array",
"description": "TXT records visible for this hostname.",
"items": {
"type": "string"
}
},
"aRecords": {
"type": "array",
"description": "A records visible for this hostname.",
"items": {
"type": "string"
}
},
"alternateCNameRecords": {
"type": "array",
"description": "Alternate CName records visible for this hostname.",
"items": {
"type": "string"
}
},
"alternateTxtRecords": {
"type": "array",
"description": "Alternate TXT records visible for this hostname.",
"items": {
"type": "string"
}
}
}
},
"CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo": {
"type": "object",
"description": "Raw failure information if DNS verification fails.",
"properties": {
"code": {
"type": "string",
"description": "Standardized string to programmatically identify the error.",
"readOnly": true
},
"message": {
"type": "string",
"description": "Detailed error description and debugging information.",
"readOnly": true
},
"target": {
"type": "string",
"description": "Detailed error description and debugging information.",
"readOnly": true
},
"details": {
"type": "array",
"description": "Details or the error",
"items": {
"$ref": "#/definitions/CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem"
},
"x-ms-identifiers": [
"code"
]
}
}
},
"CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem": {
"type": "object",
"description": "Detailed errors.",
"properties": {
"code": {
"type": "string",
"description": "Standardized string to programmatically identify the error.",
"readOnly": true
},
"message": {
"type": "string",
"description": "Detailed error description and debugging information.",
"readOnly": true
},
"target": {
"type": "string",
"description": "Detailed error description and debugging information.",
"readOnly": true
}
}
},
"CustomOpenIdConnectProvider": {
"type": "object",
"description": "The configuration settings of the custom Open ID Connect provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the custom Open ID provider provider should not be enabled; otherwise, true."
},
"registration": {
"$ref": "#/definitions/OpenIdConnectRegistration",
"description": "The configuration settings of the app registration for the custom Open ID Connect provider."
},
"login": {
"$ref": "#/definitions/OpenIdConnectLogin",
"description": "The configuration settings of the login flow of the custom Open ID Connect provider."
}
}
},
"CustomScaleRule": {
"type": "object",
"description": "Container App container Custom scaling rule.",
"properties": {
"type": {
"type": "string",
"description": "Type of the custom scale rule\neg: azure-servicebus, redis etc."
},
"metadata": {
"type": "object",
"description": "Metadata properties to describe custom scale rule.",
"additionalProperties": {
"type": "string"
}
},
"auth": {
"type": "array",
"description": "Authentication secrets for the custom scale rule.",
"items": {
"$ref": "#/definitions/ScaleRuleAuth"
},
"x-ms-identifiers": [
"triggerParameter"
]
},
"identity": {
"type": "string",
"description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity."
}
}
},
"Dapr": {
"type": "object",
"description": "Container App Dapr configuration.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating if the Dapr side car is enabled",
"default": false
},
"appId": {
"type": "string",
"description": "Dapr application identifier"
},
"appProtocol": {
"type": "string",
"description": "Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http",
"default": "http",
"enum": [
"http",
"grpc"
],
"x-ms-enum": {
"name": "AppProtocol",
"modelAsString": true,
"values": [
{
"name": "http",
"value": "http",
"description": "http"
},
{
"name": "grpc",
"value": "grpc",
"description": "grpc"
}
]
}
},
"appPort": {
"type": "integer",
"format": "int32",
"description": "Tells Dapr which port your application is listening on"
},
"httpReadBufferSize": {
"type": "integer",
"format": "int32",
"description": "Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB."
},
"httpMaxRequestSize": {
"type": "integer",
"format": "int32",
"description": "Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB."
},
"logLevel": {
"$ref": "#/definitions/LogLevel",
"description": "Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info."
},
"enableApiLogging": {
"type": "boolean",
"description": "Enables API logging for the Dapr sidecar"
},
"appHealth": {
"$ref": "#/definitions/DaprAppHealth",
"description": "Dapr application health check configuration"
},
"maxConcurrency": {
"type": "integer",
"format": "int32",
"description": "Maximum number of concurrent requests, events handled by the Dapr sidecar"
}
}
},
"DaprAppHealth": {
"type": "object",
"description": "Dapr application health check configuration",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating if the health probe is enabled"
},
"path": {
"type": "string",
"description": "Path for the health probe"
},
"probeIntervalSeconds": {
"type": "integer",
"format": "int32",
"description": "Interval for the health probe in seconds",
"minimum": 1
},
"probeTimeoutMilliseconds": {
"type": "integer",
"format": "int32",
"description": "Timeout for the health probe in milliseconds",
"minimum": 1
},
"threshold": {
"type": "integer",
"format": "int32",
"description": "Threshold for the health probe",
"minimum": 1
}
}
},
"DaprComponent": {
"type": "object",
"description": "Dapr Component.",
"properties": {
"properties": {
"$ref": "#/definitions/DaprComponentProperties",
"description": "Dapr Component resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"DaprComponentProperties": {
"type": "object",
"description": "Dapr Component resource specific properties",
"properties": {
"componentType": {
"type": "string",
"description": "Component type"
},
"version": {
"type": "string",
"description": "Component version"
},
"ignoreErrors": {
"type": "boolean",
"description": "Boolean describing if the component errors are ignores",
"default": false
},
"initTimeout": {
"type": "string",
"description": "Initialization timeout"
},
"secrets": {
"type": "array",
"description": "Collection of secrets used by a Dapr component",
"items": {
"$ref": "#/definitions/Secret"
},
"x-ms-identifiers": [
"name"
]
},
"secretStoreComponent": {
"type": "string",
"description": "Name of a Dapr component to retrieve component secrets from"
},
"metadata": {
"type": "array",
"description": "Component metadata",
"items": {
"$ref": "#/definitions/DaprMetadata"
},
"x-ms-identifiers": [
"name"
]
},
"scopes": {
"type": "array",
"description": "Names of container apps that can use this Dapr component",
"items": {
"type": "string"
}
},
"provisioningState": {
"$ref": "#/definitions/DaprComponentProvisioningState",
"description": "Provisioning state of the Connected Environment Dapr Component.",
"readOnly": true
},
"deploymentErrors": {
"type": "string",
"description": "Any errors that occurred during deployment or deployment validation",
"readOnly": true
}
}
},
"DaprComponentProvisioningState": {
"type": "string",
"description": "Provisioning state of the Connected Environment Dapr Component.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"InProgress",
"Deleting"
],
"x-ms-enum": {
"name": "DaprComponentProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Succeeded",
"value": "Succeeded",
"description": "Succeeded"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Canceled",
"value": "Canceled",
"description": "Canceled"
},
{
"name": "InProgress",
"value": "InProgress",
"description": "InProgress"
},
{
"name": "Deleting",
"value": "Deleting",
"description": "Deleting"
}
]
}
},
"DaprComponentsCollection": {
"type": "object",
"description": "Dapr Components ARM resource.",
"properties": {
"value": {
"type": "array",
"description": "The DaprComponent items on this page",
"items": {
"$ref": "#/definitions/DaprComponent"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"DaprConfiguration": {
"type": "object",
"description": "Configuration properties Dapr component",
"properties": {
"version": {
"type": "string",
"description": "The version of Dapr",
"readOnly": true
}
}
},
"DaprMetadata": {
"type": "object",
"description": "Dapr component metadata.",
"properties": {
"name": {
"type": "string",
"description": "Metadata property name."
},
"value": {
"type": "string",
"description": "Metadata property value."
},
"secretRef": {
"type": "string",
"description": "Name of the Dapr Component secret from which to pull the metadata property value."
}
}
},
"DaprSecret": {
"type": "object",
"description": "Dapr component Secret for ListSecrets Action",
"properties": {
"name": {
"type": "string",
"description": "Secret Name.",
"readOnly": true
},
"value": {
"type": "string",
"format": "password",
"description": "Secret Value.",
"readOnly": true,
"x-ms-secret": true
}
}
},
"DaprSecretsCollection": {
"type": "object",
"description": "Dapr component Secrets Collection for ListSecrets Action.",
"properties": {
"value": {
"type": "array",
"description": "Collection of secrets used by a Dapr component",
"items": {
"$ref": "#/definitions/DaprSecret"
},
"x-ms-identifiers": [
"name"
]
}
},
"required": [
"value"
]
},
"DefaultAuthorizationPolicy": {
"type": "object",
"description": "The configuration settings of the Azure Active Directory default authorization policy.",
"properties": {
"allowedPrincipals": {
"$ref": "#/definitions/AllowedPrincipals",
"description": "The configuration settings of the Azure Active Directory allowed principals."
},
"allowedApplications": {
"type": "array",
"description": "The configuration settings of the Azure Active Directory allowed applications.",
"items": {
"type": "string"
}
}
}
},
"DefaultErrorResponse": {
"type": "object",
"description": "App Service error response.",
"properties": {
"error": {
"$ref": "#/definitions/DefaultErrorResponseError",
"description": "Error model.",
"readOnly": true
}
}
},
"DefaultErrorResponseError": {
"type": "object",
"description": "Error model.",
"properties": {
"code": {
"type": "string",
"description": "Standardized string to programmatically identify the error.",
"readOnly": true
},
"message": {
"type": "string",
"description": "Detailed error description and debugging information.",
"readOnly": true
},
"target": {
"type": "string",
"description": "Detailed error description and debugging information.",
"readOnly": true
},
"details": {
"type": "array",
"description": "Details or the error",
"items": {
"$ref": "#/definitions/DefaultErrorResponseErrorDetailsItem"
},
"x-ms-identifiers": [
"code"
]
},
"innererror": {
"type": "string",
"description": "More information to debug error.",
"readOnly": true
}
}
},
"DefaultErrorResponseErrorDetailsItem": {
"type": "object",
"description": "Detailed errors.",
"properties": {
"code": {
"type": "string",
"description": "Standardized string to programmatically identify the error.",
"readOnly": true
},
"message": {
"type": "string",
"description": "Detailed error description and debugging information.",
"readOnly": true
},
"target": {
"type": "string",
"description": "Detailed error description and debugging information.",
"readOnly": true
}
}
},
"DiagnosticDataProviderMetadata": {
"type": "object",
"description": "Details of a diagnostics data provider",
"properties": {
"providerName": {
"type": "string",
"description": "Name of data provider"
},
"propertyBag": {
"type": "array",
"description": "Collection of properties",
"items": {
"$ref": "#/definitions/DiagnosticDataProviderMetadataPropertyBagItem"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"DiagnosticDataProviderMetadataPropertyBagItem": {
"type": "object",
"description": "Property details",
"properties": {
"name": {
"type": "string",
"description": "Property name"
},
"value": {
"type": "string",
"description": "Property value"
}
}
},
"DiagnosticDataTableResponseColumn": {
"type": "object",
"description": "Diagnostics data column",
"properties": {
"columnName": {
"type": "string",
"description": "Column name"
},
"dataType": {
"type": "string",
"description": "Data type of the column"
},
"columnType": {
"type": "string",
"description": "Column type"
}
}
},
"DiagnosticDataTableResponseObject": {
"type": "object",
"description": "Diagnostics data table",
"properties": {
"tableName": {
"type": "string",
"description": "Table name"
},
"columns": {
"type": "array",
"description": "Columns in the table",
"items": {
"$ref": "#/definitions/DiagnosticDataTableResponseColumn"
},
"x-ms-identifiers": [
"columnName"
]
},
"rows": {
"type": "array",
"description": "Rows in the table",
"items": {}
}
}
},
"DiagnosticRendering": {
"type": "object",
"description": "Rendering details of a diagnostics table",
"properties": {
"type": {
"type": "integer",
"format": "int32",
"description": "Rendering type"
},
"title": {
"type": "string",
"description": "Title of the table"
},
"description": {
"type": "string",
"description": "Description of the table"
},
"isVisible": {
"type": "boolean",
"description": "Flag if the table should be rendered"
}
}
},
"DiagnosticSupportTopic": {
"type": "object",
"description": "Support topic information",
"properties": {
"id": {
"type": "string",
"description": "Unique topic identifier",
"readOnly": true
},
"pesId": {
"type": "string",
"description": "PES identifier",
"readOnly": true
}
}
},
"Diagnostics": {
"type": "object",
"description": "Diagnostics data for a resource.",
"properties": {
"properties": {
"$ref": "#/definitions/DiagnosticsProperties",
"description": "The resource-specific properties for this resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"DiagnosticsCollection": {
"type": "object",
"description": "Diagnostics data collection for a resource.",
"properties": {
"value": {
"type": "array",
"description": "The Diagnostics items on this page",
"items": {
"$ref": "#/definitions/Diagnostics"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"DiagnosticsDataApiResponse": {
"type": "object",
"description": "Diagnostics data returned from a detector",
"properties": {
"table": {
"$ref": "#/definitions/DiagnosticDataTableResponseObject",
"description": "Table response"
},
"renderingProperties": {
"$ref": "#/definitions/DiagnosticRendering",
"description": "Details of the table response"
}
}
},
"DiagnosticsDefinition": {
"type": "object",
"description": "Metadata of the diagnostics response",
"properties": {
"id": {
"type": "string",
"description": "Unique detector name",
"readOnly": true
},
"name": {
"type": "string",
"description": "Display Name of the detector",
"readOnly": true
},
"description": {
"type": "string",
"description": "Details of the diagnostics info",
"readOnly": true
},
"author": {
"type": "string",
"description": "Authors' names of the detector",
"readOnly": true
},
"category": {
"type": "string",
"description": "Category of the detector",
"readOnly": true
},
"supportTopicList": {
"type": "array",
"description": "List of support topics",
"items": {
"$ref": "#/definitions/DiagnosticSupportTopic"
}
},
"analysisTypes": {
"type": "array",
"description": "List of analysis types",
"items": {
"type": "string"
}
},
"type": {
"type": "string",
"description": "Authors' names of the detector",
"readOnly": true
},
"score": {
"type": "number",
"format": "float",
"description": "Authors' names of the detector",
"readOnly": true
}
}
},
"DiagnosticsProperties": {
"type": "object",
"description": "Diagnostics resource specific properties",
"properties": {
"metadata": {
"$ref": "#/definitions/DiagnosticsDefinition",
"description": "Metadata of the diagnostics response."
},
"dataset": {
"type": "array",
"description": "Set of data collections associated with the response.",
"items": {
"$ref": "#/definitions/DiagnosticsDataApiResponse"
},
"x-ms-identifiers": []
},
"status": {
"$ref": "#/definitions/DiagnosticsStatus",
"description": "Status of the diagnostics response."
},
"dataProviderMetadata": {
"$ref": "#/definitions/DiagnosticDataProviderMetadata",
"description": "List of data providers' metadata."
}
}
},
"DiagnosticsStatus": {
"type": "object",
"description": "Rendering details of a diagnostics table",
"properties": {
"message": {
"type": "string",
"description": "Diagnostic message"
},
"statusId": {
"type": "integer",
"format": "int32",
"description": "Status"
}
}
},
"DnsVerificationTestResult": {
"type": "string",
"description": "DNS verification test result.",
"enum": [
"Passed",
"Failed",
"Skipped"
],
"x-ms-enum": {
"name": "DnsVerificationTestResult",
"modelAsString": false,
"values": [
{
"name": "Passed",
"value": "Passed",
"description": "Passed"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Skipped",
"value": "Skipped",
"description": "Skipped"
}
]
}
},
"DynamicPoolConfiguration": {
"type": "object",
"description": "Dynamic pool configuration.",
"properties": {
"lifecycleConfiguration": {
"$ref": "#/definitions/LifecycleConfiguration",
"description": "The lifecycle configuration of a session in the dynamic session pool"
}
}
},
"EncryptionSettings": {
"type": "object",
"description": "The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.",
"properties": {
"containerAppAuthEncryptionSecretName": {
"type": "string",
"description": "The secret name which is referenced for EncryptionKey."
},
"containerAppAuthSigningSecretName": {
"type": "string",
"description": "The secret name which is referenced for SigningKey."
}
}
},
"EnvironmentAuthToken": {
"type": "object",
"description": "Environment Auth Token.",
"properties": {
"properties": {
"$ref": "#/definitions/EnvironmentAuthTokenProperties",
"description": "Environment auth token resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"EnvironmentAuthTokenProperties": {
"type": "object",
"description": "Environment auth token resource specific properties",
"properties": {
"token": {
"type": "string",
"format": "password",
"description": "Auth token value.",
"readOnly": true,
"x-ms-secret": true
},
"expires": {
"type": "string",
"format": "date-time",
"description": "Token expiration date.",
"readOnly": true
}
}
},
"EnvironmentProvisioningState": {
"type": "string",
"description": "Provisioning state of the Environment.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"Waiting",
"InitializationInProgress",
"InfrastructureSetupInProgress",
"InfrastructureSetupComplete",
"ScheduledForDelete",
"UpgradeRequested",
"UpgradeFailed"
],
"x-ms-enum": {
"name": "EnvironmentProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Succeeded",
"value": "Succeeded",
"description": "Succeeded"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Canceled",
"value": "Canceled",
"description": "Canceled"
},
{
"name": "Waiting",
"value": "Waiting",
"description": "Waiting"
},
{
"name": "InitializationInProgress",
"value": "InitializationInProgress",
"description": "InitializationInProgress"
},
{
"name": "InfrastructureSetupInProgress",
"value": "InfrastructureSetupInProgress",
"description": "InfrastructureSetupInProgress"
},
{
"name": "InfrastructureSetupComplete",
"value": "InfrastructureSetupComplete",
"description": "InfrastructureSetupComplete"
},
{
"name": "ScheduledForDelete",
"value": "ScheduledForDelete",
"description": "ScheduledForDelete"
},
{
"name": "UpgradeRequested",
"value": "UpgradeRequested",
"description": "UpgradeRequested"
},
{
"name": "UpgradeFailed",
"value": "UpgradeFailed",
"description": "UpgradeFailed"
}
]
}
},
"EnvironmentVar": {
"type": "object",
"description": "Container App container environment variable.",
"properties": {
"name": {
"type": "string",
"description": "Environment variable name."
},
"value": {
"type": "string",
"description": "Non-secret environment variable value."
},
"secretRef": {
"type": "string",
"description": "Name of the Container App secret from which to pull the environment variable value."
}
}
},
"ErrorEntity": {
"type": "object",
"description": "Body of the error response returned from the API.",
"properties": {
"extendedCode": {
"type": "string",
"description": "Type of error."
},
"messageTemplate": {
"type": "string",
"description": "Message template."
},
"parameters": {
"type": "array",
"description": "Parameters for the template.",
"items": {
"type": "string"
}
},
"innerErrors": {
"type": "array",
"description": "Inner errors.",
"items": {
"$ref": "#/definitions/ErrorEntity"
},
"x-ms-identifiers": []
},
"details": {
"type": "array",
"description": "Error Details.",
"items": {
"$ref": "#/definitions/ErrorEntity"
},
"x-ms-identifiers": []
},
"target": {
"type": "string",
"description": "The error target."
},
"code": {
"type": "string",
"description": "Basic error code."
},
"message": {
"type": "string",
"description": "Any details of the error."
}
}
},
"ExtendedLocation": {
"type": "object",
"description": "The complex type of the extended location.",
"properties": {
"name": {
"type": "string",
"description": "The name of the extended location."
},
"type": {
"$ref": "#/definitions/ExtendedLocationTypes",
"description": "The type of the extended location."
}
}
},
"ExtendedLocationTypes": {
"type": "string",
"description": "The type of extendedLocation.",
"enum": [
"CustomLocation"
],
"x-ms-enum": {
"name": "ExtendedLocationTypes",
"modelAsString": true,
"values": [
{
"name": "CustomLocation",
"value": "CustomLocation",
"description": "CustomLocation"
}
]
}
},
"Facebook": {
"type": "object",
"description": "The configuration settings of the Facebook provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the Facebook provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/AppRegistration",
"description": "The configuration settings of the app registration for the Facebook provider."
},
"graphApiVersion": {
"type": "string",
"description": "The version of the Facebook api to be used while logging in."
},
"login": {
"$ref": "#/definitions/LoginScopes",
"description": "The configuration settings of the login flow."
}
}
},
"ForwardProxy": {
"type": "object",
"description": "The configuration settings of a forward proxy used to make the requests.",
"properties": {
"convention": {
"$ref": "#/definitions/ForwardProxyConvention",
"description": "The convention used to determine the url of the request made."
},
"customHostHeaderName": {
"type": "string",
"description": "The name of the header containing the host of the request."
},
"customProtoHeaderName": {
"type": "string",
"description": "The name of the header containing the scheme of the request."
}
}
},
"ForwardProxyConvention": {
"type": "string",
"description": "The convention used to determine the url of the request made.",
"enum": [
"NoProxy",
"Standard",
"Custom"
],
"x-ms-enum": {
"name": "ForwardProxyConvention",
"modelAsString": false,
"values": [
{
"name": "NoProxy",
"value": "NoProxy",
"description": "NoProxy"
},
{
"name": "Standard",
"value": "Standard",
"description": "Standard"
},
{
"name": "Custom",
"value": "Custom",
"description": "Custom"
}
]
}
},
"GitHub": {
"type": "object",
"description": "The configuration settings of the GitHub provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the GitHub provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/ClientRegistration",
"description": "The configuration settings of the app registration for the GitHub provider."
},
"login": {
"$ref": "#/definitions/LoginScopes",
"description": "The configuration settings of the login flow."
}
}
},
"GithubActionConfiguration": {
"type": "object",
"description": "Configuration properties that define the mutable settings of a Container App SourceControl",
"properties": {
"registryInfo": {
"$ref": "#/definitions/RegistryInfo",
"description": "Registry configurations."
},
"azureCredentials": {
"$ref": "#/definitions/AzureCredentials",
"description": "AzureCredentials configurations."
},
"contextPath": {
"type": "string",
"description": "Context path"
},
"githubPersonalAccessToken": {
"type": "string",
"format": "password",
"description": "One time Github PAT to configure github environment",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
},
"image": {
"type": "string",
"description": "Image name"
},
"publishType": {
"type": "string",
"description": "Code or Image"
},
"os": {
"type": "string",
"description": "Operation system"
},
"runtimeStack": {
"type": "string",
"description": "Runtime stack"
},
"runtimeVersion": {
"type": "string",
"description": "Runtime version"
}
}
},
"GlobalValidation": {
"type": "object",
"description": "The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization.",
"properties": {
"unauthenticatedClientAction": {
"$ref": "#/definitions/UnauthenticatedClientActionV2",
"description": "The action to take when an unauthenticated client attempts to access the app."
},
"redirectToProvider": {
"type": "string",
"description": "The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."
},
"excludedPaths": {
"type": "array",
"description": "The paths for which unauthenticated flow would not be redirected to the login page.",
"items": {
"type": "string"
}
}
}
},
"Google": {
"type": "object",
"description": "The configuration settings of the Google provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the Google provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/ClientRegistration",
"description": "The configuration settings of the app registration for the Google provider."
},
"login": {
"$ref": "#/definitions/LoginScopes",
"description": "The configuration settings of the login flow."
},
"validation": {
"$ref": "#/definitions/AllowedAudiencesValidation",
"description": "The configuration settings of the Azure Active Directory token validation flow."
}
}
},
"HttpRoute": {
"type": "object",
"description": "Http Routes, including paths to match on and whether or not rewrites are to be done.",
"properties": {
"match": {
"$ref": "#/definitions/HttpRouteMatch",
"description": "Conditions route will match on"
},
"action": {
"$ref": "#/definitions/HttpRouteAction",
"description": "Once route is matched, what is the desired action"
}
}
},
"HttpRouteAction": {
"type": "object",
"description": "Action to perform once matching of routes is done",
"properties": {
"prefixRewrite": {
"type": "string",
"description": "Rewrite prefix, default is no rewrites"
}
}
},
"HttpRouteConfig": {
"type": "object",
"description": "A set of host names and http request routing rules for a Container App Environment",
"properties": {
"properties": {
"$ref": "#/definitions/HttpRouteConfigProperties",
"description": "Http Route Config properties"
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"HttpRouteConfigCollection": {
"type": "object",
"description": "Collection of rule based Http Route Config resources.",
"properties": {
"value": {
"type": "array",
"description": "The HttpRouteConfig items on this page",
"items": {
"$ref": "#/definitions/HttpRouteConfig"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"HttpRouteConfigProperties": {
"type": "object",
"description": "Http Route Config properties",
"properties": {
"provisioningState": {
"$ref": "#/definitions/HttpRouteProvisioningState",
"description": "The provisioning state of the Http Route Config in cluster",
"readOnly": true
},
"provisioningErrors": {
"type": "array",
"description": "List of errors when trying to reconcile http routes",
"items": {
"$ref": "#/definitions/HttpRouteProvisioningErrors"
},
"readOnly": true
},
"fqdn": {
"type": "string",
"description": "FQDN of the route resource.",
"readOnly": true
},
"customDomains": {
"type": "array",
"description": "Custom domain bindings for http Routes' hostnames.",
"items": {
"$ref": "#/definitions/CustomDomain"
},
"x-ms-identifiers": [
"name"
]
},
"rules": {
"type": "array",
"description": "Routing Rules for http route resource.",
"items": {
"$ref": "#/definitions/HttpRouteRule"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"HttpRouteMatch": {
"type": "object",
"description": "Criteria to match on",
"properties": {
"prefix": {
"type": "string",
"description": "match on all prefix's. Not exact"
},
"path": {
"type": "string",
"description": "match on exact path"
},
"pathSeparatedPrefix": {
"type": "string",
"description": "match on all prefix's. Not exact"
},
"caseSensitive": {
"type": "boolean",
"description": "path case sensitive, default is true"
}
}
},
"HttpRouteProvisioningErrors": {
"type": "object",
"description": "List of provisioning errors for a Http Route Config object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp error occured at",
"readOnly": true
},
"message": {
"type": "string",
"description": "Description or error message",
"readOnly": true
}
}
},
"HttpRouteProvisioningState": {
"type": "string",
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"Waiting",
"Updating",
"Deleting",
"Pending"
],
"x-ms-enum": {
"name": "HttpRouteProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Succeeded",
"value": "Succeeded",
"description": "Succeeded"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Canceled",
"value": "Canceled",
"description": "Canceled"
},
{
"name": "Waiting",
"value": "Waiting",
"description": "Waiting"
},
{
"name": "Updating",
"value": "Updating",
"description": "Updating"
},
{
"name": "Deleting",
"value": "Deleting",
"description": "Deleting"
},
{
"name": "Pending",
"value": "Pending",
"description": "Pending"
}
]
}
},
"HttpRouteRule": {
"type": "object",
"description": "A set of routing conditions and targets.",
"properties": {
"targets": {
"type": "array",
"description": "Targets- container apps, revisions, labels",
"items": {
"$ref": "#/definitions/HttpRouteTarget"
},
"x-ms-identifiers": [
"name"
]
},
"routes": {
"type": "array",
"description": "Routing configuration that will allow matches on specific paths/headers.",
"items": {
"$ref": "#/definitions/HttpRoute"
},
"x-ms-identifiers": [
"name"
]
},
"description": {
"type": "string",
"description": "Description of rule. Optional."
}
}
},
"HttpRouteTarget": {
"type": "object",
"description": "Targets - Container App Names, Revision Names, Labels.",
"properties": {
"containerApp": {
"type": "string",
"description": "Container App Name to route requests to"
},
"revision": {
"type": "string",
"description": "Revision to route requests to"
},
"label": {
"type": "string",
"description": "Label to route requests to"
}
},
"required": [
"containerApp"
]
},
"HttpScaleRule": {
"type": "object",
"description": "Container App container Http scaling rule.",
"properties": {
"metadata": {
"type": "object",
"description": "Metadata properties to describe http scale rule.",
"additionalProperties": {
"type": "string"
}
},
"auth": {
"type": "array",
"description": "Authentication secrets for the custom scale rule.",
"items": {
"$ref": "#/definitions/ScaleRuleAuth"
},
"x-ms-identifiers": [
"triggerParameter"
]
},
"identity": {
"type": "string",
"description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity."
}
}
},
"HttpSettings": {
"type": "object",
"description": "The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.",
"properties": {
"requireHttps": {
"type": "boolean",
"description": "false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true."
},
"routes": {
"$ref": "#/definitions/HttpSettingsRoutes",
"description": "The configuration settings of the paths HTTP requests."
},
"forwardProxy": {
"$ref": "#/definitions/ForwardProxy",
"description": "The configuration settings of a forward proxy used to make the requests."
}
}
},
"HttpSettingsRoutes": {
"type": "object",
"description": "The configuration settings of the paths HTTP requests.",
"properties": {
"apiPrefix": {
"type": "string",
"description": "The prefix that should precede all the authentication/authorization paths."
}
}
},
"IdentityProviders": {
"type": "object",
"description": "The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.",
"properties": {
"azureActiveDirectory": {
"$ref": "#/definitions/AzureActiveDirectory",
"description": "The configuration settings of the Azure Active directory provider."
},
"facebook": {
"$ref": "#/definitions/Facebook",
"description": "The configuration settings of the Facebook provider."
},
"gitHub": {
"$ref": "#/definitions/GitHub",
"description": "The configuration settings of the GitHub provider."
},
"google": {
"$ref": "#/definitions/Google",
"description": "The configuration settings of the Google provider."
},
"twitter": {
"$ref": "#/definitions/Twitter",
"description": "The configuration settings of the Twitter provider."
},
"apple": {
"$ref": "#/definitions/Apple",
"description": "The configuration settings of the Apple provider."
},
"azureStaticWebApps": {
"$ref": "#/definitions/AzureStaticWebApps",
"description": "The configuration settings of the Azure Static Web Apps provider."
},
"customOpenIdConnectProviders": {
"type": "object",
"description": "The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider.",
"additionalProperties": {
"$ref": "#/definitions/CustomOpenIdConnectProvider"
}
}
}
},
"IdentitySettings": {
"type": "object",
"description": "Optional settings for a Managed Identity that is assigned to the Container App.",
"properties": {
"identity": {
"type": "string",
"description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity."
},
"lifecycle": {
"type": "string",
"description": "Use to select the lifecycle stages of a Container App during which the Managed Identity should be available.",
"default": "All",
"enum": [
"None",
"Main",
"Init",
"All"
],
"x-ms-enum": {
"name": "IdentitySettingsLifeCycle",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "Do not use managed identity during any lifecycle stage."
},
{
"name": "Main",
"value": "Main",
"description": "Use managed identity during the main stage of the Container App lifecycle."
},
{
"name": "Init",
"value": "Init",
"description": "Use managed identity during the init stage of the Container App lifecycle."
},
{
"name": "All",
"value": "All",
"description": "Use managed identity during all lifecycle stages of the Container App."
}
]
}
}
},
"required": [
"identity"
]
},
"Ingress": {
"type": "object",
"description": "Container App Ingress configuration.",
"properties": {
"fqdn": {
"type": "string",
"description": "Hostname.",
"readOnly": true
},
"external": {
"type": "boolean",
"description": "Bool indicating if app exposes an external http endpoint",
"default": false
},
"targetPort": {
"type": "integer",
"format": "int32",
"description": "Target Port in containers for traffic from ingress"
},
"exposedPort": {
"type": "integer",
"format": "int32",
"description": "Exposed Port in containers for TCP traffic from ingress"
},
"transport": {
"type": "string",
"description": "Ingress transport protocol",
"default": "auto",
"enum": [
"auto",
"http",
"http2",
"tcp"
],
"x-ms-enum": {
"name": "IngressTransportMethod",
"modelAsString": true,
"values": [
{
"name": "auto",
"value": "auto",
"description": "auto"
},
{
"name": "http",
"value": "http",
"description": "http"
},
{
"name": "http2",
"value": "http2",
"description": "http2"
},
{
"name": "tcp",
"value": "tcp",
"description": "tcp"
}
]
}
},
"traffic": {
"type": "array",
"description": "Traffic weights for app's revisions",
"items": {
"$ref": "#/definitions/TrafficWeight"
},
"x-ms-identifiers": [
"revisionName"
]
},
"customDomains": {
"type": "array",
"description": "custom domain bindings for Container Apps' hostnames.",
"items": {
"$ref": "#/definitions/CustomDomain"
},
"x-ms-identifiers": [
"name"
]
},
"allowInsecure": {
"type": "boolean",
"description": "Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections",
"default": false
},
"ipSecurityRestrictions": {
"type": "array",
"description": "Rules to restrict incoming IP address.",
"items": {
"$ref": "#/definitions/IpSecurityRestrictionRule"
},
"x-ms-identifiers": [
"name"
]
},
"stickySessions": {
"$ref": "#/definitions/IngressStickySessions",
"description": "Sticky Sessions for Single Revision Mode"
},
"clientCertificateMode": {
"$ref": "#/definitions/IngressClientCertificateMode",
"description": "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": {
"$ref": "#/definitions/CorsPolicy",
"description": "CORS policy for container app"
},
"additionalPortMappings": {
"type": "array",
"description": "Settings to expose additional ports on container app",
"items": {
"$ref": "#/definitions/IngressPortMapping"
},
"x-ms-identifiers": [
"targetPort"
]
}
}
},
"IngressClientCertificateMode": {
"type": "string",
"description": "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.",
"enum": [
"ignore",
"accept",
"require"
],
"x-ms-enum": {
"name": "IngressClientCertificateMode",
"modelAsString": true,
"values": [
{
"name": "ignore",
"value": "ignore",
"description": "ignore"
},
{
"name": "accept",
"value": "accept",
"description": "accept"
},
{
"name": "require",
"value": "require",
"description": "require"
}
]
}
},
"IngressConfiguration": {
"type": "object",
"description": "Settings for the ingress component, including workload profile, scaling, and connection handling.",
"properties": {
"workloadProfileName": {
"type": "string",
"description": "Name of the workload profile used by the ingress component. Required."
},
"terminationGracePeriodSeconds": {
"type": "integer",
"format": "int32",
"description": "Time (in seconds) to allow active connections to complete on termination. Must be between 0 and 3600. Defaults to 480 seconds."
},
"headerCountLimit": {
"type": "integer",
"format": "int32",
"description": "Maximum number of headers per request allowed by the ingress. Must be at least 1. Defaults to 100."
},
"requestIdleTimeout": {
"type": "integer",
"format": "int32",
"description": "Duration (in minutes) before idle requests are timed out. Must be between 4 and 30 inclusive. Defaults to 4 minutes."
}
}
},
"IngressPortMapping": {
"type": "object",
"description": "Port mappings of container app ingress",
"properties": {
"external": {
"type": "boolean",
"description": "Specifies whether the app port is accessible outside of the environment"
},
"targetPort": {
"type": "integer",
"format": "int32",
"description": "Specifies the port user's container listens on"
},
"exposedPort": {
"type": "integer",
"format": "int32",
"description": "Specifies the exposed port for the target port. If not specified, it defaults to target port"
}
},
"required": [
"external",
"targetPort"
]
},
"IngressStickySessions": {
"type": "object",
"description": "Sticky Sessions for Single Revision Mode",
"properties": {
"affinity": {
"$ref": "#/definitions/Affinity",
"description": "Sticky Session Affinity"
}
}
},
"InitContainer": {
"type": "object",
"description": "Container App init container definition",
"allOf": [
{
"$ref": "#/definitions/BaseContainer"
}
]
},
"IpSecurityRestrictionRule": {
"type": "object",
"description": "Rule to restrict incoming IP address.",
"properties": {
"name": {
"type": "string",
"description": "Name for the IP restriction rule."
},
"description": {
"type": "string",
"description": "Describe the IP restriction rule that is being sent to the container-app. This is an optional field."
},
"ipAddressRange": {
"type": "string",
"description": "CIDR notation to match incoming IP address"
},
"action": {
"$ref": "#/definitions/Action",
"description": "Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny"
}
},
"required": [
"name",
"ipAddressRange",
"action"
]
},
"JavaComponent": {
"type": "object",
"description": "Java Component.",
"properties": {
"properties": {
"$ref": "#/definitions/JavaComponentProperties",
"description": "Java Component resource specific properties"
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"JavaComponentConfigurationProperty": {
"type": "object",
"description": "Configuration properties for a Java Component",
"properties": {
"propertyName": {
"type": "string",
"description": "The name of the property"
},
"value": {
"type": "string",
"description": "The value of the property"
}
}
},
"JavaComponentIngress": {
"type": "object",
"description": "Container App Ingress configuration.",
"properties": {
"fqdn": {
"type": "string",
"description": "Hostname of the Java Component endpoint",
"readOnly": true
}
}
},
"JavaComponentProperties": {
"type": "object",
"description": "Java Component common properties.",
"properties": {
"componentType": {
"$ref": "#/definitions/JavaComponentType",
"description": "Type of the Java Component."
},
"provisioningState": {
"$ref": "#/definitions/JavaComponentProvisioningState",
"description": "Provisioning state of the Java Component.",
"readOnly": true
},
"configurations": {
"type": "array",
"description": "List of Java Components configuration properties",
"items": {
"$ref": "#/definitions/JavaComponentConfigurationProperty"
},
"x-ms-identifiers": [
"propertyName"
]
},
"scale": {
"$ref": "#/definitions/JavaComponentPropertiesScale",
"description": "Java component scaling configurations"
},
"serviceBinds": {
"type": "array",
"description": "List of Java Components that are bound to the Java component",
"items": {
"$ref": "#/definitions/JavaComponentServiceBind"
},
"x-ms-identifiers": [
"name"
]
}
},
"discriminator": "componentType",
"required": [
"componentType"
]
},
"JavaComponentPropertiesScale": {
"type": "object",
"description": "Java component scaling configurations",
"properties": {
"minReplicas": {
"type": "integer",
"format": "int32",
"description": "Optional. Minimum number of Java component replicas. Defaults to 1 if not set"
},
"maxReplicas": {
"type": "integer",
"format": "int32",
"description": "Optional. Maximum number of Java component replicas"
}
}
},
"JavaComponentProvisioningState": {
"type": "string",
"description": "Provisioning state of the Java Component.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"Deleting",
"InProgress"
],
"x-ms-enum": {
"name": "JavaComponentProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Succeeded",
"value": "Succeeded",
"description": "Succeeded"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Canceled",
"value": "Canceled",
"description": "Canceled"
},
{
"name": "Deleting",
"value": "Deleting",
"description": "Deleting"
},
{
"name": "InProgress",
"value": "InProgress",
"description": "InProgress"
}
]
}
},
"JavaComponentServiceBind": {
"type": "object",
"description": "Configuration to bind a Java Component to another Java Component",
"properties": {
"name": {
"type": "string",
"description": "Name of the service bind"
},
"serviceId": {
"type": "string",
"format": "arm-id",
"description": "Resource id of the target service"
}
}
},
"JavaComponentType": {
"type": "string",
"description": "Type of the Java Component.",
"enum": [
"SpringBootAdmin",
"SpringCloudEureka",
"SpringCloudConfig"
],
"x-ms-enum": {
"name": "JavaComponentType",
"modelAsString": true,
"values": [
{
"name": "SpringBootAdmin",
"value": "SpringBootAdmin",
"description": "SpringBootAdmin"
},
{
"name": "SpringCloudEureka",
"value": "SpringCloudEureka",
"description": "SpringCloudEureka"
},
{
"name": "SpringCloudConfig",
"value": "SpringCloudConfig",
"description": "SpringCloudConfig"
}
]
}
},
"JavaComponentsCollection": {
"type": "object",
"description": "Java Components ARM resource.",
"properties": {
"value": {
"type": "array",
"description": "The JavaComponent items on this page",
"items": {
"$ref": "#/definitions/JavaComponent"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"Job": {
"type": "object",
"description": "Container App Job",
"properties": {
"properties": {
"$ref": "#/definitions/JobProperties",
"description": "Container Apps Job resource specific properties.",
"x-ms-client-flatten": true
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "The managed service identities assigned to this resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"JobConfiguration": {
"type": "object",
"description": "Non versioned Container Apps Job configuration properties",
"properties": {
"secrets": {
"type": "array",
"description": "Collection of secrets used by a Container Apps Job",
"items": {
"$ref": "#/definitions/Secret"
},
"x-ms-identifiers": [
"name"
]
},
"triggerType": {
"type": "string",
"description": "Trigger type of the job",
"default": "Manual",
"enum": [
"Schedule",
"Event",
"Manual"
],
"x-ms-enum": {
"name": "TriggerType",
"modelAsString": true,
"values": [
{
"name": "Schedule",
"value": "Schedule",
"description": "Schedule"
},
{
"name": "Event",
"value": "Event",
"description": "Event"
},
{
"name": "Manual",
"value": "Manual",
"description": "Manual"
}
]
}
},
"replicaTimeout": {
"type": "integer",
"format": "int32",
"description": "Maximum number of seconds a replica is allowed to run."
},
"replicaRetryLimit": {
"type": "integer",
"format": "int32",
"description": "Maximum number of retries before failing the job."
},
"manualTriggerConfig": {
"$ref": "#/definitions/JobConfigurationManualTriggerConfig",
"description": "Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default"
},
"scheduleTriggerConfig": {
"$ref": "#/definitions/JobConfigurationScheduleTriggerConfig",
"description": "Cron formatted repeating trigger schedule (\"* * * * *\") for cronjobs. Properties completions and parallelism would be set to 1 by default"
},
"eventTriggerConfig": {
"$ref": "#/definitions/JobConfigurationEventTriggerConfig",
"description": "Trigger configuration of an event driven job."
},
"registries": {
"type": "array",
"description": "Collection of private container registry credentials used by a Container apps job",
"items": {
"$ref": "#/definitions/RegistryCredentials"
},
"x-ms-identifiers": [
"server"
]
},
"identitySettings": {
"type": "array",
"description": "Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used.",
"items": {
"$ref": "#/definitions/IdentitySettings"
},
"x-ms-identifiers": [
"identity"
]
}
},
"required": [
"triggerType",
"replicaTimeout"
]
},
"JobConfigurationEventTriggerConfig": {
"type": "object",
"description": "Trigger configuration of an event driven job.",
"properties": {
"replicaCompletionCount": {
"type": "integer",
"format": "int32",
"description": "Minimum number of successful replica completions before overall job completion."
},
"parallelism": {
"type": "integer",
"format": "int32",
"description": "Number of parallel replicas of a job that can run at a given time."
},
"scale": {
"$ref": "#/definitions/JobScale",
"description": "Scaling configurations for event driven jobs."
}
}
},
"JobConfigurationManualTriggerConfig": {
"type": "object",
"description": "Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default",
"properties": {
"replicaCompletionCount": {
"type": "integer",
"format": "int32",
"description": "Minimum number of successful replica completions before overall job completion."
},
"parallelism": {
"type": "integer",
"format": "int32",
"description": "Number of parallel replicas of a job that can run at a given time."
}
}
},
"JobConfigurationScheduleTriggerConfig": {
"type": "object",
"description": "Cron formatted repeating trigger schedule (\"* * * * *\") for cronjobs. Properties completions and parallelism would be set to 1 by default",
"properties": {
"replicaCompletionCount": {
"type": "integer",
"format": "int32",
"description": "Minimum number of successful replica completions before overall job completion."
},
"cronExpression": {
"type": "string",
"description": "Cron formatted repeating schedule (\"* * * * *\") of a Cron Job."
},
"parallelism": {
"type": "integer",
"format": "int32",
"description": "Number of parallel replicas of a job that can run at a given time."
}
},
"required": [
"cronExpression"
]
},
"JobExecution": {
"type": "object",
"description": "Container Apps Job execution.",
"properties": {
"properties": {
"$ref": "#/definitions/JobExecutionProperties",
"description": "Container Apps Job execution specific properties.",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"JobExecutionBase": {
"type": "object",
"description": "Container App's Job execution name.",
"properties": {
"name": {
"type": "string",
"description": "Job execution name."
},
"id": {
"type": "string",
"description": "Job execution Id."
}
}
},
"JobExecutionContainer": {
"type": "object",
"description": "Container Apps Jobs execution container definition.",
"properties": {
"image": {
"type": "string",
"description": "Container image tag."
},
"name": {
"type": "string",
"description": "Custom container name."
},
"command": {
"type": "array",
"description": "Container start command.",
"items": {
"type": "string"
}
},
"args": {
"type": "array",
"description": "Container start command arguments.",
"items": {
"type": "string"
}
},
"env": {
"type": "array",
"description": "Container environment variables.",
"items": {
"$ref": "#/definitions/EnvironmentVar"
},
"x-ms-identifiers": [
"name"
]
},
"resources": {
"$ref": "#/definitions/ContainerResources",
"description": "Container resource requirements."
}
}
},
"JobExecutionProperties": {
"type": "object",
"description": "Container Apps Job execution specific properties.",
"properties": {
"status": {
"$ref": "#/definitions/JobExecutionRunningState",
"description": "Current running State of the job",
"readOnly": true
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "Job execution start time."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "Job execution end time."
},
"template": {
"$ref": "#/definitions/JobExecutionTemplate",
"description": "Job's execution container."
}
}
},
"JobExecutionRunningState": {
"type": "string",
"description": "Current running State of the job",
"enum": [
"Running",
"Processing",
"Stopped",
"Degraded",
"Failed",
"Unknown",
"Succeeded"
],
"x-ms-enum": {
"name": "JobExecutionRunningState",
"modelAsString": true,
"values": [
{
"name": "Running",
"value": "Running",
"description": "Running"
},
{
"name": "Processing",
"value": "Processing",
"description": "Processing"
},
{
"name": "Stopped",
"value": "Stopped",
"description": "Stopped"
},
{
"name": "Degraded",
"value": "Degraded",
"description": "Degraded"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Unknown",
"value": "Unknown",
"description": "Unknown"
},
{
"name": "Succeeded",
"value": "Succeeded",
"description": "Succeeded"
}
]
}
},
"JobExecutionTemplate": {
"type": "object",
"description": "Job's execution template, containing container configuration for a job's execution",
"properties": {
"containers": {
"type": "array",
"description": "List of container definitions for the Container Apps Job.",
"items": {
"$ref": "#/definitions/JobExecutionContainer"
},
"x-ms-identifiers": [
"name"
]
},
"initContainers": {
"type": "array",
"description": "List of specialized containers that run before job containers.",
"items": {
"$ref": "#/definitions/JobExecutionContainer"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"JobPatchProperties": {
"type": "object",
"description": "Container Apps Job resource specific properties.",
"properties": {
"identity": {
"$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code."
},
"tags": {
"type": "object",
"description": "Resource tags.",
"additionalProperties": {
"type": "string"
},
"x-ms-mutability": [
"read",
"update",
"create"
]
},
"properties": {
"$ref": "#/definitions/JobPatchPropertiesProperties"
}
}
},
"JobPatchPropertiesProperties": {
"type": "object",
"properties": {
"environmentId": {
"type": "string",
"description": "Resource ID of environment.",
"x-ms-mutability": [
"read",
"update",
"create"
]
},
"configuration": {
"$ref": "#/definitions/JobConfiguration",
"description": "Container Apps Job configuration properties."
},
"template": {
"$ref": "#/definitions/JobTemplate",
"description": "Container Apps job definition."
},
"outboundIpAddresses": {
"type": "array",
"description": "Outbound IP Addresses of a container apps job.",
"items": {
"type": "string"
}
},
"eventStreamEndpoint": {
"type": "string",
"description": "The endpoint of the eventstream of the container apps job."
}
}
},
"JobProperties": {
"type": "object",
"description": "Container Apps Job resource specific properties.",
"properties": {
"provisioningState": {
"$ref": "#/definitions/JobProvisioningState",
"description": "Provisioning state of the Container Apps Job.",
"readOnly": true
},
"environmentId": {
"type": "string",
"description": "Resource ID of environment.",
"x-ms-mutability": [
"read",
"create"
]
},
"workloadProfileName": {
"type": "string",
"description": "Workload profile name to pin for container apps job execution."
},
"configuration": {
"$ref": "#/definitions/JobConfiguration",
"description": "Container Apps Job configuration properties."
},
"template": {
"$ref": "#/definitions/JobTemplate",
"description": "Container Apps job definition."
},
"outboundIpAddresses": {
"type": "array",
"description": "Outbound IP Addresses of a container apps job.",
"items": {
"type": "string"
},
"readOnly": true
},
"eventStreamEndpoint": {
"type": "string",
"description": "The endpoint of the eventstream of the container apps job.",
"readOnly": true
}
}
},
"JobProvisioningState": {
"type": "string",
"description": "Provisioning state of the Container Apps Job.",
"enum": [
"InProgress",
"Succeeded",
"Failed",
"Canceled",
"Deleting"
],
"x-ms-enum": {
"name": "JobProvisioningState",
"modelAsString": true,
"values": [
{
"name": "InProgress",
"value": "InProgress",
"description": "InProgress"
},
{
"name": "Succeeded",
"value": "Succeeded",
"description": "Succeeded"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Canceled",
"value": "Canceled",
"description": "Canceled"
},
{
"name": "Deleting",
"value": "Deleting",
"description": "Deleting"
}
]
}
},
"JobScale": {
"type": "object",
"description": "Scaling configurations for event driven jobs.",
"properties": {
"pollingInterval": {
"type": "integer",
"format": "int32",
"description": "Interval to check each event source in seconds. Defaults to 30s"
},
"minExecutions": {
"type": "integer",
"format": "int32",
"description": "Minimum number of job executions that are created for a trigger, default 0",
"default": 0
},
"maxExecutions": {
"type": "integer",
"format": "int32",
"description": "Maximum number of job executions that are created for a trigger, default 100.",
"default": 100
},
"rules": {
"type": "array",
"description": "Scaling rules.",
"items": {
"$ref": "#/definitions/JobScaleRule"
}
}
}
},
"JobScaleRule": {
"type": "object",
"description": "Scaling rule.",
"properties": {
"name": {
"type": "string",
"description": "Scale Rule Name"
},
"type": {
"type": "string",
"description": "Type of the scale rule\neg: azure-servicebus, redis etc."
},
"metadata": {
"description": "Metadata properties to describe the scale rule."
},
"auth": {
"type": "array",
"description": "Authentication secrets for the scale rule.",
"items": {
"$ref": "#/definitions/ScaleRuleAuth"
}
},
"identity": {
"type": "string",
"description": "The resource ID of a user-assigned managed identity that is assigned to the job, or 'system' for system-assigned identity."
}
}
},
"JobSecretsCollection": {
"type": "object",
"description": "Container Apps Job Secrets Collection ARM resource.",
"properties": {
"value": {
"type": "array",
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/Secret"
},
"x-ms-identifiers": [
"name"
]
}
},
"required": [
"value"
]
},
"JobTemplate": {
"type": "object",
"description": "Container Apps Job 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": {
"initContainers": {
"type": "array",
"description": "List of specialized containers that run before app containers.",
"items": {
"$ref": "#/definitions/InitContainer"
},
"x-ms-identifiers": [
"name"
]
},
"containers": {
"type": "array",
"description": "List of container definitions for the Container App.",
"items": {
"$ref": "#/definitions/Container"
},
"x-ms-identifiers": [
"name"
]
},
"volumes": {
"type": "array",
"description": "List of volume definitions for the Container App.",
"items": {
"$ref": "#/definitions/Volume"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"JobsCollection": {
"type": "object",
"description": "Container Apps Jobs collection ARM resource.",
"properties": {
"value": {
"type": "array",
"description": "The Job items on this page",
"items": {
"$ref": "#/definitions/Job"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"JwtClaimChecks": {
"type": "object",
"description": "The configuration settings of the checks that should be made while validating the JWT Claims.",
"properties": {
"allowedGroups": {
"type": "array",
"description": "The list of the allowed groups.",
"items": {
"type": "string"
}
},
"allowedClientApplications": {
"type": "array",
"description": "The list of the allowed client applications.",
"items": {
"type": "string"
}
}
}
},
"KedaConfiguration": {
"type": "object",
"description": "Configuration properties Keda component",
"properties": {
"version": {
"type": "string",
"description": "The version of Keda",
"readOnly": true
}
}
},
"Kind": {
"type": "string",
"description": "Metadata to represent the container app kind, representing if a container app is workflowapp or functionapp.",
"enum": [
"workflowapp",
"functionapp"
],
"x-ms-enum": {
"name": "Kind",
"modelAsString": true,
"values": [
{
"name": "workflowapp",
"value": "workflowapp",
"description": "workflowapp"
},
{
"name": "functionapp",
"value": "functionapp",
"description": "functionapp"
}
]
}
},
"LifecycleConfiguration": {
"type": "object",
"description": "The lifecycle configuration properties of a session in the dynamic session pool",
"properties": {
"lifecycleType": {
"$ref": "#/definitions/LifecycleType",
"description": "The lifecycle type of the session pool."
},
"cooldownPeriodInSeconds": {
"type": "integer",
"format": "int32",
"description": "The cooldown period of a session in seconds when the lifecycle type is 'Timed'."
},
"maxAlivePeriodInSeconds": {
"type": "integer",
"format": "int32",
"description": "The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'."
}
}
},
"LifecycleType": {
"type": "string",
"description": "The lifecycle type of the session pool.",
"enum": [
"Timed",
"OnContainerExit"
],
"x-ms-enum": {
"name": "LifecycleType",
"modelAsString": true,
"values": [
{
"name": "Timed",
"value": "Timed",
"description": "Timed"
},
{
"name": "OnContainerExit",
"value": "OnContainerExit",
"description": "OnContainerExit"
}
]
}
},
"ListUsagesResult": {
"type": "object",
"description": "Paged collection of Usage items",
"properties": {
"value": {
"type": "array",
"description": "The Usage items on this page",
"items": {
"$ref": "#/definitions/Usage"
},
"x-ms-identifiers": [
"name"
]
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"LogAnalyticsConfiguration": {
"type": "object",
"description": "Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'",
"properties": {
"customerId": {
"type": "string",
"description": "Log analytics customer id"
},
"sharedKey": {
"type": "string",
"format": "password",
"description": "Log analytics customer key",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
}
}
},
"LogLevel": {
"type": "string",
"description": "Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.",
"enum": [
"info",
"debug",
"warn",
"error"
],
"x-ms-enum": {
"name": "LogLevel",
"modelAsString": true,
"values": [
{
"name": "info",
"value": "info",
"description": "info"
},
{
"name": "debug",
"value": "debug",
"description": "debug"
},
{
"name": "warn",
"value": "warn",
"description": "warn"
},
{
"name": "error",
"value": "error",
"description": "error"
}
]
}
},
"LogicApp": {
"type": "object",
"description": "A logic app extension resource",
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"Login": {
"type": "object",
"description": "The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.",
"properties": {
"routes": {
"$ref": "#/definitions/LoginRoutes",
"description": "The routes that specify the endpoints used for login and logout requests."
},
"tokenStore": {
"$ref": "#/definitions/TokenStore",
"description": "The configuration settings of the token store."
},
"preserveUrlFragmentsForLogins": {
"type": "boolean",
"description": "true if the fragments from the request are preserved after the login request is made; otherwise, false."
},
"allowedExternalRedirectUrls": {
"type": "array",
"description": "External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed.",
"items": {
"type": "string"
}
},
"cookieExpiration": {
"$ref": "#/definitions/CookieExpiration",
"description": "The configuration settings of the session cookie's expiration."
},
"nonce": {
"$ref": "#/definitions/Nonce",
"description": "The configuration settings of the nonce used in the login flow."
}
}
},
"LoginRoutes": {
"type": "object",
"description": "The routes that specify the endpoints used for login and logout requests.",
"properties": {
"logoutEndpoint": {
"type": "string",
"description": "The endpoint at which a logout request should be made."
}
}
},
"LoginScopes": {
"type": "object",
"description": "The configuration settings of the login flow, including the scopes that should be requested.",
"properties": {
"scopes": {
"type": "array",
"description": "A list of the scopes that should be requested while authenticating.",
"items": {
"type": "string"
}
}
}
},
"MaintenanceConfigurationCollection": {
"type": "object",
"description": "The response of list maintenance configuration resources.",
"properties": {
"value": {
"type": "array",
"description": "The MaintenanceConfigurationResource items on this page",
"items": {
"$ref": "#/definitions/MaintenanceConfigurationResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"MaintenanceConfigurationResource": {
"type": "object",
"description": "Information about the Maintenance Configuration resource.",
"properties": {
"properties": {
"$ref": "#/definitions/ScheduledEntries",
"description": "The resource-specific properties for this resource.",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"ManagedCertificate": {
"type": "object",
"description": "Managed certificates used for Custom Domain bindings of Container Apps in a Managed Environment",
"properties": {
"properties": {
"$ref": "#/definitions/ManagedCertificateProperties",
"description": "Certificate resource specific properties"
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"ManagedCertificateCollection": {
"type": "object",
"description": "Collection of Managed Certificates.",
"properties": {
"value": {
"type": "array",
"description": "The ManagedCertificate items on this page",
"items": {
"$ref": "#/definitions/ManagedCertificate"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ManagedCertificateDomainControlValidation": {
"type": "string",
"description": "Selected type of domain control validation for managed certificates.",
"enum": [
"CNAME",
"HTTP",
"TXT"
],
"x-ms-enum": {
"name": "ManagedCertificateDomainControlValidation",
"modelAsString": true,
"values": [
{
"name": "CNAME",
"value": "CNAME",
"description": "CNAME"
},
{
"name": "HTTP",
"value": "HTTP",
"description": "HTTP"
},
{
"name": "TXT",
"value": "TXT",
"description": "TXT"
}
]
}
},
"ManagedCertificatePatch": {
"type": "object",
"description": "A managed certificate to update",
"properties": {
"tags": {
"type": "object",
"description": "Application-specific metadata in the form of key-value pairs.",
"additionalProperties": {
"type": "string"
}
}
}
},
"ManagedCertificateProperties": {
"type": "object",
"description": "Certificate resource specific properties",
"properties": {
"provisioningState": {
"$ref": "#/definitions/CertificateProvisioningState",
"description": "Provisioning state of the certificate.",
"readOnly": true
},
"subjectName": {
"type": "string",
"description": "Subject name of the certificate."
},
"error": {
"type": "string",
"description": "Any error occurred during the certificate provision.",
"readOnly": true
},
"domainControlValidation": {
"$ref": "#/definitions/ManagedCertificateDomainControlValidation",
"description": "Selected type of domain control validation for managed certificates."
},
"validationToken": {
"type": "string",
"description": "A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates.",
"readOnly": true
}
}
},
"ManagedEnvironment": {
"type": "object",
"description": "An environment for hosting container apps",
"properties": {
"properties": {
"$ref": "#/definitions/ManagedEnvironmentProperties",
"description": "Managed environment resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of the Environment."
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "The managed service identities assigned to this resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"ManagedEnvironmentProperties": {
"type": "object",
"description": "Managed environment resource specific properties",
"properties": {
"provisioningState": {
"$ref": "#/definitions/EnvironmentProvisioningState",
"description": "Provisioning state of the Environment.",
"readOnly": true
},
"daprAIInstrumentationKey": {
"type": "string",
"format": "password",
"description": "Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry",
"x-ms-secret": true
},
"daprAIConnectionString": {
"type": "string",
"format": "password",
"description": "Application Insights connection string used by Dapr to export Service to Service communication telemetry",
"x-ms-secret": true
},
"vnetConfiguration": {
"$ref": "#/definitions/VnetConfiguration",
"description": "Vnet configuration for the environment"
},
"deploymentErrors": {
"type": "string",
"description": "Any errors that occurred during deployment or deployment validation",
"readOnly": true
},
"defaultDomain": {
"type": "string",
"description": "Default Domain Name for the cluster",
"readOnly": true
},
"staticIp": {
"type": "string",
"description": "Static IP of the Environment",
"readOnly": true
},
"appLogsConfiguration": {
"$ref": "#/definitions/AppLogsConfiguration",
"description": "Cluster configuration which enables the log daemon to export app logs to configured destination"
},
"zoneRedundant": {
"type": "boolean",
"description": "Whether or not this Managed Environment is zone-redundant.",
"x-ms-mutability": [
"read",
"create"
]
},
"customDomainConfiguration": {
"$ref": "#/definitions/CustomDomainConfiguration",
"description": "Custom domain configuration for the environment"
},
"eventStreamEndpoint": {
"type": "string",
"description": "The endpoint of the eventstream of the Environment.",
"readOnly": true
},
"workloadProfiles": {
"type": "array",
"description": "Workload profiles configured for the Managed Environment.",
"items": {
"$ref": "#/definitions/WorkloadProfile"
},
"x-ms-identifiers": [
"name"
]
},
"kedaConfiguration": {
"$ref": "#/definitions/KedaConfiguration",
"description": "The configuration of Keda component."
},
"daprConfiguration": {
"$ref": "#/definitions/DaprConfiguration",
"description": "The configuration of Dapr component."
},
"infrastructureResourceGroup": {
"type": "string",
"description": "Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet.",
"x-ms-mutability": [
"read",
"create"
]
},
"peerAuthentication": {
"$ref": "#/definitions/ManagedEnvironmentPropertiesPeerAuthentication",
"description": "Peer authentication settings for the Managed Environment"
},
"peerTrafficConfiguration": {
"$ref": "#/definitions/ManagedEnvironmentPropertiesPeerTrafficConfiguration",
"description": "Peer traffic settings for the Managed Environment"
},
"ingressConfiguration": {
"$ref": "#/definitions/IngressConfiguration",
"description": "Ingress configuration for the Managed Environment."
},
"privateEndpointConnections": {
"type": "array",
"description": "Private endpoint connections to the resource.",
"items": {
"$ref": "#/definitions/PrivateEndpointConnection"
},
"readOnly": true
},
"publicNetworkAccess": {
"$ref": "#/definitions/PublicNetworkAccess",
"description": "Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled'."
}
}
},
"ManagedEnvironmentPropertiesPeerAuthentication": {
"type": "object",
"description": "Peer authentication settings for the Managed Environment",
"properties": {
"mtls": {
"$ref": "#/definitions/Mtls",
"description": "Mutual TLS authentication settings for the Managed Environment"
}
}
},
"ManagedEnvironmentPropertiesPeerTrafficConfiguration": {
"type": "object",
"description": "Peer traffic settings for the Managed Environment",
"properties": {
"encryption": {
"$ref": "#/definitions/ManagedEnvironmentPropertiesPeerTrafficConfigurationEncryption",
"description": "Peer traffic encryption settings for the Managed Environment"
}
}
},
"ManagedEnvironmentPropertiesPeerTrafficConfigurationEncryption": {
"type": "object",
"description": "Peer traffic encryption settings for the Managed Environment",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating whether the peer traffic encryption is enabled"
}
}
},
"ManagedEnvironmentStorage": {
"type": "object",
"description": "Storage resource for managedEnvironment.",
"properties": {
"properties": {
"$ref": "#/definitions/ManagedEnvironmentStorageProperties",
"description": "Storage properties"
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"ManagedEnvironmentStorageProperties": {
"type": "object",
"description": "Storage properties",
"properties": {
"azureFile": {
"$ref": "#/definitions/AzureFileProperties",
"description": "Azure file properties"
},
"nfsAzureFile": {
"$ref": "#/definitions/NfsAzureFileProperties",
"description": "NFS Azure file properties"
}
}
},
"ManagedEnvironmentStoragesCollection": {
"type": "object",
"description": "Collection of Storage for Environments",
"properties": {
"value": {
"type": "array",
"description": "Collection of storage resources.",
"items": {
"$ref": "#/definitions/ManagedEnvironmentStorage"
}
}
},
"required": [
"value"
]
},
"ManagedEnvironmentsCollection": {
"type": "object",
"description": "Collection of Environments",
"properties": {
"value": {
"type": "array",
"description": "The ManagedEnvironment items on this page",
"items": {
"$ref": "#/definitions/ManagedEnvironment"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ManagedIdentitySetting": {
"type": "object",
"description": "Optional settings for a Managed Identity that is assigned to the Session pool.",
"properties": {
"identity": {
"type": "string",
"description": "The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or 'system' for system-assigned identity."
},
"lifecycle": {
"type": "string",
"description": "Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available.",
"default": "None",
"enum": [
"None",
"Main"
],
"x-ms-enum": {
"name": "SessionPoolIdentityLifeCycle",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "Do not use managed identity during any lifecycle stage."
},
{
"name": "Main",
"value": "Main",
"description": "Use managed identity during the main stage of the Container App lifecycle."
}
]
}
}
},
"required": [
"identity"
]
},
"Mtls": {
"type": "object",
"description": "Configuration properties for mutual TLS authentication",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating whether the mutual TLS authentication is enabled"
}
}
},
"NfsAzureFileProperties": {
"type": "object",
"description": "NFS Azure File Properties.",
"properties": {
"server": {
"type": "string",
"description": "Server for NFS azure file. Specify the Azure storage account server address."
},
"accessMode": {
"$ref": "#/definitions/AccessMode",
"description": "Access mode for storage"
},
"shareName": {
"type": "string",
"description": "NFS Azure file share name."
}
}
},
"Nonce": {
"type": "object",
"description": "The configuration settings of the nonce used in the login flow.",
"properties": {
"validateNonce": {
"type": "boolean",
"description": "false if the nonce should not be validated while completing the login flow; otherwise, true."
},
"nonceExpirationInterval": {
"type": "string",
"description": "The time after the request is made when the nonce should expire."
}
}
},
"OpenIdConnectClientCredential": {
"type": "object",
"description": "The authentication client credentials of the custom Open ID Connect provider.",
"properties": {
"method": {
"type": "string",
"description": "The method that should be used to authenticate the user.",
"enum": [
"ClientSecretPost"
],
"x-ms-enum": {
"modelAsString": false
}
},
"clientSecretSettingName": {
"type": "string",
"description": "The app setting that contains the client secret for the custom Open ID Connect provider."
}
}
},
"OpenIdConnectConfig": {
"type": "object",
"description": "The configuration settings of the endpoints used for the custom Open ID Connect provider.",
"properties": {
"authorizationEndpoint": {
"type": "string",
"description": "The endpoint to be used to make an authorization request."
},
"tokenEndpoint": {
"type": "string",
"description": "The endpoint to be used to request a token."
},
"issuer": {
"type": "string",
"description": "The endpoint that issues the token."
},
"certificationUri": {
"type": "string",
"description": "The endpoint that provides the keys necessary to validate the token."
},
"wellKnownOpenIdConfiguration": {
"type": "string",
"description": "The endpoint that contains all the configuration endpoints for the provider."
}
}
},
"OpenIdConnectLogin": {
"type": "object",
"description": "The configuration settings of the login flow of the custom Open ID Connect provider.",
"properties": {
"nameClaimType": {
"type": "string",
"description": "The name of the claim that contains the users name."
},
"scopes": {
"type": "array",
"description": "A list of the scopes that should be requested while authenticating.",
"items": {
"type": "string"
}
}
}
},
"OpenIdConnectRegistration": {
"type": "object",
"description": "The configuration settings of the app registration for the custom Open ID Connect provider.",
"properties": {
"clientId": {
"type": "string",
"description": "The client id of the custom Open ID Connect provider."
},
"clientCredential": {
"$ref": "#/definitions/OpenIdConnectClientCredential",
"description": "The authentication credentials of the custom Open ID Connect provider."
},
"openIdConnectConfiguration": {
"$ref": "#/definitions/OpenIdConnectConfig",
"description": "The configuration settings of the endpoints used for the custom Open ID Connect provider."
}
}
},
"OperationDetail": {
"type": "object",
"description": "Operation detail payload",
"properties": {
"name": {
"type": "string",
"description": "Name of the operation"
},
"isDataAction": {
"type": "boolean",
"description": "Indicates whether the operation is a data action"
},
"display": {
"$ref": "#/definitions/OperationDisplay",
"description": "Display of the operation"
},
"origin": {
"type": "string",
"description": "Origin of the operation"
}
}
},
"OperationDisplay": {
"type": "object",
"description": "Operation display payload",
"properties": {
"provider": {
"type": "string",
"description": "Resource provider of the operation"
},
"resource": {
"type": "string",
"description": "Resource of the operation"
},
"operation": {
"type": "string",
"description": "Localized friendly name for the operation"
},
"description": {
"type": "string",
"description": "Localized friendly description for the operation"
}
}
},
"PoolManagementType": {
"type": "string",
"description": "The pool management type of the session pool.",
"enum": [
"Manual",
"Dynamic"
],
"x-ms-enum": {
"name": "PoolManagementType",
"modelAsString": true,
"values": [
{
"name": "Manual",
"value": "Manual",
"description": "Manual"
},
{
"name": "Dynamic",
"value": "Dynamic",
"description": "Dynamic"
}
]
}
},
"PrivateEndpoint": {
"type": "object",
"description": "The Private Endpoint resource.",
"properties": {
"id": {
"type": "string",
"format": "arm-id",
"description": "The ARM identifier for Private Endpoint",
"readOnly": true
}
}
},
"PrivateEndpointConnection": {
"type": "object",
"description": "The Private Endpoint Connection resource.",
"properties": {
"properties": {
"$ref": "#/definitions/PrivateEndpointConnectionProperties",
"description": "Resource properties.",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"PrivateEndpointConnectionListResult": {
"type": "object",
"description": "The response of a PrivateEndpointConnection list operation.",
"properties": {
"value": {
"type": "array",
"description": "The PrivateEndpointConnection items on this page",
"items": {
"$ref": "#/definitions/PrivateEndpointConnection"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PrivateEndpointConnectionProperties": {
"type": "object",
"description": "Properties of the private endpoint connection.",
"properties": {
"groupIds": {
"type": "array",
"description": "The group ids for the private endpoint resource.",
"items": {
"type": "string"
},
"readOnly": true
},
"privateEndpoint": {
"$ref": "#/definitions/PrivateEndpoint",
"description": "The resource of private end point."
},
"privateLinkServiceConnectionState": {
"$ref": "#/definitions/PrivateLinkServiceConnectionState",
"description": "A collection of information about the state of the connection between service consumer and provider."
},
"provisioningState": {
"$ref": "#/definitions/PrivateEndpointConnectionProvisioningState",
"description": "The provisioning state of the private endpoint connection resource.",
"readOnly": true
}
},
"required": [
"privateLinkServiceConnectionState"
]
},
"PrivateEndpointConnectionProvisioningState": {
"type": "string",
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"Waiting",
"Updating",
"Deleting",
"Pending"
],
"x-ms-enum": {
"name": "PrivateEndpointConnectionProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Succeeded",
"value": "Succeeded",
"description": "Succeeded"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Canceled",
"value": "Canceled",
"description": "Canceled"
},
{
"name": "Waiting",
"value": "Waiting",
"description": "Waiting"
},
{
"name": "Updating",
"value": "Updating",
"description": "Updating"
},
{
"name": "Deleting",
"value": "Deleting",
"description": "Deleting"
},
{
"name": "Pending",
"value": "Pending",
"description": "Pending"
}
]
}
},
"PrivateEndpointServiceConnectionStatus": {
"type": "string",
"description": "The private endpoint connection status.",
"enum": [
"Pending",
"Approved",
"Rejected",
"Disconnected"
],
"x-ms-enum": {
"name": "PrivateEndpointServiceConnectionStatus",
"modelAsString": true,
"values": [
{
"name": "Pending",
"value": "Pending",
"description": "Pending"
},
{
"name": "Approved",
"value": "Approved",
"description": "Approved"
},
{
"name": "Rejected",
"value": "Rejected",
"description": "Rejected"
},
{
"name": "Disconnected",
"value": "Disconnected",
"description": "Disconnected"
}
]
}
},
"PrivateLinkResource": {
"type": "object",
"description": "A private link resource",
"properties": {
"properties": {
"$ref": "#/definitions/PrivateLinkResourceProperties",
"description": "Resource properties.",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource"
}
]
},
"PrivateLinkResourceListResult": {
"type": "object",
"description": "List of private link resources for a managed environment.",
"properties": {
"value": {
"type": "array",
"description": "The PrivateLinkResource items on this page",
"items": {
"$ref": "#/definitions/PrivateLinkResource"
}
},
"nextLink": {
"type": "string",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PrivateLinkResourceProperties": {
"type": "object",
"description": "Properties of a private link resource.",
"properties": {
"groupId": {
"type": "string",
"description": "The private link resource group id.",
"readOnly": true
},
"requiredMembers": {
"type": "array",
"description": "The private link resource required member names.",
"items": {
"type": "string"
},
"readOnly": true
},
"requiredZoneNames": {
"type": "array",
"description": "The private link resource private link DNS zone name.",
"items": {
"type": "string"
}
}
}
},
"PrivateLinkServiceConnectionState": {
"type": "object",
"description": "A collection of information about the state of the connection between service consumer and provider.",
"properties": {
"status": {
"$ref": "#/definitions/PrivateEndpointServiceConnectionStatus",
"description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service."
},
"description": {
"type": "string",
"description": "The reason for approval/rejection of the connection."
},
"actionsRequired": {
"type": "string",
"description": "A message indicating if changes on the service provider require any updates on the consumer."
}
}
},
"PublicNetworkAccess": {
"type": "string",
"description": "Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled'.",
"enum": [
"Enabled",
"Disabled"
],
"x-ms-enum": {
"name": "PublicNetworkAccess",
"modelAsString": true,
"values": [
{
"name": "Enabled",
"value": "Enabled",
"description": "Enabled"
},
{
"name": "Disabled",
"value": "Disabled",
"description": "Disabled"
}
]
}
},
"QueueScaleRule": {
"type": "object",
"description": "Container App container Azure Queue based scaling rule.",
"properties": {
"accountName": {
"type": "string",
"description": "Storage account name. required if using managed identity to authenticate"
},
"queueName": {
"type": "string",
"description": "Queue name."
},
"queueLength": {
"type": "integer",
"format": "int32",
"description": "Queue length."
},
"auth": {
"type": "array",
"description": "Authentication secrets for the queue scale rule.",
"items": {
"$ref": "#/definitions/ScaleRuleAuth"
},
"x-ms-identifiers": [
"triggerParameter"
]
},
"identity": {
"type": "string",
"description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity."
}
}
},
"RegistryCredentials": {
"type": "object",
"description": "Container App Private Registry",
"properties": {
"server": {
"type": "string",
"description": "Container Registry Server"
},
"username": {
"type": "string",
"description": "Container Registry Username"
},
"passwordSecretRef": {
"type": "string",
"description": "The name of the Secret that contains the registry login password"
},
"identity": {
"type": "string",
"description": "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'"
}
}
},
"RegistryInfo": {
"type": "object",
"description": "Container App registry information.",
"properties": {
"registryUrl": {
"type": "string",
"description": "registry server Url."
},
"registryUserName": {
"type": "string",
"description": "registry username."
},
"registryPassword": {
"type": "string",
"format": "password",
"description": "registry secret.",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
}
}
},
"Replica": {
"type": "object",
"description": "Container App Revision Replica.",
"properties": {
"properties": {
"$ref": "#/definitions/ReplicaProperties",
"description": "Replica resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"ReplicaCollection": {
"type": "object",
"description": "Container App Revision Replicas collection ARM resource.",
"properties": {
"value": {
"type": "array",
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/Replica"
}
}
},
"required": [
"value"
]
},
"ReplicaContainer": {
"type": "object",
"description": "Container object under Container App Revision Replica.",
"properties": {
"name": {
"type": "string",
"description": "The Name of the Container"
},
"containerId": {
"type": "string",
"description": "The Id of the Container"
},
"ready": {
"type": "boolean",
"description": "The container ready status"
},
"started": {
"type": "boolean",
"description": "The container start status"
},
"restartCount": {
"type": "integer",
"format": "int32",
"description": "The container restart count"
},
"runningState": {
"$ref": "#/definitions/ContainerAppContainerRunningState",
"description": "Current running state of the container",
"readOnly": true
},
"runningStateDetails": {
"type": "string",
"description": "The details of container current running state",
"readOnly": true
},
"logStreamEndpoint": {
"type": "string",
"description": "Log Stream endpoint",
"readOnly": true
},
"execEndpoint": {
"type": "string",
"description": "Container exec endpoint",
"readOnly": true
}
}
},
"ReplicaProperties": {
"type": "object",
"description": "Replica resource specific properties",
"properties": {
"createdTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp describing when the pod was created by controller",
"readOnly": true
},
"runningState": {
"$ref": "#/definitions/ContainerAppReplicaRunningState",
"description": "Current running state of the replica",
"readOnly": true
},
"runningStateDetails": {
"type": "string",
"description": "The details of replica current running state",
"readOnly": true
},
"containers": {
"type": "array",
"description": "The containers collection under a replica.",
"items": {
"$ref": "#/definitions/ReplicaContainer"
},
"x-ms-identifiers": [
"name"
]
},
"initContainers": {
"type": "array",
"description": "The init containers collection under a replica.",
"items": {
"$ref": "#/definitions/ReplicaContainer"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"ResourceTags": {
"type": "object",
"description": "List of key value pairs that describe the resource. This will overwrite the existing tags.",
"properties": {
"tags": {
"type": "object",
"description": "Resource tags.",
"additionalProperties": {
"type": "string"
},
"x-ms-mutability": [
"read",
"update",
"create"
]
}
}
},
"Revision": {
"type": "object",
"description": "Container App Revision.",
"properties": {
"properties": {
"$ref": "#/definitions/RevisionProperties",
"description": "Revision resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"RevisionCollection": {
"type": "object",
"description": "Container App Revisions collection ARM resource.",
"properties": {
"value": {
"type": "array",
"description": "The Revision items on this page",
"items": {
"$ref": "#/definitions/Revision"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"RevisionHealthState": {
"type": "string",
"description": "Current health State of the revision",
"enum": [
"Healthy",
"Unhealthy",
"None"
],
"x-ms-enum": {
"name": "RevisionHealthState",
"modelAsString": true,
"values": [
{
"name": "Healthy",
"value": "Healthy",
"description": "Healthy"
},
{
"name": "Unhealthy",
"value": "Unhealthy",
"description": "Unhealthy"
},
{
"name": "None",
"value": "None",
"description": "None"
}
]
}
},
"RevisionProperties": {
"type": "object",
"description": "Revision resource specific properties",
"properties": {
"createdTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp describing when the revision was created\nby controller",
"readOnly": true
},
"lastActiveTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp describing when the revision was last active. Only meaningful when revision is inactive",
"readOnly": true
},
"fqdn": {
"type": "string",
"description": "Fully qualified domain name of the revision",
"readOnly": true
},
"template": {
"$ref": "#/definitions/Template",
"description": "Container App Revision Template with all possible settings and the\ndefaults if user did not provide them. The defaults are populated\nas they were at the creation time",
"readOnly": true
},
"active": {
"type": "boolean",
"description": "Boolean describing if the Revision is Active",
"readOnly": true
},
"replicas": {
"type": "integer",
"format": "int32",
"description": "Number of pods currently running for this revision",
"readOnly": true
},
"trafficWeight": {
"type": "integer",
"format": "int32",
"description": "Traffic weight assigned to this revision",
"readOnly": true
},
"provisioningError": {
"type": "string",
"description": "Optional Field - Platform Error Message",
"readOnly": true
},
"healthState": {
"$ref": "#/definitions/RevisionHealthState",
"description": "Current health State of the revision",
"readOnly": true
},
"provisioningState": {
"$ref": "#/definitions/RevisionProvisioningState",
"description": "Current provisioning State of the revision",
"readOnly": true
},
"runningState": {
"$ref": "#/definitions/RevisionRunningState",
"description": "Current running state of the revision",
"readOnly": true
}
}
},
"RevisionProvisioningState": {
"type": "string",
"description": "Current provisioning State of the revision",
"enum": [
"Provisioning",
"Provisioned",
"Failed",
"Deprovisioning",
"Deprovisioned"
],
"x-ms-enum": {
"name": "RevisionProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Provisioning",
"value": "Provisioning",
"description": "Provisioning"
},
{
"name": "Provisioned",
"value": "Provisioned",
"description": "Provisioned"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Deprovisioning",
"value": "Deprovisioning",
"description": "Deprovisioning"
},
{
"name": "Deprovisioned",
"value": "Deprovisioned",
"description": "Deprovisioned"
}
]
}
},
"RevisionRunningState": {
"type": "string",
"description": "Current running state of the revision",
"enum": [
"Running",
"Processing",
"Stopped",
"Degraded",
"Failed",
"Unknown"
],
"x-ms-enum": {
"name": "RevisionRunningState",
"modelAsString": true,
"values": [
{
"name": "Running",
"value": "Running",
"description": "Running"
},
{
"name": "Processing",
"value": "Processing",
"description": "Processing"
},
{
"name": "Stopped",
"value": "Stopped",
"description": "Stopped"
},
{
"name": "Degraded",
"value": "Degraded",
"description": "Degraded"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Unknown",
"value": "Unknown",
"description": "Unknown"
}
]
}
},
"Runtime": {
"type": "object",
"description": "Container App Runtime configuration.",
"properties": {
"java": {
"$ref": "#/definitions/RuntimeJava",
"description": "Java app configuration"
}
}
},
"RuntimeJava": {
"type": "object",
"description": "Java app configuration",
"properties": {
"enableMetrics": {
"type": "boolean",
"description": "Enable jmx core metrics for the java app"
}
}
},
"Scale": {
"type": "object",
"description": "Container App scaling configurations.",
"properties": {
"minReplicas": {
"type": "integer",
"format": "int32",
"description": "Optional. Minimum number of container replicas."
},
"maxReplicas": {
"type": "integer",
"format": "int32",
"description": "Optional. Maximum number of container replicas. Defaults to 10 if not set.",
"default": 10
},
"cooldownPeriod": {
"type": "integer",
"format": "int32",
"description": "Optional. KEDA Cooldown Period in seconds. Defaults to 300 seconds if not set."
},
"pollingInterval": {
"type": "integer",
"format": "int32",
"description": "Optional. KEDA Polling Interval in seconds. Defaults to 30 seconds if not set."
},
"rules": {
"type": "array",
"description": "Scaling rules.",
"items": {
"$ref": "#/definitions/ScaleRule"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"ScaleConfiguration": {
"type": "object",
"description": "Scale configuration.",
"properties": {
"maxConcurrentSessions": {
"type": "integer",
"format": "int32",
"description": "The maximum count of sessions at the same time."
},
"readySessionInstances": {
"type": "integer",
"format": "int32",
"description": "The minimum count of ready session instances."
}
}
},
"ScaleRule": {
"type": "object",
"description": "Container App container scaling rule.",
"properties": {
"name": {
"type": "string",
"description": "Scale Rule Name"
},
"azureQueue": {
"$ref": "#/definitions/QueueScaleRule",
"description": "Azure Queue based scaling."
},
"custom": {
"$ref": "#/definitions/CustomScaleRule",
"description": "Custom scale rule."
},
"http": {
"$ref": "#/definitions/HttpScaleRule",
"description": "HTTP requests based scaling."
},
"tcp": {
"$ref": "#/definitions/TcpScaleRule",
"description": "Tcp requests based scaling."
}
}
},
"ScaleRuleAuth": {
"type": "object",
"description": "Auth Secrets for Scale Rule",
"properties": {
"secretRef": {
"type": "string",
"description": "Name of the secret from which to pull the auth params."
},
"triggerParameter": {
"type": "string",
"description": "Trigger Parameter that uses the secret"
}
}
},
"ScheduledEntries": {
"type": "object",
"description": "List of maintenance schedules for a managed environment.",
"properties": {
"scheduledEntries": {
"type": "array",
"description": "List of maintenance schedules for a managed environment.",
"items": {
"$ref": "#/definitions/ScheduledEntry"
},
"x-ms-client-name": "ScheduledEntries",
"x-ms-identifiers": []
}
},
"required": [
"scheduledEntries"
]
},
"ScheduledEntry": {
"type": "object",
"description": "Maintenance schedule entry for a managed environment.",
"properties": {
"weekDay": {
"$ref": "#/definitions/WeekDay",
"description": "Day of the week when a managed environment can be patched."
},
"startHourUtc": {
"type": "integer",
"format": "int32",
"description": "Start hour after which managed environment maintenance can start from 0 to 23 hour."
},
"durationHours": {
"type": "integer",
"format": "int32",
"description": "Length of maintenance window range from 8 to 24 hours."
}
},
"required": [
"weekDay",
"startHourUtc",
"durationHours"
]
},
"Scheme": {
"type": "string",
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"enum": [
"HTTP",
"HTTPS"
],
"x-ms-enum": {
"name": "Scheme",
"modelAsString": true,
"values": [
{
"name": "HTTP",
"value": "HTTP",
"description": "HTTP"
},
{
"name": "HTTPS",
"value": "HTTPS",
"description": "HTTPS"
}
]
}
},
"Secret": {
"type": "object",
"description": "Secret definition.",
"properties": {
"name": {
"type": "string",
"description": "Secret Name."
},
"value": {
"type": "string",
"format": "password",
"description": "Secret Value.",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
},
"identity": {
"type": "string",
"description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity."
},
"keyVaultUrl": {
"type": "string",
"description": "Azure Key Vault URL pointing to the secret referenced by the container app."
}
}
},
"SecretKeyVaultProperties": {
"type": "object",
"description": "Properties for a secret stored in a Key Vault.",
"properties": {
"identity": {
"type": "string",
"description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity."
},
"keyVaultUrl": {
"type": "string",
"description": "URL pointing to the Azure Key Vault secret."
}
}
},
"SecretVolumeItem": {
"type": "object",
"description": "Secret to be added to volume.",
"properties": {
"secretRef": {
"type": "string",
"description": "Name of the Container App secret from which to pull the secret value."
},
"path": {
"type": "string",
"description": "Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef."
}
}
},
"SecretsCollection": {
"type": "object",
"description": "Container App Secrets Collection ARM resource.",
"properties": {
"value": {
"type": "array",
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/ContainerAppSecret"
},
"x-ms-identifiers": [
"name"
]
}
},
"required": [
"value"
]
},
"Service": {
"type": "object",
"description": "Container App to be a dev service",
"properties": {
"type": {
"type": "string",
"description": "Dev ContainerApp service type"
}
},
"required": [
"type"
]
},
"ServiceBind": {
"type": "object",
"description": "Configuration to bind a ContainerApp to a dev ContainerApp Service",
"properties": {
"serviceId": {
"type": "string",
"description": "Resource id of the target service"
},
"name": {
"type": "string",
"description": "Name of the service bind"
}
}
},
"SessionContainer": {
"type": "object",
"description": "Container definitions for the sessions of the session pool.",
"properties": {
"image": {
"type": "string",
"description": "Container image tag."
},
"name": {
"type": "string",
"description": "Custom container name."
},
"command": {
"type": "array",
"description": "Container start command.",
"items": {
"type": "string"
}
},
"args": {
"type": "array",
"description": "Container start command arguments.",
"items": {
"type": "string"
}
},
"env": {
"type": "array",
"description": "Container environment variables.",
"items": {
"$ref": "#/definitions/EnvironmentVar"
},
"x-ms-identifiers": [
"name"
]
},
"resources": {
"$ref": "#/definitions/SessionContainerResources",
"description": "Container resource requirements."
}
}
},
"SessionContainerResources": {
"type": "object",
"description": "Container resource requirements for sessions of the session pool.",
"properties": {
"cpu": {
"type": "number",
"format": "double",
"description": "Required CPU in cores, e.g. 0.5"
},
"memory": {
"type": "string",
"description": "Required memory, e.g. \"250Mb\""
}
}
},
"SessionIngress": {
"type": "object",
"description": "Session pool ingress configuration.",
"properties": {
"targetPort": {
"type": "integer",
"format": "int32",
"description": "Target port in containers for traffic from ingress"
}
}
},
"SessionNetworkConfiguration": {
"type": "object",
"description": "Session network configuration.",
"properties": {
"status": {
"$ref": "#/definitions/SessionNetworkStatus",
"description": "Network status for the sessions."
}
}
},
"SessionNetworkStatus": {
"type": "string",
"description": "Network status for the sessions.",
"enum": [
"EgressEnabled",
"EgressDisabled"
],
"x-ms-enum": {
"name": "SessionNetworkStatus",
"modelAsString": true,
"values": [
{
"name": "EgressEnabled",
"value": "EgressEnabled",
"description": "EgressEnabled"
},
{
"name": "EgressDisabled",
"value": "EgressDisabled",
"description": "EgressDisabled"
}
]
}
},
"SessionPool": {
"type": "object",
"description": "Container App session pool.",
"properties": {
"properties": {
"$ref": "#/definitions/SessionPoolProperties",
"description": "Container App session pool resource specific properties",
"x-ms-client-flatten": true
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "The managed service identities assigned to this resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"SessionPoolCollection": {
"type": "object",
"description": "Session pool collection Azure resource.",
"properties": {
"value": {
"type": "array",
"description": "The SessionPool items on this page",
"items": {
"$ref": "#/definitions/SessionPool"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"SessionPoolProperties": {
"type": "object",
"description": "Container App session pool resource specific properties",
"properties": {
"environmentId": {
"type": "string",
"format": "arm-id",
"description": "Resource ID of the session pool's environment.",
"x-ms-mutability": [
"read",
"create"
],
"x-ms-arm-id-details": {
"allowedResources": [
{
"type": "Microsoft.App/managedEnvironments"
}
]
}
},
"containerType": {
"$ref": "#/definitions/ContainerType",
"description": "The container type of the sessions. You can use your own container to build the session pool, or you can use a predefined container to run workload with specific language."
},
"poolManagementType": {
"$ref": "#/definitions/PoolManagementType",
"description": "The pool management type of the session pool."
},
"nodeCount": {
"type": "integer",
"format": "int32",
"description": "The number of nodes the session pool is using.",
"readOnly": true
},
"scaleConfiguration": {
"$ref": "#/definitions/ScaleConfiguration",
"description": "The scale configuration of the session pool."
},
"secrets": {
"type": "array",
"description": "The secrets of the session pool.",
"items": {
"$ref": "#/definitions/SessionPoolSecret"
},
"x-ms-identifiers": [
"name"
]
},
"dynamicPoolConfiguration": {
"$ref": "#/definitions/DynamicPoolConfiguration",
"description": "The pool configuration if the poolManagementType is dynamic."
},
"customContainerTemplate": {
"$ref": "#/definitions/CustomContainerTemplate",
"description": "The custom container configuration if the containerType is CustomContainer."
},
"sessionNetworkConfiguration": {
"$ref": "#/definitions/SessionNetworkConfiguration",
"description": "The network configuration of the sessions in the session pool."
},
"poolManagementEndpoint": {
"type": "string",
"format": "uri",
"description": "The endpoint to manage the pool.",
"readOnly": true
},
"provisioningState": {
"$ref": "#/definitions/SessionPoolProvisioningState",
"description": "Provisioning state of the session pool.",
"readOnly": true
},
"managedIdentitySettings": {
"type": "array",
"description": "Optional settings for a Managed Identity that is assigned to the Session pool.",
"items": {
"$ref": "#/definitions/ManagedIdentitySetting"
},
"x-ms-identifiers": [
"identity"
]
}
}
},
"SessionPoolProvisioningState": {
"type": "string",
"description": "Provisioning state of the session pool.",
"enum": [
"InProgress",
"Succeeded",
"Failed",
"Canceled",
"Deleting"
],
"x-ms-enum": {
"name": "SessionPoolProvisioningState",
"modelAsString": true,
"values": [
{
"name": "InProgress",
"value": "InProgress",
"description": "InProgress"
},
{
"name": "Succeeded",
"value": "Succeeded",
"description": "Succeeded"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Canceled",
"value": "Canceled",
"description": "Canceled"
},
{
"name": "Deleting",
"value": "Deleting",
"description": "Deleting"
}
]
}
},
"SessionPoolSecret": {
"type": "object",
"description": "Secret definition.",
"properties": {
"name": {
"type": "string",
"description": "Secret Name."
},
"value": {
"type": "string",
"format": "password",
"description": "Secret Value.",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
}
}
},
"SessionPoolUpdatableProperties": {
"type": "object",
"description": "Container App session pool updatable properties.",
"properties": {
"tags": {
"type": "object",
"description": "Resource tags.",
"additionalProperties": {
"type": "string"
},
"x-ms-mutability": [
"read",
"update",
"create"
]
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "Managed identities needed by a session pool to interact with other Azure services to not maintain any secrets or credentials in code."
},
"properties": {
"$ref": "#/definitions/SessionPoolUpdatablePropertiesProperties",
"description": "Session pool resource specific updatable properties.",
"x-ms-client-flatten": true
}
}
},
"SessionPoolUpdatablePropertiesProperties": {
"type": "object",
"description": "Session pool resource specific updatable properties.",
"properties": {
"scaleConfiguration": {
"$ref": "#/definitions/ScaleConfiguration",
"description": "The scale configuration of the session pool."
},
"secrets": {
"type": "array",
"description": "The secrets of the session pool.",
"items": {
"$ref": "#/definitions/SessionPoolSecret"
},
"x-ms-identifiers": [
"name"
]
},
"dynamicPoolConfiguration": {
"$ref": "#/definitions/DynamicPoolConfiguration",
"description": "The pool configuration if the poolManagementType is dynamic."
},
"customContainerTemplate": {
"$ref": "#/definitions/CustomContainerTemplate",
"description": "The custom container configuration if the containerType is CustomContainer."
},
"sessionNetworkConfiguration": {
"$ref": "#/definitions/SessionNetworkConfiguration",
"description": "The network configuration of the sessions in the session pool."
}
}
},
"SessionRegistryCredentials": {
"type": "object",
"description": "Session pool private registry credentials.",
"properties": {
"server": {
"type": "string",
"description": "Container registry server."
},
"username": {
"type": "string",
"description": "Container registry username."
},
"passwordSecretRef": {
"type": "string",
"description": "The name of the secret that contains the registry login password"
},
"identity": {
"type": "string",
"description": "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'"
}
}
},
"SourceControl": {
"type": "object",
"description": "Container App SourceControl.",
"properties": {
"properties": {
"$ref": "#/definitions/SourceControlProperties",
"description": "SourceControl resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"SourceControlCollection": {
"type": "object",
"description": "SourceControl collection ARM resource.",
"properties": {
"value": {
"type": "array",
"description": "The SourceControl items on this page",
"items": {
"$ref": "#/definitions/SourceControl"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"SourceControlOperationState": {
"type": "string",
"description": "Current provisioning State of the operation",
"enum": [
"InProgress",
"Succeeded",
"Failed",
"Canceled"
],
"x-ms-enum": {
"name": "SourceControlOperationState",
"modelAsString": true,
"values": [
{
"name": "InProgress",
"value": "InProgress",
"description": "InProgress"
},
{
"name": "Succeeded",
"value": "Succeeded",
"description": "Succeeded"
},
{
"name": "Failed",
"value": "Failed",
"description": "Failed"
},
{
"name": "Canceled",
"value": "Canceled",
"description": "Canceled"
}
]
}
},
"SourceControlProperties": {
"type": "object",
"description": "SourceControl resource specific properties",
"properties": {
"operationState": {
"$ref": "#/definitions/SourceControlOperationState",
"description": "Current provisioning State of the operation",
"readOnly": true
},
"repoUrl": {
"type": "string",
"description": "The repo url which will be integrated to ContainerApp."
},
"branch": {
"type": "string",
"description": "The branch which will trigger the auto deployment"
},
"githubActionConfiguration": {
"$ref": "#/definitions/GithubActionConfiguration",
"description": "Container App Revision Template with all possible settings and the\ndefaults if user did not provide them. The defaults are populated\nas they were at the creation time"
}
}
},
"SpringBootAdminComponent": {
"type": "object",
"description": "Spring Boot Admin properties.",
"properties": {
"ingress": {
"$ref": "#/definitions/JavaComponentIngress",
"description": "Java Component Ingress configurations."
}
},
"allOf": [
{
"$ref": "#/definitions/JavaComponentProperties"
}
],
"x-ms-discriminator-value": "SpringBootAdmin"
},
"SpringCloudConfigComponent": {
"type": "object",
"description": "Spring Cloud Config properties.",
"allOf": [
{
"$ref": "#/definitions/JavaComponentProperties"
}
],
"x-ms-discriminator-value": "SpringCloudConfig"
},
"SpringCloudEurekaComponent": {
"type": "object",
"description": "Spring Cloud Eureka properties.",
"properties": {
"ingress": {
"$ref": "#/definitions/JavaComponentIngress",
"description": "Java Component Ingress configurations."
}
},
"allOf": [
{
"$ref": "#/definitions/JavaComponentProperties"
}
],
"x-ms-discriminator-value": "SpringCloudEureka"
},
"StorageType": {
"type": "string",
"description": "Storage type for the volume. If not provided, use EmptyDir.",
"enum": [
"AzureFile",
"EmptyDir",
"Secret",
"NfsAzureFile"
],
"x-ms-enum": {
"name": "StorageType",
"modelAsString": true,
"values": [
{
"name": "AzureFile",
"value": "AzureFile",
"description": "AzureFile"
},
{
"name": "EmptyDir",
"value": "EmptyDir",
"description": "EmptyDir"
},
{
"name": "Secret",
"value": "Secret",
"description": "Secret"
},
{
"name": "NfsAzureFile",
"value": "NfsAzureFile",
"description": "NfsAzureFile"
}
]
}
},
"TcpScaleRule": {
"type": "object",
"description": "Container App container Tcp scaling rule.",
"properties": {
"metadata": {
"type": "object",
"description": "Metadata properties to describe tcp scale rule.",
"additionalProperties": {
"type": "string"
}
},
"auth": {
"type": "array",
"description": "Authentication secrets for the tcp scale rule.",
"items": {
"$ref": "#/definitions/ScaleRuleAuth"
},
"x-ms-identifiers": [
"triggerParameter"
]
},
"identity": {
"type": "string",
"description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity."
}
}
},
"Template": {
"type": "object",
"description": "Container App versioned application definition.\nDefines the desired state of an immutable revision.\nAny changes to this section Will result in a new revision being created",
"properties": {
"revisionSuffix": {
"type": "string",
"description": "User friendly suffix that is appended to the revision name"
},
"terminationGracePeriodSeconds": {
"type": "integer",
"format": "int64",
"description": "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."
},
"initContainers": {
"type": "array",
"description": "List of specialized containers that run before app containers.",
"items": {
"$ref": "#/definitions/InitContainer"
},
"x-ms-identifiers": [
"name"
]
},
"containers": {
"type": "array",
"description": "List of container definitions for the Container App.",
"items": {
"$ref": "#/definitions/Container"
},
"x-ms-identifiers": [
"name"
]
},
"scale": {
"$ref": "#/definitions/Scale",
"description": "Scaling properties for the Container App."
},
"volumes": {
"type": "array",
"description": "List of volume definitions for the Container App.",
"items": {
"$ref": "#/definitions/Volume"
},
"x-ms-identifiers": [
"name"
]
},
"serviceBinds": {
"type": "array",
"description": "List of container app services bound to the app",
"items": {
"$ref": "#/definitions/ServiceBind"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"TokenStore": {
"type": "object",
"description": "The configuration settings of the token store.",
"properties": {
"enabled": {
"type": "boolean",
"description": "true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\nThe default is false."
},
"tokenRefreshExtensionHours": {
"type": "number",
"format": "double",
"description": "The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."
},
"azureBlobStorage": {
"$ref": "#/definitions/BlobStorageTokenStore",
"description": "The configuration settings of the storage of the tokens if blob storage is used."
}
}
},
"TrafficWeight": {
"type": "object",
"description": "Traffic weight assigned to a revision",
"properties": {
"revisionName": {
"type": "string",
"description": "Name of a revision"
},
"weight": {
"type": "integer",
"format": "int32",
"description": "Traffic weight assigned to a revision"
},
"latestRevision": {
"type": "boolean",
"description": "Indicates that the traffic weight belongs to a latest stable revision",
"default": false
},
"label": {
"type": "string",
"description": "Associates a traffic label with a revision"
}
}
},
"Twitter": {
"type": "object",
"description": "The configuration settings of the Twitter provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the Twitter provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/TwitterRegistration",
"description": "The configuration settings of the app registration for the Twitter provider."
}
}
},
"TwitterRegistration": {
"type": "object",
"description": "The configuration settings of the app registration for the Twitter provider.",
"properties": {
"consumerKey": {
"type": "string",
"description": "The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"
},
"consumerSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."
}
}
},
"Type": {
"type": "string",
"description": "The type of probe.",
"enum": [
"Liveness",
"Readiness",
"Startup"
],
"x-ms-enum": {
"name": "Type",
"modelAsString": true,
"values": [
{
"name": "Liveness",
"value": "Liveness",
"description": "Liveness"
},
{
"name": "Readiness",
"value": "Readiness",
"description": "Readiness"
},
{
"name": "Startup",
"value": "Startup",
"description": "Startup"
}
]
}
},
"UnauthenticatedClientActionV2": {
"type": "string",
"description": "The action to take when an unauthenticated client attempts to access the app.",
"enum": [
"RedirectToLoginPage",
"AllowAnonymous",
"Return401",
"Return403"
],
"x-ms-enum": {
"name": "UnauthenticatedClientActionV2",
"modelAsString": false,
"values": [
{
"name": "RedirectToLoginPage",
"value": "RedirectToLoginPage",
"description": "RedirectToLoginPage"
},
{
"name": "AllowAnonymous",
"value": "AllowAnonymous",
"description": "AllowAnonymous"
},
{
"name": "Return401",
"value": "Return401",
"description": "Return401"
},
{
"name": "Return403",
"value": "Return403",
"description": "Return403"
}
]
}
},
"Usage": {
"type": "object",
"description": "Describes Compute Resource Usage.",
"properties": {
"unit": {
"type": "string",
"description": "An enum describing the unit of usage measurement.",
"enum": [
"Count"
],
"x-ms-enum": {
"modelAsString": false
}
},
"currentValue": {
"type": "number",
"format": "float",
"description": "The current usage of the resource."
},
"limit": {
"type": "number",
"format": "float",
"description": "The maximum permitted usage of the resource."
},
"name": {
"$ref": "#/definitions/UsageName",
"description": "The name of the type of usage."
}
},
"required": [
"unit",
"currentValue",
"limit",
"name"
]
},
"UsageName": {
"type": "object",
"description": "The Usage Names.",
"properties": {
"value": {
"type": "string",
"description": "The name of the resource."
},
"localizedValue": {
"type": "string",
"description": "The localized name of the resource."
}
}
},
"VnetConfiguration": {
"type": "object",
"description": "Configuration properties for apps environment to join a Virtual Network",
"properties": {
"internal": {
"type": "boolean",
"description": "Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property",
"x-ms-mutability": [
"read",
"create"
]
},
"infrastructureSubnetId": {
"type": "string",
"description": "Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges.",
"x-ms-mutability": [
"read",
"create"
]
},
"dockerBridgeCidr": {
"type": "string",
"description": "CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges.",
"x-ms-mutability": [
"read",
"create"
]
},
"platformReservedCidr": {
"type": "string",
"description": "IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges.",
"x-ms-mutability": [
"read",
"create"
]
},
"platformReservedDnsIP": {
"type": "string",
"description": "An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server.",
"x-ms-mutability": [
"read",
"create"
]
}
}
},
"Volume": {
"type": "object",
"description": "Volume definitions for the Container App.",
"properties": {
"name": {
"type": "string",
"description": "Volume name."
},
"storageType": {
"$ref": "#/definitions/StorageType",
"description": "Storage type for the volume. If not provided, use EmptyDir."
},
"storageName": {
"type": "string",
"description": "Name of storage resource. No need to provide for EmptyDir and Secret."
},
"secrets": {
"type": "array",
"description": "List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume.",
"items": {
"$ref": "#/definitions/SecretVolumeItem"
},
"x-ms-identifiers": [
"secretRef"
]
},
"mountOptions": {
"type": "string",
"description": "Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string."
}
}
},
"VolumeMount": {
"type": "object",
"description": "Volume mount for the Container App.",
"properties": {
"volumeName": {
"type": "string",
"description": "This must match the Name of a Volume."
},
"mountPath": {
"type": "string",
"description": "Path within the container at which the volume should be mounted.Must not contain ':'."
},
"subPath": {
"type": "string",
"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)."
}
}
},
"WeekDay": {
"type": "string",
"description": "Day of the week when a managed environment can be patched.",
"enum": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"x-ms-enum": {
"name": "WeekDay",
"modelAsString": false,
"values": [
{
"name": "Monday",
"value": "Monday",
"description": "Monday"
},
{
"name": "Tuesday",
"value": "Tuesday",
"description": "Tuesday"
},
{
"name": "Wednesday",
"value": "Wednesday",
"description": "Wednesday"
},
{
"name": "Thursday",
"value": "Thursday",
"description": "Thursday"
},
{
"name": "Friday",
"value": "Friday",
"description": "Friday"
},
{
"name": "Saturday",
"value": "Saturday",
"description": "Saturday"
},
{
"name": "Sunday",
"value": "Sunday",
"description": "Sunday"
}
]
}
},
"WorkflowEnvelope": {
"type": "object",
"description": "Schema for the workflow object.",
"properties": {
"properties": {
"$ref": "#/definitions/WorkflowEnvelopeProperties",
"description": "Additional workflow properties."
},
"kind": {
"$ref": "#/definitions/WorkflowKind",
"description": "Gets the logic app hybrid workflow kind."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"WorkflowEnvelopeCollection": {
"type": "object",
"description": "Collection of workflow information elements.",
"properties": {
"value": {
"type": "array",
"description": "The WorkflowEnvelope items on this page",
"items": {
"$ref": "#/definitions/WorkflowEnvelope"
}
},
"nextLink": {
"type": "string",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WorkflowEnvelopeProperties": {
"type": "object",
"description": "Additional workflow properties.",
"properties": {
"files": {
"description": "Gets or sets the files."
},
"flowState": {
"$ref": "#/definitions/WorkflowState",
"description": "Gets or sets the state of the workflow."
},
"health": {
"$ref": "#/definitions/WorkflowHealth",
"description": "Gets or sets workflow health."
}
}
},
"WorkflowHealth": {
"type": "object",
"description": "Represents the workflow health.",
"properties": {
"state": {
"$ref": "#/definitions/WorkflowHealthState",
"description": "Gets or sets the workflow health state."
},
"error": {
"$ref": "#/definitions/ErrorEntity",
"description": "Gets or sets the workflow error."
}
},
"required": [
"state"
]
},
"WorkflowHealthState": {
"type": "string",
"description": "Gets or sets the workflow health state.",
"enum": [
"NotSpecified",
"Healthy",
"Unhealthy",
"Unknown"
],
"x-ms-enum": {
"name": "WorkflowHealthState",
"modelAsString": false,
"values": [
{
"name": "NotSpecified",
"value": "NotSpecified",
"description": "NotSpecified"
},
{
"name": "Healthy",
"value": "Healthy",
"description": "Healthy"
},
{
"name": "Unhealthy",
"value": "Unhealthy",
"description": "Unhealthy"
},
{
"name": "Unknown",
"value": "Unknown",
"description": "Unknown"
}
]
}
},
"WorkflowKind": {
"type": "string",
"description": "Gets the logic app hybrid workflow kind.",
"enum": [
"Stateful",
"Stateless",
"Agentic"
],
"x-ms-enum": {
"name": "WorkflowKind",
"modelAsString": true,
"values": [
{
"name": "Stateful",
"value": "Stateful",
"description": "Stateful"
},
{
"name": "Stateless",
"value": "Stateless",
"description": "Stateless"
},
{
"name": "Agentic",
"value": "Agentic",
"description": "Agentic"
}
]
}
},
"WorkflowState": {
"type": "string",
"description": "The workflow state.",
"enum": [
"NotSpecified",
"Completed",
"Enabled",
"Disabled",
"Deleted",
"Suspended"
],
"x-ms-enum": {
"name": "WorkflowState",
"modelAsString": true,
"values": [
{
"name": "NotSpecified",
"value": "NotSpecified",
"description": "NotSpecified"
},
{
"name": "Completed",
"value": "Completed",
"description": "Completed"
},
{
"name": "Enabled",
"value": "Enabled",
"description": "Enabled"
},
{
"name": "Disabled",
"value": "Disabled",
"description": "Disabled"
},
{
"name": "Deleted",
"value": "Deleted",
"description": "Deleted"
},
{
"name": "Suspended",
"value": "Suspended",
"description": "Suspended"
}
]
}
},
"WorkloadProfile": {
"type": "object",
"description": "Workload profile to scope container app execution.",
"properties": {
"name": {
"type": "string",
"description": "Workload profile type for the workloads to run on."
},
"workloadProfileType": {
"type": "string",
"description": "Workload profile type for the workloads to run on."
},
"minimumCount": {
"type": "integer",
"format": "int32",
"description": "The minimum capacity."
},
"maximumCount": {
"type": "integer",
"format": "int32",
"description": "The maximum capacity."
}
},
"required": [
"name",
"workloadProfileType"
]
},
"WorkloadProfileStatesProperties": {
"type": "object",
"description": "Workload Profile resource specific properties.",
"properties": {
"minimumCount": {
"type": "integer",
"format": "int32",
"description": "Minimum count of instances."
},
"maximumCount": {
"type": "integer",
"format": "int32",
"description": "Maximum count of nodes."
},
"currentCount": {
"type": "integer",
"format": "int32",
"description": "Current count of nodes."
}
}
},
"workloadProfileStates": {
"type": "object",
"description": "Collection of all the workload Profile States for a Managed Environment..",
"properties": {
"properties": {
"$ref": "#/definitions/WorkloadProfileStatesProperties",
"description": "Workload Profile resource specific properties."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"workloadProfileStatesCollection": {
"type": "object",
"description": "Collection of workloadProfileStates",
"properties": {
"value": {
"type": "array",
"description": "The workloadProfileStates items on this page",
"items": {
"$ref": "#/definitions/workloadProfileStates"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
}
},
"parameters": {}
}