Microsoft.App (preview:2025-02-02)

2025/05/09 • 180 new methods

AppResiliency_CreateOrUpdate (new)
Description :  Create or update container app resiliency policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{appName}/resiliencyPolicies/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
name:
{
Description: Name of the resiliency policy. ,
Required: True ,
}
string ,
resiliencyEnvelope:
{
Description: The resiliency policy to create or update. ,
Required: True ,
}
{
properties:
{
Description: App Resiliency resource specific properties ,
Required: False ,
}
{
timeoutPolicy:
{
Description: Policy to set request timeouts ,
Required: False ,
}
{
responseTimeoutInSeconds:
{
Description: Timeout, in seconds, for a request to respond ,
Format: int32 ,
Required: False ,
}
integer ,
connectionTimeoutInSeconds:
{
Description: Timeout, in seconds, for a request to initiate a connection ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
httpRetryPolicy:
{
Description: Policy that defines http request retry conditions ,
Required: False ,
}
{
maxRetries:
{
Description: Maximum number of times a request will retry ,
Format: int32 ,
Required: False ,
}
integer ,
retryBackOff:
{
Description: Settings for retry backoff characteristics ,
Required: False ,
}
{
initialDelayInMilliseconds:
{
Description: Initial delay, in milliseconds, before retrying a request ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInMilliseconds:
{
Description: Maximum interval, in milliseconds, between retries ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
matches:
{
Description: Conditions that must be met for a request to be retried ,
Required: False ,
}
{
headers:
{
Description: Headers that must be present for a request to be retried ,
Required: False ,
}
[
{
header:
{
Description: Name of the header ,
Required: False ,
}
string ,
match:
{
Description: Type of match to perform ,
Required: False ,
}
{
exactMatch:
{
Description: Exact value of the header ,
Required: False ,
}
string ,
prefixMatch:
{
Description: Prefix value of the header ,
Required: False ,
}
string ,
suffixMatch:
{
Description: Suffix value of the header ,
Required: False ,
}
string ,
regexMatch:
{
Description: Regex value of the header ,
Required: False ,
}
string ,
}
,
}
,
]
,
httpStatusCodes:
{
Description: Additional http status codes that can trigger a retry ,
Required: False ,
}
[
integer ,
]
,
errors:
{
Description: Errors that can trigger a retry ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
tcpRetryPolicy:
{
Description: Policy that defines tcp request retry conditions ,
Required: False ,
}
{
maxConnectAttempts:
{
Description: Maximum number of attempts to connect to the tcp service ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
circuitBreakerPolicy:
{
Description: Policy that defines circuit breaker conditions ,
Required: False ,
}
{
consecutiveErrors:
{
Description: Number of consecutive errors before the circuit breaker opens ,
Format: int32 ,
Required: False ,
}
integer ,
intervalInSeconds:
{
Description: The time interval, in seconds, between endpoint checks. This can result in opening the circuit breaker if the check fails as well as closing the circuit breaker if the check succeeds. Defaults to 10s. ,
Format: int32 ,
Required: False ,
}
integer ,
maxEjectionPercent:
{
Description: Maximum percentage of hosts that will be ejected after failure threshold has been met ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
httpConnectionPool:
{
Description: Defines parameters for http connection pooling ,
Required: False ,
}
{
http1MaxPendingRequests:
{
Description: Maximum number of pending http1 requests allowed ,
Format: int32 ,
Required: False ,
}
integer ,
http2MaxRequests:
{
Description: Maximum number of http2 requests allowed ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tcpConnectionPool:
{
Description: Defines parameters for tcp connection pooling ,
Required: False ,
}
{
maxConnections:
{
Description: Maximum number of tcp connections allowed ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: App Resiliency resource specific properties ,
Required: False ,
}
{
timeoutPolicy:
{
Description: Policy to set request timeouts ,
Required: False ,
}
{
responseTimeoutInSeconds:
{
Description: Timeout, in seconds, for a request to respond ,
Format: int32 ,
Required: False ,
}
integer ,
connectionTimeoutInSeconds:
{
Description: Timeout, in seconds, for a request to initiate a connection ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
httpRetryPolicy:
{
Description: Policy that defines http request retry conditions ,
Required: False ,
}
{
maxRetries:
{
Description: Maximum number of times a request will retry ,
Format: int32 ,
Required: False ,
}
integer ,
retryBackOff:
{
Description: Settings for retry backoff characteristics ,
Required: False ,
}
{
initialDelayInMilliseconds:
{
Description: Initial delay, in milliseconds, before retrying a request ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInMilliseconds:
{
Description: Maximum interval, in milliseconds, between retries ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
matches:
{
Description: Conditions that must be met for a request to be retried ,
Required: False ,
}
{
headers:
{
Description: Headers that must be present for a request to be retried ,
Required: False ,
}
[
{
header:
{
Description: Name of the header ,
Required: False ,
}
string ,
match:
{
Description: Type of match to perform ,
Required: False ,
}
{
exactMatch:
{
Description: Exact value of the header ,
Required: False ,
}
string ,
prefixMatch:
{
Description: Prefix value of the header ,
Required: False ,
}
string ,
suffixMatch:
{
Description: Suffix value of the header ,
Required: False ,
}
string ,
regexMatch:
{
Description: Regex value of the header ,
Required: False ,
}
string ,
}
,
}
,
]
,
httpStatusCodes:
{
Description: Additional http status codes that can trigger a retry ,
Required: False ,
}
[
integer ,
]
,
errors:
{
Description: Errors that can trigger a retry ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
tcpRetryPolicy:
{
Description: Policy that defines tcp request retry conditions ,
Required: False ,
}
{
maxConnectAttempts:
{
Description: Maximum number of attempts to connect to the tcp service ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
circuitBreakerPolicy:
{
Description: Policy that defines circuit breaker conditions ,
Required: False ,
}
{
consecutiveErrors:
{
Description: Number of consecutive errors before the circuit breaker opens ,
Format: int32 ,
Required: False ,
}
integer ,
intervalInSeconds:
{
Description: The time interval, in seconds, between endpoint checks. This can result in opening the circuit breaker if the check fails as well as closing the circuit breaker if the check succeeds. Defaults to 10s. ,
Format: int32 ,
Required: False ,
}
integer ,
maxEjectionPercent:
{
Description: Maximum percentage of hosts that will be ejected after failure threshold has been met ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
httpConnectionPool:
{
Description: Defines parameters for http connection pooling ,
Required: False ,
}
{
http1MaxPendingRequests:
{
Description: Maximum number of pending http1 requests allowed ,
Format: int32 ,
Required: False ,
}
integer ,
http2MaxRequests:
{
Description: Maximum number of http2 requests allowed ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tcpConnectionPool:
{
Description: Defines parameters for tcp connection pooling ,
Required: False ,
}
{
maxConnections:
{
Description: Maximum number of tcp connections allowed ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: App Resiliency resource specific properties ,
Required: False ,
}
{
timeoutPolicy:
{
Description: Policy to set request timeouts ,
Required: False ,
}
{
responseTimeoutInSeconds:
{
Description: Timeout, in seconds, for a request to respond ,
Format: int32 ,
Required: False ,
}
integer ,
connectionTimeoutInSeconds:
{
Description: Timeout, in seconds, for a request to initiate a connection ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
httpRetryPolicy:
{
Description: Policy that defines http request retry conditions ,
Required: False ,
}
{
maxRetries:
{
Description: Maximum number of times a request will retry ,
Format: int32 ,
Required: False ,
}
integer ,
retryBackOff:
{
Description: Settings for retry backoff characteristics ,
Required: False ,
}
{
initialDelayInMilliseconds:
{
Description: Initial delay, in milliseconds, before retrying a request ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInMilliseconds:
{
Description: Maximum interval, in milliseconds, between retries ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
matches:
{
Description: Conditions that must be met for a request to be retried ,
Required: False ,
}
{
headers:
{
Description: Headers that must be present for a request to be retried ,
Required: False ,
}
[
{
header:
{
Description: Name of the header ,
Required: False ,
}
string ,
match:
{
Description: Type of match to perform ,
Required: False ,
}
{
exactMatch:
{
Description: Exact value of the header ,
Required: False ,
}
string ,
prefixMatch:
{
Description: Prefix value of the header ,
Required: False ,
}
string ,
suffixMatch:
{
Description: Suffix value of the header ,
Required: False ,
}
string ,
regexMatch:
{
Description: Regex value of the header ,
Required: False ,
}
string ,
}
,
}
,
]
,
httpStatusCodes:
{
Description: Additional http status codes that can trigger a retry ,
Required: False ,
}
[
integer ,
]
,
errors:
{
Description: Errors that can trigger a retry ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
tcpRetryPolicy:
{
Description: Policy that defines tcp request retry conditions ,
Required: False ,
}
{
maxConnectAttempts:
{
Description: Maximum number of attempts to connect to the tcp service ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
circuitBreakerPolicy:
{
Description: Policy that defines circuit breaker conditions ,
Required: False ,
}
{
consecutiveErrors:
{
Description: Number of consecutive errors before the circuit breaker opens ,
Format: int32 ,
Required: False ,
}
integer ,
intervalInSeconds:
{
Description: The time interval, in seconds, between endpoint checks. This can result in opening the circuit breaker if the check fails as well as closing the circuit breaker if the check succeeds. Defaults to 10s. ,
Format: int32 ,
Required: False ,
}
integer ,
maxEjectionPercent:
{
Description: Maximum percentage of hosts that will be ejected after failure threshold has been met ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
httpConnectionPool:
{
Description: Defines parameters for http connection pooling ,
Required: False ,
}
{
http1MaxPendingRequests:
{
Description: Maximum number of pending http1 requests allowed ,
Format: int32 ,
Required: False ,
}
integer ,
http2MaxRequests:
{
Description: Maximum number of http2 requests allowed ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tcpConnectionPool:
{
Description: Defines parameters for tcp connection pooling ,
Required: False ,
}
{
maxConnections:
{
Description: Maximum number of tcp connections allowed ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppResiliency_Update (new)
Description :  Update container app resiliency policy.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{appName}/resiliencyPolicies/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
name:
{
Description: Name of the resiliency policy. ,
Required: True ,
}
string ,
resiliencyEnvelope:
{
Description: The resiliency policy to update. ,
Required: True ,
}
{
properties:
{
Description: App Resiliency resource specific properties ,
Required: False ,
}
{
timeoutPolicy:
{
Description: Policy to set request timeouts ,
Required: False ,
}
{
responseTimeoutInSeconds:
{
Description: Timeout, in seconds, for a request to respond ,
Format: int32 ,
Required: False ,
}
integer ,
connectionTimeoutInSeconds:
{
Description: Timeout, in seconds, for a request to initiate a connection ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
httpRetryPolicy:
{
Description: Policy that defines http request retry conditions ,
Required: False ,
}
{
maxRetries:
{
Description: Maximum number of times a request will retry ,
Format: int32 ,
Required: False ,
}
integer ,
retryBackOff:
{
Description: Settings for retry backoff characteristics ,
Required: False ,
}
{
initialDelayInMilliseconds:
{
Description: Initial delay, in milliseconds, before retrying a request ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInMilliseconds:
{
Description: Maximum interval, in milliseconds, between retries ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
matches:
{
Description: Conditions that must be met for a request to be retried ,
Required: False ,
}
{
headers:
{
Description: Headers that must be present for a request to be retried ,
Required: False ,
}
[
{
header:
{
Description: Name of the header ,
Required: False ,
}
string ,
match:
{
Description: Type of match to perform ,
Required: False ,
}
{
exactMatch:
{
Description: Exact value of the header ,
Required: False ,
}
string ,
prefixMatch:
{
Description: Prefix value of the header ,
Required: False ,
}
string ,
suffixMatch:
{
Description: Suffix value of the header ,
Required: False ,
}
string ,
regexMatch:
{
Description: Regex value of the header ,
Required: False ,
}
string ,
}
,
}
,
]
,
httpStatusCodes:
{
Description: Additional http status codes that can trigger a retry ,
Required: False ,
}
[
integer ,
]
,
errors:
{
Description: Errors that can trigger a retry ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
tcpRetryPolicy:
{
Description: Policy that defines tcp request retry conditions ,
Required: False ,
}
{
maxConnectAttempts:
{
Description: Maximum number of attempts to connect to the tcp service ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
circuitBreakerPolicy:
{
Description: Policy that defines circuit breaker conditions ,
Required: False ,
}
{
consecutiveErrors:
{
Description: Number of consecutive errors before the circuit breaker opens ,
Format: int32 ,
Required: False ,
}
integer ,
intervalInSeconds:
{
Description: The time interval, in seconds, between endpoint checks. This can result in opening the circuit breaker if the check fails as well as closing the circuit breaker if the check succeeds. Defaults to 10s. ,
Format: int32 ,
Required: False ,
}
integer ,
maxEjectionPercent:
{
Description: Maximum percentage of hosts that will be ejected after failure threshold has been met ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
httpConnectionPool:
{
Description: Defines parameters for http connection pooling ,
Required: False ,
}
{
http1MaxPendingRequests:
{
Description: Maximum number of pending http1 requests allowed ,
Format: int32 ,
Required: False ,
}
integer ,
http2MaxRequests:
{
Description: Maximum number of http2 requests allowed ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tcpConnectionPool:
{
Description: Defines parameters for tcp connection pooling ,
Required: False ,
}
{
maxConnections:
{
Description: Maximum number of tcp connections allowed ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: App Resiliency resource specific properties ,
Required: False ,
}
{
timeoutPolicy:
{
Description: Policy to set request timeouts ,
Required: False ,
}
{
responseTimeoutInSeconds:
{
Description: Timeout, in seconds, for a request to respond ,
Format: int32 ,
Required: False ,
}
integer ,
connectionTimeoutInSeconds:
{
Description: Timeout, in seconds, for a request to initiate a connection ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
httpRetryPolicy:
{
Description: Policy that defines http request retry conditions ,
Required: False ,
}
{
maxRetries:
{
Description: Maximum number of times a request will retry ,
Format: int32 ,
Required: False ,
}
integer ,
retryBackOff:
{
Description: Settings for retry backoff characteristics ,
Required: False ,
}
{
initialDelayInMilliseconds:
{
Description: Initial delay, in milliseconds, before retrying a request ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInMilliseconds:
{
Description: Maximum interval, in milliseconds, between retries ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
matches:
{
Description: Conditions that must be met for a request to be retried ,
Required: False ,
}
{
headers:
{
Description: Headers that must be present for a request to be retried ,
Required: False ,
}
[
{
header:
{
Description: Name of the header ,
Required: False ,
}
string ,
match:
{
Description: Type of match to perform ,
Required: False ,
}
{
exactMatch:
{
Description: Exact value of the header ,
Required: False ,
}
string ,
prefixMatch:
{
Description: Prefix value of the header ,
Required: False ,
}
string ,
suffixMatch:
{
Description: Suffix value of the header ,
Required: False ,
}
string ,
regexMatch:
{
Description: Regex value of the header ,
Required: False ,
}
string ,
}
,
}
,
]
,
httpStatusCodes:
{
Description: Additional http status codes that can trigger a retry ,
Required: False ,
}
[
integer ,
]
,
errors:
{
Description: Errors that can trigger a retry ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
tcpRetryPolicy:
{
Description: Policy that defines tcp request retry conditions ,
Required: False ,
}
{
maxConnectAttempts:
{
Description: Maximum number of attempts to connect to the tcp service ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
circuitBreakerPolicy:
{
Description: Policy that defines circuit breaker conditions ,
Required: False ,
}
{
consecutiveErrors:
{
Description: Number of consecutive errors before the circuit breaker opens ,
Format: int32 ,
Required: False ,
}
integer ,
intervalInSeconds:
{
Description: The time interval, in seconds, between endpoint checks. This can result in opening the circuit breaker if the check fails as well as closing the circuit breaker if the check succeeds. Defaults to 10s. ,
Format: int32 ,
Required: False ,
}
integer ,
maxEjectionPercent:
{
Description: Maximum percentage of hosts that will be ejected after failure threshold has been met ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
httpConnectionPool:
{
Description: Defines parameters for http connection pooling ,
Required: False ,
}
{
http1MaxPendingRequests:
{
Description: Maximum number of pending http1 requests allowed ,
Format: int32 ,
Required: False ,
}
integer ,
http2MaxRequests:
{
Description: Maximum number of http2 requests allowed ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tcpConnectionPool:
{
Description: Defines parameters for tcp connection pooling ,
Required: False ,
}
{
maxConnections:
{
Description: Maximum number of tcp connections allowed ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppResiliency_Delete (new)
Description :  Delete container app resiliency policy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{appName}/resiliencyPolicies/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
name:
{
Description: Name of the resiliency policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppResiliency_Get (new)
Description :  Get container app resiliency policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{appName}/resiliencyPolicies/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
name:
{
Description: Name of the resiliency policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: App Resiliency resource specific properties ,
Required: False ,
}
{
timeoutPolicy:
{
Description: Policy to set request timeouts ,
Required: False ,
}
{
responseTimeoutInSeconds:
{
Description: Timeout, in seconds, for a request to respond ,
Format: int32 ,
Required: False ,
}
integer ,
connectionTimeoutInSeconds:
{
Description: Timeout, in seconds, for a request to initiate a connection ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
httpRetryPolicy:
{
Description: Policy that defines http request retry conditions ,
Required: False ,
}
{
maxRetries:
{
Description: Maximum number of times a request will retry ,
Format: int32 ,
Required: False ,
}
integer ,
retryBackOff:
{
Description: Settings for retry backoff characteristics ,
Required: False ,
}
{
initialDelayInMilliseconds:
{
Description: Initial delay, in milliseconds, before retrying a request ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInMilliseconds:
{
Description: Maximum interval, in milliseconds, between retries ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
matches:
{
Description: Conditions that must be met for a request to be retried ,
Required: False ,
}
{
headers:
{
Description: Headers that must be present for a request to be retried ,
Required: False ,
}
[
{
header:
{
Description: Name of the header ,
Required: False ,
}
string ,
match:
{
Description: Type of match to perform ,
Required: False ,
}
{
exactMatch:
{
Description: Exact value of the header ,
Required: False ,
}
string ,
prefixMatch:
{
Description: Prefix value of the header ,
Required: False ,
}
string ,
suffixMatch:
{
Description: Suffix value of the header ,
Required: False ,
}
string ,
regexMatch:
{
Description: Regex value of the header ,
Required: False ,
}
string ,
}
,
}
,
]
,
httpStatusCodes:
{
Description: Additional http status codes that can trigger a retry ,
Required: False ,
}
[
integer ,
]
,
errors:
{
Description: Errors that can trigger a retry ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
tcpRetryPolicy:
{
Description: Policy that defines tcp request retry conditions ,
Required: False ,
}
{
maxConnectAttempts:
{
Description: Maximum number of attempts to connect to the tcp service ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
circuitBreakerPolicy:
{
Description: Policy that defines circuit breaker conditions ,
Required: False ,
}
{
consecutiveErrors:
{
Description: Number of consecutive errors before the circuit breaker opens ,
Format: int32 ,
Required: False ,
}
integer ,
intervalInSeconds:
{
Description: The time interval, in seconds, between endpoint checks. This can result in opening the circuit breaker if the check fails as well as closing the circuit breaker if the check succeeds. Defaults to 10s. ,
Format: int32 ,
Required: False ,
}
integer ,
maxEjectionPercent:
{
Description: Maximum percentage of hosts that will be ejected after failure threshold has been met ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
httpConnectionPool:
{
Description: Defines parameters for http connection pooling ,
Required: False ,
}
{
http1MaxPendingRequests:
{
Description: Maximum number of pending http1 requests allowed ,
Format: int32 ,
Required: False ,
}
integer ,
http2MaxRequests:
{
Description: Maximum number of http2 requests allowed ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tcpConnectionPool:
{
Description: Defines parameters for tcp connection pooling ,
Required: False ,
}
{
maxConnections:
{
Description: Maximum number of tcp connections allowed ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AppResiliency_List (new)
Description :  List container app resiliency policies.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{appName}/resiliencyPolicies
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
appName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: App Resiliency resource specific properties ,
Required: False ,
}
{
timeoutPolicy:
{
Description: Policy to set request timeouts ,
Required: False ,
}
{
responseTimeoutInSeconds:
{
Description: Timeout, in seconds, for a request to respond ,
Format: int32 ,
Required: False ,
}
integer ,
connectionTimeoutInSeconds:
{
Description: Timeout, in seconds, for a request to initiate a connection ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
httpRetryPolicy:
{
Description: Policy that defines http request retry conditions ,
Required: False ,
}
{
maxRetries:
{
Description: Maximum number of times a request will retry ,
Format: int32 ,
Required: False ,
}
integer ,
retryBackOff:
{
Description: Settings for retry backoff characteristics ,
Required: False ,
}
{
initialDelayInMilliseconds:
{
Description: Initial delay, in milliseconds, before retrying a request ,
Format: int64 ,
Required: False ,
}
integer ,
maxIntervalInMilliseconds:
{
Description: Maximum interval, in milliseconds, between retries ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
matches:
{
Description: Conditions that must be met for a request to be retried ,
Required: False ,
}
{
headers:
{
Description: Headers that must be present for a request to be retried ,
Required: False ,
}
[
{
header:
{
Description: Name of the header ,
Required: False ,
}
string ,
match:
{
Description: Type of match to perform ,
Required: False ,
}
{
exactMatch:
{
Description: Exact value of the header ,
Required: False ,
}
string ,
prefixMatch:
{
Description: Prefix value of the header ,
Required: False ,
}
string ,
suffixMatch:
{
Description: Suffix value of the header ,
Required: False ,
}
string ,
regexMatch:
{
Description: Regex value of the header ,
Required: False ,
}
string ,
}
,
}
,
]
,
httpStatusCodes:
{
Description: Additional http status codes that can trigger a retry ,
Required: False ,
}
[
integer ,
]
,
errors:
{
Description: Errors that can trigger a retry ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
tcpRetryPolicy:
{
Description: Policy that defines tcp request retry conditions ,
Required: False ,
}
{
maxConnectAttempts:
{
Description: Maximum number of attempts to connect to the tcp service ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
circuitBreakerPolicy:
{
Description: Policy that defines circuit breaker conditions ,
Required: False ,
}
{
consecutiveErrors:
{
Description: Number of consecutive errors before the circuit breaker opens ,
Format: int32 ,
Required: False ,
}
integer ,
intervalInSeconds:
{
Description: The time interval, in seconds, between endpoint checks. This can result in opening the circuit breaker if the check fails as well as closing the circuit breaker if the check succeeds. Defaults to 10s. ,
Format: int32 ,
Required: False ,
}
integer ,
maxEjectionPercent:
{
Description: Maximum percentage of hosts that will be ejected after failure threshold has been met ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
httpConnectionPool:
{
Description: Defines parameters for http connection pooling ,
Required: False ,
}
{
http1MaxPendingRequests:
{
Description: Maximum number of pending http1 requests allowed ,
Format: int32 ,
Required: False ,
}
integer ,
http2MaxRequests:
{
Description: Maximum number of http2 requests allowed ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tcpConnectionPool:
{
Description: Defines parameters for tcp connection pooling ,
Required: False ,
}
{
maxConnections:
{
Description: Maximum number of tcp connections allowed ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsAuthConfigs_ListByContainerApp (new)
Description :  Get the Container App AuthConfigs in a given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: AuthConfig resource specific properties ,
Required: False ,
}
{
platform:
{
Description: The configuration settings of the platform of ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
}
,
globalValidation:
{
Description: The configuration settings that determines the validation flow of users using Service Authentication/Authorization. ,
Required: False ,
}
{
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
Return401: No description available. ,
Return403: No description available. ,
}
,
Required: False ,
}
enum ,
redirectToProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Required: False ,
}
string ,
excludedPaths:
{
Description: The paths for which unauthenticated flow would not be redirected to the login page. ,
Required: False ,
}
[
string ,
]
,
}
,
identityProviders:
{
Description: The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
azureActiveDirectory:
{
Description: The configuration settings of the Azure Active directory provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Active Directory app registration. ,
Required: False ,
}
{
openIdIssuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateSubjectAlternativeName:
{
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 a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateIssuer:
{
Description: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the Azure Active Directory login flow. ,
Required: False ,
}
{
loginParameters:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
disableWWWAuthenticate:
{
Description: true if the www-authenticate provider should be omitted from the request; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
jwtClaimChecks:
{
Description: The configuration settings of the checks that should be made while validating the JWT Claims. ,
Required: False ,
}
{
allowedGroups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
allowedClientApplications:
{
Description: The list of the allowed client applications. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedAudiences:
{
Description: The list of audiences that can make successful authentication/authorization requests. ,
Required: False ,
}
[
string ,
]
,
defaultAuthorizationPolicy:
{
Description: The configuration settings of the default authorization policy. ,
Required: False ,
}
{
allowedPrincipals:
{
Description: The configuration settings of the Azure Active Directory allowed principals. ,
Required: False ,
}
{
groups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
identities:
{
Description: The list of the allowed identities. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedApplications:
{
Description: The configuration settings of the Azure Active Directory allowed applications. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
isAutoProvisioned:
{
Description: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property. ,
Required: False ,
}
boolean ,
}
,
facebook:
{
Description: The configuration settings of the Facebook provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Facebook provider. ,
Required: False ,
}
{
appId:
{
Description: The App ID of the app used for login. ,
Required: False ,
}
string ,
appSecretSettingName:
{
Description: The app setting name that contains the app secret. ,
Required: False ,
}
string ,
}
,
graphApiVersion:
{
Description: The version of the Facebook api to be used while logging in. ,
Required: False ,
}
string ,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
gitHub:
{
Description: The configuration settings of the GitHub provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the GitHub provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
google:
{
Description: The configuration settings of the Google provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Google provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Google provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
twitter:
{
Description: The configuration settings of the Twitter provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Twitter provider. ,
Required: False ,
}
{
consumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
consumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
}
,
}
,
apple:
{
Description: The configuration settings of the Apple provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Apple provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Apple registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
azureStaticWebApps:
{
Description: The configuration settings of the Azure Static Web Apps provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Static Web Apps registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
}
,
}
,
customOpenIdConnectProviders:
{
Description: The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. ,
Required: False ,
}
object ,
}
,
login:
{
Description: The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
routes:
{
Description: The routes that specify the endpoints used for login and logout requests. ,
Required: False ,
}
{
logoutEndpoint:
{
Description: The endpoint at which a logout request should be made. ,
Required: False ,
}
string ,
}
,
tokenStore:
{
Description: The configuration settings of the token store. ,
Required: False ,
}
{
enabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
azureBlobStorage:
{
Description: The configuration settings of the storage of the tokens if blob storage is used. ,
Required: False ,
}
{
sasUrlSettingName:
{
Description: The name of the app secrets containing the SAS URL of the blob storage containing the tokens. Should not be used along with blobContainerUri. ,
Required: False ,
}
string ,
blobContainerUri:
{
Description: The URI of the blob storage containing the tokens. Should not be used along with sasUrlSettingName. ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of a User-Assigned Managed Identity. Should not be used along with managedIdentityResourceId. ,
Required: False ,
}
string ,
managedIdentityResourceId:
{
Description: The Resource ID of a User-Assigned Managed Identity. Should not be used along with clientId. ,
Required: False ,
}
string ,
}
,
}
,
preserveUrlFragmentsForLogins:
{
Description: true if the fragments from the request are preserved after the login request is made; otherwise, false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
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. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
cookieExpiration:
{
Description: The configuration settings of the session cookie's expiration. ,
Required: False ,
}
{
convention:
{
Description: The convention used when determining the session cookie's expiration. ,
Enum:
{
FixedTime: No description available. ,
IdentityProviderDerived: No description available. ,
}
,
Required: False ,
}
enum ,
timeToExpiration:
{
Description: The time after the request is made when the session cookie should expire. ,
Required: False ,
}
string ,
}
,
nonce:
{
Description: The configuration settings of the nonce used in the login flow. ,
Required: False ,
}
{
validateNonce:
{
Description: false if the nonce should not be validated while completing the login flow; otherwise, true. ,
Required: False ,
}
boolean ,
nonceExpirationInterval:
{
Description: The time after the request is made when the nonce should expire. ,
Required: False ,
}
string ,
}
,
}
,
httpSettings:
{
Description: The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
requireHttps:
{
Description: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. ,
Required: False ,
}
boolean ,
routes:
{
Description: The configuration settings of the paths HTTP requests. ,
Required: False ,
}
{
apiPrefix:
{
Description: The prefix that should precede all the authentication/authorization paths. ,
Required: False ,
}
string ,
}
,
forwardProxy:
{
Description: The configuration settings of a forward proxy used to make the requests. ,
Required: False ,
}
{
convention:
{
Description: The convention used to determine the url of the request made. ,
Enum:
{
NoProxy: No description available. ,
Standard: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
customHostHeaderName:
{
Description: The name of the header containing the host of the request. ,
Required: False ,
}
string ,
customProtoHeaderName:
{
Description: The name of the header containing the scheme of the request. ,
Required: False ,
}
string ,
}
,
}
,
encryptionSettings:
{
Description: The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
containerAppAuthEncryptionSecretName:
{
Description: The secret name which is referenced for EncryptionKey. ,
Required: False ,
}
string ,
containerAppAuthSigningSecretName:
{
Description: The secret name which is referenced for SigningKey. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsAuthConfigs_Get (new)
Description :  Get a AuthConfig of a Container App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{authConfigName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
authConfigName:
{
Description: Name of the Container App AuthConfig. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AuthConfig resource specific properties ,
Required: False ,
}
{
platform:
{
Description: The configuration settings of the platform of ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
}
,
globalValidation:
{
Description: The configuration settings that determines the validation flow of users using Service Authentication/Authorization. ,
Required: False ,
}
{
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
Return401: No description available. ,
Return403: No description available. ,
}
,
Required: False ,
}
enum ,
redirectToProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Required: False ,
}
string ,
excludedPaths:
{
Description: The paths for which unauthenticated flow would not be redirected to the login page. ,
Required: False ,
}
[
string ,
]
,
}
,
identityProviders:
{
Description: The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
azureActiveDirectory:
{
Description: The configuration settings of the Azure Active directory provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Active Directory app registration. ,
Required: False ,
}
{
openIdIssuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateSubjectAlternativeName:
{
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 a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateIssuer:
{
Description: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the Azure Active Directory login flow. ,
Required: False ,
}
{
loginParameters:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
disableWWWAuthenticate:
{
Description: true if the www-authenticate provider should be omitted from the request; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
jwtClaimChecks:
{
Description: The configuration settings of the checks that should be made while validating the JWT Claims. ,
Required: False ,
}
{
allowedGroups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
allowedClientApplications:
{
Description: The list of the allowed client applications. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedAudiences:
{
Description: The list of audiences that can make successful authentication/authorization requests. ,
Required: False ,
}
[
string ,
]
,
defaultAuthorizationPolicy:
{
Description: The configuration settings of the default authorization policy. ,
Required: False ,
}
{
allowedPrincipals:
{
Description: The configuration settings of the Azure Active Directory allowed principals. ,
Required: False ,
}
{
groups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
identities:
{
Description: The list of the allowed identities. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedApplications:
{
Description: The configuration settings of the Azure Active Directory allowed applications. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
isAutoProvisioned:
{
Description: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property. ,
Required: False ,
}
boolean ,
}
,
facebook:
{
Description: The configuration settings of the Facebook provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Facebook provider. ,
Required: False ,
}
{
appId:
{
Description: The App ID of the app used for login. ,
Required: False ,
}
string ,
appSecretSettingName:
{
Description: The app setting name that contains the app secret. ,
Required: False ,
}
string ,
}
,
graphApiVersion:
{
Description: The version of the Facebook api to be used while logging in. ,
Required: False ,
}
string ,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
gitHub:
{
Description: The configuration settings of the GitHub provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the GitHub provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
google:
{
Description: The configuration settings of the Google provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Google provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Google provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
twitter:
{
Description: The configuration settings of the Twitter provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Twitter provider. ,
Required: False ,
}
{
consumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
consumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
}
,
}
,
apple:
{
Description: The configuration settings of the Apple provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Apple provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Apple registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
azureStaticWebApps:
{
Description: The configuration settings of the Azure Static Web Apps provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Static Web Apps registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
}
,
}
,
customOpenIdConnectProviders:
{
Description: The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. ,
Required: False ,
}
object ,
}
,
login:
{
Description: The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
routes:
{
Description: The routes that specify the endpoints used for login and logout requests. ,
Required: False ,
}
{
logoutEndpoint:
{
Description: The endpoint at which a logout request should be made. ,
Required: False ,
}
string ,
}
,
tokenStore:
{
Description: The configuration settings of the token store. ,
Required: False ,
}
{
enabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
azureBlobStorage:
{
Description: The configuration settings of the storage of the tokens if blob storage is used. ,
Required: False ,
}
{
sasUrlSettingName:
{
Description: The name of the app secrets containing the SAS URL of the blob storage containing the tokens. Should not be used along with blobContainerUri. ,
Required: False ,
}
string ,
blobContainerUri:
{
Description: The URI of the blob storage containing the tokens. Should not be used along with sasUrlSettingName. ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of a User-Assigned Managed Identity. Should not be used along with managedIdentityResourceId. ,
Required: False ,
}
string ,
managedIdentityResourceId:
{
Description: The Resource ID of a User-Assigned Managed Identity. Should not be used along with clientId. ,
Required: False ,
}
string ,
}
,
}
,
preserveUrlFragmentsForLogins:
{
Description: true if the fragments from the request are preserved after the login request is made; otherwise, false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
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. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
cookieExpiration:
{
Description: The configuration settings of the session cookie's expiration. ,
Required: False ,
}
{
convention:
{
Description: The convention used when determining the session cookie's expiration. ,
Enum:
{
FixedTime: No description available. ,
IdentityProviderDerived: No description available. ,
}
,
Required: False ,
}
enum ,
timeToExpiration:
{
Description: The time after the request is made when the session cookie should expire. ,
Required: False ,
}
string ,
}
,
nonce:
{
Description: The configuration settings of the nonce used in the login flow. ,
Required: False ,
}
{
validateNonce:
{
Description: false if the nonce should not be validated while completing the login flow; otherwise, true. ,
Required: False ,
}
boolean ,
nonceExpirationInterval:
{
Description: The time after the request is made when the nonce should expire. ,
Required: False ,
}
string ,
}
,
}
,
httpSettings:
{
Description: The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
requireHttps:
{
Description: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. ,
Required: False ,
}
boolean ,
routes:
{
Description: The configuration settings of the paths HTTP requests. ,
Required: False ,
}
{
apiPrefix:
{
Description: The prefix that should precede all the authentication/authorization paths. ,
Required: False ,
}
string ,
}
,
forwardProxy:
{
Description: The configuration settings of a forward proxy used to make the requests. ,
Required: False ,
}
{
convention:
{
Description: The convention used to determine the url of the request made. ,
Enum:
{
NoProxy: No description available. ,
Standard: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
customHostHeaderName:
{
Description: The name of the header containing the host of the request. ,
Required: False ,
}
string ,
customProtoHeaderName:
{
Description: The name of the header containing the scheme of the request. ,
Required: False ,
}
string ,
}
,
}
,
encryptionSettings:
{
Description: The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
containerAppAuthEncryptionSecretName:
{
Description: The secret name which is referenced for EncryptionKey. ,
Required: False ,
}
string ,
containerAppAuthSigningSecretName:
{
Description: The secret name which is referenced for SigningKey. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsAuthConfigs_CreateOrUpdate (new)
Description :  Create or update the AuthConfig for a Container App.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{authConfigName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
authConfigName:
{
Description: Name of the Container App AuthConfig. ,
Required: True ,
}
string ,
authConfigEnvelope:
{
Description: Properties used to create a Container App AuthConfig ,
Required: True ,
}
{
properties:
{
Description: AuthConfig resource specific properties ,
Required: False ,
}
{
platform:
{
Description: The configuration settings of the platform of ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
}
,
globalValidation:
{
Description: The configuration settings that determines the validation flow of users using Service Authentication/Authorization. ,
Required: False ,
}
{
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
Return401: No description available. ,
Return403: No description available. ,
}
,
Required: False ,
}
enum ,
redirectToProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Required: False ,
}
string ,
excludedPaths:
{
Description: The paths for which unauthenticated flow would not be redirected to the login page. ,
Required: False ,
}
[
string ,
]
,
}
,
identityProviders:
{
Description: The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
azureActiveDirectory:
{
Description: The configuration settings of the Azure Active directory provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Active Directory app registration. ,
Required: False ,
}
{
openIdIssuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateSubjectAlternativeName:
{
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 a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateIssuer:
{
Description: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the Azure Active Directory login flow. ,
Required: False ,
}
{
loginParameters:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
disableWWWAuthenticate:
{
Description: true if the www-authenticate provider should be omitted from the request; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
jwtClaimChecks:
{
Description: The configuration settings of the checks that should be made while validating the JWT Claims. ,
Required: False ,
}
{
allowedGroups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
allowedClientApplications:
{
Description: The list of the allowed client applications. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedAudiences:
{
Description: The list of audiences that can make successful authentication/authorization requests. ,
Required: False ,
}
[
string ,
]
,
defaultAuthorizationPolicy:
{
Description: The configuration settings of the default authorization policy. ,
Required: False ,
}
{
allowedPrincipals:
{
Description: The configuration settings of the Azure Active Directory allowed principals. ,
Required: False ,
}
{
groups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
identities:
{
Description: The list of the allowed identities. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedApplications:
{
Description: The configuration settings of the Azure Active Directory allowed applications. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
isAutoProvisioned:
{
Description: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property. ,
Required: False ,
}
boolean ,
}
,
facebook:
{
Description: The configuration settings of the Facebook provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Facebook provider. ,
Required: False ,
}
{
appId:
{
Description: The App ID of the app used for login. ,
Required: False ,
}
string ,
appSecretSettingName:
{
Description: The app setting name that contains the app secret. ,
Required: False ,
}
string ,
}
,
graphApiVersion:
{
Description: The version of the Facebook api to be used while logging in. ,
Required: False ,
}
string ,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
gitHub:
{
Description: The configuration settings of the GitHub provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the GitHub provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
google:
{
Description: The configuration settings of the Google provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Google provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Google provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
twitter:
{
Description: The configuration settings of the Twitter provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Twitter provider. ,
Required: False ,
}
{
consumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
consumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
}
,
}
,
apple:
{
Description: The configuration settings of the Apple provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Apple provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Apple registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
azureStaticWebApps:
{
Description: The configuration settings of the Azure Static Web Apps provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Static Web Apps registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
}
,
}
,
customOpenIdConnectProviders:
{
Description: The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. ,
Required: False ,
}
object ,
}
,
login:
{
Description: The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
routes:
{
Description: The routes that specify the endpoints used for login and logout requests. ,
Required: False ,
}
{
logoutEndpoint:
{
Description: The endpoint at which a logout request should be made. ,
Required: False ,
}
string ,
}
,
tokenStore:
{
Description: The configuration settings of the token store. ,
Required: False ,
}
{
enabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
azureBlobStorage:
{
Description: The configuration settings of the storage of the tokens if blob storage is used. ,
Required: False ,
}
{
sasUrlSettingName:
{
Description: The name of the app secrets containing the SAS URL of the blob storage containing the tokens. Should not be used along with blobContainerUri. ,
Required: False ,
}
string ,
blobContainerUri:
{
Description: The URI of the blob storage containing the tokens. Should not be used along with sasUrlSettingName. ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of a User-Assigned Managed Identity. Should not be used along with managedIdentityResourceId. ,
Required: False ,
}
string ,
managedIdentityResourceId:
{
Description: The Resource ID of a User-Assigned Managed Identity. Should not be used along with clientId. ,
Required: False ,
}
string ,
}
,
}
,
preserveUrlFragmentsForLogins:
{
Description: true if the fragments from the request are preserved after the login request is made; otherwise, false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
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. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
cookieExpiration:
{
Description: The configuration settings of the session cookie's expiration. ,
Required: False ,
}
{
convention:
{
Description: The convention used when determining the session cookie's expiration. ,
Enum:
{
FixedTime: No description available. ,
IdentityProviderDerived: No description available. ,
}
,
Required: False ,
}
enum ,
timeToExpiration:
{
Description: The time after the request is made when the session cookie should expire. ,
Required: False ,
}
string ,
}
,
nonce:
{
Description: The configuration settings of the nonce used in the login flow. ,
Required: False ,
}
{
validateNonce:
{
Description: false if the nonce should not be validated while completing the login flow; otherwise, true. ,
Required: False ,
}
boolean ,
nonceExpirationInterval:
{
Description: The time after the request is made when the nonce should expire. ,
Required: False ,
}
string ,
}
,
}
,
httpSettings:
{
Description: The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
requireHttps:
{
Description: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. ,
Required: False ,
}
boolean ,
routes:
{
Description: The configuration settings of the paths HTTP requests. ,
Required: False ,
}
{
apiPrefix:
{
Description: The prefix that should precede all the authentication/authorization paths. ,
Required: False ,
}
string ,
}
,
forwardProxy:
{
Description: The configuration settings of a forward proxy used to make the requests. ,
Required: False ,
}
{
convention:
{
Description: The convention used to determine the url of the request made. ,
Enum:
{
NoProxy: No description available. ,
Standard: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
customHostHeaderName:
{
Description: The name of the header containing the host of the request. ,
Required: False ,
}
string ,
customProtoHeaderName:
{
Description: The name of the header containing the scheme of the request. ,
Required: False ,
}
string ,
}
,
}
,
encryptionSettings:
{
Description: The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
containerAppAuthEncryptionSecretName:
{
Description: The secret name which is referenced for EncryptionKey. ,
Required: False ,
}
string ,
containerAppAuthSigningSecretName:
{
Description: The secret name which is referenced for SigningKey. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AuthConfig resource specific properties ,
Required: False ,
}
{
platform:
{
Description: The configuration settings of the platform of ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
enabled:
{
Description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. ,
Required: False ,
}
boolean ,
runtimeVersion:
{
Description: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. ,
Required: False ,
}
string ,
}
,
globalValidation:
{
Description: The configuration settings that determines the validation flow of users using Service Authentication/Authorization. ,
Required: False ,
}
{
unauthenticatedClientAction:
{
Description: The action to take when an unauthenticated client attempts to access the app. ,
Enum:
{
RedirectToLoginPage: No description available. ,
AllowAnonymous: No description available. ,
Return401: No description available. ,
Return403: No description available. ,
}
,
Required: False ,
}
enum ,
redirectToProvider:
{
Description: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". ,
Required: False ,
}
string ,
excludedPaths:
{
Description: The paths for which unauthenticated flow would not be redirected to the login page. ,
Required: False ,
}
[
string ,
]
,
}
,
identityProviders:
{
Description: The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
azureActiveDirectory:
{
Description: The configuration settings of the Azure Active directory provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Active Directory app registration. ,
Required: False ,
}
{
openIdIssuer:
{
Description: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret of the relying party application. ,
Required: False ,
}
string ,
clientSecretCertificateThumbprint:
{
Description: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateSubjectAlternativeName:
{
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 a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
clientSecretCertificateIssuer:
{
Description: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the Azure Active Directory login flow. ,
Required: False ,
}
{
loginParameters:
{
Description: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". ,
Required: False ,
}
[
string ,
]
,
disableWWWAuthenticate:
{
Description: true if the www-authenticate provider should be omitted from the request; otherwise, false. ,
Required: False ,
}
boolean ,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
jwtClaimChecks:
{
Description: The configuration settings of the checks that should be made while validating the JWT Claims. ,
Required: False ,
}
{
allowedGroups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
allowedClientApplications:
{
Description: The list of the allowed client applications. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedAudiences:
{
Description: The list of audiences that can make successful authentication/authorization requests. ,
Required: False ,
}
[
string ,
]
,
defaultAuthorizationPolicy:
{
Description: The configuration settings of the default authorization policy. ,
Required: False ,
}
{
allowedPrincipals:
{
Description: The configuration settings of the Azure Active Directory allowed principals. ,
Required: False ,
}
{
groups:
{
Description: The list of the allowed groups. ,
Required: False ,
}
[
string ,
]
,
identities:
{
Description: The list of the allowed identities. ,
Required: False ,
}
[
string ,
]
,
}
,
allowedApplications:
{
Description: The configuration settings of the Azure Active Directory allowed applications. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
isAutoProvisioned:
{
Description: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property. ,
Required: False ,
}
boolean ,
}
,
facebook:
{
Description: The configuration settings of the Facebook provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Facebook provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Facebook provider. ,
Required: False ,
}
{
appId:
{
Description: The App ID of the app used for login. ,
Required: False ,
}
string ,
appSecretSettingName:
{
Description: The app setting name that contains the app secret. ,
Required: False ,
}
string ,
}
,
graphApiVersion:
{
Description: The version of the Facebook api to be used while logging in. ,
Required: False ,
}
string ,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
gitHub:
{
Description: The configuration settings of the GitHub provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the GitHub provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the GitHub provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
google:
{
Description: The configuration settings of the Google provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Google provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Google provider. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
validation:
{
Description: The configuration settings of the Azure Active Directory token validation flow. ,
Required: False ,
}
{
allowedAudiences:
{
Description: The configuration settings of the allowed list of audiences from which to validate the JWT token. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
twitter:
{
Description: The configuration settings of the Twitter provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Twitter provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the app registration for the Twitter provider. ,
Required: False ,
}
{
consumerKey:
{
Description: The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in ,
Required: False ,
}
string ,
consumerSecretSettingName:
{
Description: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. ,
Required: False ,
}
string ,
}
,
}
,
apple:
{
Description: The configuration settings of the Apple provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Apple provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Apple registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
clientSecretSettingName:
{
Description: The app setting name that contains the client secret. ,
Required: False ,
}
string ,
}
,
login:
{
Description: The configuration settings of the login flow. ,
Required: False ,
}
{
scopes:
{
Description: A list of the scopes that should be requested while authenticating. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
azureStaticWebApps:
{
Description: The configuration settings of the Azure Static Web Apps provider. ,
Required: False ,
}
{
enabled:
{
Description: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. ,
Required: False ,
}
boolean ,
registration:
{
Description: The configuration settings of the Azure Static Web Apps registration. ,
Required: False ,
}
{
clientId:
{
Description: The Client ID of the app used for login. ,
Required: False ,
}
string ,
}
,
}
,
customOpenIdConnectProviders:
{
Description: The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider. ,
Required: False ,
}
object ,
}
,
login:
{
Description: The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
routes:
{
Description: The routes that specify the endpoints used for login and logout requests. ,
Required: False ,
}
{
logoutEndpoint:
{
Description: The endpoint at which a logout request should be made. ,
Required: False ,
}
string ,
}
,
tokenStore:
{
Description: The configuration settings of the token store. ,
Required: False ,
}
{
enabled:
{
Description: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
tokenRefreshExtensionHours:
{
Description: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. ,
Format: double ,
Required: False ,
}
number ,
azureBlobStorage:
{
Description: The configuration settings of the storage of the tokens if blob storage is used. ,
Required: False ,
}
{
sasUrlSettingName:
{
Description: The name of the app secrets containing the SAS URL of the blob storage containing the tokens. Should not be used along with blobContainerUri. ,
Required: False ,
}
string ,
blobContainerUri:
{
Description: The URI of the blob storage containing the tokens. Should not be used along with sasUrlSettingName. ,
Required: False ,
}
string ,
clientId:
{
Description: The Client ID of a User-Assigned Managed Identity. Should not be used along with managedIdentityResourceId. ,
Required: False ,
}
string ,
managedIdentityResourceId:
{
Description: The Resource ID of a User-Assigned Managed Identity. Should not be used along with clientId. ,
Required: False ,
}
string ,
}
,
}
,
preserveUrlFragmentsForLogins:
{
Description: true if the fragments from the request are preserved after the login request is made; otherwise, false. ,
Required: False ,
}
boolean ,
allowedExternalRedirectUrls:
{
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. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. ,
Required: False ,
}
[
string ,
]
,
cookieExpiration:
{
Description: The configuration settings of the session cookie's expiration. ,
Required: False ,
}
{
convention:
{
Description: The convention used when determining the session cookie's expiration. ,
Enum:
{
FixedTime: No description available. ,
IdentityProviderDerived: No description available. ,
}
,
Required: False ,
}
enum ,
timeToExpiration:
{
Description: The time after the request is made when the session cookie should expire. ,
Required: False ,
}
string ,
}
,
nonce:
{
Description: The configuration settings of the nonce used in the login flow. ,
Required: False ,
}
{
validateNonce:
{
Description: false if the nonce should not be validated while completing the login flow; otherwise, true. ,
Required: False ,
}
boolean ,
nonceExpirationInterval:
{
Description: The time after the request is made when the nonce should expire. ,
Required: False ,
}
string ,
}
,
}
,
httpSettings:
{
Description: The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
requireHttps:
{
Description: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. ,
Required: False ,
}
boolean ,
routes:
{
Description: The configuration settings of the paths HTTP requests. ,
Required: False ,
}
{
apiPrefix:
{
Description: The prefix that should precede all the authentication/authorization paths. ,
Required: False ,
}
string ,
}
,
forwardProxy:
{
Description: The configuration settings of a forward proxy used to make the requests. ,
Required: False ,
}
{
convention:
{
Description: The convention used to determine the url of the request made. ,
Enum:
{
NoProxy: No description available. ,
Standard: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
customHostHeaderName:
{
Description: The name of the header containing the host of the request. ,
Required: False ,
}
string ,
customProtoHeaderName:
{
Description: The name of the header containing the scheme of the request. ,
Required: False ,
}
string ,
}
,
}
,
encryptionSettings:
{
Description: The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization. ,
Required: False ,
}
{
containerAppAuthEncryptionSecretName:
{
Description: The secret name which is referenced for EncryptionKey. ,
Required: False ,
}
string ,
containerAppAuthSigningSecretName:
{
Description: The secret name which is referenced for SigningKey. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsAuthConfigs_Delete (new)
Description :  Delete a Container App AuthConfig.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{authConfigName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
authConfigName:
{
Description: Name of the Container App AuthConfig. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
AvailableWorkloadProfiles_Get (new)
Description :  Get all available workload profiles for a location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/availableManagedEnvironmentsWorkloadProfileTypes
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of workload profiles. ,
Required: True ,
}
[
{
location:
{
Description: Region of the workload profile. ,
Required: False ,
}
string ,
properties:
{
Description: Revision resource specific properties ,
Required: False ,
}
{
category:
{
Description: Used to categorize workload profiles. ,
Required: False ,
}
string ,
applicability:
{
Description: indicates whether the profile is default for the location. ,
Enum:
{
LocationDefault: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
cores:
{
Description: Number of cores in CPU. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGiB:
{
Description: Memory in GiB. ,
Format: int32 ,
Required: False ,
}
integer ,
gpus:
{
Description: Number of GPUs. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: The everyday name of the workload profile. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingMeters_Get (new)
Description :  Get all billingMeters for a location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/billingMeters
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of billing meters. ,
Required: True ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ,
Required: False ,
}
string ,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Region for the billing meter. ,
Required: False ,
}
string ,
properties:
{
Description: Revision resource specific properties ,
Required: False ,
}
{
category:
{
Description: Used to categorize billing meters. ,
Required: False ,
}
string ,
meterType:
{
Description: Billing meter type. ,
Required: False ,
}
string ,
displayName:
{
Description: The everyday name of the billing meter. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
Builders_ListBySubscription (new)
Description :  List BuilderResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.App/builders
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The BuilderResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of a builder resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of the container apps environment that the builder is associated with. ,
Format: arm-id ,
Required: True ,
}
string ,
containerRegistries:
{
Description: List of mappings of container registries and the managed identity used to connect to it. ,
Required: False ,
}
[
{
containerRegistryServer:
{
Description: Login server of the container registry. ,
Required: True ,
}
string ,
identityResourceId:
{
Description: Resource ID of the managed identity. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Builders_ListByResourceGroup (new)
Description :  List BuilderResource resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The BuilderResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of a builder resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of the container apps environment that the builder is associated with. ,
Format: arm-id ,
Required: True ,
}
string ,
containerRegistries:
{
Description: List of mappings of container registries and the managed identity used to connect to it. ,
Required: False ,
}
[
{
containerRegistryServer:
{
Description: Login server of the container registry. ,
Required: True ,
}
string ,
identityResourceId:
{
Description: Resource ID of the managed identity. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Builders_Get (new)
Description :  Get a BuilderResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
builderName:
{
Description: The name of the builder. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of a builder resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of the container apps environment that the builder is associated with. ,
Format: arm-id ,
Required: True ,
}
string ,
containerRegistries:
{
Description: List of mappings of container registries and the managed identity used to connect to it. ,
Required: False ,
}
[
{
containerRegistryServer:
{
Description: Login server of the container registry. ,
Required: True ,
}
string ,
identityResourceId:
{
Description: Resource ID of the managed identity. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Builders_CreateOrUpdate (new)
Description :  Create or update a BuilderResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
builderName:
{
Description: The name of the builder. ,
Required: True ,
}
string ,
builderEnvelope:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of a builder resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of the container apps environment that the builder is associated with. ,
Format: arm-id ,
Required: True ,
}
string ,
containerRegistries:
{
Description: List of mappings of container registries and the managed identity used to connect to it. ,
Required: False ,
}
[
{
containerRegistryServer:
{
Description: Login server of the container registry. ,
Required: True ,
}
string ,
identityResourceId:
{
Description: Resource ID of the managed identity. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of a builder resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of the container apps environment that the builder is associated with. ,
Format: arm-id ,
Required: True ,
}
string ,
containerRegistries:
{
Description: List of mappings of container registries and the managed identity used to connect to it. ,
Required: False ,
}
[
{
containerRegistryServer:
{
Description: Login server of the container registry. ,
Required: True ,
}
string ,
identityResourceId:
{
Description: Resource ID of the managed identity. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Information about the SourceToCloud builder resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of a builder resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of the container apps environment that the builder is associated with. ,
Format: arm-id ,
Required: True ,
}
string ,
containerRegistries:
{
Description: List of mappings of container registries and the managed identity used to connect to it. ,
Required: False ,
}
[
{
containerRegistryServer:
{
Description: Login server of the container registry. ,
Required: True ,
}
string ,
identityResourceId:
{
Description: Resource ID of the managed identity. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Builders_Update (new)
Description :  Update a BuilderResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
builderName:
{
Description: The name of the builder. ,
Required: True ,
}
string ,
builderEnvelope:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The updatable properties of the BuilderResource. ,
Required: False ,
}
{
environmentId:
{
Description: Resource ID of the container apps environment that the builder is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of a builder resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of the container apps environment that the builder is associated with. ,
Format: arm-id ,
Required: True ,
}
string ,
containerRegistries:
{
Description: List of mappings of container registries and the managed identity used to connect to it. ,
Required: False ,
}
[
{
containerRegistryServer:
{
Description: Login server of the container registry. ,
Required: True ,
}
string ,
identityResourceId:
{
Description: Resource ID of the managed identity. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Builders_Delete (new)
Description :  Delete a BuilderResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
builderName:
{
Description: The name of the builder. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BuildsByBuilderResource_List (new)
Description :  List BuildResource resources by BuilderResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}/builds
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
builderName:
{
Description: The name of the builder. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The BuildResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Build provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
buildStatus:
{
Description: Status of the build once it has been provisioned. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
destinationContainerRegistry:
{
Description: Container registry that the final image will be uploaded to. ,
Required: False ,
}
{
server:
{
Description: Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it. ,
Required: True ,
}
string ,
image:
{
Description: Full name that the final image should be uploaded as, including both image name and tag. ,
Required: False ,
}
string ,
}
,
configuration:
{
Description: Configuration of the build. ,
Required: False ,
}
{
baseOs:
{
Description: Base OS used to build and run the app. ,
Required: False ,
}
string ,
platform:
{
Description: Platform to be used to build and run the app. ,
Required: False ,
}
string ,
platformVersion:
{
Description: Platform version to be used to build and run the app. ,
Required: False ,
}
string ,
environmentVariables:
{
Description: List of environment variables to be passed to the build, secrets should not be used in environment variable. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: True ,
}
string ,
value:
{
Description: Environment variable value. ,
Required: True ,
}
string ,
}
,
]
,
preBuildSteps:
{
Description: List of steps to perform before the build. ,
Required: False ,
}
[
{
description:
{
Description: Description of the pre-build step. ,
Required: False ,
}
string ,
scripts:
{
Description: List of custom commands to run. ,
Required: False ,
}
[
string ,
]
,
httpGet:
{
Description: Http get request to send before the build. ,
Required: False ,
}
{
url:
{
Description: URL to make HTTP GET request against. ,
Required: True ,
}
string ,
fileName:
{
Description: Name of the file that the request should be saved to. ,
Required: False ,
}
string ,
headers:
{
Description: List of headers to send with the request. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
uploadEndpoint:
{
Description: Endpoint to which the source code should be uploaded. ,
Required: False ,
}
string ,
logStreamEndpoint:
{
Description: Endpoint from which the build logs can be streamed. ,
Required: False ,
}
string ,
tokenEndpoint:
{
Description: Endpoint to use to retrieve an authentication token for log streaming and uploading source code. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Builds_Get (new)
Description :  Get a BuildResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}/builds/{buildName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
builderName:
{
Description: The name of the builder. ,
Required: True ,
}
string ,
buildName:
{
Description: The name of a build. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Build provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
buildStatus:
{
Description: Status of the build once it has been provisioned. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
destinationContainerRegistry:
{
Description: Container registry that the final image will be uploaded to. ,
Required: False ,
}
{
server:
{
Description: Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it. ,
Required: True ,
}
string ,
image:
{
Description: Full name that the final image should be uploaded as, including both image name and tag. ,
Required: False ,
}
string ,
}
,
configuration:
{
Description: Configuration of the build. ,
Required: False ,
}
{
baseOs:
{
Description: Base OS used to build and run the app. ,
Required: False ,
}
string ,
platform:
{
Description: Platform to be used to build and run the app. ,
Required: False ,
}
string ,
platformVersion:
{
Description: Platform version to be used to build and run the app. ,
Required: False ,
}
string ,
environmentVariables:
{
Description: List of environment variables to be passed to the build, secrets should not be used in environment variable. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: True ,
}
string ,
value:
{
Description: Environment variable value. ,
Required: True ,
}
string ,
}
,
]
,
preBuildSteps:
{
Description: List of steps to perform before the build. ,
Required: False ,
}
[
{
description:
{
Description: Description of the pre-build step. ,
Required: False ,
}
string ,
scripts:
{
Description: List of custom commands to run. ,
Required: False ,
}
[
string ,
]
,
httpGet:
{
Description: Http get request to send before the build. ,
Required: False ,
}
{
url:
{
Description: URL to make HTTP GET request against. ,
Required: True ,
}
string ,
fileName:
{
Description: Name of the file that the request should be saved to. ,
Required: False ,
}
string ,
headers:
{
Description: List of headers to send with the request. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
uploadEndpoint:
{
Description: Endpoint to which the source code should be uploaded. ,
Required: False ,
}
string ,
logStreamEndpoint:
{
Description: Endpoint from which the build logs can be streamed. ,
Required: False ,
}
string ,
tokenEndpoint:
{
Description: Endpoint to use to retrieve an authentication token for log streaming and uploading source code. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Builds_CreateOrUpdate (new)
Description :  Create a BuildResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}/builds/{buildName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
builderName:
{
Description: The name of the builder. ,
Required: True ,
}
string ,
buildName:
{
Description: The name of a build. ,
Required: True ,
}
string ,
buildEnvelope:
{
Description: Resource create or update parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Build provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
buildStatus:
{
Description: Status of the build once it has been provisioned. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
destinationContainerRegistry:
{
Description: Container registry that the final image will be uploaded to. ,
Required: False ,
}
{
server:
{
Description: Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it. ,
Required: True ,
}
string ,
image:
{
Description: Full name that the final image should be uploaded as, including both image name and tag. ,
Required: False ,
}
string ,
}
,
configuration:
{
Description: Configuration of the build. ,
Required: False ,
}
{
baseOs:
{
Description: Base OS used to build and run the app. ,
Required: False ,
}
string ,
platform:
{
Description: Platform to be used to build and run the app. ,
Required: False ,
}
string ,
platformVersion:
{
Description: Platform version to be used to build and run the app. ,
Required: False ,
}
string ,
environmentVariables:
{
Description: List of environment variables to be passed to the build, secrets should not be used in environment variable. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: True ,
}
string ,
value:
{
Description: Environment variable value. ,
Required: True ,
}
string ,
}
,
]
,
preBuildSteps:
{
Description: List of steps to perform before the build. ,
Required: False ,
}
[
{
description:
{
Description: Description of the pre-build step. ,
Required: False ,
}
string ,
scripts:
{
Description: List of custom commands to run. ,
Required: False ,
}
[
string ,
]
,
httpGet:
{
Description: Http get request to send before the build. ,
Required: False ,
}
{
url:
{
Description: URL to make HTTP GET request against. ,
Required: True ,
}
string ,
fileName:
{
Description: Name of the file that the request should be saved to. ,
Required: False ,
}
string ,
headers:
{
Description: List of headers to send with the request. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
uploadEndpoint:
{
Description: Endpoint to which the source code should be uploaded. ,
Required: False ,
}
string ,
logStreamEndpoint:
{
Description: Endpoint from which the build logs can be streamed. ,
Required: False ,
}
string ,
tokenEndpoint:
{
Description: Endpoint to use to retrieve an authentication token for log streaming and uploading source code. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Build provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
buildStatus:
{
Description: Status of the build once it has been provisioned. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
destinationContainerRegistry:
{
Description: Container registry that the final image will be uploaded to. ,
Required: False ,
}
{
server:
{
Description: Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it. ,
Required: True ,
}
string ,
image:
{
Description: Full name that the final image should be uploaded as, including both image name and tag. ,
Required: False ,
}
string ,
}
,
configuration:
{
Description: Configuration of the build. ,
Required: False ,
}
{
baseOs:
{
Description: Base OS used to build and run the app. ,
Required: False ,
}
string ,
platform:
{
Description: Platform to be used to build and run the app. ,
Required: False ,
}
string ,
platformVersion:
{
Description: Platform version to be used to build and run the app. ,
Required: False ,
}
string ,
environmentVariables:
{
Description: List of environment variables to be passed to the build, secrets should not be used in environment variable. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: True ,
}
string ,
value:
{
Description: Environment variable value. ,
Required: True ,
}
string ,
}
,
]
,
preBuildSteps:
{
Description: List of steps to perform before the build. ,
Required: False ,
}
[
{
description:
{
Description: Description of the pre-build step. ,
Required: False ,
}
string ,
scripts:
{
Description: List of custom commands to run. ,
Required: False ,
}
[
string ,
]
,
httpGet:
{
Description: Http get request to send before the build. ,
Required: False ,
}
{
url:
{
Description: URL to make HTTP GET request against. ,
Required: True ,
}
string ,
fileName:
{
Description: Name of the file that the request should be saved to. ,
Required: False ,
}
string ,
headers:
{
Description: List of headers to send with the request. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
uploadEndpoint:
{
Description: Endpoint to which the source code should be uploaded. ,
Required: False ,
}
string ,
logStreamEndpoint:
{
Description: Endpoint from which the build logs can be streamed. ,
Required: False ,
}
string ,
tokenEndpoint:
{
Description: Endpoint to use to retrieve an authentication token for log streaming and uploading source code. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Information pertaining to an individual build. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Build provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
buildStatus:
{
Description: Status of the build once it has been provisioned. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
destinationContainerRegistry:
{
Description: Container registry that the final image will be uploaded to. ,
Required: False ,
}
{
server:
{
Description: Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it. ,
Required: True ,
}
string ,
image:
{
Description: Full name that the final image should be uploaded as, including both image name and tag. ,
Required: False ,
}
string ,
}
,
configuration:
{
Description: Configuration of the build. ,
Required: False ,
}
{
baseOs:
{
Description: Base OS used to build and run the app. ,
Required: False ,
}
string ,
platform:
{
Description: Platform to be used to build and run the app. ,
Required: False ,
}
string ,
platformVersion:
{
Description: Platform version to be used to build and run the app. ,
Required: False ,
}
string ,
environmentVariables:
{
Description: List of environment variables to be passed to the build, secrets should not be used in environment variable. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: True ,
}
string ,
value:
{
Description: Environment variable value. ,
Required: True ,
}
string ,
}
,
]
,
preBuildSteps:
{
Description: List of steps to perform before the build. ,
Required: False ,
}
[
{
description:
{
Description: Description of the pre-build step. ,
Required: False ,
}
string ,
scripts:
{
Description: List of custom commands to run. ,
Required: False ,
}
[
string ,
]
,
httpGet:
{
Description: Http get request to send before the build. ,
Required: False ,
}
{
url:
{
Description: URL to make HTTP GET request against. ,
Required: True ,
}
string ,
fileName:
{
Description: Name of the file that the request should be saved to. ,
Required: False ,
}
string ,
headers:
{
Description: List of headers to send with the request. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
uploadEndpoint:
{
Description: Endpoint to which the source code should be uploaded. ,
Required: False ,
}
string ,
logStreamEndpoint:
{
Description: Endpoint from which the build logs can be streamed. ,
Required: False ,
}
string ,
tokenEndpoint:
{
Description: Endpoint to use to retrieve an authentication token for log streaming and uploading source code. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Builds_Delete (new)
Description :  Delete a BuildResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}/builds/{buildName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
builderName:
{
Description: The name of the builder. ,
Required: True ,
}
string ,
buildName:
{
Description: The name of a build. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BuildAuthToken_List (new)
Description :  Gets the token used to connect to the endpoint where source code can be uploaded for a build.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}/builds/{buildName}/listAuthToken
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
builderName:
{
Description: The name of the builder. ,
Required: True ,
}
string ,
buildName:
{
Description: The name of a build. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
token:
{
Description: Authentication token. ,
Required: False ,
}
string ,
expires:
{
Description: Token expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConnectedEnvironments_ListBySubscription (new)
Description :  Get all connectedEnvironments for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.App/connectedEnvironments
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: ConnectedEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the connectedEnvironment ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
customDomainConfiguration:
{
Description: Custom domain configuration for the environment ,
Required: False ,
}
{
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: Dns suffix for the environment domain ,
Required: False ,
}
string ,
certificateKeyVaultProperties:
{
Description: Certificate stored in Azure Key Vault. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret that holds the certificate. ,
Format: uri ,
Required: False ,
}
string ,
}
,
certificateValue:
{
Description: PFX or PEM blob ,
Format: byte ,
Required: False ,
}
string ,
certificatePassword:
{
Description: Certificate password ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ConnectedEnvironments_ListByResourceGroup (new)
Description :  Get all connectedEnvironments in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: ConnectedEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the connectedEnvironment ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
customDomainConfiguration:
{
Description: Custom domain configuration for the environment ,
Required: False ,
}
{
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: Dns suffix for the environment domain ,
Required: False ,
}
string ,
certificateKeyVaultProperties:
{
Description: Certificate stored in Azure Key Vault. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret that holds the certificate. ,
Format: uri ,
Required: False ,
}
string ,
}
,
certificateValue:
{
Description: PFX or PEM blob ,
Format: byte ,
Required: False ,
}
string ,
certificatePassword:
{
Description: Certificate password ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ConnectedEnvironments_Get (new)
Description :  Get the properties of an connectedEnvironment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the connectedEnvironment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: ConnectedEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the connectedEnvironment ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
customDomainConfiguration:
{
Description: Custom domain configuration for the environment ,
Required: False ,
}
{
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: Dns suffix for the environment domain ,
Required: False ,
}
string ,
certificateKeyVaultProperties:
{
Description: Certificate stored in Azure Key Vault. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret that holds the certificate. ,
Format: uri ,
Required: False ,
}
string ,
}
,
certificateValue:
{
Description: PFX or PEM blob ,
Format: byte ,
Required: False ,
}
string ,
certificatePassword:
{
Description: Certificate password ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ConnectedEnvironments_CreateOrUpdate (new)
Description :  Creates or updates an connectedEnvironment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the connectedEnvironment. ,
Required: True ,
}
string ,
environmentEnvelope:
{
Description: Configuration details of the connectedEnvironment. ,
Required: True ,
}
{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: ConnectedEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the connectedEnvironment ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
customDomainConfiguration:
{
Description: Custom domain configuration for the environment ,
Required: False ,
}
{
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: Dns suffix for the environment domain ,
Required: False ,
}
string ,
certificateKeyVaultProperties:
{
Description: Certificate stored in Azure Key Vault. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret that holds the certificate. ,
Format: uri ,
Required: False ,
}
string ,
}
,
certificateValue:
{
Description: PFX or PEM blob ,
Format: byte ,
Required: False ,
}
string ,
certificatePassword:
{
Description: Certificate password ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: ConnectedEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the connectedEnvironment ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
customDomainConfiguration:
{
Description: Custom domain configuration for the environment ,
Required: False ,
}
{
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: Dns suffix for the environment domain ,
Required: False ,
}
string ,
certificateKeyVaultProperties:
{
Description: Certificate stored in Azure Key Vault. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret that holds the certificate. ,
Format: uri ,
Required: False ,
}
string ,
}
,
certificateValue:
{
Description: PFX or PEM blob ,
Format: byte ,
Required: False ,
}
string ,
certificatePassword:
{
Description: Certificate password ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: ConnectedEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the connectedEnvironment ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
customDomainConfiguration:
{
Description: Custom domain configuration for the environment ,
Required: False ,
}
{
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: Dns suffix for the environment domain ,
Required: False ,
}
string ,
certificateKeyVaultProperties:
{
Description: Certificate stored in Azure Key Vault. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret that holds the certificate. ,
Format: uri ,
Required: False ,
}
string ,
}
,
certificateValue:
{
Description: PFX or PEM blob ,
Format: byte ,
Required: False ,
}
string ,
certificatePassword:
{
Description: Certificate password ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ConnectedEnvironments_Delete (new)
Description :  Delete an connectedEnvironment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the connectedEnvironment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ConnectedEnvironments_Update (new)
Description :  Patches a Managed Environment. Only patching of tags is supported currently
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the connectedEnvironment. ,
Required: True ,
}
string ,
environmentEnvelope:
{
Description: Configuration details of the connectedEnvironment. ,
Required: False ,
}
object ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: ConnectedEnvironment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Kubernetes Environment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Waiting: No description available. ,
InitializationInProgress: No description available. ,
InfrastructureSetupInProgress: No description available. ,
InfrastructureSetupComplete: No description available. ,
ScheduledForDelete: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
defaultDomain:
{
Description: Default Domain Name for the cluster ,
Required: False ,
}
string ,
staticIp:
{
Description: Static IP of the connectedEnvironment ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
customDomainConfiguration:
{
Description: Custom domain configuration for the environment ,
Required: False ,
}
{
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
dnsSuffix:
{
Description: Dns suffix for the environment domain ,
Required: False ,
}
string ,
certificateKeyVaultProperties:
{
Description: Certificate stored in Azure Key Vault. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret that holds the certificate. ,
Format: uri ,
Required: False ,
}
string ,
}
,
certificateValue:
{
Description: PFX or PEM blob ,
Format: byte ,
Required: False ,
}
string ,
certificatePassword:
{
Description: Certificate password ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ConnectedEnvironments_CheckNameAvailability (new)
Description :  Checks if resource connectedEnvironmentName is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/checkNameAvailability
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
checkNameAvailabilityRequest:
{
Description: The check connectedEnvironmentName availability request. ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ConnectedEnvironmentsCertificates_List (new)
Description :  Get the Certificates in a given connected environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the Connected Environment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the certificate. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
DeleteFailed: No description available. ,
Pending: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
certificateKeyVaultProperties:
{
Description: Properties for a certificate stored in a Key Vault. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret that holds the certificate. ,
Format: uri ,
Required: False ,
}
string ,
}
,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
subjectAlternativeNames:
{
Description: Subject alternative names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
value:
{
Description: PFX or PEM blob ,
Format: byte ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
certificateType:
{
Description: The type of the certificate. Allowed values are `ServerSSLCertificate` and `ImagePullTrustedCA` ,
Enum:
{
ServerSSLCertificate: No description available. ,
ImagePullTrustedCA: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ConnectedEnvironmentsCertificates_Get (new)
Description :  Get the specified Certificate.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the Connected Environment. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the Certificate. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the certificate. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
DeleteFailed: No description available. ,
Pending: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
certificateKeyVaultProperties:
{
Description: Properties for a certificate stored in a Key Vault. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret that holds the certificate. ,
Format: uri ,
Required: False ,
}
string ,
}
,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
subjectAlternativeNames:
{
Description: Subject alternative names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
value:
{
Description: PFX or PEM blob ,
Format: byte ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
certificateType:
{
Description: The type of the certificate. Allowed values are `ServerSSLCertificate` and `ImagePullTrustedCA` ,
Enum:
{
ServerSSLCertificate: No description available. ,
ImagePullTrustedCA: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ConnectedEnvironmentsCertificates_CreateOrUpdate (new)
Description :  Create or Update a Certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the Connected Environment. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the Certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Certificate to be created or updated ,
Required: False ,
}
{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the certificate. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
DeleteFailed: No description available. ,
Pending: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
certificateKeyVaultProperties:
{
Description: Properties for a certificate stored in a Key Vault. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret that holds the certificate. ,
Format: uri ,
Required: False ,
}
string ,
}
,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
subjectAlternativeNames:
{
Description: Subject alternative names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
value:
{
Description: PFX or PEM blob ,
Format: byte ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
certificateType:
{
Description: The type of the certificate. Allowed values are `ServerSSLCertificate` and `ImagePullTrustedCA` ,
Enum:
{
ServerSSLCertificate: No description available. ,
ImagePullTrustedCA: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the certificate. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
DeleteFailed: No description available. ,
Pending: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
certificateKeyVaultProperties:
{
Description: Properties for a certificate stored in a Key Vault. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret that holds the certificate. ,
Format: uri ,
Required: False ,
}
string ,
}
,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
subjectAlternativeNames:
{
Description: Subject alternative names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
value:
{
Description: PFX or PEM blob ,
Format: byte ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
certificateType:
{
Description: The type of the certificate. Allowed values are `ServerSSLCertificate` and `ImagePullTrustedCA` ,
Enum:
{
ServerSSLCertificate: No description available. ,
ImagePullTrustedCA: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the certificate. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
DeleteFailed: No description available. ,
Pending: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
certificateKeyVaultProperties:
{
Description: Properties for a certificate stored in a Key Vault. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret that holds the certificate. ,
Format: uri ,
Required: False ,
}
string ,
}
,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
subjectAlternativeNames:
{
Description: Subject alternative names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
value:
{
Description: PFX or PEM blob ,
Format: byte ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
certificateType:
{
Description: The type of the certificate. Allowed values are `ServerSSLCertificate` and `ImagePullTrustedCA` ,
Enum:
{
ServerSSLCertificate: No description available. ,
ImagePullTrustedCA: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConnectedEnvironmentsCertificates_Delete (new)
Description :  Deletes the specified Certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the Connected Environment. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the Certificate. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConnectedEnvironmentsCertificates_Update (new)
Description :  Patches a certificate. Currently only patching of tags is supported
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the Connected Environment. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of the Certificate. ,
Required: True ,
}
string ,
certificateEnvelope:
{
Description: Properties of a certificate that need to be updated ,
Required: True ,
}
{
tags:
{
Description: Application-specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Certificate resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the certificate. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
DeleteFailed: No description available. ,
Pending: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
certificateKeyVaultProperties:
{
Description: Properties for a certificate stored in a Key Vault. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret that holds the certificate. ,
Format: uri ,
Required: False ,
}
string ,
}
,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
subjectAlternativeNames:
{
Description: Subject alternative names the certificate applies to. ,
Required: False ,
}
[
string ,
]
,
value:
{
Description: PFX or PEM blob ,
Format: byte ,
Required: False ,
}
string ,
issuer:
{
Description: Certificate issuer. ,
Required: False ,
}
string ,
issueDate:
{
Description: Certificate issue Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Certificate expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
valid:
{
Description: Is the certificate valid?. ,
Required: False ,
}
boolean ,
publicKeyHash:
{
Description: Public key hash. ,
Required: False ,
}
string ,
certificateType:
{
Description: The type of the certificate. Allowed values are `ServerSSLCertificate` and `ImagePullTrustedCA` ,
Enum:
{
ServerSSLCertificate: No description available. ,
ImagePullTrustedCA: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConnectedEnvironmentsDaprComponents_List (new)
Description :  Get the Dapr Components for a connected environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the connected environment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of Dapr component resources. ,
Required: True ,
}
[
{
properties:
{
Description: Dapr component properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Connected Environment Dapr Component. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ConnectedEnvironmentsDaprComponents_Get (new)
Description :  Get a dapr component.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the connected environment. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the Dapr Component. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Dapr component properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Connected Environment Dapr Component. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ConnectedEnvironmentsDaprComponents_CreateOrUpdate (new)
Description :  Creates or updates a Dapr Component in a connected environment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the connected environment. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the Dapr Component. ,
Required: True ,
}
string ,
daprComponentEnvelope:
{
Description: Configuration details of the Dapr Component. ,
Required: True ,
}
{
properties:
{
Description: Dapr component properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Connected Environment Dapr Component. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Dapr component properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Connected Environment Dapr Component. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Dapr component properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Connected Environment Dapr Component. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConnectedEnvironmentsDaprComponents_Delete (new)
Description :  Delete a Dapr Component from a connected environment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the connected environment. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the Dapr Component. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConnectedEnvironmentsDaprComponents_ListSecrets (new)
Description :  List secrets for a dapr component
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}/listSecrets
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the connected environment. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the Dapr Component. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of secrets used by a Dapr component ,
Required: True ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ConnectedEnvironmentsStorages_List (new)
Description :  Get all storages for a connectedEnvironment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of storage resources. ,
Required: True ,
}
[
{
properties:
{
Description: Storage properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the storage. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
azureFile:
{
Description: Azure file properties ,
Required: False ,
}
{
accountName:
{
Description: Storage account name for azure file. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage account key for azure file. ,
Required: False ,
}
string ,
accountKeyVaultProperties:
{
Description: Storage account key stored as an Azure Key Vault secret. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret. ,
Required: False ,
}
string ,
}
,
accessMode:
{
Description: Access mode for storage ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Azure file share name. ,
Required: False ,
}
string ,
}
,
smb:
{
Description: SMB storage properties ,
Required: False ,
}
{
host:
{
Description: The host name or IP address of the SMB server. ,
Required: False ,
}
string ,
shareName:
{
Description: The path to the SMB shared folder. ,
Required: False ,
}
string ,
username:
{
Description: The user to log on to the SMB server. ,
Required: False ,
}
string ,
domain:
{
Description: The domain name for the user. ,
Required: False ,
}
string ,
password:
{
Description: The password for the user. ,
Required: False ,
}
string ,
accessMode:
{
Description: Access mode for storage ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ConnectedEnvironmentsStorages_Get (new)
Description :  Get storage for a connectedEnvironment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages/{storageName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
storageName:
{
Description: Name of the storage. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Storage properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the storage. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
azureFile:
{
Description: Azure file properties ,
Required: False ,
}
{
accountName:
{
Description: Storage account name for azure file. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage account key for azure file. ,
Required: False ,
}
string ,
accountKeyVaultProperties:
{
Description: Storage account key stored as an Azure Key Vault secret. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret. ,
Required: False ,
}
string ,
}
,
accessMode:
{
Description: Access mode for storage ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Azure file share name. ,
Required: False ,
}
string ,
}
,
smb:
{
Description: SMB storage properties ,
Required: False ,
}
{
host:
{
Description: The host name or IP address of the SMB server. ,
Required: False ,
}
string ,
shareName:
{
Description: The path to the SMB shared folder. ,
Required: False ,
}
string ,
username:
{
Description: The user to log on to the SMB server. ,
Required: False ,
}
string ,
domain:
{
Description: The domain name for the user. ,
Required: False ,
}
string ,
password:
{
Description: The password for the user. ,
Required: False ,
}
string ,
accessMode:
{
Description: Access mode for storage ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ConnectedEnvironmentsStorages_CreateOrUpdate (new)
Description :  Create or update storage for a connectedEnvironment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages/{storageName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
storageName:
{
Description: Name of the storage. ,
Required: True ,
}
string ,
storageEnvelope:
{
Description: Configuration details of storage. ,
Required: True ,
}
{
properties:
{
Description: Storage properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the storage. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
azureFile:
{
Description: Azure file properties ,
Required: False ,
}
{
accountName:
{
Description: Storage account name for azure file. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage account key for azure file. ,
Required: False ,
}
string ,
accountKeyVaultProperties:
{
Description: Storage account key stored as an Azure Key Vault secret. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret. ,
Required: False ,
}
string ,
}
,
accessMode:
{
Description: Access mode for storage ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Azure file share name. ,
Required: False ,
}
string ,
}
,
smb:
{
Description: SMB storage properties ,
Required: False ,
}
{
host:
{
Description: The host name or IP address of the SMB server. ,
Required: False ,
}
string ,
shareName:
{
Description: The path to the SMB shared folder. ,
Required: False ,
}
string ,
username:
{
Description: The user to log on to the SMB server. ,
Required: False ,
}
string ,
domain:
{
Description: The domain name for the user. ,
Required: False ,
}
string ,
password:
{
Description: The password for the user. ,
Required: False ,
}
string ,
accessMode:
{
Description: Access mode for storage ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Storage properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the storage. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
azureFile:
{
Description: Azure file properties ,
Required: False ,
}
{
accountName:
{
Description: Storage account name for azure file. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage account key for azure file. ,
Required: False ,
}
string ,
accountKeyVaultProperties:
{
Description: Storage account key stored as an Azure Key Vault secret. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret. ,
Required: False ,
}
string ,
}
,
accessMode:
{
Description: Access mode for storage ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Azure file share name. ,
Required: False ,
}
string ,
}
,
smb:
{
Description: SMB storage properties ,
Required: False ,
}
{
host:
{
Description: The host name or IP address of the SMB server. ,
Required: False ,
}
string ,
shareName:
{
Description: The path to the SMB shared folder. ,
Required: False ,
}
string ,
username:
{
Description: The user to log on to the SMB server. ,
Required: False ,
}
string ,
domain:
{
Description: The domain name for the user. ,
Required: False ,
}
string ,
password:
{
Description: The password for the user. ,
Required: False ,
}
string ,
accessMode:
{
Description: Access mode for storage ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Storage properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the storage. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
InProgress: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment or deployment validation ,
Required: False ,
}
string ,
azureFile:
{
Description: Azure file properties ,
Required: False ,
}
{
accountName:
{
Description: Storage account name for azure file. ,
Required: False ,
}
string ,
accountKey:
{
Description: Storage account key for azure file. ,
Required: False ,
}
string ,
accountKeyVaultProperties:
{
Description: Storage account key stored as an Azure Key Vault secret. ,
Required: False ,
}
{
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: URL pointing to the Azure Key Vault secret. ,
Required: False ,
}
string ,
}
,
accessMode:
{
Description: Access mode for storage ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Azure file share name. ,
Required: False ,
}
string ,
}
,
smb:
{
Description: SMB storage properties ,
Required: False ,
}
{
host:
{
Description: The host name or IP address of the SMB server. ,
Required: False ,
}
string ,
shareName:
{
Description: The path to the SMB shared folder. ,
Required: False ,
}
string ,
username:
{
Description: The user to log on to the SMB server. ,
Required: False ,
}
string ,
domain:
{
Description: The domain name for the user. ,
Required: False ,
}
string ,
password:
{
Description: The password for the user. ,
Required: False ,
}
string ,
accessMode:
{
Description: Access mode for storage ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConnectedEnvironmentsStorages_Delete (new)
Description :  Delete storage for a connectedEnvironment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages/{storageName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectedEnvironmentName:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
storageName:
{
Description: Name of the storage. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContainerApps_ListBySubscription (new)
Description :  Get the Container Apps in a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.App/containerApps
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used to render different experiences for resources of the same type; e.g. WorkflowApp is a kind of Microsoft.App/ContainerApps type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
workflowapp: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: ContainerApp resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container App. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStatus:
{
Description: Running status of the Container App. ,
Enum:
{
Progressing: Container App is transitioning between Stopped and Running states. ,
Running: Container App is in Running state. ,
Stopped: Container App is in Stopped state. ,
Suspended: Container App Job is in Suspended state. ,
Ready: Container App Job is in Ready state. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Deprecated. Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container app execution. ,
Required: False ,
}
string ,
patchingConfiguration:
{
Description: Container App auto patch configuration. ,
Required: False ,
}
{
patchingMode:
{
Description: Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
latestRevisionName:
{
Description: Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
latestReadyRevisionName:
{
Description: Name of the latest ready revision of the Container App. ,
Required: False ,
}
string ,
latestRevisionFqdn:
{
Description: Fully Qualified Domain Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
configuration:
{
Description: Non versioned Container App configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container app ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: Azure Key Vault URL pointing to the secret referenced by the container app. ,
Required: False ,
}
string ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Single: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.Multiple: Multiple revisions can be active, including optional traffic weights and labels.Labels: Only revisions with labels are active. Traffic weights can be applied to labels. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
Labels: No description available. ,
}
,
Required: False ,
}
enum ,
targetLabel:
{
Description: Required in labels revisions mode. Label to apply to newly created revision. ,
Required: False ,
}
string ,
ingress:
{
Description: Ingress configurations. ,
Required: False ,
}
{
fqdn:
{
Description: Hostname. ,
Required: False ,
}
string ,
external:
{
Description: Bool indicating if app exposes an external http endpoint ,
Required: False ,
}
boolean ,
targetPort:
{
Description: Target Port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
exposedPort:
{
Description: Exposed Port in containers for TCP traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: No description available. ,
tcp: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Traffic weights for app's revisions ,
Required: False ,
}
[
{
revisionName:
{
Description: Name of a revision ,
Required: False ,
}
string ,
weight:
{
Description: Traffic weight assigned to a revision ,
Format: int32 ,
Required: False ,
}
integer ,
latestRevision:
{
Description: Indicates that the traffic weight belongs to a latest stable revision ,
Required: False ,
}
boolean ,
label:
{
Description: Associates a traffic label with a revision ,
Required: False ,
}
string ,
}
,
]
,
customDomains:
{
Description: custom domain bindings for Container Apps' hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: True ,
}
string ,
bindingType:
{
Description: Custom Domain binding type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
Auto: No description available. ,
}
,
Required: False ,
}
enum ,
certificateId:
{
Description: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. ,
Required: False ,
}
string ,
}
,
]
,
allowInsecure:
{
Description: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Rules to restrict incoming IP address. ,
Required: False ,
}
[
{
name:
{
Description: Name for the IP restriction rule. ,
Required: True ,
}
string ,
description:
{
Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. ,
Required: False ,
}
string ,
ipAddressRange:
{
Description: CIDR notation to match incoming IP address ,
Required: True ,
}
string ,
action:
{
Description: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
stickySessions:
{
Description: Sticky Sessions for Single Revision Mode ,
Required: False ,
}
{
affinity:
{
Description: Sticky Session Affinity ,
Enum:
{
sticky: No description available. ,
none: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateMode:
{
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: No description available. ,
accept: No description available. ,
require: No description available. ,
}
,
Required: False ,
}
enum ,
corsPolicy:
{
Description: CORS policy for container app ,
Required: False ,
}
{
allowedOrigins:
{
Description: Specifies the content for the access-control-allow-origins header ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Specifies the content for the access-control-allow-methods header ,
Required: False ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Specifies the content for the access-control-allow-headers header ,
Required: False ,
}
[
string ,
]
,
exposeHeaders:
{
Description: Specifies the content for the access-control-expose-headers header ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: Specifies the content for the access-control-max-age header ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: Specifies whether the resource allows credentials ,
Required: False ,
}
boolean ,
}
,
additionalPortMappings:
{
Description: Settings to expose additional ports on container app ,
Required: False ,
}
[
{
external:
{
Description: Specifies whether the app port is accessible outside of the environment ,
Required: True ,
}
boolean ,
targetPort:
{
Description: Specifies the port user's container listens on ,
Format: int32 ,
Required: True ,
}
integer ,
exposedPort:
{
Description: Specifies the exposed port for the target port. If not specified, it defaults to target port ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetPortHttpScheme:
{
Description: Whether an http app listens on http or https ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
registries:
{
Description: Collection of private container registry credentials for containers used by the Container app ,
Required: False ,
}
[
{
server:
{
Description: Container Registry Server ,
Required: False ,
}
string ,
username:
{
Description: Container Registry Username ,
Required: False ,
}
string ,
passwordSecretRef:
{
Description: The name of the Secret that contains the registry login password ,
Required: False ,
}
string ,
identity:
{
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' ,
Required: False ,
}
string ,
}
,
]
,
dapr:
{
Description: Dapr configuration for the Container App. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appProtocol:
{
Description: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http ,
Enum:
{
http: No description available. ,
grpc: No description available. ,
}
,
Required: False ,
}
enum ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
appHealth:
{
Description: Dapr application health check configuration ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the health probe is enabled ,
Required: False ,
}
boolean ,
path:
{
Description: Path for the health probe ,
Required: False ,
}
string ,
probeIntervalSeconds:
{
Description: Interval for the health probe in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
probeTimeoutMilliseconds:
{
Description: Timeout for the health probe in milliseconds ,
Format: int32 ,
Required: False ,
}
integer ,
threshold:
{
Description: Threshold for the health probe ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maxConcurrency:
{
Description: Maximum number of concurrent requests, events handled by the Dapr sidecar ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
runtime:
{
Description: App runtime configuration for the Container App. ,
Required: False ,
}
{
java:
{
Description: Java app configuration ,
Required: False ,
}
{
enableMetrics:
{
Description: Enable jmx core metrics for the java app ,
Required: False ,
}
boolean ,
javaAgent:
{
Description: Diagnostic capabilities achieved by java agent ,
Required: False ,
}
{
enabled:
{
Description: Enable java agent injection for the java app. ,
Required: False ,
}
boolean ,
logging:
{
Description: Capabilities on the java logging scenario. ,
Required: False ,
}
{
loggerSettings:
{
Description: Settings of the logger for the java app. ,
Required: False ,
}
[
{
logger:
{
Description: Logger name. ,
Required: True ,
}
string ,
level:
{
Description: The specified logger's log level. ,
Enum:
{
off: No description available. ,
error: No description available. ,
info: No description available. ,
debug: No description available. ,
trace: No description available. ,
warn: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
dotnet:
{
Description: .NET app configuration ,
Required: False ,
}
{
autoConfigureDataProtection:
{
Description: Auto configure the ASP.NET Core Data Protection feature ,
Required: False ,
}
boolean ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
Format: int32 ,
Required: False ,
}
integer ,
revisionTransitionThreshold:
{
Description: Optional. The percent of the total number of replicas that must be brought up before revision transition occurs. Defaults to 100 when none is given. Value must be greater than 0 and less than or equal to 100. ,
Format: int32 ,
Required: False ,
}
integer ,
service:
{
Description: Container App to be a dev Container App Service ,
Required: False ,
}
{
type:
{
Description: Dev ContainerApp service type ,
Required: True ,
}
string ,
}
,
identitySettings:
{
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. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. ,
Enum:
{
Init: No description available. ,
Main: No description available. ,
None: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container app. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerApps_ListByResourceGroup (new)
Description :  Get the Container Apps in a given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used to render different experiences for resources of the same type; e.g. WorkflowApp is a kind of Microsoft.App/ContainerApps type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
workflowapp: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: ContainerApp resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container App. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStatus:
{
Description: Running status of the Container App. ,
Enum:
{
Progressing: Container App is transitioning between Stopped and Running states. ,
Running: Container App is in Running state. ,
Stopped: Container App is in Stopped state. ,
Suspended: Container App Job is in Suspended state. ,
Ready: Container App Job is in Ready state. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Deprecated. Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container app execution. ,
Required: False ,
}
string ,
patchingConfiguration:
{
Description: Container App auto patch configuration. ,
Required: False ,
}
{
patchingMode:
{
Description: Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
latestRevisionName:
{
Description: Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
latestReadyRevisionName:
{
Description: Name of the latest ready revision of the Container App. ,
Required: False ,
}
string ,
latestRevisionFqdn:
{
Description: Fully Qualified Domain Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
configuration:
{
Description: Non versioned Container App configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container app ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: Azure Key Vault URL pointing to the secret referenced by the container app. ,
Required: False ,
}
string ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Single: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.Multiple: Multiple revisions can be active, including optional traffic weights and labels.Labels: Only revisions with labels are active. Traffic weights can be applied to labels. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
Labels: No description available. ,
}
,
Required: False ,
}
enum ,
targetLabel:
{
Description: Required in labels revisions mode. Label to apply to newly created revision. ,
Required: False ,
}
string ,
ingress:
{
Description: Ingress configurations. ,
Required: False ,
}
{
fqdn:
{
Description: Hostname. ,
Required: False ,
}
string ,
external:
{
Description: Bool indicating if app exposes an external http endpoint ,
Required: False ,
}
boolean ,
targetPort:
{
Description: Target Port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
exposedPort:
{
Description: Exposed Port in containers for TCP traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: No description available. ,
tcp: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Traffic weights for app's revisions ,
Required: False ,
}
[
{
revisionName:
{
Description: Name of a revision ,
Required: False ,
}
string ,
weight:
{
Description: Traffic weight assigned to a revision ,
Format: int32 ,
Required: False ,
}
integer ,
latestRevision:
{
Description: Indicates that the traffic weight belongs to a latest stable revision ,
Required: False ,
}
boolean ,
label:
{
Description: Associates a traffic label with a revision ,
Required: False ,
}
string ,
}
,
]
,
customDomains:
{
Description: custom domain bindings for Container Apps' hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: True ,
}
string ,
bindingType:
{
Description: Custom Domain binding type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
Auto: No description available. ,
}
,
Required: False ,
}
enum ,
certificateId:
{
Description: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. ,
Required: False ,
}
string ,
}
,
]
,
allowInsecure:
{
Description: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Rules to restrict incoming IP address. ,
Required: False ,
}
[
{
name:
{
Description: Name for the IP restriction rule. ,
Required: True ,
}
string ,
description:
{
Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. ,
Required: False ,
}
string ,
ipAddressRange:
{
Description: CIDR notation to match incoming IP address ,
Required: True ,
}
string ,
action:
{
Description: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
stickySessions:
{
Description: Sticky Sessions for Single Revision Mode ,
Required: False ,
}
{
affinity:
{
Description: Sticky Session Affinity ,
Enum:
{
sticky: No description available. ,
none: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateMode:
{
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: No description available. ,
accept: No description available. ,
require: No description available. ,
}
,
Required: False ,
}
enum ,
corsPolicy:
{
Description: CORS policy for container app ,
Required: False ,
}
{
allowedOrigins:
{
Description: Specifies the content for the access-control-allow-origins header ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Specifies the content for the access-control-allow-methods header ,
Required: False ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Specifies the content for the access-control-allow-headers header ,
Required: False ,
}
[
string ,
]
,
exposeHeaders:
{
Description: Specifies the content for the access-control-expose-headers header ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: Specifies the content for the access-control-max-age header ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: Specifies whether the resource allows credentials ,
Required: False ,
}
boolean ,
}
,
additionalPortMappings:
{
Description: Settings to expose additional ports on container app ,
Required: False ,
}
[
{
external:
{
Description: Specifies whether the app port is accessible outside of the environment ,
Required: True ,
}
boolean ,
targetPort:
{
Description: Specifies the port user's container listens on ,
Format: int32 ,
Required: True ,
}
integer ,
exposedPort:
{
Description: Specifies the exposed port for the target port. If not specified, it defaults to target port ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetPortHttpScheme:
{
Description: Whether an http app listens on http or https ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
registries:
{
Description: Collection of private container registry credentials for containers used by the Container app ,
Required: False ,
}
[
{
server:
{
Description: Container Registry Server ,
Required: False ,
}
string ,
username:
{
Description: Container Registry Username ,
Required: False ,
}
string ,
passwordSecretRef:
{
Description: The name of the Secret that contains the registry login password ,
Required: False ,
}
string ,
identity:
{
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' ,
Required: False ,
}
string ,
}
,
]
,
dapr:
{
Description: Dapr configuration for the Container App. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appProtocol:
{
Description: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http ,
Enum:
{
http: No description available. ,
grpc: No description available. ,
}
,
Required: False ,
}
enum ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
appHealth:
{
Description: Dapr application health check configuration ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the health probe is enabled ,
Required: False ,
}
boolean ,
path:
{
Description: Path for the health probe ,
Required: False ,
}
string ,
probeIntervalSeconds:
{
Description: Interval for the health probe in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
probeTimeoutMilliseconds:
{
Description: Timeout for the health probe in milliseconds ,
Format: int32 ,
Required: False ,
}
integer ,
threshold:
{
Description: Threshold for the health probe ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maxConcurrency:
{
Description: Maximum number of concurrent requests, events handled by the Dapr sidecar ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
runtime:
{
Description: App runtime configuration for the Container App. ,
Required: False ,
}
{
java:
{
Description: Java app configuration ,
Required: False ,
}
{
enableMetrics:
{
Description: Enable jmx core metrics for the java app ,
Required: False ,
}
boolean ,
javaAgent:
{
Description: Diagnostic capabilities achieved by java agent ,
Required: False ,
}
{
enabled:
{
Description: Enable java agent injection for the java app. ,
Required: False ,
}
boolean ,
logging:
{
Description: Capabilities on the java logging scenario. ,
Required: False ,
}
{
loggerSettings:
{
Description: Settings of the logger for the java app. ,
Required: False ,
}
[
{
logger:
{
Description: Logger name. ,
Required: True ,
}
string ,
level:
{
Description: The specified logger's log level. ,
Enum:
{
off: No description available. ,
error: No description available. ,
info: No description available. ,
debug: No description available. ,
trace: No description available. ,
warn: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
dotnet:
{
Description: .NET app configuration ,
Required: False ,
}
{
autoConfigureDataProtection:
{
Description: Auto configure the ASP.NET Core Data Protection feature ,
Required: False ,
}
boolean ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
Format: int32 ,
Required: False ,
}
integer ,
revisionTransitionThreshold:
{
Description: Optional. The percent of the total number of replicas that must be brought up before revision transition occurs. Defaults to 100 when none is given. Value must be greater than 0 and less than or equal to 100. ,
Format: int32 ,
Required: False ,
}
integer ,
service:
{
Description: Container App to be a dev Container App Service ,
Required: False ,
}
{
type:
{
Description: Dev ContainerApp service type ,
Required: True ,
}
string ,
}
,
identitySettings:
{
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. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. ,
Enum:
{
Init: No description available. ,
Main: No description available. ,
None: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container app. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerApps_Get (new)
Description :  Get the properties of a Container App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used to render different experiences for resources of the same type; e.g. WorkflowApp is a kind of Microsoft.App/ContainerApps type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
workflowapp: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: ContainerApp resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container App. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStatus:
{
Description: Running status of the Container App. ,
Enum:
{
Progressing: Container App is transitioning between Stopped and Running states. ,
Running: Container App is in Running state. ,
Stopped: Container App is in Stopped state. ,
Suspended: Container App Job is in Suspended state. ,
Ready: Container App Job is in Ready state. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Deprecated. Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container app execution. ,
Required: False ,
}
string ,
patchingConfiguration:
{
Description: Container App auto patch configuration. ,
Required: False ,
}
{
patchingMode:
{
Description: Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
latestRevisionName:
{
Description: Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
latestReadyRevisionName:
{
Description: Name of the latest ready revision of the Container App. ,
Required: False ,
}
string ,
latestRevisionFqdn:
{
Description: Fully Qualified Domain Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
configuration:
{
Description: Non versioned Container App configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container app ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: Azure Key Vault URL pointing to the secret referenced by the container app. ,
Required: False ,
}
string ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Single: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.Multiple: Multiple revisions can be active, including optional traffic weights and labels.Labels: Only revisions with labels are active. Traffic weights can be applied to labels. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
Labels: No description available. ,
}
,
Required: False ,
}
enum ,
targetLabel:
{
Description: Required in labels revisions mode. Label to apply to newly created revision. ,
Required: False ,
}
string ,
ingress:
{
Description: Ingress configurations. ,
Required: False ,
}
{
fqdn:
{
Description: Hostname. ,
Required: False ,
}
string ,
external:
{
Description: Bool indicating if app exposes an external http endpoint ,
Required: False ,
}
boolean ,
targetPort:
{
Description: Target Port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
exposedPort:
{
Description: Exposed Port in containers for TCP traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: No description available. ,
tcp: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Traffic weights for app's revisions ,
Required: False ,
}
[
{
revisionName:
{
Description: Name of a revision ,
Required: False ,
}
string ,
weight:
{
Description: Traffic weight assigned to a revision ,
Format: int32 ,
Required: False ,
}
integer ,
latestRevision:
{
Description: Indicates that the traffic weight belongs to a latest stable revision ,
Required: False ,
}
boolean ,
label:
{
Description: Associates a traffic label with a revision ,
Required: False ,
}
string ,
}
,
]
,
customDomains:
{
Description: custom domain bindings for Container Apps' hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: True ,
}
string ,
bindingType:
{
Description: Custom Domain binding type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
Auto: No description available. ,
}
,
Required: False ,
}
enum ,
certificateId:
{
Description: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. ,
Required: False ,
}
string ,
}
,
]
,
allowInsecure:
{
Description: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Rules to restrict incoming IP address. ,
Required: False ,
}
[
{
name:
{
Description: Name for the IP restriction rule. ,
Required: True ,
}
string ,
description:
{
Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. ,
Required: False ,
}
string ,
ipAddressRange:
{
Description: CIDR notation to match incoming IP address ,
Required: True ,
}
string ,
action:
{
Description: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
stickySessions:
{
Description: Sticky Sessions for Single Revision Mode ,
Required: False ,
}
{
affinity:
{
Description: Sticky Session Affinity ,
Enum:
{
sticky: No description available. ,
none: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateMode:
{
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: No description available. ,
accept: No description available. ,
require: No description available. ,
}
,
Required: False ,
}
enum ,
corsPolicy:
{
Description: CORS policy for container app ,
Required: False ,
}
{
allowedOrigins:
{
Description: Specifies the content for the access-control-allow-origins header ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Specifies the content for the access-control-allow-methods header ,
Required: False ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Specifies the content for the access-control-allow-headers header ,
Required: False ,
}
[
string ,
]
,
exposeHeaders:
{
Description: Specifies the content for the access-control-expose-headers header ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: Specifies the content for the access-control-max-age header ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: Specifies whether the resource allows credentials ,
Required: False ,
}
boolean ,
}
,
additionalPortMappings:
{
Description: Settings to expose additional ports on container app ,
Required: False ,
}
[
{
external:
{
Description: Specifies whether the app port is accessible outside of the environment ,
Required: True ,
}
boolean ,
targetPort:
{
Description: Specifies the port user's container listens on ,
Format: int32 ,
Required: True ,
}
integer ,
exposedPort:
{
Description: Specifies the exposed port for the target port. If not specified, it defaults to target port ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetPortHttpScheme:
{
Description: Whether an http app listens on http or https ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
registries:
{
Description: Collection of private container registry credentials for containers used by the Container app ,
Required: False ,
}
[
{
server:
{
Description: Container Registry Server ,
Required: False ,
}
string ,
username:
{
Description: Container Registry Username ,
Required: False ,
}
string ,
passwordSecretRef:
{
Description: The name of the Secret that contains the registry login password ,
Required: False ,
}
string ,
identity:
{
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' ,
Required: False ,
}
string ,
}
,
]
,
dapr:
{
Description: Dapr configuration for the Container App. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appProtocol:
{
Description: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http ,
Enum:
{
http: No description available. ,
grpc: No description available. ,
}
,
Required: False ,
}
enum ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
appHealth:
{
Description: Dapr application health check configuration ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the health probe is enabled ,
Required: False ,
}
boolean ,
path:
{
Description: Path for the health probe ,
Required: False ,
}
string ,
probeIntervalSeconds:
{
Description: Interval for the health probe in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
probeTimeoutMilliseconds:
{
Description: Timeout for the health probe in milliseconds ,
Format: int32 ,
Required: False ,
}
integer ,
threshold:
{
Description: Threshold for the health probe ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maxConcurrency:
{
Description: Maximum number of concurrent requests, events handled by the Dapr sidecar ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
runtime:
{
Description: App runtime configuration for the Container App. ,
Required: False ,
}
{
java:
{
Description: Java app configuration ,
Required: False ,
}
{
enableMetrics:
{
Description: Enable jmx core metrics for the java app ,
Required: False ,
}
boolean ,
javaAgent:
{
Description: Diagnostic capabilities achieved by java agent ,
Required: False ,
}
{
enabled:
{
Description: Enable java agent injection for the java app. ,
Required: False ,
}
boolean ,
logging:
{
Description: Capabilities on the java logging scenario. ,
Required: False ,
}
{
loggerSettings:
{
Description: Settings of the logger for the java app. ,
Required: False ,
}
[
{
logger:
{
Description: Logger name. ,
Required: True ,
}
string ,
level:
{
Description: The specified logger's log level. ,
Enum:
{
off: No description available. ,
error: No description available. ,
info: No description available. ,
debug: No description available. ,
trace: No description available. ,
warn: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
dotnet:
{
Description: .NET app configuration ,
Required: False ,
}
{
autoConfigureDataProtection:
{
Description: Auto configure the ASP.NET Core Data Protection feature ,
Required: False ,
}
boolean ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
Format: int32 ,
Required: False ,
}
integer ,
revisionTransitionThreshold:
{
Description: Optional. The percent of the total number of replicas that must be brought up before revision transition occurs. Defaults to 100 when none is given. Value must be greater than 0 and less than or equal to 100. ,
Format: int32 ,
Required: False ,
}
integer ,
service:
{
Description: Container App to be a dev Container App Service ,
Required: False ,
}
{
type:
{
Description: Dev ContainerApp service type ,
Required: True ,
}
string ,
}
,
identitySettings:
{
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. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. ,
Enum:
{
Init: No description available. ,
Main: No description available. ,
None: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container app. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerApps_CreateOrUpdate (new)
Description :  Create or update a Container App.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
containerAppEnvelope:
{
Description: Properties used to create a container app ,
Required: True ,
}
{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used to render different experiences for resources of the same type; e.g. WorkflowApp is a kind of Microsoft.App/ContainerApps type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
workflowapp: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: ContainerApp resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container App. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStatus:
{
Description: Running status of the Container App. ,
Enum:
{
Progressing: Container App is transitioning between Stopped and Running states. ,
Running: Container App is in Running state. ,
Stopped: Container App is in Stopped state. ,
Suspended: Container App Job is in Suspended state. ,
Ready: Container App Job is in Ready state. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Deprecated. Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container app execution. ,
Required: False ,
}
string ,
patchingConfiguration:
{
Description: Container App auto patch configuration. ,
Required: False ,
}
{
patchingMode:
{
Description: Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
latestRevisionName:
{
Description: Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
latestReadyRevisionName:
{
Description: Name of the latest ready revision of the Container App. ,
Required: False ,
}
string ,
latestRevisionFqdn:
{
Description: Fully Qualified Domain Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
configuration:
{
Description: Non versioned Container App configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container app ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: Azure Key Vault URL pointing to the secret referenced by the container app. ,
Required: False ,
}
string ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Single: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.Multiple: Multiple revisions can be active, including optional traffic weights and labels.Labels: Only revisions with labels are active. Traffic weights can be applied to labels. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
Labels: No description available. ,
}
,
Required: False ,
}
enum ,
targetLabel:
{
Description: Required in labels revisions mode. Label to apply to newly created revision. ,
Required: False ,
}
string ,
ingress:
{
Description: Ingress configurations. ,
Required: False ,
}
{
fqdn:
{
Description: Hostname. ,
Required: False ,
}
string ,
external:
{
Description: Bool indicating if app exposes an external http endpoint ,
Required: False ,
}
boolean ,
targetPort:
{
Description: Target Port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
exposedPort:
{
Description: Exposed Port in containers for TCP traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: No description available. ,
tcp: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Traffic weights for app's revisions ,
Required: False ,
}
[
{
revisionName:
{
Description: Name of a revision ,
Required: False ,
}
string ,
weight:
{
Description: Traffic weight assigned to a revision ,
Format: int32 ,
Required: False ,
}
integer ,
latestRevision:
{
Description: Indicates that the traffic weight belongs to a latest stable revision ,
Required: False ,
}
boolean ,
label:
{
Description: Associates a traffic label with a revision ,
Required: False ,
}
string ,
}
,
]
,
customDomains:
{
Description: custom domain bindings for Container Apps' hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: True ,
}
string ,
bindingType:
{
Description: Custom Domain binding type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
Auto: No description available. ,
}
,
Required: False ,
}
enum ,
certificateId:
{
Description: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. ,
Required: False ,
}
string ,
}
,
]
,
allowInsecure:
{
Description: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Rules to restrict incoming IP address. ,
Required: False ,
}
[
{
name:
{
Description: Name for the IP restriction rule. ,
Required: True ,
}
string ,
description:
{
Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. ,
Required: False ,
}
string ,
ipAddressRange:
{
Description: CIDR notation to match incoming IP address ,
Required: True ,
}
string ,
action:
{
Description: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
stickySessions:
{
Description: Sticky Sessions for Single Revision Mode ,
Required: False ,
}
{
affinity:
{
Description: Sticky Session Affinity ,
Enum:
{
sticky: No description available. ,
none: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateMode:
{
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: No description available. ,
accept: No description available. ,
require: No description available. ,
}
,
Required: False ,
}
enum ,
corsPolicy:
{
Description: CORS policy for container app ,
Required: False ,
}
{
allowedOrigins:
{
Description: Specifies the content for the access-control-allow-origins header ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Specifies the content for the access-control-allow-methods header ,
Required: False ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Specifies the content for the access-control-allow-headers header ,
Required: False ,
}
[
string ,
]
,
exposeHeaders:
{
Description: Specifies the content for the access-control-expose-headers header ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: Specifies the content for the access-control-max-age header ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: Specifies whether the resource allows credentials ,
Required: False ,
}
boolean ,
}
,
additionalPortMappings:
{
Description: Settings to expose additional ports on container app ,
Required: False ,
}
[
{
external:
{
Description: Specifies whether the app port is accessible outside of the environment ,
Required: True ,
}
boolean ,
targetPort:
{
Description: Specifies the port user's container listens on ,
Format: int32 ,
Required: True ,
}
integer ,
exposedPort:
{
Description: Specifies the exposed port for the target port. If not specified, it defaults to target port ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetPortHttpScheme:
{
Description: Whether an http app listens on http or https ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
registries:
{
Description: Collection of private container registry credentials for containers used by the Container app ,
Required: False ,
}
[
{
server:
{
Description: Container Registry Server ,
Required: False ,
}
string ,
username:
{
Description: Container Registry Username ,
Required: False ,
}
string ,
passwordSecretRef:
{
Description: The name of the Secret that contains the registry login password ,
Required: False ,
}
string ,
identity:
{
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' ,
Required: False ,
}
string ,
}
,
]
,
dapr:
{
Description: Dapr configuration for the Container App. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appProtocol:
{
Description: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http ,
Enum:
{
http: No description available. ,
grpc: No description available. ,
}
,
Required: False ,
}
enum ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
appHealth:
{
Description: Dapr application health check configuration ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the health probe is enabled ,
Required: False ,
}
boolean ,
path:
{
Description: Path for the health probe ,
Required: False ,
}
string ,
probeIntervalSeconds:
{
Description: Interval for the health probe in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
probeTimeoutMilliseconds:
{
Description: Timeout for the health probe in milliseconds ,
Format: int32 ,
Required: False ,
}
integer ,
threshold:
{
Description: Threshold for the health probe ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maxConcurrency:
{
Description: Maximum number of concurrent requests, events handled by the Dapr sidecar ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
runtime:
{
Description: App runtime configuration for the Container App. ,
Required: False ,
}
{
java:
{
Description: Java app configuration ,
Required: False ,
}
{
enableMetrics:
{
Description: Enable jmx core metrics for the java app ,
Required: False ,
}
boolean ,
javaAgent:
{
Description: Diagnostic capabilities achieved by java agent ,
Required: False ,
}
{
enabled:
{
Description: Enable java agent injection for the java app. ,
Required: False ,
}
boolean ,
logging:
{
Description: Capabilities on the java logging scenario. ,
Required: False ,
}
{
loggerSettings:
{
Description: Settings of the logger for the java app. ,
Required: False ,
}
[
{
logger:
{
Description: Logger name. ,
Required: True ,
}
string ,
level:
{
Description: The specified logger's log level. ,
Enum:
{
off: No description available. ,
error: No description available. ,
info: No description available. ,
debug: No description available. ,
trace: No description available. ,
warn: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
dotnet:
{
Description: .NET app configuration ,
Required: False ,
}
{
autoConfigureDataProtection:
{
Description: Auto configure the ASP.NET Core Data Protection feature ,
Required: False ,
}
boolean ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
Format: int32 ,
Required: False ,
}
integer ,
revisionTransitionThreshold:
{
Description: Optional. The percent of the total number of replicas that must be brought up before revision transition occurs. Defaults to 100 when none is given. Value must be greater than 0 and less than or equal to 100. ,
Format: int32 ,
Required: False ,
}
integer ,
service:
{
Description: Container App to be a dev Container App Service ,
Required: False ,
}
{
type:
{
Description: Dev ContainerApp service type ,
Required: True ,
}
string ,
}
,
identitySettings:
{
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. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. ,
Enum:
{
Init: No description available. ,
Main: No description available. ,
None: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container app. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used to render different experiences for resources of the same type; e.g. WorkflowApp is a kind of Microsoft.App/ContainerApps type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
workflowapp: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: ContainerApp resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container App. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStatus:
{
Description: Running status of the Container App. ,
Enum:
{
Progressing: Container App is transitioning between Stopped and Running states. ,
Running: Container App is in Running state. ,
Stopped: Container App is in Stopped state. ,
Suspended: Container App Job is in Suspended state. ,
Ready: Container App Job is in Ready state. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Deprecated. Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container app execution. ,
Required: False ,
}
string ,
patchingConfiguration:
{
Description: Container App auto patch configuration. ,
Required: False ,
}
{
patchingMode:
{
Description: Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
latestRevisionName:
{
Description: Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
latestReadyRevisionName:
{
Description: Name of the latest ready revision of the Container App. ,
Required: False ,
}
string ,
latestRevisionFqdn:
{
Description: Fully Qualified Domain Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
configuration:
{
Description: Non versioned Container App configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container app ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: Azure Key Vault URL pointing to the secret referenced by the container app. ,
Required: False ,
}
string ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Single: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.Multiple: Multiple revisions can be active, including optional traffic weights and labels.Labels: Only revisions with labels are active. Traffic weights can be applied to labels. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
Labels: No description available. ,
}
,
Required: False ,
}
enum ,
targetLabel:
{
Description: Required in labels revisions mode. Label to apply to newly created revision. ,
Required: False ,
}
string ,
ingress:
{
Description: Ingress configurations. ,
Required: False ,
}
{
fqdn:
{
Description: Hostname. ,
Required: False ,
}
string ,
external:
{
Description: Bool indicating if app exposes an external http endpoint ,
Required: False ,
}
boolean ,
targetPort:
{
Description: Target Port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
exposedPort:
{
Description: Exposed Port in containers for TCP traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: No description available. ,
tcp: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Traffic weights for app's revisions ,
Required: False ,
}
[
{
revisionName:
{
Description: Name of a revision ,
Required: False ,
}
string ,
weight:
{
Description: Traffic weight assigned to a revision ,
Format: int32 ,
Required: False ,
}
integer ,
latestRevision:
{
Description: Indicates that the traffic weight belongs to a latest stable revision ,
Required: False ,
}
boolean ,
label:
{
Description: Associates a traffic label with a revision ,
Required: False ,
}
string ,
}
,
]
,
customDomains:
{
Description: custom domain bindings for Container Apps' hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: True ,
}
string ,
bindingType:
{
Description: Custom Domain binding type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
Auto: No description available. ,
}
,
Required: False ,
}
enum ,
certificateId:
{
Description: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. ,
Required: False ,
}
string ,
}
,
]
,
allowInsecure:
{
Description: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Rules to restrict incoming IP address. ,
Required: False ,
}
[
{
name:
{
Description: Name for the IP restriction rule. ,
Required: True ,
}
string ,
description:
{
Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. ,
Required: False ,
}
string ,
ipAddressRange:
{
Description: CIDR notation to match incoming IP address ,
Required: True ,
}
string ,
action:
{
Description: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
stickySessions:
{
Description: Sticky Sessions for Single Revision Mode ,
Required: False ,
}
{
affinity:
{
Description: Sticky Session Affinity ,
Enum:
{
sticky: No description available. ,
none: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateMode:
{
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: No description available. ,
accept: No description available. ,
require: No description available. ,
}
,
Required: False ,
}
enum ,
corsPolicy:
{
Description: CORS policy for container app ,
Required: False ,
}
{
allowedOrigins:
{
Description: Specifies the content for the access-control-allow-origins header ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Specifies the content for the access-control-allow-methods header ,
Required: False ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Specifies the content for the access-control-allow-headers header ,
Required: False ,
}
[
string ,
]
,
exposeHeaders:
{
Description: Specifies the content for the access-control-expose-headers header ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: Specifies the content for the access-control-max-age header ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: Specifies whether the resource allows credentials ,
Required: False ,
}
boolean ,
}
,
additionalPortMappings:
{
Description: Settings to expose additional ports on container app ,
Required: False ,
}
[
{
external:
{
Description: Specifies whether the app port is accessible outside of the environment ,
Required: True ,
}
boolean ,
targetPort:
{
Description: Specifies the port user's container listens on ,
Format: int32 ,
Required: True ,
}
integer ,
exposedPort:
{
Description: Specifies the exposed port for the target port. If not specified, it defaults to target port ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetPortHttpScheme:
{
Description: Whether an http app listens on http or https ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
registries:
{
Description: Collection of private container registry credentials for containers used by the Container app ,
Required: False ,
}
[
{
server:
{
Description: Container Registry Server ,
Required: False ,
}
string ,
username:
{
Description: Container Registry Username ,
Required: False ,
}
string ,
passwordSecretRef:
{
Description: The name of the Secret that contains the registry login password ,
Required: False ,
}
string ,
identity:
{
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' ,
Required: False ,
}
string ,
}
,
]
,
dapr:
{
Description: Dapr configuration for the Container App. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appProtocol:
{
Description: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http ,
Enum:
{
http: No description available. ,
grpc: No description available. ,
}
,
Required: False ,
}
enum ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
appHealth:
{
Description: Dapr application health check configuration ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the health probe is enabled ,
Required: False ,
}
boolean ,
path:
{
Description: Path for the health probe ,
Required: False ,
}
string ,
probeIntervalSeconds:
{
Description: Interval for the health probe in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
probeTimeoutMilliseconds:
{
Description: Timeout for the health probe in milliseconds ,
Format: int32 ,
Required: False ,
}
integer ,
threshold:
{
Description: Threshold for the health probe ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maxConcurrency:
{
Description: Maximum number of concurrent requests, events handled by the Dapr sidecar ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
runtime:
{
Description: App runtime configuration for the Container App. ,
Required: False ,
}
{
java:
{
Description: Java app configuration ,
Required: False ,
}
{
enableMetrics:
{
Description: Enable jmx core metrics for the java app ,
Required: False ,
}
boolean ,
javaAgent:
{
Description: Diagnostic capabilities achieved by java agent ,
Required: False ,
}
{
enabled:
{
Description: Enable java agent injection for the java app. ,
Required: False ,
}
boolean ,
logging:
{
Description: Capabilities on the java logging scenario. ,
Required: False ,
}
{
loggerSettings:
{
Description: Settings of the logger for the java app. ,
Required: False ,
}
[
{
logger:
{
Description: Logger name. ,
Required: True ,
}
string ,
level:
{
Description: The specified logger's log level. ,
Enum:
{
off: No description available. ,
error: No description available. ,
info: No description available. ,
debug: No description available. ,
trace: No description available. ,
warn: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
dotnet:
{
Description: .NET app configuration ,
Required: False ,
}
{
autoConfigureDataProtection:
{
Description: Auto configure the ASP.NET Core Data Protection feature ,
Required: False ,
}
boolean ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
Format: int32 ,
Required: False ,
}
integer ,
revisionTransitionThreshold:
{
Description: Optional. The percent of the total number of replicas that must be brought up before revision transition occurs. Defaults to 100 when none is given. Value must be greater than 0 and less than or equal to 100. ,
Format: int32 ,
Required: False ,
}
integer ,
service:
{
Description: Container App to be a dev Container App Service ,
Required: False ,
}
{
type:
{
Description: Dev ContainerApp service type ,
Required: True ,
}
string ,
}
,
identitySettings:
{
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. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. ,
Enum:
{
Init: No description available. ,
Main: No description available. ,
None: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container app. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used to render different experiences for resources of the same type; e.g. WorkflowApp is a kind of Microsoft.App/ContainerApps type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
workflowapp: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: ContainerApp resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container App. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStatus:
{
Description: Running status of the Container App. ,
Enum:
{
Progressing: Container App is transitioning between Stopped and Running states. ,
Running: Container App is in Running state. ,
Stopped: Container App is in Stopped state. ,
Suspended: Container App Job is in Suspended state. ,
Ready: Container App Job is in Ready state. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Deprecated. Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container app execution. ,
Required: False ,
}
string ,
patchingConfiguration:
{
Description: Container App auto patch configuration. ,
Required: False ,
}
{
patchingMode:
{
Description: Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
latestRevisionName:
{
Description: Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
latestReadyRevisionName:
{
Description: Name of the latest ready revision of the Container App. ,
Required: False ,
}
string ,
latestRevisionFqdn:
{
Description: Fully Qualified Domain Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
configuration:
{
Description: Non versioned Container App configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container app ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: Azure Key Vault URL pointing to the secret referenced by the container app. ,
Required: False ,
}
string ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Single: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.Multiple: Multiple revisions can be active, including optional traffic weights and labels.Labels: Only revisions with labels are active. Traffic weights can be applied to labels. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
Labels: No description available. ,
}
,
Required: False ,
}
enum ,
targetLabel:
{
Description: Required in labels revisions mode. Label to apply to newly created revision. ,
Required: False ,
}
string ,
ingress:
{
Description: Ingress configurations. ,
Required: False ,
}
{
fqdn:
{
Description: Hostname. ,
Required: False ,
}
string ,
external:
{
Description: Bool indicating if app exposes an external http endpoint ,
Required: False ,
}
boolean ,
targetPort:
{
Description: Target Port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
exposedPort:
{
Description: Exposed Port in containers for TCP traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: No description available. ,
tcp: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Traffic weights for app's revisions ,
Required: False ,
}
[
{
revisionName:
{
Description: Name of a revision ,
Required: False ,
}
string ,
weight:
{
Description: Traffic weight assigned to a revision ,
Format: int32 ,
Required: False ,
}
integer ,
latestRevision:
{
Description: Indicates that the traffic weight belongs to a latest stable revision ,
Required: False ,
}
boolean ,
label:
{
Description: Associates a traffic label with a revision ,
Required: False ,
}
string ,
}
,
]
,
customDomains:
{
Description: custom domain bindings for Container Apps' hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: True ,
}
string ,
bindingType:
{
Description: Custom Domain binding type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
Auto: No description available. ,
}
,
Required: False ,
}
enum ,
certificateId:
{
Description: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. ,
Required: False ,
}
string ,
}
,
]
,
allowInsecure:
{
Description: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Rules to restrict incoming IP address. ,
Required: False ,
}
[
{
name:
{
Description: Name for the IP restriction rule. ,
Required: True ,
}
string ,
description:
{
Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. ,
Required: False ,
}
string ,
ipAddressRange:
{
Description: CIDR notation to match incoming IP address ,
Required: True ,
}
string ,
action:
{
Description: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
stickySessions:
{
Description: Sticky Sessions for Single Revision Mode ,
Required: False ,
}
{
affinity:
{
Description: Sticky Session Affinity ,
Enum:
{
sticky: No description available. ,
none: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateMode:
{
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: No description available. ,
accept: No description available. ,
require: No description available. ,
}
,
Required: False ,
}
enum ,
corsPolicy:
{
Description: CORS policy for container app ,
Required: False ,
}
{
allowedOrigins:
{
Description: Specifies the content for the access-control-allow-origins header ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Specifies the content for the access-control-allow-methods header ,
Required: False ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Specifies the content for the access-control-allow-headers header ,
Required: False ,
}
[
string ,
]
,
exposeHeaders:
{
Description: Specifies the content for the access-control-expose-headers header ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: Specifies the content for the access-control-max-age header ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: Specifies whether the resource allows credentials ,
Required: False ,
}
boolean ,
}
,
additionalPortMappings:
{
Description: Settings to expose additional ports on container app ,
Required: False ,
}
[
{
external:
{
Description: Specifies whether the app port is accessible outside of the environment ,
Required: True ,
}
boolean ,
targetPort:
{
Description: Specifies the port user's container listens on ,
Format: int32 ,
Required: True ,
}
integer ,
exposedPort:
{
Description: Specifies the exposed port for the target port. If not specified, it defaults to target port ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetPortHttpScheme:
{
Description: Whether an http app listens on http or https ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
registries:
{
Description: Collection of private container registry credentials for containers used by the Container app ,
Required: False ,
}
[
{
server:
{
Description: Container Registry Server ,
Required: False ,
}
string ,
username:
{
Description: Container Registry Username ,
Required: False ,
}
string ,
passwordSecretRef:
{
Description: The name of the Secret that contains the registry login password ,
Required: False ,
}
string ,
identity:
{
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' ,
Required: False ,
}
string ,
}
,
]
,
dapr:
{
Description: Dapr configuration for the Container App. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appProtocol:
{
Description: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http ,
Enum:
{
http: No description available. ,
grpc: No description available. ,
}
,
Required: False ,
}
enum ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
appHealth:
{
Description: Dapr application health check configuration ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the health probe is enabled ,
Required: False ,
}
boolean ,
path:
{
Description: Path for the health probe ,
Required: False ,
}
string ,
probeIntervalSeconds:
{
Description: Interval for the health probe in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
probeTimeoutMilliseconds:
{
Description: Timeout for the health probe in milliseconds ,
Format: int32 ,
Required: False ,
}
integer ,
threshold:
{
Description: Threshold for the health probe ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maxConcurrency:
{
Description: Maximum number of concurrent requests, events handled by the Dapr sidecar ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
runtime:
{
Description: App runtime configuration for the Container App. ,
Required: False ,
}
{
java:
{
Description: Java app configuration ,
Required: False ,
}
{
enableMetrics:
{
Description: Enable jmx core metrics for the java app ,
Required: False ,
}
boolean ,
javaAgent:
{
Description: Diagnostic capabilities achieved by java agent ,
Required: False ,
}
{
enabled:
{
Description: Enable java agent injection for the java app. ,
Required: False ,
}
boolean ,
logging:
{
Description: Capabilities on the java logging scenario. ,
Required: False ,
}
{
loggerSettings:
{
Description: Settings of the logger for the java app. ,
Required: False ,
}
[
{
logger:
{
Description: Logger name. ,
Required: True ,
}
string ,
level:
{
Description: The specified logger's log level. ,
Enum:
{
off: No description available. ,
error: No description available. ,
info: No description available. ,
debug: No description available. ,
trace: No description available. ,
warn: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
dotnet:
{
Description: .NET app configuration ,
Required: False ,
}
{
autoConfigureDataProtection:
{
Description: Auto configure the ASP.NET Core Data Protection feature ,
Required: False ,
}
boolean ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
Format: int32 ,
Required: False ,
}
integer ,
revisionTransitionThreshold:
{
Description: Optional. The percent of the total number of replicas that must be brought up before revision transition occurs. Defaults to 100 when none is given. Value must be greater than 0 and less than or equal to 100. ,
Format: int32 ,
Required: False ,
}
integer ,
service:
{
Description: Container App to be a dev Container App Service ,
Required: False ,
}
{
type:
{
Description: Dev ContainerApp service type ,
Required: True ,
}
string ,
}
,
identitySettings:
{
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. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. ,
Enum:
{
Init: No description available. ,
Main: No description available. ,
None: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container app. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerApps_Delete (new)
Description :  Delete a Container App.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerApps_Update (new)
Description :  Patches a Container App using JSON Merge Patch
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
containerAppEnvelope:
{
Description: Properties of a Container App that need to be updated ,
Required: True ,
}
{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used to render different experiences for resources of the same type; e.g. WorkflowApp is a kind of Microsoft.App/ContainerApps type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
workflowapp: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: ContainerApp resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container App. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStatus:
{
Description: Running status of the Container App. ,
Enum:
{
Progressing: Container App is transitioning between Stopped and Running states. ,
Running: Container App is in Running state. ,
Stopped: Container App is in Stopped state. ,
Suspended: Container App Job is in Suspended state. ,
Ready: Container App Job is in Ready state. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Deprecated. Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container app execution. ,
Required: False ,
}
string ,
patchingConfiguration:
{
Description: Container App auto patch configuration. ,
Required: False ,
}
{
patchingMode:
{
Description: Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
latestRevisionName:
{
Description: Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
latestReadyRevisionName:
{
Description: Name of the latest ready revision of the Container App. ,
Required: False ,
}
string ,
latestRevisionFqdn:
{
Description: Fully Qualified Domain Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
configuration:
{
Description: Non versioned Container App configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container app ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: Azure Key Vault URL pointing to the secret referenced by the container app. ,
Required: False ,
}
string ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Single: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.Multiple: Multiple revisions can be active, including optional traffic weights and labels.Labels: Only revisions with labels are active. Traffic weights can be applied to labels. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
Labels: No description available. ,
}
,
Required: False ,
}
enum ,
targetLabel:
{
Description: Required in labels revisions mode. Label to apply to newly created revision. ,
Required: False ,
}
string ,
ingress:
{
Description: Ingress configurations. ,
Required: False ,
}
{
fqdn:
{
Description: Hostname. ,
Required: False ,
}
string ,
external:
{
Description: Bool indicating if app exposes an external http endpoint ,
Required: False ,
}
boolean ,
targetPort:
{
Description: Target Port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
exposedPort:
{
Description: Exposed Port in containers for TCP traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: No description available. ,
tcp: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Traffic weights for app's revisions ,
Required: False ,
}
[
{
revisionName:
{
Description: Name of a revision ,
Required: False ,
}
string ,
weight:
{
Description: Traffic weight assigned to a revision ,
Format: int32 ,
Required: False ,
}
integer ,
latestRevision:
{
Description: Indicates that the traffic weight belongs to a latest stable revision ,
Required: False ,
}
boolean ,
label:
{
Description: Associates a traffic label with a revision ,
Required: False ,
}
string ,
}
,
]
,
customDomains:
{
Description: custom domain bindings for Container Apps' hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: True ,
}
string ,
bindingType:
{
Description: Custom Domain binding type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
Auto: No description available. ,
}
,
Required: False ,
}
enum ,
certificateId:
{
Description: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. ,
Required: False ,
}
string ,
}
,
]
,
allowInsecure:
{
Description: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Rules to restrict incoming IP address. ,
Required: False ,
}
[
{
name:
{
Description: Name for the IP restriction rule. ,
Required: True ,
}
string ,
description:
{
Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. ,
Required: False ,
}
string ,
ipAddressRange:
{
Description: CIDR notation to match incoming IP address ,
Required: True ,
}
string ,
action:
{
Description: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
stickySessions:
{
Description: Sticky Sessions for Single Revision Mode ,
Required: False ,
}
{
affinity:
{
Description: Sticky Session Affinity ,
Enum:
{
sticky: No description available. ,
none: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateMode:
{
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: No description available. ,
accept: No description available. ,
require: No description available. ,
}
,
Required: False ,
}
enum ,
corsPolicy:
{
Description: CORS policy for container app ,
Required: False ,
}
{
allowedOrigins:
{
Description: Specifies the content for the access-control-allow-origins header ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Specifies the content for the access-control-allow-methods header ,
Required: False ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Specifies the content for the access-control-allow-headers header ,
Required: False ,
}
[
string ,
]
,
exposeHeaders:
{
Description: Specifies the content for the access-control-expose-headers header ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: Specifies the content for the access-control-max-age header ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: Specifies whether the resource allows credentials ,
Required: False ,
}
boolean ,
}
,
additionalPortMappings:
{
Description: Settings to expose additional ports on container app ,
Required: False ,
}
[
{
external:
{
Description: Specifies whether the app port is accessible outside of the environment ,
Required: True ,
}
boolean ,
targetPort:
{
Description: Specifies the port user's container listens on ,
Format: int32 ,
Required: True ,
}
integer ,
exposedPort:
{
Description: Specifies the exposed port for the target port. If not specified, it defaults to target port ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetPortHttpScheme:
{
Description: Whether an http app listens on http or https ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
registries:
{
Description: Collection of private container registry credentials for containers used by the Container app ,
Required: False ,
}
[
{
server:
{
Description: Container Registry Server ,
Required: False ,
}
string ,
username:
{
Description: Container Registry Username ,
Required: False ,
}
string ,
passwordSecretRef:
{
Description: The name of the Secret that contains the registry login password ,
Required: False ,
}
string ,
identity:
{
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' ,
Required: False ,
}
string ,
}
,
]
,
dapr:
{
Description: Dapr configuration for the Container App. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appProtocol:
{
Description: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http ,
Enum:
{
http: No description available. ,
grpc: No description available. ,
}
,
Required: False ,
}
enum ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
appHealth:
{
Description: Dapr application health check configuration ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the health probe is enabled ,
Required: False ,
}
boolean ,
path:
{
Description: Path for the health probe ,
Required: False ,
}
string ,
probeIntervalSeconds:
{
Description: Interval for the health probe in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
probeTimeoutMilliseconds:
{
Description: Timeout for the health probe in milliseconds ,
Format: int32 ,
Required: False ,
}
integer ,
threshold:
{
Description: Threshold for the health probe ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maxConcurrency:
{
Description: Maximum number of concurrent requests, events handled by the Dapr sidecar ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
runtime:
{
Description: App runtime configuration for the Container App. ,
Required: False ,
}
{
java:
{
Description: Java app configuration ,
Required: False ,
}
{
enableMetrics:
{
Description: Enable jmx core metrics for the java app ,
Required: False ,
}
boolean ,
javaAgent:
{
Description: Diagnostic capabilities achieved by java agent ,
Required: False ,
}
{
enabled:
{
Description: Enable java agent injection for the java app. ,
Required: False ,
}
boolean ,
logging:
{
Description: Capabilities on the java logging scenario. ,
Required: False ,
}
{
loggerSettings:
{
Description: Settings of the logger for the java app. ,
Required: False ,
}
[
{
logger:
{
Description: Logger name. ,
Required: True ,
}
string ,
level:
{
Description: The specified logger's log level. ,
Enum:
{
off: No description available. ,
error: No description available. ,
info: No description available. ,
debug: No description available. ,
trace: No description available. ,
warn: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
dotnet:
{
Description: .NET app configuration ,
Required: False ,
}
{
autoConfigureDataProtection:
{
Description: Auto configure the ASP.NET Core Data Protection feature ,
Required: False ,
}
boolean ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
Format: int32 ,
Required: False ,
}
integer ,
revisionTransitionThreshold:
{
Description: Optional. The percent of the total number of replicas that must be brought up before revision transition occurs. Defaults to 100 when none is given. Value must be greater than 0 and less than or equal to 100. ,
Format: int32 ,
Required: False ,
}
integer ,
service:
{
Description: Container App to be a dev Container App Service ,
Required: False ,
}
{
type:
{
Description: Dev ContainerApp service type ,
Required: True ,
}
string ,
}
,
identitySettings:
{
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. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. ,
Enum:
{
Init: No description available. ,
Main: No description available. ,
None: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container app. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used to render different experiences for resources of the same type; e.g. WorkflowApp is a kind of Microsoft.App/ContainerApps type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
workflowapp: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: ContainerApp resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container App. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStatus:
{
Description: Running status of the Container App. ,
Enum:
{
Progressing: Container App is transitioning between Stopped and Running states. ,
Running: Container App is in Running state. ,
Stopped: Container App is in Stopped state. ,
Suspended: Container App Job is in Suspended state. ,
Ready: Container App Job is in Ready state. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Deprecated. Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container app execution. ,
Required: False ,
}
string ,
patchingConfiguration:
{
Description: Container App auto patch configuration. ,
Required: False ,
}
{
patchingMode:
{
Description: Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
latestRevisionName:
{
Description: Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
latestReadyRevisionName:
{
Description: Name of the latest ready revision of the Container App. ,
Required: False ,
}
string ,
latestRevisionFqdn:
{
Description: Fully Qualified Domain Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
configuration:
{
Description: Non versioned Container App configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container app ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: Azure Key Vault URL pointing to the secret referenced by the container app. ,
Required: False ,
}
string ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Single: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.Multiple: Multiple revisions can be active, including optional traffic weights and labels.Labels: Only revisions with labels are active. Traffic weights can be applied to labels. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
Labels: No description available. ,
}
,
Required: False ,
}
enum ,
targetLabel:
{
Description: Required in labels revisions mode. Label to apply to newly created revision. ,
Required: False ,
}
string ,
ingress:
{
Description: Ingress configurations. ,
Required: False ,
}
{
fqdn:
{
Description: Hostname. ,
Required: False ,
}
string ,
external:
{
Description: Bool indicating if app exposes an external http endpoint ,
Required: False ,
}
boolean ,
targetPort:
{
Description: Target Port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
exposedPort:
{
Description: Exposed Port in containers for TCP traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: No description available. ,
tcp: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Traffic weights for app's revisions ,
Required: False ,
}
[
{
revisionName:
{
Description: Name of a revision ,
Required: False ,
}
string ,
weight:
{
Description: Traffic weight assigned to a revision ,
Format: int32 ,
Required: False ,
}
integer ,
latestRevision:
{
Description: Indicates that the traffic weight belongs to a latest stable revision ,
Required: False ,
}
boolean ,
label:
{
Description: Associates a traffic label with a revision ,
Required: False ,
}
string ,
}
,
]
,
customDomains:
{
Description: custom domain bindings for Container Apps' hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: True ,
}
string ,
bindingType:
{
Description: Custom Domain binding type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
Auto: No description available. ,
}
,
Required: False ,
}
enum ,
certificateId:
{
Description: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. ,
Required: False ,
}
string ,
}
,
]
,
allowInsecure:
{
Description: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Rules to restrict incoming IP address. ,
Required: False ,
}
[
{
name:
{
Description: Name for the IP restriction rule. ,
Required: True ,
}
string ,
description:
{
Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. ,
Required: False ,
}
string ,
ipAddressRange:
{
Description: CIDR notation to match incoming IP address ,
Required: True ,
}
string ,
action:
{
Description: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
stickySessions:
{
Description: Sticky Sessions for Single Revision Mode ,
Required: False ,
}
{
affinity:
{
Description: Sticky Session Affinity ,
Enum:
{
sticky: No description available. ,
none: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateMode:
{
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: No description available. ,
accept: No description available. ,
require: No description available. ,
}
,
Required: False ,
}
enum ,
corsPolicy:
{
Description: CORS policy for container app ,
Required: False ,
}
{
allowedOrigins:
{
Description: Specifies the content for the access-control-allow-origins header ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Specifies the content for the access-control-allow-methods header ,
Required: False ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Specifies the content for the access-control-allow-headers header ,
Required: False ,
}
[
string ,
]
,
exposeHeaders:
{
Description: Specifies the content for the access-control-expose-headers header ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: Specifies the content for the access-control-max-age header ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: Specifies whether the resource allows credentials ,
Required: False ,
}
boolean ,
}
,
additionalPortMappings:
{
Description: Settings to expose additional ports on container app ,
Required: False ,
}
[
{
external:
{
Description: Specifies whether the app port is accessible outside of the environment ,
Required: True ,
}
boolean ,
targetPort:
{
Description: Specifies the port user's container listens on ,
Format: int32 ,
Required: True ,
}
integer ,
exposedPort:
{
Description: Specifies the exposed port for the target port. If not specified, it defaults to target port ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetPortHttpScheme:
{
Description: Whether an http app listens on http or https ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
registries:
{
Description: Collection of private container registry credentials for containers used by the Container app ,
Required: False ,
}
[
{
server:
{
Description: Container Registry Server ,
Required: False ,
}
string ,
username:
{
Description: Container Registry Username ,
Required: False ,
}
string ,
passwordSecretRef:
{
Description: The name of the Secret that contains the registry login password ,
Required: False ,
}
string ,
identity:
{
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' ,
Required: False ,
}
string ,
}
,
]
,
dapr:
{
Description: Dapr configuration for the Container App. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appProtocol:
{
Description: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http ,
Enum:
{
http: No description available. ,
grpc: No description available. ,
}
,
Required: False ,
}
enum ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
appHealth:
{
Description: Dapr application health check configuration ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the health probe is enabled ,
Required: False ,
}
boolean ,
path:
{
Description: Path for the health probe ,
Required: False ,
}
string ,
probeIntervalSeconds:
{
Description: Interval for the health probe in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
probeTimeoutMilliseconds:
{
Description: Timeout for the health probe in milliseconds ,
Format: int32 ,
Required: False ,
}
integer ,
threshold:
{
Description: Threshold for the health probe ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maxConcurrency:
{
Description: Maximum number of concurrent requests, events handled by the Dapr sidecar ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
runtime:
{
Description: App runtime configuration for the Container App. ,
Required: False ,
}
{
java:
{
Description: Java app configuration ,
Required: False ,
}
{
enableMetrics:
{
Description: Enable jmx core metrics for the java app ,
Required: False ,
}
boolean ,
javaAgent:
{
Description: Diagnostic capabilities achieved by java agent ,
Required: False ,
}
{
enabled:
{
Description: Enable java agent injection for the java app. ,
Required: False ,
}
boolean ,
logging:
{
Description: Capabilities on the java logging scenario. ,
Required: False ,
}
{
loggerSettings:
{
Description: Settings of the logger for the java app. ,
Required: False ,
}
[
{
logger:
{
Description: Logger name. ,
Required: True ,
}
string ,
level:
{
Description: The specified logger's log level. ,
Enum:
{
off: No description available. ,
error: No description available. ,
info: No description available. ,
debug: No description available. ,
trace: No description available. ,
warn: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
dotnet:
{
Description: .NET app configuration ,
Required: False ,
}
{
autoConfigureDataProtection:
{
Description: Auto configure the ASP.NET Core Data Protection feature ,
Required: False ,
}
boolean ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
Format: int32 ,
Required: False ,
}
integer ,
revisionTransitionThreshold:
{
Description: Optional. The percent of the total number of replicas that must be brought up before revision transition occurs. Defaults to 100 when none is given. Value must be greater than 0 and less than or equal to 100. ,
Format: int32 ,
Required: False ,
}
integer ,
service:
{
Description: Container App to be a dev Container App Service ,
Required: False ,
}
{
type:
{
Description: Dev ContainerApp service type ,
Required: True ,
}
string ,
}
,
identitySettings:
{
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. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. ,
Enum:
{
Init: No description available. ,
Main: No description available. ,
None: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container app. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerApps_ListCustomHostNameAnalysis (new)
Description :  Analyzes a custom hostname for a Container App
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/listCustomHostNameAnalysis
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
customHostname:
{
Description: Custom hostname. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
hostName:
{
Description: Host name that was analyzed ,
Required: False ,
}
string ,
isHostnameAlreadyVerified:
{
Description: true if hostname is already verified; otherwise, false. ,
Required: False ,
}
boolean ,
customDomainVerificationTest:
{
Description: DNS verification test result. ,
Enum:
{
Passed: No description available. ,
Failed: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
customDomainVerificationFailureInfo:
{
Description: Raw failure information if DNS verification fails. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
}
,
hasConflictOnManagedEnvironment:
{
Description: true if there is a conflict on the Container App's managed environment; otherwise, false. ,
Required: False ,
}
boolean ,
conflictWithEnvironmentCustomDomain:
{
Description: true if there is a conflict on the Container App's managed environment level custom domain; otherwise, false. ,
Required: False ,
}
boolean ,
conflictingContainerAppResourceId:
{
Description: Name of the conflicting Container App on the Managed Environment if it's within the same subscription. ,
Required: False ,
}
string ,
cNameRecords:
{
Description: CName records visible for this hostname. ,
Required: False ,
}
[
string ,
]
,
txtRecords:
{
Description: TXT records visible for this hostname. ,
Required: False ,
}
[
string ,
]
,
aRecords:
{
Description: A records visible for this hostname. ,
Required: False ,
}
[
string ,
]
,
alternateCNameRecords:
{
Description: Alternate CName records visible for this hostname. ,
Required: False ,
}
[
string ,
]
,
alternateTxtRecords:
{
Description: Alternate TXT records visible for this hostname. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerApps_ListSecrets (new)
Description :  List secrets for a container app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/listSecrets
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: Azure Key Vault URL pointing to the secret referenced by the container app. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerApps_GetAuthToken (new)
Description :  Get auth token for a container app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/getAuthtoken
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Container App auth token resource specific properties ,
Required: False ,
}
{
token:
{
Description: Auth token value. ,
Required: False ,
}
string ,
expires:
{
Description: Token expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerApps_Start (new)
Description :  Start a container app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/start
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used to render different experiences for resources of the same type; e.g. WorkflowApp is a kind of Microsoft.App/ContainerApps type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
workflowapp: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: ContainerApp resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container App. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStatus:
{
Description: Running status of the Container App. ,
Enum:
{
Progressing: Container App is transitioning between Stopped and Running states. ,
Running: Container App is in Running state. ,
Stopped: Container App is in Stopped state. ,
Suspended: Container App Job is in Suspended state. ,
Ready: Container App Job is in Ready state. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Deprecated. Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container app execution. ,
Required: False ,
}
string ,
patchingConfiguration:
{
Description: Container App auto patch configuration. ,
Required: False ,
}
{
patchingMode:
{
Description: Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
latestRevisionName:
{
Description: Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
latestReadyRevisionName:
{
Description: Name of the latest ready revision of the Container App. ,
Required: False ,
}
string ,
latestRevisionFqdn:
{
Description: Fully Qualified Domain Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
configuration:
{
Description: Non versioned Container App configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container app ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: Azure Key Vault URL pointing to the secret referenced by the container app. ,
Required: False ,
}
string ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Single: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.Multiple: Multiple revisions can be active, including optional traffic weights and labels.Labels: Only revisions with labels are active. Traffic weights can be applied to labels. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
Labels: No description available. ,
}
,
Required: False ,
}
enum ,
targetLabel:
{
Description: Required in labels revisions mode. Label to apply to newly created revision. ,
Required: False ,
}
string ,
ingress:
{
Description: Ingress configurations. ,
Required: False ,
}
{
fqdn:
{
Description: Hostname. ,
Required: False ,
}
string ,
external:
{
Description: Bool indicating if app exposes an external http endpoint ,
Required: False ,
}
boolean ,
targetPort:
{
Description: Target Port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
exposedPort:
{
Description: Exposed Port in containers for TCP traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: No description available. ,
tcp: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Traffic weights for app's revisions ,
Required: False ,
}
[
{
revisionName:
{
Description: Name of a revision ,
Required: False ,
}
string ,
weight:
{
Description: Traffic weight assigned to a revision ,
Format: int32 ,
Required: False ,
}
integer ,
latestRevision:
{
Description: Indicates that the traffic weight belongs to a latest stable revision ,
Required: False ,
}
boolean ,
label:
{
Description: Associates a traffic label with a revision ,
Required: False ,
}
string ,
}
,
]
,
customDomains:
{
Description: custom domain bindings for Container Apps' hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: True ,
}
string ,
bindingType:
{
Description: Custom Domain binding type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
Auto: No description available. ,
}
,
Required: False ,
}
enum ,
certificateId:
{
Description: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. ,
Required: False ,
}
string ,
}
,
]
,
allowInsecure:
{
Description: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Rules to restrict incoming IP address. ,
Required: False ,
}
[
{
name:
{
Description: Name for the IP restriction rule. ,
Required: True ,
}
string ,
description:
{
Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. ,
Required: False ,
}
string ,
ipAddressRange:
{
Description: CIDR notation to match incoming IP address ,
Required: True ,
}
string ,
action:
{
Description: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
stickySessions:
{
Description: Sticky Sessions for Single Revision Mode ,
Required: False ,
}
{
affinity:
{
Description: Sticky Session Affinity ,
Enum:
{
sticky: No description available. ,
none: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateMode:
{
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: No description available. ,
accept: No description available. ,
require: No description available. ,
}
,
Required: False ,
}
enum ,
corsPolicy:
{
Description: CORS policy for container app ,
Required: False ,
}
{
allowedOrigins:
{
Description: Specifies the content for the access-control-allow-origins header ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Specifies the content for the access-control-allow-methods header ,
Required: False ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Specifies the content for the access-control-allow-headers header ,
Required: False ,
}
[
string ,
]
,
exposeHeaders:
{
Description: Specifies the content for the access-control-expose-headers header ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: Specifies the content for the access-control-max-age header ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: Specifies whether the resource allows credentials ,
Required: False ,
}
boolean ,
}
,
additionalPortMappings:
{
Description: Settings to expose additional ports on container app ,
Required: False ,
}
[
{
external:
{
Description: Specifies whether the app port is accessible outside of the environment ,
Required: True ,
}
boolean ,
targetPort:
{
Description: Specifies the port user's container listens on ,
Format: int32 ,
Required: True ,
}
integer ,
exposedPort:
{
Description: Specifies the exposed port for the target port. If not specified, it defaults to target port ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetPortHttpScheme:
{
Description: Whether an http app listens on http or https ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
registries:
{
Description: Collection of private container registry credentials for containers used by the Container app ,
Required: False ,
}
[
{
server:
{
Description: Container Registry Server ,
Required: False ,
}
string ,
username:
{
Description: Container Registry Username ,
Required: False ,
}
string ,
passwordSecretRef:
{
Description: The name of the Secret that contains the registry login password ,
Required: False ,
}
string ,
identity:
{
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' ,
Required: False ,
}
string ,
}
,
]
,
dapr:
{
Description: Dapr configuration for the Container App. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appProtocol:
{
Description: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http ,
Enum:
{
http: No description available. ,
grpc: No description available. ,
}
,
Required: False ,
}
enum ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
appHealth:
{
Description: Dapr application health check configuration ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the health probe is enabled ,
Required: False ,
}
boolean ,
path:
{
Description: Path for the health probe ,
Required: False ,
}
string ,
probeIntervalSeconds:
{
Description: Interval for the health probe in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
probeTimeoutMilliseconds:
{
Description: Timeout for the health probe in milliseconds ,
Format: int32 ,
Required: False ,
}
integer ,
threshold:
{
Description: Threshold for the health probe ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maxConcurrency:
{
Description: Maximum number of concurrent requests, events handled by the Dapr sidecar ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
runtime:
{
Description: App runtime configuration for the Container App. ,
Required: False ,
}
{
java:
{
Description: Java app configuration ,
Required: False ,
}
{
enableMetrics:
{
Description: Enable jmx core metrics for the java app ,
Required: False ,
}
boolean ,
javaAgent:
{
Description: Diagnostic capabilities achieved by java agent ,
Required: False ,
}
{
enabled:
{
Description: Enable java agent injection for the java app. ,
Required: False ,
}
boolean ,
logging:
{
Description: Capabilities on the java logging scenario. ,
Required: False ,
}
{
loggerSettings:
{
Description: Settings of the logger for the java app. ,
Required: False ,
}
[
{
logger:
{
Description: Logger name. ,
Required: True ,
}
string ,
level:
{
Description: The specified logger's log level. ,
Enum:
{
off: No description available. ,
error: No description available. ,
info: No description available. ,
debug: No description available. ,
trace: No description available. ,
warn: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
dotnet:
{
Description: .NET app configuration ,
Required: False ,
}
{
autoConfigureDataProtection:
{
Description: Auto configure the ASP.NET Core Data Protection feature ,
Required: False ,
}
boolean ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
Format: int32 ,
Required: False ,
}
integer ,
revisionTransitionThreshold:
{
Description: Optional. The percent of the total number of replicas that must be brought up before revision transition occurs. Defaults to 100 when none is given. Value must be greater than 0 and less than or equal to 100. ,
Format: int32 ,
Required: False ,
}
integer ,
service:
{
Description: Container App to be a dev Container App Service ,
Required: False ,
}
{
type:
{
Description: Dev ContainerApp service type ,
Required: True ,
}
string ,
}
,
identitySettings:
{
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. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. ,
Enum:
{
Init: No description available. ,
Main: No description available. ,
None: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container app. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerApps_Stop (new)
Description :  Stop a container app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/stop
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used to render different experiences for resources of the same type; e.g. WorkflowApp is a kind of Microsoft.App/ContainerApps type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
workflowapp: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: ContainerApp resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container App. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStatus:
{
Description: Running status of the Container App. ,
Enum:
{
Progressing: Container App is transitioning between Stopped and Running states. ,
Running: Container App is in Running state. ,
Stopped: Container App is in Stopped state. ,
Suspended: Container App Job is in Suspended state. ,
Ready: Container App Job is in Ready state. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Deprecated. Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container app execution. ,
Required: False ,
}
string ,
patchingConfiguration:
{
Description: Container App auto patch configuration. ,
Required: False ,
}
{
patchingMode:
{
Description: Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
latestRevisionName:
{
Description: Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
latestReadyRevisionName:
{
Description: Name of the latest ready revision of the Container App. ,
Required: False ,
}
string ,
latestRevisionFqdn:
{
Description: Fully Qualified Domain Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
configuration:
{
Description: Non versioned Container App configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container app ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: Azure Key Vault URL pointing to the secret referenced by the container app. ,
Required: False ,
}
string ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Single: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.Multiple: Multiple revisions can be active, including optional traffic weights and labels.Labels: Only revisions with labels are active. Traffic weights can be applied to labels. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
Labels: No description available. ,
}
,
Required: False ,
}
enum ,
targetLabel:
{
Description: Required in labels revisions mode. Label to apply to newly created revision. ,
Required: False ,
}
string ,
ingress:
{
Description: Ingress configurations. ,
Required: False ,
}
{
fqdn:
{
Description: Hostname. ,
Required: False ,
}
string ,
external:
{
Description: Bool indicating if app exposes an external http endpoint ,
Required: False ,
}
boolean ,
targetPort:
{
Description: Target Port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
exposedPort:
{
Description: Exposed Port in containers for TCP traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: No description available. ,
tcp: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Traffic weights for app's revisions ,
Required: False ,
}
[
{
revisionName:
{
Description: Name of a revision ,
Required: False ,
}
string ,
weight:
{
Description: Traffic weight assigned to a revision ,
Format: int32 ,
Required: False ,
}
integer ,
latestRevision:
{
Description: Indicates that the traffic weight belongs to a latest stable revision ,
Required: False ,
}
boolean ,
label:
{
Description: Associates a traffic label with a revision ,
Required: False ,
}
string ,
}
,
]
,
customDomains:
{
Description: custom domain bindings for Container Apps' hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: True ,
}
string ,
bindingType:
{
Description: Custom Domain binding type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
Auto: No description available. ,
}
,
Required: False ,
}
enum ,
certificateId:
{
Description: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. ,
Required: False ,
}
string ,
}
,
]
,
allowInsecure:
{
Description: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Rules to restrict incoming IP address. ,
Required: False ,
}
[
{
name:
{
Description: Name for the IP restriction rule. ,
Required: True ,
}
string ,
description:
{
Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. ,
Required: False ,
}
string ,
ipAddressRange:
{
Description: CIDR notation to match incoming IP address ,
Required: True ,
}
string ,
action:
{
Description: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
stickySessions:
{
Description: Sticky Sessions for Single Revision Mode ,
Required: False ,
}
{
affinity:
{
Description: Sticky Session Affinity ,
Enum:
{
sticky: No description available. ,
none: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateMode:
{
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: No description available. ,
accept: No description available. ,
require: No description available. ,
}
,
Required: False ,
}
enum ,
corsPolicy:
{
Description: CORS policy for container app ,
Required: False ,
}
{
allowedOrigins:
{
Description: Specifies the content for the access-control-allow-origins header ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Specifies the content for the access-control-allow-methods header ,
Required: False ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Specifies the content for the access-control-allow-headers header ,
Required: False ,
}
[
string ,
]
,
exposeHeaders:
{
Description: Specifies the content for the access-control-expose-headers header ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: Specifies the content for the access-control-max-age header ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: Specifies whether the resource allows credentials ,
Required: False ,
}
boolean ,
}
,
additionalPortMappings:
{
Description: Settings to expose additional ports on container app ,
Required: False ,
}
[
{
external:
{
Description: Specifies whether the app port is accessible outside of the environment ,
Required: True ,
}
boolean ,
targetPort:
{
Description: Specifies the port user's container listens on ,
Format: int32 ,
Required: True ,
}
integer ,
exposedPort:
{
Description: Specifies the exposed port for the target port. If not specified, it defaults to target port ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetPortHttpScheme:
{
Description: Whether an http app listens on http or https ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
registries:
{
Description: Collection of private container registry credentials for containers used by the Container app ,
Required: False ,
}
[
{
server:
{
Description: Container Registry Server ,
Required: False ,
}
string ,
username:
{
Description: Container Registry Username ,
Required: False ,
}
string ,
passwordSecretRef:
{
Description: The name of the Secret that contains the registry login password ,
Required: False ,
}
string ,
identity:
{
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' ,
Required: False ,
}
string ,
}
,
]
,
dapr:
{
Description: Dapr configuration for the Container App. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appProtocol:
{
Description: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http ,
Enum:
{
http: No description available. ,
grpc: No description available. ,
}
,
Required: False ,
}
enum ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
appHealth:
{
Description: Dapr application health check configuration ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the health probe is enabled ,
Required: False ,
}
boolean ,
path:
{
Description: Path for the health probe ,
Required: False ,
}
string ,
probeIntervalSeconds:
{
Description: Interval for the health probe in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
probeTimeoutMilliseconds:
{
Description: Timeout for the health probe in milliseconds ,
Format: int32 ,
Required: False ,
}
integer ,
threshold:
{
Description: Threshold for the health probe ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maxConcurrency:
{
Description: Maximum number of concurrent requests, events handled by the Dapr sidecar ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
runtime:
{
Description: App runtime configuration for the Container App. ,
Required: False ,
}
{
java:
{
Description: Java app configuration ,
Required: False ,
}
{
enableMetrics:
{
Description: Enable jmx core metrics for the java app ,
Required: False ,
}
boolean ,
javaAgent:
{
Description: Diagnostic capabilities achieved by java agent ,
Required: False ,
}
{
enabled:
{
Description: Enable java agent injection for the java app. ,
Required: False ,
}
boolean ,
logging:
{
Description: Capabilities on the java logging scenario. ,
Required: False ,
}
{
loggerSettings:
{
Description: Settings of the logger for the java app. ,
Required: False ,
}
[
{
logger:
{
Description: Logger name. ,
Required: True ,
}
string ,
level:
{
Description: The specified logger's log level. ,
Enum:
{
off: No description available. ,
error: No description available. ,
info: No description available. ,
debug: No description available. ,
trace: No description available. ,
warn: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
dotnet:
{
Description: .NET app configuration ,
Required: False ,
}
{
autoConfigureDataProtection:
{
Description: Auto configure the ASP.NET Core Data Protection feature ,
Required: False ,
}
boolean ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
Format: int32 ,
Required: False ,
}
integer ,
revisionTransitionThreshold:
{
Description: Optional. The percent of the total number of replicas that must be brought up before revision transition occurs. Defaults to 100 when none is given. Value must be greater than 0 and less than or equal to 100. ,
Format: int32 ,
Required: False ,
}
integer ,
service:
{
Description: Container App to be a dev Container App Service ,
Required: False ,
}
{
type:
{
Description: Dev ContainerApp service type ,
Required: True ,
}
string ,
}
,
identitySettings:
{
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. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. ,
Enum:
{
Init: No description available. ,
Main: No description available. ,
None: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container app. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsBuildsByContainerApp_List (new)
Description :  List Container Apps Build resources by Container App
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/builds
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App the Build is associated. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Container Apps Build Resource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Build provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
buildStatus:
{
Description: Status of the build once it has been provisioned. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
destinationContainerRegistry:
{
Description: Container registry that the final image will be uploaded to. ,
Required: False ,
}
{
server:
{
Description: Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it. ,
Required: True ,
}
string ,
image:
{
Description: Full name that the final image should be uploaded as, including both image name and tag. ,
Required: False ,
}
string ,
}
,
configuration:
{
Description: Configuration of the build. ,
Required: False ,
}
{
baseOs:
{
Description: Base OS used to build and run the app. ,
Required: False ,
}
string ,
platform:
{
Description: Platform to be used to build and run the app. ,
Required: False ,
}
string ,
platformVersion:
{
Description: Platform version to be used to build and run the app. ,
Required: False ,
}
string ,
environmentVariables:
{
Description: List of environment variables to be passed to the build, secrets should not be used in environment variable. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: True ,
}
string ,
value:
{
Description: Environment variable value. ,
Required: True ,
}
string ,
}
,
]
,
preBuildSteps:
{
Description: List of steps to perform before the build. ,
Required: False ,
}
[
{
description:
{
Description: Description of the pre-build step. ,
Required: False ,
}
string ,
scripts:
{
Description: List of custom commands to run. ,
Required: False ,
}
[
string ,
]
,
httpGet:
{
Description: Http get request to send before the build. ,
Required: False ,
}
{
url:
{
Description: URL to make HTTP GET request against. ,
Required: True ,
}
string ,
fileName:
{
Description: Name of the file that the request should be saved to. ,
Required: False ,
}
string ,
headers:
{
Description: List of headers to send with the request. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
logStreamEndpoint:
{
Description: Endpoint from which the build logs can be streamed. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContainerAppsBuilds_Get (new)
Description :  Get a Container Apps Build resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/builds/{buildName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App the Build is associated. ,
Required: True ,
}
string ,
buildName:
{
Description: The name of a build. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Build provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
buildStatus:
{
Description: Status of the build once it has been provisioned. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
destinationContainerRegistry:
{
Description: Container registry that the final image will be uploaded to. ,
Required: False ,
}
{
server:
{
Description: Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it. ,
Required: True ,
}
string ,
image:
{
Description: Full name that the final image should be uploaded as, including both image name and tag. ,
Required: False ,
}
string ,
}
,
configuration:
{
Description: Configuration of the build. ,
Required: False ,
}
{
baseOs:
{
Description: Base OS used to build and run the app. ,
Required: False ,
}
string ,
platform:
{
Description: Platform to be used to build and run the app. ,
Required: False ,
}
string ,
platformVersion:
{
Description: Platform version to be used to build and run the app. ,
Required: False ,
}
string ,
environmentVariables:
{
Description: List of environment variables to be passed to the build, secrets should not be used in environment variable. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: True ,
}
string ,
value:
{
Description: Environment variable value. ,
Required: True ,
}
string ,
}
,
]
,
preBuildSteps:
{
Description: List of steps to perform before the build. ,
Required: False ,
}
[
{
description:
{
Description: Description of the pre-build step. ,
Required: False ,
}
string ,
scripts:
{
Description: List of custom commands to run. ,
Required: False ,
}
[
string ,
]
,
httpGet:
{
Description: Http get request to send before the build. ,
Required: False ,
}
{
url:
{
Description: URL to make HTTP GET request against. ,
Required: True ,
}
string ,
fileName:
{
Description: Name of the file that the request should be saved to. ,
Required: False ,
}
string ,
headers:
{
Description: List of headers to send with the request. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
logStreamEndpoint:
{
Description: Endpoint from which the build logs can be streamed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContainerAppsBuilds_Delete (new)
Description :  Delete a Container Apps Build resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/builds/{buildName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App the Build is associated. ,
Required: True ,
}
string ,
buildName:
{
Description: The name of a build. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContainerAppsLabelHistory_ListLabelHistory (new)
Description :  Get the Label History for a given Container App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/labelHistory
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Container App Label History resource specific properties ,
Required: False ,
}
{
records:
{
Description: List of label history records. ,
Required: False ,
}
[
{
revision:
{
Description: Container App revision name that label was applied to. ,
Required: False ,
}
string ,
start:
{
Description: Timestamp describing when the label was applied to the revision. ,
Format: date-time ,
Required: False ,
}
string ,
stop:
{
Description: Timestamp describing when the label was removed from the revision. Only meaningful when the label is currently applied to the revision. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the label history record. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsLabelHistory_GetLabelHistory (new)
Description :  Get the history of a label.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/labelHistory/{labelName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App ,
Required: True ,
}
string ,
labelName:
{
Description: Name of the Container App label. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Container App Label History resource specific properties ,
Required: False ,
}
{
records:
{
Description: List of label history records. ,
Required: False ,
}
[
{
revision:
{
Description: Container App revision name that label was applied to. ,
Required: False ,
}
string ,
start:
{
Description: Timestamp describing when the label was applied to the revision. ,
Format: date-time ,
Required: False ,
}
string ,
stop:
{
Description: Timestamp describing when the label was removed from the revision. Only meaningful when the label is currently applied to the revision. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of the label history record. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsLabelHistory_DeleteLabelHistory (new)
Description :  Delete the history of a label.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/labelHistory/{labelName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App ,
Required: True ,
}
string ,
labelName:
{
Description: Name of the Container App label. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsPatches_ListByContainerApp (new)
Description :  List Container Apps Patch resources by ContainerApp.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/patches
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App the Patch is associated. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For example, $filter=properties/patchApplyStatus eq 'Succeeded' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of patch resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties that describes current states of the patch resource. ,
Required: False ,
}
{
targetEnvironmentId:
{
Description: The Azure resource id of the target environment for the patch. ,
Format: arm-id ,
Required: False ,
}
string ,
targetContainerAppId:
{
Description: The Azure resource id of the target container app for the patch. ,
Format: arm-id ,
Required: False ,
}
string ,
targetRevisionId:
{
Description: The Azure resource id of the target revision for the patch. ,
Format: arm-id ,
Required: False ,
}
string ,
patchApplyStatus:
{
Description: The status of the patch operation. ,
Enum:
{
NotStarted: No description available. ,
RebaseInProgress: No description available. ,
CreatingRevision: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
RebaseFailed: No description available. ,
RevisionCreationFailed: No description available. ,
ImagePushPullFailed: No description available. ,
ManuallySkipped: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The UTC timestamp that describes when the patch object was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The UTC timestamp that describes when the patch object was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
patchDetails:
{
Description: Detailed info describes the patch operation for the target container app. ,
Required: False ,
}
[
{
targetContainerName:
{
Description: The name of the target container for the patch. ,
Required: True ,
}
string ,
targetImage:
{
Description: The name of the target image for the patch. ,
Required: True ,
}
string ,
lastDetectionTime:
{
Description: The UTC timestamp that describes the latest detection was done. ,
Format: date-time ,
Required: True ,
}
string ,
detectionStatus:
{
Description: The status of the patch detection. ,
Enum:
{
Succeeded: No description available. ,
RegistryLoginFailed: No description available. ,
Failed: No description available. ,
}
,
Required: True ,
}
enum ,
newImageName:
{
Description: The name of the new image created by the patch. ,
Required: False ,
}
string ,
newLayer:
{
Description: New layer update details in the target image. ,
Required: False ,
}
{
name:
{
Description: The details of the new layer for the target image. ,
Required: False ,
}
string ,
frameworkAndVersion:
{
Description: The framework and its version in the new run image for the target image. ,
Required: False ,
}
string ,
osAndVersion:
{
Description: The OS name and its version in the new run image for the target image. ,
Required: False ,
}
string ,
}
,
oldLayer:
{
Description: The old layer details in the target image. ,
Required: False ,
}
{
name:
{
Description: The details of the old layer for the target image. ,
Required: False ,
}
string ,
frameworkAndVersion:
{
Description: The framework and its version in the old run image for the target image. ,
Required: False ,
}
string ,
osAndVersion:
{
Description: The OS name and its version in the old run image for the target image. ,
Required: False ,
}
string ,
}
,
patchType:
{
Description: The type for the patch. ,
Enum:
{
FrameworkSecurity: No description available. ,
OSSecurity: No description available. ,
FrameworkAndOSSecurity: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: the link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContainerAppsPatches_Get (new)
Description :  Get details for specific Container Apps Patch by patch name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/patches/{patchName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App the Patch is associated. ,
Required: True ,
}
string ,
patchName:
{
Description: The name of the patch ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties that describes current states of the patch resource. ,
Required: False ,
}
{
targetEnvironmentId:
{
Description: The Azure resource id of the target environment for the patch. ,
Format: arm-id ,
Required: False ,
}
string ,
targetContainerAppId:
{
Description: The Azure resource id of the target container app for the patch. ,
Format: arm-id ,
Required: False ,
}
string ,
targetRevisionId:
{
Description: The Azure resource id of the target revision for the patch. ,
Format: arm-id ,
Required: False ,
}
string ,
patchApplyStatus:
{
Description: The status of the patch operation. ,
Enum:
{
NotStarted: No description available. ,
RebaseInProgress: No description available. ,
CreatingRevision: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
RebaseFailed: No description available. ,
RevisionCreationFailed: No description available. ,
ImagePushPullFailed: No description available. ,
ManuallySkipped: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The UTC timestamp that describes when the patch object was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The UTC timestamp that describes when the patch object was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
patchDetails:
{
Description: Detailed info describes the patch operation for the target container app. ,
Required: False ,
}
[
{
targetContainerName:
{
Description: The name of the target container for the patch. ,
Required: True ,
}
string ,
targetImage:
{
Description: The name of the target image for the patch. ,
Required: True ,
}
string ,
lastDetectionTime:
{
Description: The UTC timestamp that describes the latest detection was done. ,
Format: date-time ,
Required: True ,
}
string ,
detectionStatus:
{
Description: The status of the patch detection. ,
Enum:
{
Succeeded: No description available. ,
RegistryLoginFailed: No description available. ,
Failed: No description available. ,
}
,
Required: True ,
}
enum ,
newImageName:
{
Description: The name of the new image created by the patch. ,
Required: False ,
}
string ,
newLayer:
{
Description: New layer update details in the target image. ,
Required: False ,
}
{
name:
{
Description: The details of the new layer for the target image. ,
Required: False ,
}
string ,
frameworkAndVersion:
{
Description: The framework and its version in the new run image for the target image. ,
Required: False ,
}
string ,
osAndVersion:
{
Description: The OS name and its version in the new run image for the target image. ,
Required: False ,
}
string ,
}
,
oldLayer:
{
Description: The old layer details in the target image. ,
Required: False ,
}
{
name:
{
Description: The details of the old layer for the target image. ,
Required: False ,
}
string ,
frameworkAndVersion:
{
Description: The framework and its version in the old run image for the target image. ,
Required: False ,
}
string ,
osAndVersion:
{
Description: The OS name and its version in the old run image for the target image. ,
Required: False ,
}
string ,
}
,
patchType:
{
Description: The type for the patch. ,
Enum:
{
FrameworkSecurity: No description available. ,
OSSecurity: No description available. ,
FrameworkAndOSSecurity: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContainerAppsPatches_Delete (new)
Description :  Delete specific Container Apps Patch by patch name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/patches/{patchName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App the Patch is associated. ,
Required: True ,
}
string ,
patchName:
{
Description: The name of the patch ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContainerAppsPatches_SkipConfigure (new)
Description :  Configure the Container Apps Patch skip option by patch name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/patches/{patchName}/skipConfig
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App the Patch is associated. ,
Required: True ,
}
string ,
patchName:
{
Description: The name of the patch ,
Required: True ,
}
string ,
patchSkipConfig:
{
Description: Configure patcher to skip a patch or not. ,
Required: True ,
}
{
skip:
{
Description: The flag to indicate whether to skip the patch or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContainerAppsPatches_Apply (new)
Description :  Apply a Container Apps Patch resource with patch name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/patches/{patchName}/apply
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App the Patch is associated. ,
Required: True ,
}
string ,
patchName:
{
Description: The name of the patch ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties that describes current states of the patch resource. ,
Required: False ,
}
{
targetEnvironmentId:
{
Description: The Azure resource id of the target environment for the patch. ,
Format: arm-id ,
Required: False ,
}
string ,
targetContainerAppId:
{
Description: The Azure resource id of the target container app for the patch. ,
Format: arm-id ,
Required: False ,
}
string ,
targetRevisionId:
{
Description: The Azure resource id of the target revision for the patch. ,
Format: arm-id ,
Required: False ,
}
string ,
patchApplyStatus:
{
Description: The status of the patch operation. ,
Enum:
{
NotStarted: No description available. ,
RebaseInProgress: No description available. ,
CreatingRevision: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
RebaseFailed: No description available. ,
RevisionCreationFailed: No description available. ,
ImagePushPullFailed: No description available. ,
ManuallySkipped: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The UTC timestamp that describes when the patch object was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: The UTC timestamp that describes when the patch object was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
patchDetails:
{
Description: Detailed info describes the patch operation for the target container app. ,
Required: False ,
}
[
{
targetContainerName:
{
Description: The name of the target container for the patch. ,
Required: True ,
}
string ,
targetImage:
{
Description: The name of the target image for the patch. ,
Required: True ,
}
string ,
lastDetectionTime:
{
Description: The UTC timestamp that describes the latest detection was done. ,
Format: date-time ,
Required: True ,
}
string ,
detectionStatus:
{
Description: The status of the patch detection. ,
Enum:
{
Succeeded: No description available. ,
RegistryLoginFailed: No description available. ,
Failed: No description available. ,
}
,
Required: True ,
}
enum ,
newImageName:
{
Description: The name of the new image created by the patch. ,
Required: False ,
}
string ,
newLayer:
{
Description: New layer update details in the target image. ,
Required: False ,
}
{
name:
{
Description: The details of the new layer for the target image. ,
Required: False ,
}
string ,
frameworkAndVersion:
{
Description: The framework and its version in the new run image for the target image. ,
Required: False ,
}
string ,
osAndVersion:
{
Description: The OS name and its version in the new run image for the target image. ,
Required: False ,
}
string ,
}
,
oldLayer:
{
Description: The old layer details in the target image. ,
Required: False ,
}
{
name:
{
Description: The details of the old layer for the target image. ,
Required: False ,
}
string ,
frameworkAndVersion:
{
Description: The framework and its version in the old run image for the target image. ,
Required: False ,
}
string ,
osAndVersion:
{
Description: The OS name and its version in the old run image for the target image. ,
Required: False ,
}
string ,
}
,
patchType:
{
Description: The type for the patch. ,
Enum:
{
FrameworkSecurity: No description available. ,
OSSecurity: No description available. ,
FrameworkAndOSSecurity: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ContainerAppsRevisions_ListRevisions (new)
Description :  Get the Revisions for a given Container App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App for which Revisions are needed. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Revision resource specific properties ,
Required: False ,
}
{
createdTime:
{
Description: Timestamp describing when the revision was created by controller ,
Format: date-time ,
Required: False ,
}
string ,
lastActiveTime:
{
Description: Timestamp describing when the revision was last active. Only meaningful when revision is inactive ,
Format: date-time ,
Required: False ,
}
string ,
fqdn:
{
Description: Fully qualified domain name of the revision ,
Required: False ,
}
string ,
template:
{
Description: Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
active:
{
Description: Boolean describing if the Revision is Active ,
Required: False ,
}
boolean ,
replicas:
{
Description: Number of pods currently running for this revision ,
Format: int32 ,
Required: False ,
}
integer ,
trafficWeight:
{
Description: Traffic weight assigned to this revision ,
Format: int32 ,
Required: False ,
}
integer ,
labels:
{
Description: List of labels assigned to this revision. ,
Required: False ,
}
[
string ,
]
,
provisioningError:
{
Description: Optional Field - Platform Error Message ,
Required: False ,
}
string ,
healthState:
{
Description: Current health State of the revision ,
Enum:
{
Healthy: No description available. ,
Unhealthy: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current provisioning State of the revision ,
Enum:
{
Provisioning: No description available. ,
Provisioned: No description available. ,
Failed: No description available. ,
Deprovisioning: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
runningState:
{
Description: Current running state of the revision ,
Enum:
{
Running: No description available. ,
Processing: No description available. ,
Stopped: No description available. ,
Degraded: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsRevisions_GetRevision (new)
Description :  Get a revision of a Container App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
revisionName:
{
Description: Name of the Container App Revision. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Revision resource specific properties ,
Required: False ,
}
{
createdTime:
{
Description: Timestamp describing when the revision was created by controller ,
Format: date-time ,
Required: False ,
}
string ,
lastActiveTime:
{
Description: Timestamp describing when the revision was last active. Only meaningful when revision is inactive ,
Format: date-time ,
Required: False ,
}
string ,
fqdn:
{
Description: Fully qualified domain name of the revision ,
Required: False ,
}
string ,
template:
{
Description: Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
active:
{
Description: Boolean describing if the Revision is Active ,
Required: False ,
}
boolean ,
replicas:
{
Description: Number of pods currently running for this revision ,
Format: int32 ,
Required: False ,
}
integer ,
trafficWeight:
{
Description: Traffic weight assigned to this revision ,
Format: int32 ,
Required: False ,
}
integer ,
labels:
{
Description: List of labels assigned to this revision. ,
Required: False ,
}
[
string ,
]
,
provisioningError:
{
Description: Optional Field - Platform Error Message ,
Required: False ,
}
string ,
healthState:
{
Description: Current health State of the revision ,
Enum:
{
Healthy: No description available. ,
Unhealthy: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current provisioning State of the revision ,
Enum:
{
Provisioning: No description available. ,
Provisioned: No description available. ,
Failed: No description available. ,
Deprovisioning: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
runningState:
{
Description: Current running state of the revision ,
Enum:
{
Running: No description available. ,
Processing: No description available. ,
Stopped: No description available. ,
Degraded: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsRevisions_ActivateRevision (new)
Description :  Activates a revision for a Container App
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/activate
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
revisionName:
{
Description: Name of the Container App Revision. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsRevisions_DeactivateRevision (new)
Description :  Deactivates a revision for a Container App
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/deactivate
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
revisionName:
{
Description: Name of the Container App Revision. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsRevisionReplicas_GetReplica (new)
Description :  Get a replica for a Container App Revision.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas/{replicaName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
revisionName:
{
Description: Name of the Container App Revision. ,
Required: True ,
}
string ,
replicaName:
{
Description: Name of the Container App Revision Replica. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Replica resource specific properties ,
Required: False ,
}
{
createdTime:
{
Description: Timestamp describing when the pod was created by controller ,
Format: date-time ,
Required: False ,
}
string ,
runningState:
{
Description: Current running state of the replica ,
Enum:
{
Running: No description available. ,
NotRunning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
runningStateDetails:
{
Description: The details of replica current running state ,
Required: False ,
}
string ,
containers:
{
Description: The containers collection under a replica. ,
Required: False ,
}
[
{
name:
{
Description: The Name of the Container ,
Required: False ,
}
string ,
containerId:
{
Description: The Id of the Container ,
Required: False ,
}
string ,
ready:
{
Description: The container ready status ,
Required: False ,
}
boolean ,
started:
{
Description: The container start status ,
Required: False ,
}
boolean ,
restartCount:
{
Description: The container restart count ,
Format: int32 ,
Required: False ,
}
integer ,
runningState:
{
Description: Current running state of the container ,
Enum:
{
Running: No description available. ,
Terminated: No description available. ,
Waiting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStateDetails:
{
Description: The details of container current running state ,
Required: False ,
}
string ,
logStreamEndpoint:
{
Description: Log Stream endpoint ,
Required: False ,
}
string ,
execEndpoint:
{
Description: Container exec endpoint ,
Required: False ,
}
string ,
debugEndpoint:
{
Description: Container debug endpoint ,
Required: False ,
}
string ,
}
,
]
,
initContainers:
{
Description: The init containers collection under a replica. ,
Required: False ,
}
[
{
name:
{
Description: The Name of the Container ,
Required: False ,
}
string ,
containerId:
{
Description: The Id of the Container ,
Required: False ,
}
string ,
ready:
{
Description: The container ready status ,
Required: False ,
}
boolean ,
started:
{
Description: The container start status ,
Required: False ,
}
boolean ,
restartCount:
{
Description: The container restart count ,
Format: int32 ,
Required: False ,
}
integer ,
runningState:
{
Description: Current running state of the container ,
Enum:
{
Running: No description available. ,
Terminated: No description available. ,
Waiting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStateDetails:
{
Description: The details of container current running state ,
Required: False ,
}
string ,
logStreamEndpoint:
{
Description: Log Stream endpoint ,
Required: False ,
}
string ,
execEndpoint:
{
Description: Container exec endpoint ,
Required: False ,
}
string ,
debugEndpoint:
{
Description: Container debug endpoint ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsRevisionReplicas_ListReplicas (new)
Description :  List replicas for a Container App Revision.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
revisionName:
{
Description: Name of the Container App Revision. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Replica resource specific properties ,
Required: False ,
}
{
createdTime:
{
Description: Timestamp describing when the pod was created by controller ,
Format: date-time ,
Required: False ,
}
string ,
runningState:
{
Description: Current running state of the replica ,
Enum:
{
Running: No description available. ,
NotRunning: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
runningStateDetails:
{
Description: The details of replica current running state ,
Required: False ,
}
string ,
containers:
{
Description: The containers collection under a replica. ,
Required: False ,
}
[
{
name:
{
Description: The Name of the Container ,
Required: False ,
}
string ,
containerId:
{
Description: The Id of the Container ,
Required: False ,
}
string ,
ready:
{
Description: The container ready status ,
Required: False ,
}
boolean ,
started:
{
Description: The container start status ,
Required: False ,
}
boolean ,
restartCount:
{
Description: The container restart count ,
Format: int32 ,
Required: False ,
}
integer ,
runningState:
{
Description: Current running state of the container ,
Enum:
{
Running: No description available. ,
Terminated: No description available. ,
Waiting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStateDetails:
{
Description: The details of container current running state ,
Required: False ,
}
string ,
logStreamEndpoint:
{
Description: Log Stream endpoint ,
Required: False ,
}
string ,
execEndpoint:
{
Description: Container exec endpoint ,
Required: False ,
}
string ,
debugEndpoint:
{
Description: Container debug endpoint ,
Required: False ,
}
string ,
}
,
]
,
initContainers:
{
Description: The init containers collection under a replica. ,
Required: False ,
}
[
{
name:
{
Description: The Name of the Container ,
Required: False ,
}
string ,
containerId:
{
Description: The Id of the Container ,
Required: False ,
}
string ,
ready:
{
Description: The container ready status ,
Required: False ,
}
boolean ,
started:
{
Description: The container start status ,
Required: False ,
}
boolean ,
restartCount:
{
Description: The container restart count ,
Format: int32 ,
Required: False ,
}
integer ,
runningState:
{
Description: Current running state of the container ,
Enum:
{
Running: No description available. ,
Terminated: No description available. ,
Waiting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStateDetails:
{
Description: The details of container current running state ,
Required: False ,
}
string ,
logStreamEndpoint:
{
Description: Log Stream endpoint ,
Required: False ,
}
string ,
execEndpoint:
{
Description: Container exec endpoint ,
Required: False ,
}
string ,
debugEndpoint:
{
Description: Container debug endpoint ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsRevisions_RestartRevision (new)
Description :  Restarts a revision for a Container App
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/restart
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
revisionName:
{
Description: Name of the Container App Revision. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsDiagnostics_ListDetectors (new)
Description :  Get the list of diagnostics for a given Container App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectors
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App for which detector info is needed. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of diagnostic data. ,
Required: True ,
}
[
{
properties:
{
Description: Diagnostics resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: Metadata of the diagnostics response. ,
Required: False ,
}
{
id:
{
Description: Unique detector name ,
Required: False ,
}
string ,
name:
{
Description: Display Name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Details of the diagnostics info ,
Required: False ,
}
string ,
author:
{
Description: Authors' names of the detector ,
Required: False ,
}
string ,
category:
{
Description: Category of the detector ,
Required: False ,
}
string ,
supportTopicList:
{
Description: List of support topics ,
Required: False ,
}
[
{
id:
{
Description: Unique topic identifier ,
Required: False ,
}
string ,
pesId:
{
Description: PES identifier ,
Required: False ,
}
string ,
}
,
]
,
analysisTypes:
{
Description: List of analysis types ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Authors' names of the detector ,
Required: False ,
}
string ,
score:
{
Description: Authors' names of the detector ,
Required: False ,
}
number ,
}
,
dataset:
{
Description: Set of data collections associated with the response. ,
Required: False ,
}
[
{
table:
{
Description: Table response ,
Required: False ,
}
{
tableName:
{
Description: Table name ,
Required: False ,
}
string ,
columns:
{
Description: Columns in the table ,
Required: False ,
}
[
{
columnName:
{
Description: Column name ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column ,
Required: False ,
}
string ,
columnType:
{
Description: Column type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Rows in the table ,
Required: False ,
}
[
object ,
]
,
}
,
renderingProperties:
{
Description: Details of the table response ,
Required: False ,
}
{
type:
{
Description: Rendering type ,
Format: int32 ,
Required: False ,
}
integer ,
title:
{
Description: Title of the table ,
Required: False ,
}
string ,
description:
{
Description: Description of the table ,
Required: False ,
}
string ,
isVisible:
{
Description: Flag if the table should be rendered ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
status:
{
Description: Status of the diagnostics response. ,
Required: False ,
}
{
message:
{
Description: Diagnostic message ,
Required: False ,
}
string ,
statusId:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataProviderMetadata:
{
Description: List of data providers' metadata. ,
Required: False ,
}
{
providerName:
{
Description: Name of data provider ,
Required: False ,
}
string ,
propertyBag:
{
Description: Collection of properties ,
Required: False ,
}
[
{
name:
{
Description: Property name ,
Required: False ,
}
string ,
value:
{
Description: Property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsDiagnostics_GetDetector (new)
Description :  Get a diagnostics result of a Container App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectors/{detectorName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
detectorName:
{
Description: Name of the Container App Detector. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Diagnostics resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: Metadata of the diagnostics response. ,
Required: False ,
}
{
id:
{
Description: Unique detector name ,
Required: False ,
}
string ,
name:
{
Description: Display Name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Details of the diagnostics info ,
Required: False ,
}
string ,
author:
{
Description: Authors' names of the detector ,
Required: False ,
}
string ,
category:
{
Description: Category of the detector ,
Required: False ,
}
string ,
supportTopicList:
{
Description: List of support topics ,
Required: False ,
}
[
{
id:
{
Description: Unique topic identifier ,
Required: False ,
}
string ,
pesId:
{
Description: PES identifier ,
Required: False ,
}
string ,
}
,
]
,
analysisTypes:
{
Description: List of analysis types ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Authors' names of the detector ,
Required: False ,
}
string ,
score:
{
Description: Authors' names of the detector ,
Required: False ,
}
number ,
}
,
dataset:
{
Description: Set of data collections associated with the response. ,
Required: False ,
}
[
{
table:
{
Description: Table response ,
Required: False ,
}
{
tableName:
{
Description: Table name ,
Required: False ,
}
string ,
columns:
{
Description: Columns in the table ,
Required: False ,
}
[
{
columnName:
{
Description: Column name ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column ,
Required: False ,
}
string ,
columnType:
{
Description: Column type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Rows in the table ,
Required: False ,
}
[
object ,
]
,
}
,
renderingProperties:
{
Description: Details of the table response ,
Required: False ,
}
{
type:
{
Description: Rendering type ,
Format: int32 ,
Required: False ,
}
integer ,
title:
{
Description: Title of the table ,
Required: False ,
}
string ,
description:
{
Description: Description of the table ,
Required: False ,
}
string ,
isVisible:
{
Description: Flag if the table should be rendered ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
status:
{
Description: Status of the diagnostics response. ,
Required: False ,
}
{
message:
{
Description: Diagnostic message ,
Required: False ,
}
string ,
statusId:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataProviderMetadata:
{
Description: List of data providers' metadata. ,
Required: False ,
}
{
providerName:
{
Description: Name of data provider ,
Required: False ,
}
string ,
propertyBag:
{
Description: Collection of properties ,
Required: False ,
}
[
{
name:
{
Description: Property name ,
Required: False ,
}
string ,
value:
{
Description: Property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsDiagnostics_ListRevisions (new)
Description :  Get the Revisions for a given Container App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/revisionsApi/revisions/
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App for which Revisions are needed. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Revision resource specific properties ,
Required: False ,
}
{
createdTime:
{
Description: Timestamp describing when the revision was created by controller ,
Format: date-time ,
Required: False ,
}
string ,
lastActiveTime:
{
Description: Timestamp describing when the revision was last active. Only meaningful when revision is inactive ,
Format: date-time ,
Required: False ,
}
string ,
fqdn:
{
Description: Fully qualified domain name of the revision ,
Required: False ,
}
string ,
template:
{
Description: Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
active:
{
Description: Boolean describing if the Revision is Active ,
Required: False ,
}
boolean ,
replicas:
{
Description: Number of pods currently running for this revision ,
Format: int32 ,
Required: False ,
}
integer ,
trafficWeight:
{
Description: Traffic weight assigned to this revision ,
Format: int32 ,
Required: False ,
}
integer ,
labels:
{
Description: List of labels assigned to this revision. ,
Required: False ,
}
[
string ,
]
,
provisioningError:
{
Description: Optional Field - Platform Error Message ,
Required: False ,
}
string ,
healthState:
{
Description: Current health State of the revision ,
Enum:
{
Healthy: No description available. ,
Unhealthy: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current provisioning State of the revision ,
Enum:
{
Provisioning: No description available. ,
Provisioned: No description available. ,
Failed: No description available. ,
Deprovisioning: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
runningState:
{
Description: Current running state of the revision ,
Enum:
{
Running: No description available. ,
Processing: No description available. ,
Stopped: No description available. ,
Degraded: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsDiagnostics_GetRevision (new)
Description :  Get a revision of a Container App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/revisionsApi/revisions/{revisionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
revisionName:
{
Description: Name of the Container App Revision. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Revision resource specific properties ,
Required: False ,
}
{
createdTime:
{
Description: Timestamp describing when the revision was created by controller ,
Format: date-time ,
Required: False ,
}
string ,
lastActiveTime:
{
Description: Timestamp describing when the revision was last active. Only meaningful when revision is inactive ,
Format: date-time ,
Required: False ,
}
string ,
fqdn:
{
Description: Fully qualified domain name of the revision ,
Required: False ,
}
string ,
template:
{
Description: Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
active:
{
Description: Boolean describing if the Revision is Active ,
Required: False ,
}
boolean ,
replicas:
{
Description: Number of pods currently running for this revision ,
Format: int32 ,
Required: False ,
}
integer ,
trafficWeight:
{
Description: Traffic weight assigned to this revision ,
Format: int32 ,
Required: False ,
}
integer ,
labels:
{
Description: List of labels assigned to this revision. ,
Required: False ,
}
[
string ,
]
,
provisioningError:
{
Description: Optional Field - Platform Error Message ,
Required: False ,
}
string ,
healthState:
{
Description: Current health State of the revision ,
Enum:
{
Healthy: No description available. ,
Unhealthy: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current provisioning State of the revision ,
Enum:
{
Provisioning: No description available. ,
Provisioned: No description available. ,
Failed: No description available. ,
Deprovisioning: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
runningState:
{
Description: Current running state of the revision ,
Enum:
{
Running: No description available. ,
Processing: No description available. ,
Stopped: No description available. ,
Degraded: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ContainerAppsDiagnostics_GetRoot (new)
Description :  Get the properties of a Container App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/rootApi/
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
containerAppName:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The complex type of the extended location. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
CustomLocation: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
managedBy:
{
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. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used to render different experiences for resources of the same type; e.g. WorkflowApp is a kind of Microsoft.App/ContainerApps type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
workflowapp: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: ContainerApp resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container App. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
runningStatus:
{
Description: Running status of the Container App. ,
Enum:
{
Progressing: Container App is transitioning between Stopped and Running states. ,
Running: Container App is in Running state. ,
Stopped: Container App is in Stopped state. ,
Suspended: Container App Job is in Suspended state. ,
Ready: Container App Job is in Ready state. ,
}
,
Required: False ,
}
enum ,
deploymentErrors:
{
Description: Any errors that occurred during deployment ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: Deprecated. Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container app execution. ,
Required: False ,
}
string ,
patchingConfiguration:
{
Description: Container App auto patch configuration. ,
Required: False ,
}
{
patchingMode:
{
Description: Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
latestRevisionName:
{
Description: Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
latestReadyRevisionName:
{
Description: Name of the latest ready revision of the Container App. ,
Required: False ,
}
string ,
latestRevisionFqdn:
{
Description: Fully Qualified Domain Name of the latest revision of the Container App. ,
Required: False ,
}
string ,
customDomainVerificationId:
{
Description: Id used to verify domain name ownership ,
Required: False ,
}
string ,
configuration:
{
Description: Non versioned Container App configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container app ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
identity:
{
Description: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: Azure Key Vault URL pointing to the secret referenced by the container app. ,
Required: False ,
}
string ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Single: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.Multiple: Multiple revisions can be active, including optional traffic weights and labels.Labels: Only revisions with labels are active. Traffic weights can be applied to labels. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
Labels: No description available. ,
}
,
Required: False ,
}
enum ,
targetLabel:
{
Description: Required in labels revisions mode. Label to apply to newly created revision. ,
Required: False ,
}
string ,
ingress:
{
Description: Ingress configurations. ,
Required: False ,
}
{
fqdn:
{
Description: Hostname. ,
Required: False ,
}
string ,
external:
{
Description: Bool indicating if app exposes an external http endpoint ,
Required: False ,
}
boolean ,
targetPort:
{
Description: Target Port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
exposedPort:
{
Description: Exposed Port in containers for TCP traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: No description available. ,
tcp: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Traffic weights for app's revisions ,
Required: False ,
}
[
{
revisionName:
{
Description: Name of a revision ,
Required: False ,
}
string ,
weight:
{
Description: Traffic weight assigned to a revision ,
Format: int32 ,
Required: False ,
}
integer ,
latestRevision:
{
Description: Indicates that the traffic weight belongs to a latest stable revision ,
Required: False ,
}
boolean ,
label:
{
Description: Associates a traffic label with a revision ,
Required: False ,
}
string ,
}
,
]
,
customDomains:
{
Description: custom domain bindings for Container Apps' hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: True ,
}
string ,
bindingType:
{
Description: Custom Domain binding type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
Auto: No description available. ,
}
,
Required: False ,
}
enum ,
certificateId:
{
Description: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. ,
Required: False ,
}
string ,
}
,
]
,
allowInsecure:
{
Description: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections ,
Required: False ,
}
boolean ,
ipSecurityRestrictions:
{
Description: Rules to restrict incoming IP address. ,
Required: False ,
}
[
{
name:
{
Description: Name for the IP restriction rule. ,
Required: True ,
}
string ,
description:
{
Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. ,
Required: False ,
}
string ,
ipAddressRange:
{
Description: CIDR notation to match incoming IP address ,
Required: True ,
}
string ,
action:
{
Description: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
stickySessions:
{
Description: Sticky Sessions for Single Revision Mode ,
Required: False ,
}
{
affinity:
{
Description: Sticky Session Affinity ,
Enum:
{
sticky: No description available. ,
none: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientCertificateMode:
{
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: No description available. ,
accept: No description available. ,
require: No description available. ,
}
,
Required: False ,
}
enum ,
corsPolicy:
{
Description: CORS policy for container app ,
Required: False ,
}
{
allowedOrigins:
{
Description: Specifies the content for the access-control-allow-origins header ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Specifies the content for the access-control-allow-methods header ,
Required: False ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Specifies the content for the access-control-allow-headers header ,
Required: False ,
}
[
string ,
]
,
exposeHeaders:
{
Description: Specifies the content for the access-control-expose-headers header ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: Specifies the content for the access-control-max-age header ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: Specifies whether the resource allows credentials ,
Required: False ,
}
boolean ,
}
,
additionalPortMappings:
{
Description: Settings to expose additional ports on container app ,
Required: False ,
}
[
{
external:
{
Description: Specifies whether the app port is accessible outside of the environment ,
Required: True ,
}
boolean ,
targetPort:
{
Description: Specifies the port user's container listens on ,
Format: int32 ,
Required: True ,
}
integer ,
exposedPort:
{
Description: Specifies the exposed port for the target port. If not specified, it defaults to target port ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
targetPortHttpScheme:
{
Description: Whether an http app listens on http or https ,
Enum:
{
http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
registries:
{
Description: Collection of private container registry credentials for containers used by the Container app ,
Required: False ,
}
[
{
server:
{
Description: Container Registry Server ,
Required: False ,
}
string ,
username:
{
Description: Container Registry Username ,
Required: False ,
}
string ,
passwordSecretRef:
{
Description: The name of the Secret that contains the registry login password ,
Required: False ,
}
string ,
identity:
{
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' ,
Required: False ,
}
string ,
}
,
]
,
dapr:
{
Description: Dapr configuration for the Container App. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appProtocol:
{
Description: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http ,
Enum:
{
http: No description available. ,
grpc: No description available. ,
}
,
Required: False ,
}
enum ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
appHealth:
{
Description: Dapr application health check configuration ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the health probe is enabled ,
Required: False ,
}
boolean ,
path:
{
Description: Path for the health probe ,
Required: False ,
}
string ,
probeIntervalSeconds:
{
Description: Interval for the health probe in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
probeTimeoutMilliseconds:
{
Description: Timeout for the health probe in milliseconds ,
Format: int32 ,
Required: False ,
}
integer ,
threshold:
{
Description: Threshold for the health probe ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
maxConcurrency:
{
Description: Maximum number of concurrent requests, events handled by the Dapr sidecar ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
runtime:
{
Description: App runtime configuration for the Container App. ,
Required: False ,
}
{
java:
{
Description: Java app configuration ,
Required: False ,
}
{
enableMetrics:
{
Description: Enable jmx core metrics for the java app ,
Required: False ,
}
boolean ,
javaAgent:
{
Description: Diagnostic capabilities achieved by java agent ,
Required: False ,
}
{
enabled:
{
Description: Enable java agent injection for the java app. ,
Required: False ,
}
boolean ,
logging:
{
Description: Capabilities on the java logging scenario. ,
Required: False ,
}
{
loggerSettings:
{
Description: Settings of the logger for the java app. ,
Required: False ,
}
[
{
logger:
{
Description: Logger name. ,
Required: True ,
}
string ,
level:
{
Description: The specified logger's log level. ,
Enum:
{
off: No description available. ,
error: No description available. ,
info: No description available. ,
debug: No description available. ,
trace: No description available. ,
warn: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
dotnet:
{
Description: .NET app configuration ,
Required: False ,
}
{
autoConfigureDataProtection:
{
Description: Auto configure the ASP.NET Core Data Protection feature ,
Required: False ,
}
boolean ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
Format: int32 ,
Required: False ,
}
integer ,
revisionTransitionThreshold:
{
Description: Optional. The percent of the total number of replicas that must be brought up before revision transition occurs. Defaults to 100 when none is given. Value must be greater than 0 and less than or equal to 100. ,
Format: int32 ,
Required: False ,
}
integer ,
service:
{
Description: Container App to be a dev Container App Service ,
Required: False ,
}
{
type:
{
Description: Dev ContainerApp service type ,
Required: True ,
}
string ,
}
,
identitySettings:
{
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. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. ,
Enum:
{
Init: No description available. ,
Main: No description available. ,
None: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
terminationGracePeriodSeconds:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
initContainers:
{
Description: List of specialized containers that run before app containers. ,
Required: False ,
}
[
object ,
]
,
containers:
{
Description: List of container definitions for the Container App. ,
Required: False ,
}
[
{
probes:
{
Description: List of probes for the container. ,
Required: False ,
}
[
{
failureThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGet:
{
Description: HTTPGet specifies the http request to perform. ,
Required: False ,
}
{
host:
{
Description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. ,
Required: False ,
}
string ,
httpHeaders:
{
Description: Custom headers to set in the request. HTTP allows repeated headers. ,
Required: False ,
}
[
{
name:
{
Description: The header field name ,
Required: True ,
}
string ,
value:
{
Description: The header field value ,
Required: True ,
}
string ,
}
,
]
,
path:
{
Description: Path to access on the HTTP server. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
scheme:
{
Description: Scheme to use for connecting to the host. Defaults to HTTP. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
initialDelaySeconds:
{
Description: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. ,
Format: int32 ,
Required: False ,
}
integer ,
periodSeconds:
{
Description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
successThreshold:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tcpSocket:
{
Description: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ,
Required: False ,
}
{
host:
{
Description: Optional: Host name to connect to, defaults to the pod IP. ,
Required: False ,
}
string ,
port:
{
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. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
terminationGracePeriodSeconds:
{
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) ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: The type of probe. ,
Enum:
{
Liveness: No description available. ,
Readiness: No description available. ,
Startup: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
scale:
{
Description: Scaling properties for the Container App. ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of container replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of container replicas. Defaults to 10 if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
cooldownPeriod:
{
Description: Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
accountName:
{
Description: Storage account name. required if using managed identity to authenticate ,
Required: False ,
}
string ,
queueName:
{
Description: Queue name. ,
Required: False ,
}
string ,
queueLength:
{
Description: Queue length. ,
Format: int32 ,
Required: False ,
}
integer ,
auth:
{
Description: Authentication secrets for the queue scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
custom:
{
Description: Custom scale rule. ,
Required: False ,
}
{
type:
{
Description: Type of the custom scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe custom scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
http:
{
Description: HTTP requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe http scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the custom scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
tcp:
{
Description: Tcp requests based scaling. ,
Required: False ,
}
{
metadata:
{
Description: Metadata properties to describe tcp scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the tcp scale rule. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
Required: False ,
}
string ,
}
,
]
,
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
volumes:
{
Description: List of volume definitions for the Container App. ,
Required: False ,
}
[
{
name:
{
Description: Volume name. ,
Required: False ,
}
string ,
storageType:
{
Description: Storage type for the volume. If not provided, use EmptyDir. ,
Enum:
{
AzureFile: No description available. ,
EmptyDir: No description available. ,
Secret: No description available. ,
NfsAzureFile: No description available. ,
Smb: No description available. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir and Secret. ,
Required: False ,
}
string ,
secrets:
{
Description: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. ,
Required: False ,
}
[
{
secretRef:
{
Description: Name of the Container App secret from which to pull the secret value. ,
Required: False ,
}
string ,
path:
{
Description: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. ,
Required: False ,
}
string ,
}
,
]
,
mountOptions:
{
Description: Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. ,
Required: False ,
}
string ,
}
,
]
,
serviceBinds:
{
Description: List of container app services bound to the app ,
Required: False ,
}
[
{
serviceId:
{
Description: Resource id of the target service ,
Required: False ,
}
string ,
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
clientType:
{
Description: Type of the client to be used to connect to the service ,
Required: False ,
}
string ,
customizedKeys:
{
Description: Customized keys for customizing injected values to the app ,
Required: False ,
}
object ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container app. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ManagedEnvironmentDiagnostics_ListDetectors (new)
Description :  Get the list of diagnostics for a Managed Environment used to host container apps.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectors
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
environmentName:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of diagnostic data. ,
Required: True ,
}
[
{
properties:
{
Description: Diagnostics resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: Metadata of the diagnostics response. ,
Required: False ,
}
{
id:
{
Description: Unique detector name ,
Required: False ,
}
string ,
name:
{
Description: Display Name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Details of the diagnostics info ,
Required: False ,
}
string ,
author:
{
Description: Authors' names of the detector ,
Required: False ,
}
string ,
category:
{
Description: Category of the detector ,
Required: False ,
}
string ,
supportTopicList:
{
Description: List of support topics ,
Required: False ,
}
[
{
id:
{
Description: Unique topic identifier ,
Required: False ,
}
string ,
pesId:
{
Description: PES identifier ,
Required: False ,
}
string ,
}
,
]
,
analysisTypes:
{
Description: List of analysis types ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Authors' names of the detector ,
Required: False ,
}
string ,
score:
{
Description: Authors' names of the detector ,
Required: False ,
}
number ,
}
,
dataset:
{
Description: Set of data collections associated with the response. ,
Required: False ,
}
[
{
table:
{
Description: Table response ,
Required: False ,
}
{
tableName:
{
Description: Table name ,
Required: False ,
}
string ,
columns:
{
Description: Columns in the table ,
Required: False ,
}
[
{
columnName:
{
Description: Column name ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column ,
Required: False ,
}
string ,
columnType:
{
Description: Column type ,
Required: False ,
}
string ,
}
,
]
,
rows:
{
Description: Rows in the table ,
Required: False ,
}
[
object ,
]
,
}
,
renderingProperties:
{
Description: Details of the table response ,
Required: False ,
}
{
type:
{
Description: Rendering type ,
Format: int32 ,
Required: False ,
}
integer ,
title:
{
Description: Title of the table ,
Required: False ,
}
string ,
description:
{
Description: Description of the table ,
Required: False ,
}
string ,
isVisible:
{
Description: Flag if the table should be rendered ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
status:
{
Description: Status of the diagnostics response. ,
Required: False ,
}
{
message:
{
Description: Diagnostic message ,
Required: False ,
}
string ,
statusId:
{
Description: Status ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
dataProviderMetadata:
{
Description: List of data providers' metadata. ,
Required: False ,
}
{
providerName:
{
Description: Name of data provider ,
Required: False ,
}
string ,
propertyBag:
{
Description: Collection of properties ,
Required: False ,
}
[
{
name:
{
Description: Property name ,
Required: False ,
}
string ,
value:
{
Description: Property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Description: Details or the error ,
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
ManagedEnvironmentDiagnostics_GetDetector (new)
Description :  Get the diagnostics data for a Managed Environment used to host container apps.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectors/{detectorName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
environmentName:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
detectorName:
{
Description: Name of the Managed Environment detector. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Diagnostics resource specific properties ,
Required: False ,
}
{
metadata:
{
Description: Metadata of the diagnostics response. ,
Required: False ,
}
{
id:
{
Description: Unique detector name ,
Required: False ,
}
string ,
name:
{
Description: Display Name of the detector ,
Required: False ,
}
string ,
description:
{
Description: Details of the diagnostics info ,
Required: False ,
}
string ,
author:
{
Description: Authors' names of the detector ,
Required: False ,
}
string ,
category:
{
Description: Category of the detector ,
Required: False ,
}
string ,
supportTopicList:
{
Description: List of support topics ,
Required: False ,
}
[
{
id:
{
Description: Unique topic identifier ,
Required: False ,
}
string ,
pesId:
{
Description: PES identifier ,
Required: False ,
}
string ,
}
,
]
,
analysisTypes:
{
Description: List of analysis types ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Authors' names of the detector ,
Required: False ,
}
string ,
score:
{
Description: Authors' names of the detector ,
Required: False ,
}
number ,
}
,
dataset:
{
Description: Set of data collections associated with the response. ,
Required: False ,
}
[
{
table:
{
Description: Table response ,
Required: False ,
}
{
tableName:
{
Description: Table name ,
Required: False ,
}
string