Microsoft.App (stable:2025-01-01)

2025/03/25 • 115 new methods

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. ,
Required: True ,
}
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. ,
Required: True ,
}
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. ,
Required: True ,
}
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. ,
Required: True ,
}
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 ,
}
[
{
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 ,
}
,
}
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 ,
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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
]
,
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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ 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_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 (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 ,
}
,
}
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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ 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_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 resources. ,
Required: True ,
}
[
{
properties:
{
Description: Dapr Component resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Component type ,
Required: False ,
}
string ,
version:
{
Description: Component version ,
Required: False ,
}
string ,
ignoreErrors:
{
Description: Boolean describing if the component errors are ignores ,
Required: False ,
}
boolean ,
initTimeout:
{
Description: Initialization timeout ,
Required: False ,
}
string ,
secrets:
{
Description: Collection of secrets used by a Dapr component ,
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 ,
}
,
]
,
secretStoreComponent:
{
Description: Name of a Dapr component to retrieve component secrets from ,
Required: False ,
}
string ,
metadata:
{
Description: Component metadata ,
Required: False ,
}
[
{
name:
{
Description: Metadata property name. ,
Required: False ,
}
string ,
value:
{
Description: Metadata property value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Dapr Component secret from which to pull the metadata property value. ,
Required: False ,
}
string ,
}
,
]
,
scopes:
{
Description: Names of container apps that can use this Dapr component ,
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 resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Component type ,
Required: False ,
}
string ,
version:
{
Description: Component version ,
Required: False ,
}
string ,
ignoreErrors:
{
Description: Boolean describing if the component errors are ignores ,
Required: False ,
}
boolean ,
initTimeout:
{
Description: Initialization timeout ,
Required: False ,
}
string ,
secrets:
{
Description: Collection of secrets used by a Dapr component ,
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 ,
}
,
]
,
secretStoreComponent:
{
Description: Name of a Dapr component to retrieve component secrets from ,
Required: False ,
}
string ,
metadata:
{
Description: Component metadata ,
Required: False ,
}
[
{
name:
{
Description: Metadata property name. ,
Required: False ,
}
string ,
value:
{
Description: Metadata property value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Dapr Component secret from which to pull the metadata property value. ,
Required: False ,
}
string ,
}
,
]
,
scopes:
{
Description: Names of container apps that can use this Dapr component ,
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 resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Component type ,
Required: False ,
}
string ,
version:
{
Description: Component version ,
Required: False ,
}
string ,
ignoreErrors:
{
Description: Boolean describing if the component errors are ignores ,
Required: False ,
}
boolean ,
initTimeout:
{
Description: Initialization timeout ,
Required: False ,
}
string ,
secrets:
{
Description: Collection of secrets used by a Dapr component ,
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 ,
}
,
]
,
secretStoreComponent:
{
Description: Name of a Dapr component to retrieve component secrets from ,
Required: False ,
}
string ,
metadata:
{
Description: Component metadata ,
Required: False ,
}
[
{
name:
{
Description: Metadata property name. ,
Required: False ,
}
string ,
value:
{
Description: Metadata property value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Dapr Component secret from which to pull the metadata property value. ,
Required: False ,
}
string ,
}
,
]
,
scopes:
{
Description: Names of container apps that can use this Dapr component ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Dapr Component resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Component type ,
Required: False ,
}
string ,
version:
{
Description: Component version ,
Required: False ,
}
string ,
ignoreErrors:
{
Description: Boolean describing if the component errors are ignores ,
Required: False ,
}
boolean ,
initTimeout:
{
Description: Initialization timeout ,
Required: False ,
}
string ,
secrets:
{
Description: Collection of secrets used by a Dapr component ,
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 ,
}
,
]
,
secretStoreComponent:
{
Description: Name of a Dapr component to retrieve component secrets from ,
Required: False ,
}
string ,
metadata:
{
Description: Component metadata ,
Required: False ,
}
[
{
name:
{
Description: Metadata property name. ,
Required: False ,
}
string ,
value:
{
Description: Metadata property value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Dapr Component secret from which to pull the metadata property value. ,
Required: False ,
}
string ,
}
,
]
,
scopes:
{
Description: Names of container apps that can use this Dapr component ,
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_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 (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 ,
}
,
}
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 ,
}
{
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 ,
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 ,
}
,
}
,
}
,
]
,
}

⚐ 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 ,
}
{
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 ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
{
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 ,
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 ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Storage properties ,
Required: False ,
}
{
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 ,
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 ,
}
,
}
,
}

⚐ 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_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 (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 ,
}
,
}
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 ,
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 ,
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 ,
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: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
}
,
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 ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
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 ,
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 ,
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: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
}
,
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 ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
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 ,
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 ,
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: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
}
,
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 ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
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 ,
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 ,
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: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
}
,
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 ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
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 ,
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 ,
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: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
}
,
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 ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
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 ,
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 ,
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: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
}
,
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 ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
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 ,
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 ,
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: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
}
,
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 ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
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 ,
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 ,
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: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
}
,
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 ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
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 ,
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 ,
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: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
}
,
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 ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
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 ,
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 ,
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: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
}
,
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 ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
}
,
}
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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
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 ,
}
,
]
,
}
,
}
,
]
,
}

⚐ 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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
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 ,
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 ,
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 ,
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: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. ,
Enum:
{
Multiple: No description available. ,
Single: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
}
,
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 ,
}
,
}
,
maxInactiveRevisions:
{
Description: Optional. Max inactive revisions a Container App can have. ,
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 in seconds. Defaults to 300 seconds if not set. ,
Format: int32 ,
Required: False ,
}
integer ,
pollingInterval:
{
Description: Optional. KEDA Polling Interval in seconds. 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. ,
}
,
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 ,
}
,
]
,
}
,
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 ,
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 ,
}
,
}
ManagedEnvironmentsDiagnostics_GetRoot (new)
Description :  Get the properties of a Managed Environment used to host container apps.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
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)

{
kind:
{
Description: Kind of the Environment. ,
Required: False ,
}
string ,
identity:
{
Description: Managed identities for the Managed Environment 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 ,
}
,
properties:
{
Description: Managed environment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the 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. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
vnetConfiguration:
{
Description: Vnet configuration for the environment ,
Required: False ,
}
{
internal:
{
Description: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. ,
Required: False ,
}
string ,
}
,
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 Environment ,
Required: False ,
}
string ,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to configured destination. ,
Required: False ,
}
{
destination:
{
Description: Logs destination, can be 'log-analytics', 'azure-monitor' or 'none' ,
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Description: Log Analytics configuration, must only be provided when destination is configured as 'log-analytics' ,
Required: False ,
}
{
customerId:
{
Description: Log analytics customer id ,
Required: False ,
}
string ,
sharedKey:
{
Description: Log analytics customer key ,
Required: False ,
}
string ,
}
,
}
,
zoneRedundant:
{
Description: Whether or not this Managed Environment is zone-redundant. ,
Required: False ,
}
boolean ,
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 ,
}
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the Environment. ,
Required: False ,
}
string ,
workloadProfiles:
{
Description: Workload profiles configured for the Managed Environment. ,
Required: False ,
}
[
{
name:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
workloadProfileType:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
minimumCount:
{
Description: The minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumCount:
{
Description: The maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
kedaConfiguration:
{
Description: The configuration of Keda component. ,
Required: False ,
}
{
version:
{
Description: The version of Keda ,
Required: False ,
}
string ,
}
,
daprConfiguration:
{
Description: The configuration of Dapr component. ,
Required: False ,
}
{
version:
{
Description: The version of Dapr ,
Required: False ,
}
string ,
}
,
infrastructureResourceGroup:
{
Description: Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet. ,
Required: False ,
}
string ,
peerAuthentication:
{
Description: Peer authentication settings for the Managed Environment ,
Required: False ,
}
{
mtls:
{
Description: Mutual TLS authentication settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the mutual TLS authentication is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
peerTrafficConfiguration:
{
Description: Peer traffic settings for the Managed Environment ,
Required: False ,
}
{
encryption:
{
Description: Peer traffic encryption settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the peer traffic encryption is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
Jobs_ListDetectors (new)
Description :  Get the list of diagnostics for a Container App Job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/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 ,
jobName:
{
Description: Job Name ,
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 ,
}
,
}
Jobs_GetDetector (new)
Description :  Get the diagnostics data for a Container App Job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/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 ,
jobName:
{
Description: Job Name ,
Required: True ,
}
string ,
detectorName:
{
Description: Name of the Container App Job 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 ,
}
,
}
Jobs_ProxyGet (new)
Description :  Get the properties of a Container App Job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectorProperties/{apiName}
{
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 ,
jobName:
{
Description: Job Name ,
Required: True ,
}
string ,
apiName:
{
Description: Proxy API Name for Container App Job. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed identities needed by a container app job to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container Apps Job resource specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container Apps Job. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container apps job execution. ,
Required: False ,
}
string ,
configuration:
{
Description: Container Apps Job configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container Apps Job ,
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 ,
}
,
]
,
triggerType:
{
Description: Trigger type of the job ,
Enum:
{
Schedule: No description available. ,
Event: No description available. ,
Manual: No description available. ,
}
,
Required: True ,
}
enum ,
replicaTimeout:
{
Description: Maximum number of seconds a replica is allowed to run. ,
Format: int32 ,
Required: True ,
}
integer ,
replicaRetryLimit:
{
Description: Maximum number of retries before failing the job. ,
Format: int32 ,
Required: False ,
}
integer ,
manualTriggerConfig:
{
Description: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
scheduleTriggerConfig:
{
Description: Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
cronExpression:
{
Description: Cron formatted repeating schedule ("* * * * *") of a Cron Job. ,
Required: True ,
}
string ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eventTriggerConfig:
{
Description: Trigger configuration of an event driven job. ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
scale:
{
Description: Scaling configurations for event driven jobs. ,
Required: False ,
}
{
pollingInterval:
{
Description: Interval to check each event source in seconds. Defaults to 30s ,
Format: int32 ,
Required: False ,
}
integer ,
minExecutions:
{
Description: Minimum number of job executions that are created for a trigger, default 0 ,
Format: int32 ,
Required: False ,
}
integer ,
maxExecutions:
{
Description: Maximum number of job executions that are created for a trigger, default 100. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
type:
{
Description: Type of the scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe the scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the 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 ,
}
,
]
,
}
,
}
,
registries:
{
Description: Collection of private container registry credentials used by a Container apps job ,
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 ,
}
,
]
,
identitySettings:
{
Description: Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used. ,
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 Apps job definition. ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
]
,
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. ,
}
,
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 ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses of a container apps job. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container apps job. ,
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 ,
}
,
}
Operations_List (new)
Description :  Lists all of the available RP operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.App/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of available operation details ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: Display of the operation ,
Required: False ,
}
{
provider:
{
Description: Resource provider of the operation ,
Required: False ,
}
string ,
resource:
{
Description: Resource of the operation ,
Required: False ,
}
string ,
operation:
{
Description: Localized friendly name for the operation ,
Required: False ,
}
string ,
description:
{
Description: Localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
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 ,
}
,
}
JavaComponents_List (new)
Description :  Get the Java Components for a managed environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/javaComponents
{
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 ,
environmentName:
{
Description: Name of the Managed 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: Java Component resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Type of the Java Component. ,
Enum:
{
SpringBootAdmin: No description available. ,
SpringCloudEureka: No description available. ,
SpringCloudConfig: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Java Component. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
configurations:
{
Description: List of Java Components configuration properties ,
Required: False ,
}
[
{
propertyName:
{
Description: The name of the property ,
Required: False ,
}
string ,
value:
{
Description: The value of the property ,
Required: False ,
}
string ,
}
,
]
,
scale:
{
Description: Java component scaling configurations ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of Java component replicas. Defaults to 1 if not set ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of Java component replicas ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
serviceBinds:
{
Description: List of Java Components that are bound to the Java component ,
Required: False ,
}
[
{
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
serviceId:
{
Description: Resource id of the target service ,
Format: arm-id ,
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 ,
}
,
]
,
}
,
}
JavaComponents_Get (new)
Description :  Get a Java Component.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/javaComponents/{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 ,
environmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
name:
{
Description: Name of the Java Component. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Java Component resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Type of the Java Component. ,
Enum:
{
SpringBootAdmin: No description available. ,
SpringCloudEureka: No description available. ,
SpringCloudConfig: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Java Component. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
configurations:
{
Description: List of Java Components configuration properties ,
Required: False ,
}
[
{
propertyName:
{
Description: The name of the property ,
Required: False ,
}
string ,
value:
{
Description: The value of the property ,
Required: False ,
}
string ,
}
,
]
,
scale:
{
Description: Java component scaling configurations ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of Java component replicas. Defaults to 1 if not set ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of Java component replicas ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
serviceBinds:
{
Description: List of Java Components that are bound to the Java component ,
Required: False ,
}
[
{
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
serviceId:
{
Description: Resource id of the target service ,
Format: arm-id ,
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 ,
}
,
]
,
}
,
}
JavaComponents_CreateOrUpdate (new)
Description :  Creates or updates a Java Component in a Managed Environment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/javaComponents/{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 ,
environmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
name:
{
Description: Name of the Java Component. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
javaComponentEnvelope:
{
Description: Configuration details of the Java Component. ,
Required: True ,
}
{
properties:
{
Description: Java Component resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Type of the Java Component. ,
Enum:
{
SpringBootAdmin: No description available. ,
SpringCloudEureka: No description available. ,
SpringCloudConfig: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Java Component. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
configurations:
{
Description: List of Java Components configuration properties ,
Required: False ,
}
[
{
propertyName:
{
Description: The name of the property ,
Required: False ,
}
string ,
value:
{
Description: The value of the property ,
Required: False ,
}
string ,
}
,
]
,
scale:
{
Description: Java component scaling configurations ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of Java component replicas. Defaults to 1 if not set ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of Java component replicas ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
serviceBinds:
{
Description: List of Java Components that are bound to the Java component ,
Required: False ,
}
[
{
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
serviceId:
{
Description: Resource id of the target service ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Java Component resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Type of the Java Component. ,
Enum:
{
SpringBootAdmin: No description available. ,
SpringCloudEureka: No description available. ,
SpringCloudConfig: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Java Component. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
configurations:
{
Description: List of Java Components configuration properties ,
Required: False ,
}
[
{
propertyName:
{
Description: The name of the property ,
Required: False ,
}
string ,
value:
{
Description: The value of the property ,
Required: False ,
}
string ,
}
,
]
,
scale:
{
Description: Java component scaling configurations ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of Java component replicas. Defaults to 1 if not set ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of Java component replicas ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
serviceBinds:
{
Description: List of Java Components that are bound to the Java component ,
Required: False ,
}
[
{
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
serviceId:
{
Description: Resource id of the target service ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Java Component resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Type of the Java Component. ,
Enum:
{
SpringBootAdmin: No description available. ,
SpringCloudEureka: No description available. ,
SpringCloudConfig: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Java Component. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
configurations:
{
Description: List of Java Components configuration properties ,
Required: False ,
}
[
{
propertyName:
{
Description: The name of the property ,
Required: False ,
}
string ,
value:
{
Description: The value of the property ,
Required: False ,
}
string ,
}
,
]
,
scale:
{
Description: Java component scaling configurations ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of Java component replicas. Defaults to 1 if not set ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of Java component replicas ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
serviceBinds:
{
Description: List of Java Components that are bound to the Java component ,
Required: False ,
}
[
{
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
serviceId:
{
Description: Resource id of the target service ,
Format: arm-id ,
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 ,
}
,
]
,
}
,
}
JavaComponents_Update (new)
Description :  Patches a Java Component using JSON Merge Patch
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/javaComponents/{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 ,
environmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
name:
{
Description: Name of the Java Component. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
javaComponentEnvelope:
{
Description: Configuration details of the Java Component. ,
Required: True ,
}
{
properties:
{
Description: Java Component resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Type of the Java Component. ,
Enum:
{
SpringBootAdmin: No description available. ,
SpringCloudEureka: No description available. ,
SpringCloudConfig: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Java Component. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
configurations:
{
Description: List of Java Components configuration properties ,
Required: False ,
}
[
{
propertyName:
{
Description: The name of the property ,
Required: False ,
}
string ,
value:
{
Description: The value of the property ,
Required: False ,
}
string ,
}
,
]
,
scale:
{
Description: Java component scaling configurations ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of Java component replicas. Defaults to 1 if not set ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of Java component replicas ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
serviceBinds:
{
Description: List of Java Components that are bound to the Java component ,
Required: False ,
}
[
{
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
serviceId:
{
Description: Resource id of the target service ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Java Component resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Type of the Java Component. ,
Enum:
{
SpringBootAdmin: No description available. ,
SpringCloudEureka: No description available. ,
SpringCloudConfig: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Java Component. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
configurations:
{
Description: List of Java Components configuration properties ,
Required: False ,
}
[
{
propertyName:
{
Description: The name of the property ,
Required: False ,
}
string ,
value:
{
Description: The value of the property ,
Required: False ,
}
string ,
}
,
]
,
scale:
{
Description: Java component scaling configurations ,
Required: False ,
}
{
minReplicas:
{
Description: Optional. Minimum number of Java component replicas. Defaults to 1 if not set ,
Format: int32 ,
Required: False ,
}
integer ,
maxReplicas:
{
Description: Optional. Maximum number of Java component replicas ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
serviceBinds:
{
Description: List of Java Components that are bound to the Java component ,
Required: False ,
}
[
{
name:
{
Description: Name of the service bind ,
Required: False ,
}
string ,
serviceId:
{
Description: Resource id of the target service ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
JavaComponents_Delete (new)
Description :  Delete a Java Component.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/javaComponents/{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 ,
environmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
name:
{
Description: Name of the Java 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 ,
}
,
]
,
}
,
}
Jobs_ListBySubscription (new)
Description :  Get the Container Apps Jobs in a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.App/jobs
{
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 ,
}
[
{
identity:
{
Description: Managed identities needed by a container app job to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container Apps Job resource specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container Apps Job. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container apps job execution. ,
Required: False ,
}
string ,
configuration:
{
Description: Container Apps Job configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container Apps Job ,
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 ,
}
,
]
,
triggerType:
{
Description: Trigger type of the job ,
Enum:
{
Schedule: No description available. ,
Event: No description available. ,
Manual: No description available. ,
}
,
Required: True ,
}
enum ,
replicaTimeout:
{
Description: Maximum number of seconds a replica is allowed to run. ,
Format: int32 ,
Required: True ,
}
integer ,
replicaRetryLimit:
{
Description: Maximum number of retries before failing the job. ,
Format: int32 ,
Required: False ,
}
integer ,
manualTriggerConfig:
{
Description: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
scheduleTriggerConfig:
{
Description: Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
cronExpression:
{
Description: Cron formatted repeating schedule ("* * * * *") of a Cron Job. ,
Required: True ,
}
string ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eventTriggerConfig:
{
Description: Trigger configuration of an event driven job. ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
scale:
{
Description: Scaling configurations for event driven jobs. ,
Required: False ,
}
{
pollingInterval:
{
Description: Interval to check each event source in seconds. Defaults to 30s ,
Format: int32 ,
Required: False ,
}
integer ,
minExecutions:
{
Description: Minimum number of job executions that are created for a trigger, default 0 ,
Format: int32 ,
Required: False ,
}
integer ,
maxExecutions:
{
Description: Maximum number of job executions that are created for a trigger, default 100. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
type:
{
Description: Type of the scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe the scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the 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 ,
}
,
]
,
}
,
}
,
registries:
{
Description: Collection of private container registry credentials used by a Container apps job ,
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 ,
}
,
]
,
identitySettings:
{
Description: Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used. ,
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 Apps job definition. ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
]
,
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. ,
}
,
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 ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses of a container apps job. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container apps job. ,
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 ,
}
,
}
Jobs_ListByResourceGroup (new)
Description :  Get the Container Apps Jobs in a given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs
{
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 ,
}
[
{
identity:
{
Description: Managed identities needed by a container app job to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container Apps Job resource specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container Apps Job. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container apps job execution. ,
Required: False ,
}
string ,
configuration:
{
Description: Container Apps Job configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container Apps Job ,
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 ,
}
,
]
,
triggerType:
{
Description: Trigger type of the job ,
Enum:
{
Schedule: No description available. ,
Event: No description available. ,
Manual: No description available. ,
}
,
Required: True ,
}
enum ,
replicaTimeout:
{
Description: Maximum number of seconds a replica is allowed to run. ,
Format: int32 ,
Required: True ,
}
integer ,
replicaRetryLimit:
{
Description: Maximum number of retries before failing the job. ,
Format: int32 ,
Required: False ,
}
integer ,
manualTriggerConfig:
{
Description: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
scheduleTriggerConfig:
{
Description: Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
cronExpression:
{
Description: Cron formatted repeating schedule ("* * * * *") of a Cron Job. ,
Required: True ,
}
string ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eventTriggerConfig:
{
Description: Trigger configuration of an event driven job. ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
scale:
{
Description: Scaling configurations for event driven jobs. ,
Required: False ,
}
{
pollingInterval:
{
Description: Interval to check each event source in seconds. Defaults to 30s ,
Format: int32 ,
Required: False ,
}
integer ,
minExecutions:
{
Description: Minimum number of job executions that are created for a trigger, default 0 ,
Format: int32 ,
Required: False ,
}
integer ,
maxExecutions:
{
Description: Maximum number of job executions that are created for a trigger, default 100. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
type:
{
Description: Type of the scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe the scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the 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 ,
}
,
]
,
}
,
}
,
registries:
{
Description: Collection of private container registry credentials used by a Container apps job ,
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 ,
}
,
]
,
identitySettings:
{
Description: Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used. ,
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 Apps job definition. ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
]
,
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. ,
}
,
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 ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses of a container apps job. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container apps job. ,
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 ,
}
,
}
Jobs_Get (new)
Description :  Get the properties of a Container Apps Job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}
{
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 ,
jobName:
{
Description: Job Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed identities needed by a container app job to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container Apps Job resource specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container Apps Job. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container apps job execution. ,
Required: False ,
}
string ,
configuration:
{
Description: Container Apps Job configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container Apps Job ,
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 ,
}
,
]
,
triggerType:
{
Description: Trigger type of the job ,
Enum:
{
Schedule: No description available. ,
Event: No description available. ,
Manual: No description available. ,
}
,
Required: True ,
}
enum ,
replicaTimeout:
{
Description: Maximum number of seconds a replica is allowed to run. ,
Format: int32 ,
Required: True ,
}
integer ,
replicaRetryLimit:
{
Description: Maximum number of retries before failing the job. ,
Format: int32 ,
Required: False ,
}
integer ,
manualTriggerConfig:
{
Description: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
scheduleTriggerConfig:
{
Description: Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
cronExpression:
{
Description: Cron formatted repeating schedule ("* * * * *") of a Cron Job. ,
Required: True ,
}
string ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eventTriggerConfig:
{
Description: Trigger configuration of an event driven job. ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
scale:
{
Description: Scaling configurations for event driven jobs. ,
Required: False ,
}
{
pollingInterval:
{
Description: Interval to check each event source in seconds. Defaults to 30s ,
Format: int32 ,
Required: False ,
}
integer ,
minExecutions:
{
Description: Minimum number of job executions that are created for a trigger, default 0 ,
Format: int32 ,
Required: False ,
}
integer ,
maxExecutions:
{
Description: Maximum number of job executions that are created for a trigger, default 100. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
type:
{
Description: Type of the scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe the scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the 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 ,
}
,
]
,
}
,
}
,
registries:
{
Description: Collection of private container registry credentials used by a Container apps job ,
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 ,
}
,
]
,
identitySettings:
{
Description: Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used. ,
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 Apps job definition. ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
]
,
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. ,
}
,
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 ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses of a container apps job. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container apps job. ,
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 ,
}
,
}
Jobs_CreateOrUpdate (new)
Description :  Create or Update a Container Apps Job.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}
{
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 ,
jobName:
{
Description: Job Name ,
Required: True ,
}
string ,
JobEnvelope:
{
Description: Properties used to create a container apps job ,
Required: True ,
}
{
identity:
{
Description: Managed identities needed by a container app job to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container Apps Job resource specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container Apps Job. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container apps job execution. ,
Required: False ,
}
string ,
configuration:
{
Description: Container Apps Job configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container Apps Job ,
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 ,
}
,
]
,
triggerType:
{
Description: Trigger type of the job ,
Enum:
{
Schedule: No description available. ,
Event: No description available. ,
Manual: No description available. ,
}
,
Required: True ,
}
enum ,
replicaTimeout:
{
Description: Maximum number of seconds a replica is allowed to run. ,
Format: int32 ,
Required: True ,
}
integer ,
replicaRetryLimit:
{
Description: Maximum number of retries before failing the job. ,
Format: int32 ,
Required: False ,
}
integer ,
manualTriggerConfig:
{
Description: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
scheduleTriggerConfig:
{
Description: Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
cronExpression:
{
Description: Cron formatted repeating schedule ("* * * * *") of a Cron Job. ,
Required: True ,
}
string ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eventTriggerConfig:
{
Description: Trigger configuration of an event driven job. ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
scale:
{
Description: Scaling configurations for event driven jobs. ,
Required: False ,
}
{
pollingInterval:
{
Description: Interval to check each event source in seconds. Defaults to 30s ,
Format: int32 ,
Required: False ,
}
integer ,
minExecutions:
{
Description: Minimum number of job executions that are created for a trigger, default 0 ,
Format: int32 ,
Required: False ,
}
integer ,
maxExecutions:
{
Description: Maximum number of job executions that are created for a trigger, default 100. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
type:
{
Description: Type of the scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe the scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the 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 ,
}
,
]
,
}
,
}
,
registries:
{
Description: Collection of private container registry credentials used by a Container apps job ,
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 ,
}
,
]
,
identitySettings:
{
Description: Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used. ,
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 Apps job definition. ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
]
,
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. ,
}
,
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 ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses of a container apps job. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container apps job. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
identity:
{
Description: Managed identities needed by a container app job to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container Apps Job resource specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container Apps Job. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container apps job execution. ,
Required: False ,
}
string ,
configuration:
{
Description: Container Apps Job configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container Apps Job ,
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 ,
}
,
]
,
triggerType:
{
Description: Trigger type of the job ,
Enum:
{
Schedule: No description available. ,
Event: No description available. ,
Manual: No description available. ,
}
,
Required: True ,
}
enum ,
replicaTimeout:
{
Description: Maximum number of seconds a replica is allowed to run. ,
Format: int32 ,
Required: True ,
}
integer ,
replicaRetryLimit:
{
Description: Maximum number of retries before failing the job. ,
Format: int32 ,
Required: False ,
}
integer ,
manualTriggerConfig:
{
Description: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
scheduleTriggerConfig:
{
Description: Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
cronExpression:
{
Description: Cron formatted repeating schedule ("* * * * *") of a Cron Job. ,
Required: True ,
}
string ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eventTriggerConfig:
{
Description: Trigger configuration of an event driven job. ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
scale:
{
Description: Scaling configurations for event driven jobs. ,
Required: False ,
}
{
pollingInterval:
{
Description: Interval to check each event source in seconds. Defaults to 30s ,
Format: int32 ,
Required: False ,
}
integer ,
minExecutions:
{
Description: Minimum number of job executions that are created for a trigger, default 0 ,
Format: int32 ,
Required: False ,
}
integer ,
maxExecutions:
{
Description: Maximum number of job executions that are created for a trigger, default 100. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
type:
{
Description: Type of the scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe the scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the 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 ,
}
,
]
,
}
,
}
,
registries:
{
Description: Collection of private container registry credentials used by a Container apps job ,
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 ,
}
,
]
,
identitySettings:
{
Description: Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used. ,
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 Apps job definition. ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
]
,
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. ,
}
,
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 ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses of a container apps job. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container apps job. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed identities needed by a container app job to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container Apps Job resource specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container Apps Job. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container apps job execution. ,
Required: False ,
}
string ,
configuration:
{
Description: Container Apps Job configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container Apps Job ,
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 ,
}
,
]
,
triggerType:
{
Description: Trigger type of the job ,
Enum:
{
Schedule: No description available. ,
Event: No description available. ,
Manual: No description available. ,
}
,
Required: True ,
}
enum ,
replicaTimeout:
{
Description: Maximum number of seconds a replica is allowed to run. ,
Format: int32 ,
Required: True ,
}
integer ,
replicaRetryLimit:
{
Description: Maximum number of retries before failing the job. ,
Format: int32 ,
Required: False ,
}
integer ,
manualTriggerConfig:
{
Description: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
scheduleTriggerConfig:
{
Description: Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
cronExpression:
{
Description: Cron formatted repeating schedule ("* * * * *") of a Cron Job. ,
Required: True ,
}
string ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eventTriggerConfig:
{
Description: Trigger configuration of an event driven job. ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
scale:
{
Description: Scaling configurations for event driven jobs. ,
Required: False ,
}
{
pollingInterval:
{
Description: Interval to check each event source in seconds. Defaults to 30s ,
Format: int32 ,
Required: False ,
}
integer ,
minExecutions:
{
Description: Minimum number of job executions that are created for a trigger, default 0 ,
Format: int32 ,
Required: False ,
}
integer ,
maxExecutions:
{
Description: Maximum number of job executions that are created for a trigger, default 100. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
type:
{
Description: Type of the scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe the scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the 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 ,
}
,
]
,
}
,
}
,
registries:
{
Description: Collection of private container registry credentials used by a Container apps job ,
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 ,
}
,
]
,
identitySettings:
{
Description: Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used. ,
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 Apps job definition. ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
]
,
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. ,
}
,
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 ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses of a container apps job. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container apps job. ,
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 ,
}
,
}
Jobs_Delete (new)
Description :  Delete a Container Apps Job.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}
{
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 ,
jobName:
{
Description: Job Name ,
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 ,
}
,
}
Jobs_Update (new)
Description :  Patches a Container Apps Job using JSON Merge Patch
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}
{
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 ,
jobName:
{
Description: Job Name ,
Required: True ,
}
string ,
JobEnvelope:
{
Description: Properties used to create a container apps job ,
Required: True ,
}
{
identity:
{
Description: Managed identities needed by a container app job to interact with other Azure services to not maintain 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 ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
configuration:
{
Description: Container Apps Job configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container Apps Job ,
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 ,
}
,
]
,
triggerType:
{
Description: Trigger type of the job ,
Enum:
{
Schedule: No description available. ,
Event: No description available. ,
Manual: No description available. ,
}
,
Required: True ,
}
enum ,
replicaTimeout:
{
Description: Maximum number of seconds a replica is allowed to run. ,
Format: int32 ,
Required: True ,
}
integer ,
replicaRetryLimit:
{
Description: Maximum number of retries before failing the job. ,
Format: int32 ,
Required: False ,
}
integer ,
manualTriggerConfig:
{
Description: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
scheduleTriggerConfig:
{
Description: Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
cronExpression:
{
Description: Cron formatted repeating schedule ("* * * * *") of a Cron Job. ,
Required: True ,
}
string ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eventTriggerConfig:
{
Description: Trigger configuration of an event driven job. ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
scale:
{
Description: Scaling configurations for event driven jobs. ,
Required: False ,
}
{
pollingInterval:
{
Description: Interval to check each event source in seconds. Defaults to 30s ,
Format: int32 ,
Required: False ,
}
integer ,
minExecutions:
{
Description: Minimum number of job executions that are created for a trigger, default 0 ,
Format: int32 ,
Required: False ,
}
integer ,
maxExecutions:
{
Description: Maximum number of job executions that are created for a trigger, default 100. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
type:
{
Description: Type of the scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe the scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the 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 ,
}
,
]
,
}
,
}
,
registries:
{
Description: Collection of private container registry credentials used by a Container apps job ,
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 ,
}
,
]
,
identitySettings:
{
Description: Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used. ,
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 Apps job definition. ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
]
,
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. ,
}
,
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 ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses of a container apps job. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container apps job. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed identities needed by a container app job to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container Apps Job resource specific properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Container Apps Job. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
environmentId:
{
Description: Resource ID of environment. ,
Required: False ,
}
string ,
workloadProfileName:
{
Description: Workload profile name to pin for container apps job execution. ,
Required: False ,
}
string ,
configuration:
{
Description: Container Apps Job configuration properties. ,
Required: False ,
}
{
secrets:
{
Description: Collection of secrets used by a Container Apps Job ,
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 ,
}
,
]
,
triggerType:
{
Description: Trigger type of the job ,
Enum:
{
Schedule: No description available. ,
Event: No description available. ,
Manual: No description available. ,
}
,
Required: True ,
}
enum ,
replicaTimeout:
{
Description: Maximum number of seconds a replica is allowed to run. ,
Format: int32 ,
Required: True ,
}
integer ,
replicaRetryLimit:
{
Description: Maximum number of retries before failing the job. ,
Format: int32 ,
Required: False ,
}
integer ,
manualTriggerConfig:
{
Description: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
scheduleTriggerConfig:
{
Description: Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
cronExpression:
{
Description: Cron formatted repeating schedule ("* * * * *") of a Cron Job. ,
Required: True ,
}
string ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
eventTriggerConfig:
{
Description: Trigger configuration of an event driven job. ,
Required: False ,
}
{
replicaCompletionCount:
{
Description: Minimum number of successful replica completions before overall job completion. ,
Format: int32 ,
Required: False ,
}
integer ,
parallelism:
{
Description: Number of parallel replicas of a job that can run at a given time. ,
Format: int32 ,
Required: False ,
}
integer ,
scale:
{
Description: Scaling configurations for event driven jobs. ,
Required: False ,
}
{
pollingInterval:
{
Description: Interval to check each event source in seconds. Defaults to 30s ,
Format: int32 ,
Required: False ,
}
integer ,
minExecutions:
{
Description: Minimum number of job executions that are created for a trigger, default 0 ,
Format: int32 ,
Required: False ,
}
integer ,
maxExecutions:
{
Description: Maximum number of job executions that are created for a trigger, default 100. ,
Format: int32 ,
Required: False ,
}
integer ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
type:
{
Description: Type of the scale rule eg: azure-servicebus, redis etc. ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata properties to describe the scale rule. ,
Required: False ,
}
object ,
auth:
{
Description: Authentication secrets for the 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 ,
}
,
]
,
}
,
}
,
registries:
{
Description: Collection of private container registry credentials used by a Container apps job ,
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 ,
}
,
]
,
identitySettings:
{
Description: Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used. ,
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 Apps job definition. ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
]
,
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. ,
}
,
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 ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses of a container apps job. ,
Required: False ,
}
[
string ,
]
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the container apps job. ,
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 ,
}
,
}
Jobs_Start (new)
Description :  Start a Container Apps Job
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/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 ,
jobName:
{
Description: Job Name ,
Required: True ,
}
string ,
template:
{
Description: Properties used to start a job execution. ,
Required: False ,
}
{
containers:
{
Description: List of container definitions for the Container Apps Job. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
ephemeralStorage:
{
Description: Ephemeral Storage, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
}
,
]
,
initContainers:
{
Description: List of specialized containers that run before job containers. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
ephemeralStorage:
{
Description: Ephemeral Storage, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Job execution name. ,
Required: False ,
}
string ,
id:
{
Description: Job execution Id. ,
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 ,
}
,
}
Jobs_StopExecution (new)
Description :  Terminates execution of a running container apps job
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions/{jobExecutionName}/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 ,
jobName:
{
Description: Job Name ,
Required: True ,
}
string ,
jobExecutionName:
{
Description: Job execution name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
}
Jobs_StopMultipleExecutions (new)
Description :  Terminates execution of a running container apps job
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/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 ,
jobName:
{
Description: Job Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
name:
{
Description: Job execution Name. ,
Required: False ,
}
string ,
id:
{
Description: Job execution Id. ,
Required: False ,
}
string ,
type:
{
Description: Job execution type ,
Required: False ,
}
string ,
properties:
{
Description: Container Apps Job execution specific properties. ,
Required: False ,
}
{
status:
{
Description: Current running State of the job ,
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. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Job execution start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job execution end time. ,
Format: date-time ,
Required: False ,
}
string ,
template:
{
Description: Job's execution container. ,
Required: False ,
}
{
containers:
{
Description: List of container definitions for the Container Apps Job. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
ephemeralStorage:
{
Description: Ephemeral Storage, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
}
,
]
,
initContainers:
{
Description: List of specialized containers that run before job containers. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
ephemeralStorage:
{
Description: Ephemeral Storage, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources. ,
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 ,
}
,
}
JobsExecutions_List (new)
Description :  Get a Container Apps Job's executions
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions
{
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 ,
jobName:
{
Description: Job Name ,
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 ,
}
[
{
name:
{
Description: Job execution Name. ,
Required: False ,
}
string ,
id:
{
Description: Job execution Id. ,
Required: False ,
}
string ,
type:
{
Description: Job execution type ,
Required: False ,
}
string ,
properties:
{
Description: Container Apps Job execution specific properties. ,
Required: False ,
}
{
status:
{
Description: Current running State of the job ,
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. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Job execution start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job execution end time. ,
Format: date-time ,
Required: False ,
}
string ,
template:
{
Description: Job's execution container. ,
Required: False ,
}
{
containers:
{
Description: List of container definitions for the Container Apps Job. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
ephemeralStorage:
{
Description: Ephemeral Storage, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
}
,
]
,
initContainers:
{
Description: List of specialized containers that run before job containers. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
ephemeralStorage:
{
Description: Ephemeral Storage, e.g. "1Gi" ,
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 ,
}
,
}
JobExecution (new)
Description :  Get details of a single job execution
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions/{jobExecutionName}
{
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 ,
jobName:
{
Description: Job Name ,
Required: True ,
}
string ,
jobExecutionName:
{
Description: Job execution name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Job execution Name. ,
Required: False ,
}
string ,
id:
{
Description: Job execution Id. ,
Required: False ,
}
string ,
type:
{
Description: Job execution type ,
Required: False ,
}
string ,
properties:
{
Description: Container Apps Job execution specific properties. ,
Required: False ,
}
{
status:
{
Description: Current running State of the job ,
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. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Job execution start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Job execution end time. ,
Format: date-time ,
Required: False ,
}
string ,
template:
{
Description: Job's execution container. ,
Required: False ,
}
{
containers:
{
Description: List of container definitions for the Container Apps Job. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
ephemeralStorage:
{
Description: Ephemeral Storage, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
}
,
]
,
initContainers:
{
Description: List of specialized containers that run before job containers. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
ephemeralStorage:
{
Description: Ephemeral Storage, e.g. "1Gi" ,
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 ,
}
,
}
Jobs_ListSecrets (new)
Description :  List secrets for a container apps job
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/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 ,
jobName:
{
Description: Job Name ,
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 ,
}
,
}
ManagedEnvironments_ListBySubscription (new)
Description :  Get all Managed Environments for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.App/managedEnvironments
{
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 ,
}
[
{
kind:
{
Description: Kind of the Environment. ,
Required: False ,
}
string ,
identity:
{
Description: Managed identities for the Managed Environment 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 ,
}
,
properties:
{
Description: Managed environment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the 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. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
vnetConfiguration:
{
Description: Vnet configuration for the environment ,
Required: False ,
}
{
internal:
{
Description: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. ,
Required: False ,
}
string ,
}
,
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 Environment ,
Required: False ,
}
string ,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to configured destination. ,
Required: False ,
}
{
destination:
{
Description: Logs destination, can be 'log-analytics', 'azure-monitor' or 'none' ,
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Description: Log Analytics configuration, must only be provided when destination is configured as 'log-analytics' ,
Required: False ,
}
{
customerId:
{
Description: Log analytics customer id ,
Required: False ,
}
string ,
sharedKey:
{
Description: Log analytics customer key ,
Required: False ,
}
string ,
}
,
}
,
zoneRedundant:
{
Description: Whether or not this Managed Environment is zone-redundant. ,
Required: False ,
}
boolean ,
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 ,
}
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the Environment. ,
Required: False ,
}
string ,
workloadProfiles:
{
Description: Workload profiles configured for the Managed Environment. ,
Required: False ,
}
[
{
name:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
workloadProfileType:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
minimumCount:
{
Description: The minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumCount:
{
Description: The maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
kedaConfiguration:
{
Description: The configuration of Keda component. ,
Required: False ,
}
{
version:
{
Description: The version of Keda ,
Required: False ,
}
string ,
}
,
daprConfiguration:
{
Description: The configuration of Dapr component. ,
Required: False ,
}
{
version:
{
Description: The version of Dapr ,
Required: False ,
}
string ,
}
,
infrastructureResourceGroup:
{
Description: Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet. ,
Required: False ,
}
string ,
peerAuthentication:
{
Description: Peer authentication settings for the Managed Environment ,
Required: False ,
}
{
mtls:
{
Description: Mutual TLS authentication settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the mutual TLS authentication is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
peerTrafficConfiguration:
{
Description: Peer traffic settings for the Managed Environment ,
Required: False ,
}
{
encryption:
{
Description: Peer traffic encryption settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the peer traffic encryption is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
]
,
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 ,
}
,
}
ManagedEnvironments_ListByResourceGroup (new)
Description :  Get all the Managed Environments in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments
{
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 ,
}
[
{
kind:
{
Description: Kind of the Environment. ,
Required: False ,
}
string ,
identity:
{
Description: Managed identities for the Managed Environment 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 ,
}
,
properties:
{
Description: Managed environment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the 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. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
vnetConfiguration:
{
Description: Vnet configuration for the environment ,
Required: False ,
}
{
internal:
{
Description: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. ,
Required: False ,
}
string ,
}
,
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 Environment ,
Required: False ,
}
string ,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to configured destination. ,
Required: False ,
}
{
destination:
{
Description: Logs destination, can be 'log-analytics', 'azure-monitor' or 'none' ,
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Description: Log Analytics configuration, must only be provided when destination is configured as 'log-analytics' ,
Required: False ,
}
{
customerId:
{
Description: Log analytics customer id ,
Required: False ,
}
string ,
sharedKey:
{
Description: Log analytics customer key ,
Required: False ,
}
string ,
}
,
}
,
zoneRedundant:
{
Description: Whether or not this Managed Environment is zone-redundant. ,
Required: False ,
}
boolean ,
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 ,
}
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the Environment. ,
Required: False ,
}
string ,
workloadProfiles:
{
Description: Workload profiles configured for the Managed Environment. ,
Required: False ,
}
[
{
name:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
workloadProfileType:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
minimumCount:
{
Description: The minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumCount:
{
Description: The maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
kedaConfiguration:
{
Description: The configuration of Keda component. ,
Required: False ,
}
{
version:
{
Description: The version of Keda ,
Required: False ,
}
string ,
}
,
daprConfiguration:
{
Description: The configuration of Dapr component. ,
Required: False ,
}
{
version:
{
Description: The version of Dapr ,
Required: False ,
}
string ,
}
,
infrastructureResourceGroup:
{
Description: Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet. ,
Required: False ,
}
string ,
peerAuthentication:
{
Description: Peer authentication settings for the Managed Environment ,
Required: False ,
}
{
mtls:
{
Description: Mutual TLS authentication settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the mutual TLS authentication is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
peerTrafficConfiguration:
{
Description: Peer traffic settings for the Managed Environment ,
Required: False ,
}
{
encryption:
{
Description: Peer traffic encryption settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the peer traffic encryption is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
]
,
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 ,
}
,
}
ManagedEnvironments_Get (new)
Description :  Get the properties of a Managed Environment used to host container apps.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}
{
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)

{
kind:
{
Description: Kind of the Environment. ,
Required: False ,
}
string ,
identity:
{
Description: Managed identities for the Managed Environment 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 ,
}
,
properties:
{
Description: Managed environment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the 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. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
vnetConfiguration:
{
Description: Vnet configuration for the environment ,
Required: False ,
}
{
internal:
{
Description: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. ,
Required: False ,
}
string ,
}
,
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 Environment ,
Required: False ,
}
string ,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to configured destination. ,
Required: False ,
}
{
destination:
{
Description: Logs destination, can be 'log-analytics', 'azure-monitor' or 'none' ,
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Description: Log Analytics configuration, must only be provided when destination is configured as 'log-analytics' ,
Required: False ,
}
{
customerId:
{
Description: Log analytics customer id ,
Required: False ,
}
string ,
sharedKey:
{
Description: Log analytics customer key ,
Required: False ,
}
string ,
}
,
}
,
zoneRedundant:
{
Description: Whether or not this Managed Environment is zone-redundant. ,
Required: False ,
}
boolean ,
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 ,
}
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the Environment. ,
Required: False ,
}
string ,
workloadProfiles:
{
Description: Workload profiles configured for the Managed Environment. ,
Required: False ,
}
[
{
name:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
workloadProfileType:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
minimumCount:
{
Description: The minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumCount:
{
Description: The maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
kedaConfiguration:
{
Description: The configuration of Keda component. ,
Required: False ,
}
{
version:
{
Description: The version of Keda ,
Required: False ,
}
string ,
}
,
daprConfiguration:
{
Description: The configuration of Dapr component. ,
Required: False ,
}
{
version:
{
Description: The version of Dapr ,
Required: False ,
}
string ,
}
,
infrastructureResourceGroup:
{
Description: Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet. ,
Required: False ,
}
string ,
peerAuthentication:
{
Description: Peer authentication settings for the Managed Environment ,
Required: False ,
}
{
mtls:
{
Description: Mutual TLS authentication settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the mutual TLS authentication is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
peerTrafficConfiguration:
{
Description: Peer traffic settings for the Managed Environment ,
Required: False ,
}
{
encryption:
{
Description: Peer traffic encryption settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the peer traffic encryption is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
ManagedEnvironments_CreateOrUpdate (new)
Description :  Creates or updates a Managed Environment used to host container apps.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}
{
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 ,
environmentEnvelope:
{
Description: Configuration details of the Environment. ,
Required: True ,
}
{
kind:
{
Description: Kind of the Environment. ,
Required: False ,
}
string ,
identity:
{
Description: Managed identities for the Managed Environment 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 ,
}
,
properties:
{
Description: Managed environment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the 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. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
vnetConfiguration:
{
Description: Vnet configuration for the environment ,
Required: False ,
}
{
internal:
{
Description: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. ,
Required: False ,
}
string ,
}
,
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 Environment ,
Required: False ,
}
string ,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to configured destination. ,
Required: False ,
}
{
destination:
{
Description: Logs destination, can be 'log-analytics', 'azure-monitor' or 'none' ,
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Description: Log Analytics configuration, must only be provided when destination is configured as 'log-analytics' ,
Required: False ,
}
{
customerId:
{
Description: Log analytics customer id ,
Required: False ,
}
string ,
sharedKey:
{
Description: Log analytics customer key ,
Required: False ,
}
string ,
}
,
}
,
zoneRedundant:
{
Description: Whether or not this Managed Environment is zone-redundant. ,
Required: False ,
}
boolean ,
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 ,
}
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the Environment. ,
Required: False ,
}
string ,
workloadProfiles:
{
Description: Workload profiles configured for the Managed Environment. ,
Required: False ,
}
[
{
name:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
workloadProfileType:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
minimumCount:
{
Description: The minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumCount:
{
Description: The maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
kedaConfiguration:
{
Description: The configuration of Keda component. ,
Required: False ,
}
{
version:
{
Description: The version of Keda ,
Required: False ,
}
string ,
}
,
daprConfiguration:
{
Description: The configuration of Dapr component. ,
Required: False ,
}
{
version:
{
Description: The version of Dapr ,
Required: False ,
}
string ,
}
,
infrastructureResourceGroup:
{
Description: Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet. ,
Required: False ,
}
string ,
peerAuthentication:
{
Description: Peer authentication settings for the Managed Environment ,
Required: False ,
}
{
mtls:
{
Description: Mutual TLS authentication settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the mutual TLS authentication is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
peerTrafficConfiguration:
{
Description: Peer traffic settings for the Managed Environment ,
Required: False ,
}
{
encryption:
{
Description: Peer traffic encryption settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the peer traffic encryption is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of the Environment. ,
Required: False ,
}
string ,
identity:
{
Description: Managed identities for the Managed Environment 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 ,
}
,
properties:
{
Description: Managed environment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the 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. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
vnetConfiguration:
{
Description: Vnet configuration for the environment ,
Required: False ,
}
{
internal:
{
Description: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. ,
Required: False ,
}
string ,
}
,
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 Environment ,
Required: False ,
}
string ,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to configured destination. ,
Required: False ,
}
{
destination:
{
Description: Logs destination, can be 'log-analytics', 'azure-monitor' or 'none' ,
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Description: Log Analytics configuration, must only be provided when destination is configured as 'log-analytics' ,
Required: False ,
}
{
customerId:
{
Description: Log analytics customer id ,
Required: False ,
}
string ,
sharedKey:
{
Description: Log analytics customer key ,
Required: False ,
}
string ,
}
,
}
,
zoneRedundant:
{
Description: Whether or not this Managed Environment is zone-redundant. ,
Required: False ,
}
boolean ,
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 ,
}
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the Environment. ,
Required: False ,
}
string ,
workloadProfiles:
{
Description: Workload profiles configured for the Managed Environment. ,
Required: False ,
}
[
{
name:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
workloadProfileType:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
minimumCount:
{
Description: The minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumCount:
{
Description: The maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
kedaConfiguration:
{
Description: The configuration of Keda component. ,
Required: False ,
}
{
version:
{
Description: The version of Keda ,
Required: False ,
}
string ,
}
,
daprConfiguration:
{
Description: The configuration of Dapr component. ,
Required: False ,
}
{
version:
{
Description: The version of Dapr ,
Required: False ,
}
string ,
}
,
infrastructureResourceGroup:
{
Description: Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet. ,
Required: False ,
}
string ,
peerAuthentication:
{
Description: Peer authentication settings for the Managed Environment ,
Required: False ,
}
{
mtls:
{
Description: Mutual TLS authentication settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the mutual TLS authentication is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
peerTrafficConfiguration:
{
Description: Peer traffic settings for the Managed Environment ,
Required: False ,
}
{
encryption:
{
Description: Peer traffic encryption settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the peer traffic encryption is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}

⚐ Response (201)

{
kind:
{
Description: Kind of the Environment. ,
Required: False ,
}
string ,
identity:
{
Description: Managed identities for the Managed Environment 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 ,
}
,
properties:
{
Description: Managed environment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the 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. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
vnetConfiguration:
{
Description: Vnet configuration for the environment ,
Required: False ,
}
{
internal:
{
Description: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. ,
Required: False ,
}
string ,
}
,
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 Environment ,
Required: False ,
}
string ,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to configured destination. ,
Required: False ,
}
{
destination:
{
Description: Logs destination, can be 'log-analytics', 'azure-monitor' or 'none' ,
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Description: Log Analytics configuration, must only be provided when destination is configured as 'log-analytics' ,
Required: False ,
}
{
customerId:
{
Description: Log analytics customer id ,
Required: False ,
}
string ,
sharedKey:
{
Description: Log analytics customer key ,
Required: False ,
}
string ,
}
,
}
,
zoneRedundant:
{
Description: Whether or not this Managed Environment is zone-redundant. ,
Required: False ,
}
boolean ,
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 ,
}
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the Environment. ,
Required: False ,
}
string ,
workloadProfiles:
{
Description: Workload profiles configured for the Managed Environment. ,
Required: False ,
}
[
{
name:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
workloadProfileType:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
minimumCount:
{
Description: The minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumCount:
{
Description: The maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
kedaConfiguration:
{
Description: The configuration of Keda component. ,
Required: False ,
}
{
version:
{
Description: The version of Keda ,
Required: False ,
}
string ,
}
,
daprConfiguration:
{
Description: The configuration of Dapr component. ,
Required: False ,
}
{
version:
{
Description: The version of Dapr ,
Required: False ,
}
string ,
}
,
infrastructureResourceGroup:
{
Description: Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet. ,
Required: False ,
}
string ,
peerAuthentication:
{
Description: Peer authentication settings for the Managed Environment ,
Required: False ,
}
{
mtls:
{
Description: Mutual TLS authentication settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the mutual TLS authentication is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
peerTrafficConfiguration:
{
Description: Peer traffic settings for the Managed Environment ,
Required: False ,
}
{
encryption:
{
Description: Peer traffic encryption settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the peer traffic encryption is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
}
ManagedEnvironments_Delete (new)
Description :  Delete a Managed Environment if it does not have any container apps.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}
{
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)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
,
}
ManagedEnvironments_Update (new)
Description :  Patches a Managed Environment using JSON Merge Patch
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}
{
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 ,
environmentEnvelope:
{
Description: Configuration details of the Environment. ,
Required: True ,
}
{
kind:
{
Description: Kind of the Environment. ,
Required: False ,
}
string ,
identity:
{
Description: Managed identities for the Managed Environment 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 ,
}
,
properties:
{
Description: Managed environment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the 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. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
vnetConfiguration:
{
Description: Vnet configuration for the environment ,
Required: False ,
}
{
internal:
{
Description: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. ,
Required: False ,
}
string ,
}
,
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 Environment ,
Required: False ,
}
string ,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to configured destination. ,
Required: False ,
}
{
destination:
{
Description: Logs destination, can be 'log-analytics', 'azure-monitor' or 'none' ,
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Description: Log Analytics configuration, must only be provided when destination is configured as 'log-analytics' ,
Required: False ,
}
{
customerId:
{
Description: Log analytics customer id ,
Required: False ,
}
string ,
sharedKey:
{
Description: Log analytics customer key ,
Required: False ,
}
string ,
}
,
}
,
zoneRedundant:
{
Description: Whether or not this Managed Environment is zone-redundant. ,
Required: False ,
}
boolean ,
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 ,
}
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the Environment. ,
Required: False ,
}
string ,
workloadProfiles:
{
Description: Workload profiles configured for the Managed Environment. ,
Required: False ,
}
[
{
name:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
workloadProfileType:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
minimumCount:
{
Description: The minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumCount:
{
Description: The maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
kedaConfiguration:
{
Description: The configuration of Keda component. ,
Required: False ,
}
{
version:
{
Description: The version of Keda ,
Required: False ,
}
string ,
}
,
daprConfiguration:
{
Description: The configuration of Dapr component. ,
Required: False ,
}
{
version:
{
Description: The version of Dapr ,
Required: False ,
}
string ,
}
,
infrastructureResourceGroup:
{
Description: Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet. ,
Required: False ,
}
string ,
peerAuthentication:
{
Description: Peer authentication settings for the Managed Environment ,
Required: False ,
}
{
mtls:
{
Description: Mutual TLS authentication settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the mutual TLS authentication is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
peerTrafficConfiguration:
{
Description: Peer traffic settings for the Managed Environment ,
Required: False ,
}
{
encryption:
{
Description: Peer traffic encryption settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the peer traffic encryption is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of the Environment. ,
Required: False ,
}
string ,
identity:
{
Description: Managed identities for the Managed Environment 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 ,
}
,
properties:
{
Description: Managed environment resource specific properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the 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. ,
UpgradeRequested: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
daprAIInstrumentationKey:
{
Description: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
daprAIConnectionString:
{
Description: Application Insights connection string used by Dapr to export Service to Service communication telemetry ,
Required: False ,
}
string ,
vnetConfiguration:
{
Description: Vnet configuration for the environment ,
Required: False ,
}
{
internal:
{
Description: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
dockerBridgeCidr:
{
Description: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedCidr:
{
Description: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
platformReservedDnsIP:
{
Description: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. ,
Required: False ,
}
string ,
}
,
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 Environment ,
Required: False ,
}
string ,
appLogsConfiguration:
{
Description: Cluster configuration which enables the log daemon to export app logs to configured destination. ,
Required: False ,
}
{
destination:
{
Description: Logs destination, can be 'log-analytics', 'azure-monitor' or 'none' ,
Required: False ,
}
string ,
logAnalyticsConfiguration:
{
Description: Log Analytics configuration, must only be provided when destination is configured as 'log-analytics' ,
Required: False ,
}
{
customerId:
{
Description: Log analytics customer id ,
Required: False ,
}
string ,
sharedKey:
{
Description: Log analytics customer key ,
Required: False ,
}
string ,
}
,
}
,
zoneRedundant:
{
Description: Whether or not this Managed Environment is zone-redundant. ,
Required: False ,
}
boolean ,
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 ,
}
,
eventStreamEndpoint:
{
Description: The endpoint of the eventstream of the Environment. ,
Required: False ,
}
string ,
workloadProfiles:
{
Description: Workload profiles configured for the Managed Environment. ,
Required: False ,
}
[
{
name:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
workloadProfileType:
{
Description: Workload profile type for the workloads to run on. ,
Required: True ,
}
string ,
minimumCount:
{
Description: The minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumCount:
{
Description: The maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
kedaConfiguration:
{
Description: The configuration of Keda component. ,
Required: False ,
}
{
version:
{
Description: The version of Keda ,
Required: False ,
}
string ,
}
,
daprConfiguration:
{
Description: The configuration of Dapr component. ,
Required: False ,
}
{
version:
{
Description: The version of Dapr ,
Required: False ,
}
string ,
}
,
infrastructureResourceGroup:
{
Description: Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet. ,
Required: False ,
}
string ,
peerAuthentication:
{
Description: Peer authentication settings for the Managed Environment ,
Required: False ,
}
{
mtls:
{
Description: Mutual TLS authentication settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the mutual TLS authentication is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
peerTrafficConfiguration:
{
Description: Peer traffic settings for the Managed Environment ,
Required: False ,
}
{
encryption:
{
Description: Peer traffic encryption settings for the Managed Environment ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating whether the peer traffic encryption is enabled ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
}
Certificates_List (new)
Description :  Get the Certificates in a given managed environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
Description: Name of the Managed 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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
]
,
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 ,
}
,
}
Certificates_Get (new)
Description :  Get the specified Certificate.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
Description: Name of the Managed 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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ 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 ,
}
,
}
Certificates_CreateOrUpdate (new)
Description :  Create or Update a Certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
Description: Name of the Managed 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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}
,
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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ 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 ,
}
,
}
Certificates_Delete (new)
Description :  Deletes the specified Certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
Description: Name of the Managed 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)

{}

⚐ 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 ,
}
,
}
Certificates_Update (new)
Description :  Patches a certificate. Currently only patching of tags is supported
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
Description: Name of the Managed 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. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
}

⚐ 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 ,
}
,
}
ManagedCertificates_Get (new)
Description :  Get the specified Managed Certificate.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}
{
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 Managed Environment. ,
Required: True ,
}
string ,
managedCertificateName:
{
Description: Name of the Managed 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. ,
}
,
Required: False ,
}
enum ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
error:
{
Description: Any error occurred during the certificate provision. ,
Required: False ,
}
string ,
domainControlValidation:
{
Description: Selected type of domain control validation for managed certificates. ,
Enum:
{
CNAME: No description available. ,
HTTP: No description available. ,
TXT: No description available. ,
}
,
Required: False ,
}
enum ,
validationToken:
{
Description: A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates. ,
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 ,
}
,
}
ManagedCertificates_CreateOrUpdate (new)
Description :  Create or Update a Managed Certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}
{
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 Managed Environment. ,
Required: True ,
}
string ,
managedCertificateName:
{
Description: Name of the Managed Certificate. ,
Required: True ,
}
string ,
managedCertificateEnvelope:
{
Description: Managed 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. ,
}
,
Required: False ,
}
enum ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
error:
{
Description: Any error occurred during the certificate provision. ,
Required: False ,
}
string ,
domainControlValidation:
{
Description: Selected type of domain control validation for managed certificates. ,
Enum:
{
CNAME: No description available. ,
HTTP: No description available. ,
TXT: No description available. ,
}
,
Required: False ,
}
enum ,
validationToken:
{
Description: A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates. ,
Required: False ,
}
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. ,
}
,
Required: False ,
}
enum ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
error:
{
Description: Any error occurred during the certificate provision. ,
Required: False ,
}
string ,
domainControlValidation:
{
Description: Selected type of domain control validation for managed certificates. ,
Enum:
{
CNAME: No description available. ,
HTTP: No description available. ,
TXT: No description available. ,
}
,
Required: False ,
}
enum ,
validationToken:
{
Description: A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates. ,
Required: False ,
}
string ,
}
,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
error:
{
Description: Any error occurred during the certificate provision. ,
Required: False ,
}
string ,
domainControlValidation:
{
Description: Selected type of domain control validation for managed certificates. ,
Enum:
{
CNAME: No description available. ,
HTTP: No description available. ,
TXT: No description available. ,
}
,
Required: False ,
}
enum ,
validationToken:
{
Description: A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (400)

{}

⚐ 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 ,
}
,
}
ManagedCertificates_Delete (new)
Description :  Deletes the specified Managed Certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}
{
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 Managed Environment. ,
Required: True ,
}
string ,
managedCertificateName:
{
Description: Name of the Managed Certificate. ,
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 ,
}
,
}
ManagedCertificates_Update (new)
Description :  Patches a managed certificate. Oly patching of tags is supported
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}
{
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 Managed Environment. ,
Required: True ,
}
string ,
managedCertificateName:
{
Description: Name of the Managed Certificate. ,
Required: True ,
}
string ,
managedCertificateEnvelope:
{
Description: Properties of a managed 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. ,
}
,
Required: False ,
}
enum ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
error:
{
Description: Any error occurred during the certificate provision. ,
Required: False ,
}
string ,
domainControlValidation:
{
Description: Selected type of domain control validation for managed certificates. ,
Enum:
{
CNAME: No description available. ,
HTTP: No description available. ,
TXT: No description available. ,
}
,
Required: False ,
}
enum ,
validationToken:
{
Description: A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates. ,
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 ,
}
,
}
ManagedCertificates_List (new)
Description :  Get the Managed Certificates in a given managed environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates
{
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 Managed 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. ,
}
,
Required: False ,
}
enum ,
subjectName:
{
Description: Subject name of the certificate. ,
Required: False ,
}
string ,
error:
{
Description: Any error occurred during the certificate provision. ,
Required: False ,
}
string ,
domainControlValidation:
{
Description: Selected type of domain control validation for managed certificates. ,
Enum:
{
CNAME: No description available. ,
HTTP: No description available. ,
TXT: No description available. ,
}
,
Required: False ,
}
enum ,
validationToken:
{
Description: A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates. ,
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 ,
}
,
}
Namespaces_CheckNameAvailability (new)
Description :  Checks if resource name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
checkNameAvailabilityRequest:
{
Description: The check name 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 ,
}
,
}
ManagedEnvironments_GetAuthToken (new)
Description :  Checks if resource name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Environment 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 (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 ,
}
,
}
ManagedEnvironments_ListWorkloadProfileStates (new)
Description :  Get all workload Profile States for a Managed Environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/workloadProfileStates
{
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 ,
environmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
properties:
{
Description: Workload Profile resource specific properties. ,
Required: False ,
}
{
minimumCount:
{
Description: Minimum count of instances. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumCount:
{
Description: Maximum count of nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
currentCount:
{
Description: Current count of nodes. ,
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 ,
}
,
}
DaprComponents_List (new)
Description :  Get the Dapr Components for a managed environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
Description: Name of the Managed 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: Dapr Component resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Component type ,
Required: False ,
}
string ,
version:
{
Description: Component version ,
Required: False ,
}
string ,
ignoreErrors:
{
Description: Boolean describing if the component errors are ignores ,
Required: False ,
}
boolean ,
initTimeout:
{
Description: Initialization timeout ,
Required: False ,
}
string ,
secrets:
{
Description: Collection of secrets used by a Dapr component ,
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 ,
}
,
]
,
secretStoreComponent:
{
Description: Name of a Dapr component to retrieve component secrets from ,
Required: False ,
}
string ,
metadata:
{
Description: Component metadata ,
Required: False ,
}
[
{
name:
{
Description: Metadata property name. ,
Required: False ,
}
string ,
value:
{
Description: Metadata property value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Dapr Component secret from which to pull the metadata property value. ,
Required: False ,
}
string ,
}
,
]
,
scopes:
{
Description: Names of container apps that can use this Dapr component ,
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 ,
}
,
}
DaprComponents_Get (new)
Description :  Get a dapr component.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
Description: Name of the Managed 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 resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Component type ,
Required: False ,
}
string ,
version:
{
Description: Component version ,
Required: False ,
}
string ,
ignoreErrors:
{
Description: Boolean describing if the component errors are ignores ,
Required: False ,
}
boolean ,
initTimeout:
{
Description: Initialization timeout ,
Required: False ,
}
string ,
secrets:
{
Description: Collection of secrets used by a Dapr component ,
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 ,
}
,
]
,
secretStoreComponent:
{
Description: Name of a Dapr component to retrieve component secrets from ,
Required: False ,
}
string ,
metadata:
{
Description: Component metadata ,
Required: False ,
}
[
{
name:
{
Description: Metadata property name. ,
Required: False ,
}
string ,
value:
{
Description: Metadata property value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Dapr Component secret from which to pull the metadata property value. ,
Required: False ,
}
string ,
}
,
]
,
scopes:
{
Description: Names of container apps that can use this Dapr component ,
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 ,
}
,
}
DaprComponents_CreateOrUpdate (new)
Description :  Creates or updates a Dapr Component in a Managed Environment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
Description: Name of the Managed 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 resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Component type ,
Required: False ,
}
string ,
version:
{
Description: Component version ,
Required: False ,
}
string ,
ignoreErrors:
{
Description: Boolean describing if the component errors are ignores ,
Required: False ,
}
boolean ,
initTimeout:
{
Description: Initialization timeout ,
Required: False ,
}
string ,
secrets:
{
Description: Collection of secrets used by a Dapr component ,
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 ,
}
,
]
,
secretStoreComponent:
{
Description: Name of a Dapr component to retrieve component secrets from ,
Required: False ,
}
string ,
metadata:
{
Description: Component metadata ,
Required: False ,
}
[
{
name:
{
Description: Metadata property name. ,
Required: False ,
}
string ,
value:
{
Description: Metadata property value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Dapr Component secret from which to pull the metadata property value. ,
Required: False ,
}
string ,
}
,
]
,
scopes:
{
Description: Names of container apps that can use this Dapr component ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Dapr Component resource specific properties ,
Required: False ,
}
{
componentType:
{
Description: Component type ,
Required: False ,
}
string ,
version:
{
Description: Component version ,
Required: False ,
}
string ,
ignoreErrors:
{
Description: Boolean describing if the component errors are ignores ,
Required: False ,
}
boolean ,
initTimeout:
{
Description: Initialization timeout ,
Required: False ,
}
string ,
secrets:
{
Description: Collection of secrets used by a Dapr component ,
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 ,
}
,
]
,
secretStoreComponent:
{
Description: Name of a Dapr component to retrieve component secrets from ,
Required: False ,
}
string ,
metadata:
{
Description: Component metadata ,
Required: False ,
}
[
{
name:
{
Description: Metadata property name. ,
Required: False ,
}
string ,
value:
{
Description: Metadata property value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Dapr Component secret from which to pull the metadata property value. ,
Required: False ,
}
string ,
}
,
]
,
scopes:
{
Description: Names of container apps that can use this Dapr component ,
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 ,
}
,
}
DaprComponents_Delete (new)
Description :  Delete a Dapr Component from a Managed Environment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
Description: Name of the Managed 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)

{}

⚐ 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 ,
}
,
}
DaprComponents_ListSecrets (new)
Description :  List secrets for a dapr component
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
Description: Name of the Managed 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 ,
}
,
}
ManagedEnvironmentsStorages_List (new)
Description :  Get all storages for a managedEnvironment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
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 storage resources. ,
Required: True ,
}
[
{
properties:
{
Description: Storage properties ,
Required: False ,
}
{
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 ,
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 ,
}
,
nfsAzureFile:
{
Description: NFS Azure file properties ,
Required: False ,
}
{
server:
{
Description: Server for NFS azure file. Specify the Azure storage account server address. ,
Required: False ,
}
string ,
accessMode:
{
Description: Access mode for storage ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: NFS Azure file share name. ,
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 ,
}
,
}
ManagedEnvironmentsStorages_Get (new)
Description :  Get storage for a managedEnvironment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
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 ,
}
{
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 ,
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 ,
}
,
nfsAzureFile:
{
Description: NFS Azure file properties ,
Required: False ,
}
{
server:
{
Description: Server for NFS azure file. Specify the Azure storage account server address. ,
Required: False ,
}
string ,
accessMode:
{
Description: Access mode for storage ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: NFS Azure file share name. ,
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 ,
}
,
}
ManagedEnvironmentsStorages_CreateOrUpdate (new)
Description :  Create or update storage for a managedEnvironment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
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 ,
}
{
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 ,
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 ,
}
,
nfsAzureFile:
{
Description: NFS Azure file properties ,
Required: False ,
}
{
server:
{
Description: Server for NFS azure file. Specify the Azure storage account server address. ,
Required: False ,
}
string ,
accessMode:
{
Description: Access mode for storage ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: NFS Azure file share name. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Storage properties ,
Required: False ,
}
{
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 ,
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 ,
}
,
nfsAzureFile:
{
Description: NFS Azure file properties ,
Required: False ,
}
{
server:
{
Description: Server for NFS azure file. Specify the Azure storage account server address. ,
Required: False ,
}
string ,
accessMode:
{
Description: Access mode for storage ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: NFS Azure file share name. ,
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 ,
}
,
}
ManagedEnvironmentsStorages_Delete (new)
Description :  Delete storage for a managedEnvironment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/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 ,
environmentName:
{
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)

{}

⚐ 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 ,
}
,
}
ContainerAppsSessionPools_ListBySubscription (new)
Description :  Get the session pools in a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.App/sessionPools
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
}
[
{
identity:
{
Description: Managed identities needed by a session pool to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container App session pool resource specific properties ,
Required: False ,
}
{
environmentId:
{
Description: Resource ID of the session pool's environment. ,
Format: arm-id ,
Required: False ,
}
string ,
containerType:
{
Description: The container type of the sessions. ,
Enum:
{
CustomContainer: No description available. ,
PythonLTS: No description available. ,
}
,
Required: False ,
}
enum ,
poolManagementType:
{
Description: The pool management type of the session pool. ,
Enum:
{
Manual: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
nodeCount:
{
Description: The number of nodes the session pool is using. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleConfiguration:
{
Description: The scale configuration of the session pool. ,
Required: False ,
}
{
maxConcurrentSessions:
{
Description: The maximum count of sessions at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
readySessionInstances:
{
Description: The minimum count of ready session instances. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: The secrets of the session pool. ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
}
,
]
,
dynamicPoolConfiguration:
{
Description: The pool configuration if the poolManagementType is dynamic. ,
Required: False ,
}
{
lifecycleConfiguration:
{
Description: The lifecycle configuration of a session in the dynamic session pool ,
Required: False ,
}
{
lifecycleType:
{
Description: The lifecycle type of the session pool. ,
Enum:
{
Timed: No description available. ,
OnContainerExit: No description available. ,
}
,
Required: False ,
}
enum ,
cooldownPeriodInSeconds:
{
Description: The cooldown period of a session in seconds when the lifecycle type is 'Timed'. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAlivePeriodInSeconds:
{
Description: The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
customContainerTemplate:
{
Description: The custom container configuration if the containerType is CustomContainer. ,
Required: False ,
}
{
registryCredentials:
{
Description: Private container registry credentials for containers used by the sessions of the session pool. ,
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 ,
}
,
containers:
{
Description: List of container definitions for the sessions of the session pool. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
}
,
}
,
]
,
ingress:
{
Description: Session pool ingress configuration. ,
Required: False ,
}
{
targetPort:
{
Description: Target port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sessionNetworkConfiguration:
{
Description: The network configuration of the sessions in the session pool. ,
Required: False ,
}
{
status:
{
Description: Network status for the sessions. ,
Enum:
{
EgressEnabled: No description available. ,
EgressDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
poolManagementEndpoint:
{
Description: The endpoint to manage the pool. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the session pool. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentitySettings:
{
Description: Optional settings for a Managed Identity that is assigned to the Session pool. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available. ,
Enum:
{
None: No description available. ,
Main: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
ContainerAppsSessionPools_ListByResourceGroup (new)
Description :  Get the session pools in a given resource group of a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/sessionPools
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources. ,
Required: True ,
}
[
{
identity:
{
Description: Managed identities needed by a session pool to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container App session pool resource specific properties ,
Required: False ,
}
{
environmentId:
{
Description: Resource ID of the session pool's environment. ,
Format: arm-id ,
Required: False ,
}
string ,
containerType:
{
Description: The container type of the sessions. ,
Enum:
{
CustomContainer: No description available. ,
PythonLTS: No description available. ,
}
,
Required: False ,
}
enum ,
poolManagementType:
{
Description: The pool management type of the session pool. ,
Enum:
{
Manual: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
nodeCount:
{
Description: The number of nodes the session pool is using. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleConfiguration:
{
Description: The scale configuration of the session pool. ,
Required: False ,
}
{
maxConcurrentSessions:
{
Description: The maximum count of sessions at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
readySessionInstances:
{
Description: The minimum count of ready session instances. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: The secrets of the session pool. ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
}
,
]
,
dynamicPoolConfiguration:
{
Description: The pool configuration if the poolManagementType is dynamic. ,
Required: False ,
}
{
lifecycleConfiguration:
{
Description: The lifecycle configuration of a session in the dynamic session pool ,
Required: False ,
}
{
lifecycleType:
{
Description: The lifecycle type of the session pool. ,
Enum:
{
Timed: No description available. ,
OnContainerExit: No description available. ,
}
,
Required: False ,
}
enum ,
cooldownPeriodInSeconds:
{
Description: The cooldown period of a session in seconds when the lifecycle type is 'Timed'. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAlivePeriodInSeconds:
{
Description: The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
customContainerTemplate:
{
Description: The custom container configuration if the containerType is CustomContainer. ,
Required: False ,
}
{
registryCredentials:
{
Description: Private container registry credentials for containers used by the sessions of the session pool. ,
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 ,
}
,
containers:
{
Description: List of container definitions for the sessions of the session pool. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
}
,
}
,
]
,
ingress:
{
Description: Session pool ingress configuration. ,
Required: False ,
}
{
targetPort:
{
Description: Target port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sessionNetworkConfiguration:
{
Description: The network configuration of the sessions in the session pool. ,
Required: False ,
}
{
status:
{
Description: Network status for the sessions. ,
Enum:
{
EgressEnabled: No description available. ,
EgressDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
poolManagementEndpoint:
{
Description: The endpoint to manage the pool. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the session pool. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentitySettings:
{
Description: Optional settings for a Managed Identity that is assigned to the Session pool. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available. ,
Enum:
{
None: No description available. ,
Main: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
ContainerAppsSessionPools_Get (new)
Description :  Get the properties of a session pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/sessionPools/{sessionPoolName}
{
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 ,
sessionPoolName:
{
Description: Name of the session pool. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed identities needed by a session pool to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container App session pool resource specific properties ,
Required: False ,
}
{
environmentId:
{
Description: Resource ID of the session pool's environment. ,
Format: arm-id ,
Required: False ,
}
string ,
containerType:
{
Description: The container type of the sessions. ,
Enum:
{
CustomContainer: No description available. ,
PythonLTS: No description available. ,
}
,
Required: False ,
}
enum ,
poolManagementType:
{
Description: The pool management type of the session pool. ,
Enum:
{
Manual: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
nodeCount:
{
Description: The number of nodes the session pool is using. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleConfiguration:
{
Description: The scale configuration of the session pool. ,
Required: False ,
}
{
maxConcurrentSessions:
{
Description: The maximum count of sessions at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
readySessionInstances:
{
Description: The minimum count of ready session instances. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: The secrets of the session pool. ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
}
,
]
,
dynamicPoolConfiguration:
{
Description: The pool configuration if the poolManagementType is dynamic. ,
Required: False ,
}
{
lifecycleConfiguration:
{
Description: The lifecycle configuration of a session in the dynamic session pool ,
Required: False ,
}
{
lifecycleType:
{
Description: The lifecycle type of the session pool. ,
Enum:
{
Timed: No description available. ,
OnContainerExit: No description available. ,
}
,
Required: False ,
}
enum ,
cooldownPeriodInSeconds:
{
Description: The cooldown period of a session in seconds when the lifecycle type is 'Timed'. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAlivePeriodInSeconds:
{
Description: The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
customContainerTemplate:
{
Description: The custom container configuration if the containerType is CustomContainer. ,
Required: False ,
}
{
registryCredentials:
{
Description: Private container registry credentials for containers used by the sessions of the session pool. ,
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 ,
}
,
containers:
{
Description: List of container definitions for the sessions of the session pool. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
}
,
}
,
]
,
ingress:
{
Description: Session pool ingress configuration. ,
Required: False ,
}
{
targetPort:
{
Description: Target port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sessionNetworkConfiguration:
{
Description: The network configuration of the sessions in the session pool. ,
Required: False ,
}
{
status:
{
Description: Network status for the sessions. ,
Enum:
{
EgressEnabled: No description available. ,
EgressDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
poolManagementEndpoint:
{
Description: The endpoint to manage the pool. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the session pool. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentitySettings:
{
Description: Optional settings for a Managed Identity that is assigned to the Session pool. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available. ,
Enum:
{
None: No description available. ,
Main: 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 ,
}
,
]
,
}
,
}
ContainerAppsSessionPools_CreateOrUpdate (new)
Description :  Create or update a session pool with the given properties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/sessionPools/{sessionPoolName}
{
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 ,
sessionPoolName:
{
Description: Name of the session pool. ,
Required: True ,
}
string ,
sessionPoolEnvelope:
{
Description: Properties used to create a session pool ,
Required: True ,
}
{
identity:
{
Description: Managed identities needed by a session pool to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container App session pool resource specific properties ,
Required: False ,
}
{
environmentId:
{
Description: Resource ID of the session pool's environment. ,
Format: arm-id ,
Required: False ,
}
string ,
containerType:
{
Description: The container type of the sessions. ,
Enum:
{
CustomContainer: No description available. ,
PythonLTS: No description available. ,
}
,
Required: False ,
}
enum ,
poolManagementType:
{
Description: The pool management type of the session pool. ,
Enum:
{
Manual: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
nodeCount:
{
Description: The number of nodes the session pool is using. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleConfiguration:
{
Description: The scale configuration of the session pool. ,
Required: False ,
}
{
maxConcurrentSessions:
{
Description: The maximum count of sessions at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
readySessionInstances:
{
Description: The minimum count of ready session instances. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: The secrets of the session pool. ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
}
,
]
,
dynamicPoolConfiguration:
{
Description: The pool configuration if the poolManagementType is dynamic. ,
Required: False ,
}
{
lifecycleConfiguration:
{
Description: The lifecycle configuration of a session in the dynamic session pool ,
Required: False ,
}
{
lifecycleType:
{
Description: The lifecycle type of the session pool. ,
Enum:
{
Timed: No description available. ,
OnContainerExit: No description available. ,
}
,
Required: False ,
}
enum ,
cooldownPeriodInSeconds:
{
Description: The cooldown period of a session in seconds when the lifecycle type is 'Timed'. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAlivePeriodInSeconds:
{
Description: The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
customContainerTemplate:
{
Description: The custom container configuration if the containerType is CustomContainer. ,
Required: False ,
}
{
registryCredentials:
{
Description: Private container registry credentials for containers used by the sessions of the session pool. ,
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 ,
}
,
containers:
{
Description: List of container definitions for the sessions of the session pool. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
}
,
}
,
]
,
ingress:
{
Description: Session pool ingress configuration. ,
Required: False ,
}
{
targetPort:
{
Description: Target port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sessionNetworkConfiguration:
{
Description: The network configuration of the sessions in the session pool. ,
Required: False ,
}
{
status:
{
Description: Network status for the sessions. ,
Enum:
{
EgressEnabled: No description available. ,
EgressDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
poolManagementEndpoint:
{
Description: The endpoint to manage the pool. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the session pool. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentitySettings:
{
Description: Optional settings for a Managed Identity that is assigned to the Session pool. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available. ,
Enum:
{
None: No description available. ,
Main: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed identities needed by a session pool to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container App session pool resource specific properties ,
Required: False ,
}
{
environmentId:
{
Description: Resource ID of the session pool's environment. ,
Format: arm-id ,
Required: False ,
}
string ,
containerType:
{
Description: The container type of the sessions. ,
Enum:
{
CustomContainer: No description available. ,
PythonLTS: No description available. ,
}
,
Required: False ,
}
enum ,
poolManagementType:
{
Description: The pool management type of the session pool. ,
Enum:
{
Manual: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
nodeCount:
{
Description: The number of nodes the session pool is using. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleConfiguration:
{
Description: The scale configuration of the session pool. ,
Required: False ,
}
{
maxConcurrentSessions:
{
Description: The maximum count of sessions at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
readySessionInstances:
{
Description: The minimum count of ready session instances. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: The secrets of the session pool. ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
}
,
]
,
dynamicPoolConfiguration:
{
Description: The pool configuration if the poolManagementType is dynamic. ,
Required: False ,
}
{
lifecycleConfiguration:
{
Description: The lifecycle configuration of a session in the dynamic session pool ,
Required: False ,
}
{
lifecycleType:
{
Description: The lifecycle type of the session pool. ,
Enum:
{
Timed: No description available. ,
OnContainerExit: No description available. ,
}
,
Required: False ,
}
enum ,
cooldownPeriodInSeconds:
{
Description: The cooldown period of a session in seconds when the lifecycle type is 'Timed'. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAlivePeriodInSeconds:
{
Description: The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
customContainerTemplate:
{
Description: The custom container configuration if the containerType is CustomContainer. ,
Required: False ,
}
{
registryCredentials:
{
Description: Private container registry credentials for containers used by the sessions of the session pool. ,
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 ,
}
,
containers:
{
Description: List of container definitions for the sessions of the session pool. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
}
,
}
,
]
,
ingress:
{
Description: Session pool ingress configuration. ,
Required: False ,
}
{
targetPort:
{
Description: Target port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sessionNetworkConfiguration:
{
Description: The network configuration of the sessions in the session pool. ,
Required: False ,
}
{
status:
{
Description: Network status for the sessions. ,
Enum:
{
EgressEnabled: No description available. ,
EgressDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
poolManagementEndpoint:
{
Description: The endpoint to manage the pool. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the session pool. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentitySettings:
{
Description: Optional settings for a Managed Identity that is assigned to the Session pool. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available. ,
Enum:
{
None: No description available. ,
Main: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Managed identities needed by a session pool to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container App session pool resource specific properties ,
Required: False ,
}
{
environmentId:
{
Description: Resource ID of the session pool's environment. ,
Format: arm-id ,
Required: False ,
}
string ,
containerType:
{
Description: The container type of the sessions. ,
Enum:
{
CustomContainer: No description available. ,
PythonLTS: No description available. ,
}
,
Required: False ,
}
enum ,
poolManagementType:
{
Description: The pool management type of the session pool. ,
Enum:
{
Manual: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
nodeCount:
{
Description: The number of nodes the session pool is using. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleConfiguration:
{
Description: The scale configuration of the session pool. ,
Required: False ,
}
{
maxConcurrentSessions:
{
Description: The maximum count of sessions at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
readySessionInstances:
{
Description: The minimum count of ready session instances. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: The secrets of the session pool. ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
}
,
]
,
dynamicPoolConfiguration:
{
Description: The pool configuration if the poolManagementType is dynamic. ,
Required: False ,
}
{
lifecycleConfiguration:
{
Description: The lifecycle configuration of a session in the dynamic session pool ,
Required: False ,
}
{
lifecycleType:
{
Description: The lifecycle type of the session pool. ,
Enum:
{
Timed: No description available. ,
OnContainerExit: No description available. ,
}
,
Required: False ,
}
enum ,
cooldownPeriodInSeconds:
{
Description: The cooldown period of a session in seconds when the lifecycle type is 'Timed'. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAlivePeriodInSeconds:
{
Description: The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
customContainerTemplate:
{
Description: The custom container configuration if the containerType is CustomContainer. ,
Required: False ,
}
{
registryCredentials:
{
Description: Private container registry credentials for containers used by the sessions of the session pool. ,
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 ,
}
,
containers:
{
Description: List of container definitions for the sessions of the session pool. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
}
,
}
,
]
,
ingress:
{
Description: Session pool ingress configuration. ,
Required: False ,
}
{
targetPort:
{
Description: Target port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sessionNetworkConfiguration:
{
Description: The network configuration of the sessions in the session pool. ,
Required: False ,
}
{
status:
{
Description: Network status for the sessions. ,
Enum:
{
EgressEnabled: No description available. ,
EgressDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
poolManagementEndpoint:
{
Description: The endpoint to manage the pool. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the session pool. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentitySettings:
{
Description: Optional settings for a Managed Identity that is assigned to the Session pool. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available. ,
Enum:
{
None: No description available. ,
Main: 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 ,
}
,
]
,
}
,
}
ContainerAppsSessionPools_Update (new)
Description :  Patches a session pool using JSON merge patch
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/sessionPools/{sessionPoolName}
{
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 ,
sessionPoolName:
{
Description: Name of the session pool. ,
Required: True ,
}
string ,
sessionPoolEnvelope:
{
Description: Properties used to create a session pool ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Managed identities needed by a session pool to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Session pool resource specific updatable properties. ,
Required: False ,
}
{
scaleConfiguration:
{
Description: The scale configuration of the session pool. ,
Required: False ,
}
{
maxConcurrentSessions:
{
Description: The maximum count of sessions at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
readySessionInstances:
{
Description: The minimum count of ready session instances. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: The secrets of the session pool. ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
}
,
]
,
dynamicPoolConfiguration:
{
Description: The pool configuration if the poolManagementType is dynamic. ,
Required: False ,
}
{
lifecycleConfiguration:
{
Description: The lifecycle configuration of a session in the dynamic session pool ,
Required: False ,
}
{
lifecycleType:
{
Description: The lifecycle type of the session pool. ,
Enum:
{
Timed: No description available. ,
OnContainerExit: No description available. ,
}
,
Required: False ,
}
enum ,
cooldownPeriodInSeconds:
{
Description: The cooldown period of a session in seconds when the lifecycle type is 'Timed'. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAlivePeriodInSeconds:
{
Description: The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
customContainerTemplate:
{
Description: The custom container configuration if the containerType is CustomContainer. ,
Required: False ,
}
{
registryCredentials:
{
Description: Private container registry credentials for containers used by the sessions of the session pool. ,
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 ,
}
,
containers:
{
Description: List of container definitions for the sessions of the session pool. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
}
,
}
,
]
,
ingress:
{
Description: Session pool ingress configuration. ,
Required: False ,
}
{
targetPort:
{
Description: Target port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sessionNetworkConfiguration:
{
Description: The network configuration of the sessions in the session pool. ,
Required: False ,
}
{
status:
{
Description: Network status for the sessions. ,
Enum:
{
EgressEnabled: No description available. ,
EgressDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed identities needed by a session pool to interact with other Azure services to not maintain 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 ,
}
,
properties:
{
Description: Container App session pool resource specific properties ,
Required: False ,
}
{
environmentId:
{
Description: Resource ID of the session pool's environment. ,
Format: arm-id ,
Required: False ,
}
string ,
containerType:
{
Description: The container type of the sessions. ,
Enum:
{
CustomContainer: No description available. ,
PythonLTS: No description available. ,
}
,
Required: False ,
}
enum ,
poolManagementType:
{
Description: The pool management type of the session pool. ,
Enum:
{
Manual: No description available. ,
Dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
nodeCount:
{
Description: The number of nodes the session pool is using. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleConfiguration:
{
Description: The scale configuration of the session pool. ,
Required: False ,
}
{
maxConcurrentSessions:
{
Description: The maximum count of sessions at the same time. ,
Format: int32 ,
Required: False ,
}
integer ,
readySessionInstances:
{
Description: The minimum count of ready session instances. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: The secrets of the session pool. ,
Required: False ,
}
[
{
name:
{
Description: Secret Name. ,
Required: False ,
}
string ,
value:
{
Description: Secret Value. ,
Required: False ,
}
string ,
}
,
]
,
dynamicPoolConfiguration:
{
Description: The pool configuration if the poolManagementType is dynamic. ,
Required: False ,
}
{
lifecycleConfiguration:
{
Description: The lifecycle configuration of a session in the dynamic session pool ,
Required: False ,
}
{
lifecycleType:
{
Description: The lifecycle type of the session pool. ,
Enum:
{
Timed: No description available. ,
OnContainerExit: No description available. ,
}
,
Required: False ,
}
enum ,
cooldownPeriodInSeconds:
{
Description: The cooldown period of a session in seconds when the lifecycle type is 'Timed'. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAlivePeriodInSeconds:
{
Description: The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
customContainerTemplate:
{
Description: The custom container configuration if the containerType is CustomContainer. ,
Required: False ,
}
{
registryCredentials:
{
Description: Private container registry credentials for containers used by the sessions of the session pool. ,
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 ,
}
,
containers:
{
Description: List of container definitions for the sessions of the session pool. ,
Required: False ,
}
[
{
image:
{
Description: Container image tag. ,
Required: False ,
}
string ,
name:
{
Description: Custom container name. ,
Required: False ,
}
string ,
command:
{
Description: Container start command. ,
Required: False ,
}
[
string ,
]
,
args:
{
Description: Container start command arguments. ,
Required: False ,
}
[
string ,
]
,
env:
{
Description: Container environment variables. ,
Required: False ,
}
[
{
name:
{
Description: Environment variable name. ,
Required: False ,
}
string ,
value:
{
Description: Non-secret environment variable value. ,
Required: False ,
}
string ,
secretRef:
{
Description: Name of the Container App secret from which to pull the environment variable value. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Container resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "250Mb" ,
Required: False ,
}
string ,
}
,
}
,
]
,
ingress:
{
Description: Session pool ingress configuration. ,
Required: False ,
}
{
targetPort:
{
Description: Target port in containers for traffic from ingress ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sessionNetworkConfiguration:
{
Description: The network configuration of the sessions in the session pool. ,
Required: False ,
}
{
status:
{
Description: Network status for the sessions. ,
Enum:
{
EgressEnabled: No description available. ,
EgressDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
poolManagementEndpoint:
{
Description: The endpoint to manage the pool. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the session pool. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
managedIdentitySettings:
{
Description: Optional settings for a Managed Identity that is assigned to the Session pool. ,
Required: False ,
}
[
{
identity:
{
Description: The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or 'system' for system-assigned identity. ,
Required: True ,
}
string ,
lifecycle:
{
Description: Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available. ,
Enum:
{
None: No description available. ,
Main: 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 ,
}
,
]
,
}
,
}
ContainerAppsSessionPools_Delete (new)
Description :  Delete the session pool with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/sessionPools/{sessionPoolName}
{
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 ,
sessionPoolName:
{
Description: Name of the session pool. ,
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 ,
}
,
]
,
}
,
}
ContainerAppsSourceControls_ListByContainerApp (new)
Description :  Get the Container App SourceControls in a given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols
{
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: SourceControl resource specific properties ,
Required: False ,
}
{
operationState:
{
Description: Current provisioning State of the operation ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
repoUrl:
{
Description: The repo url which will be integrated to ContainerApp. ,
Required: False ,
}
string ,
branch:
{
Description: The branch which will trigger the auto deployment ,
Required: False ,
}
string ,
githubActionConfiguration:
{
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 ,
}
{
registryInfo:
{
Description: Registry configurations. ,
Required: False ,
}
{
registryUrl:
{
Description: registry server Url. ,
Required: False ,
}
string ,
registryUserName:
{
Description: registry username. ,
Required: False ,
}
string ,
registryPassword:
{
Description: registry secret. ,
Required: False ,
}
string ,
}
,
azureCredentials:
{
Description: AzureCredentials configurations. ,
Required: False ,
}
{
clientId:
{
Description: Client Id. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of auth github does for deploying the template ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
contextPath:
{
Description: Context path ,
Required: False ,
}
string ,
githubPersonalAccessToken:
{
Description: One time Github PAT to configure github environment ,
Required: False ,
}
string ,
image:
{
Description: Image name ,
Required: False ,
}
string ,
publishType:
{
Description: Code or Image ,
Required: False ,
}
string ,
os:
{
Description: Operation system ,
Required: False ,
}
string ,
runtimeStack:
{
Description: Runtime stack ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version ,
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 ,
}
,
}
ContainerAppsSourceControls_Get (new)
Description :  Get a SourceControl of a Container App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{sourceControlName}
{
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 ,
sourceControlName:
{
Description: Name of the Container App SourceControl. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SourceControl resource specific properties ,
Required: False ,
}
{
operationState:
{
Description: Current provisioning State of the operation ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
repoUrl:
{
Description: The repo url which will be integrated to ContainerApp. ,
Required: False ,
}
string ,
branch:
{
Description: The branch which will trigger the auto deployment ,
Required: False ,
}
string ,
githubActionConfiguration:
{
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 ,
}
{
registryInfo:
{
Description: Registry configurations. ,
Required: False ,
}
{
registryUrl:
{
Description: registry server Url. ,
Required: False ,
}
string ,
registryUserName:
{
Description: registry username. ,
Required: False ,
}
string ,
registryPassword:
{
Description: registry secret. ,
Required: False ,
}
string ,
}
,
azureCredentials:
{
Description: AzureCredentials configurations. ,
Required: False ,
}
{
clientId:
{
Description: Client Id. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of auth github does for deploying the template ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
contextPath:
{
Description: Context path ,
Required: False ,
}
string ,
githubPersonalAccessToken:
{
Description: One time Github PAT to configure github environment ,
Required: False ,
}
string ,
image:
{
Description: Image name ,
Required: False ,
}
string ,
publishType:
{
Description: Code or Image ,
Required: False ,
}
string ,
os:
{
Description: Operation system ,
Required: False ,
}
string ,
runtimeStack:
{
Description: Runtime stack ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version ,
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 ,
}
,
}
ContainerAppsSourceControls_CreateOrUpdate (new)
Description :  Create or update the SourceControl for a Container App.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{sourceControlName}
{
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 ,
sourceControlName:
{
Description: Name of the Container App SourceControl. ,
Required: True ,
}
string ,
sourceControlEnvelope:
{
Description: Properties used to create a Container App SourceControl ,
Required: True ,
}
{
properties:
{
Description: SourceControl resource specific properties ,
Required: False ,
}
{
operationState:
{
Description: Current provisioning State of the operation ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
repoUrl:
{
Description: The repo url which will be integrated to ContainerApp. ,
Required: False ,
}
string ,
branch:
{
Description: The branch which will trigger the auto deployment ,
Required: False ,
}
string ,
githubActionConfiguration:
{
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 ,
}
{
registryInfo:
{
Description: Registry configurations. ,
Required: False ,
}
{
registryUrl:
{
Description: registry server Url. ,
Required: False ,
}
string ,
registryUserName:
{
Description: registry username. ,
Required: False ,
}
string ,
registryPassword:
{
Description: registry secret. ,
Required: False ,
}
string ,
}
,
azureCredentials:
{
Description: AzureCredentials configurations. ,
Required: False ,
}
{
clientId:
{
Description: Client Id. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of auth github does for deploying the template ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
contextPath:
{
Description: Context path ,
Required: False ,
}
string ,
githubPersonalAccessToken:
{
Description: One time Github PAT to configure github environment ,
Required: False ,
}
string ,
image:
{
Description: Image name ,
Required: False ,
}
string ,
publishType:
{
Description: Code or Image ,
Required: False ,
}
string ,
os:
{
Description: Operation system ,
Required: False ,
}
string ,
runtimeStack:
{
Description: Runtime stack ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SourceControl resource specific properties ,
Required: False ,
}
{
operationState:
{
Description: Current provisioning State of the operation ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
repoUrl:
{
Description: The repo url which will be integrated to ContainerApp. ,
Required: False ,
}
string ,
branch:
{
Description: The branch which will trigger the auto deployment ,
Required: False ,
}
string ,
githubActionConfiguration:
{
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 ,
}
{
registryInfo:
{
Description: Registry configurations. ,
Required: False ,
}
{
registryUrl:
{
Description: registry server Url. ,
Required: False ,
}
string ,
registryUserName:
{
Description: registry username. ,
Required: False ,
}
string ,
registryPassword:
{
Description: registry secret. ,
Required: False ,
}
string ,
}
,
azureCredentials:
{
Description: AzureCredentials configurations. ,
Required: False ,
}
{
clientId:
{
Description: Client Id. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of auth github does for deploying the template ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
contextPath:
{
Description: Context path ,
Required: False ,
}
string ,
githubPersonalAccessToken:
{
Description: One time Github PAT to configure github environment ,
Required: False ,
}
string ,
image:
{
Description: Image name ,
Required: False ,
}
string ,
publishType:
{
Description: Code or Image ,
Required: False ,
}
string ,
os:
{
Description: Operation system ,
Required: False ,
}
string ,
runtimeStack:
{
Description: Runtime stack ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: SourceControl resource specific properties ,
Required: False ,
}
{
operationState:
{
Description: Current provisioning State of the operation ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
repoUrl:
{
Description: The repo url which will be integrated to ContainerApp. ,
Required: False ,
}
string ,
branch:
{
Description: The branch which will trigger the auto deployment ,
Required: False ,
}
string ,
githubActionConfiguration:
{
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 ,
}
{
registryInfo:
{
Description: Registry configurations. ,
Required: False ,
}
{
registryUrl:
{
Description: registry server Url. ,
Required: False ,
}
string ,
registryUserName:
{
Description: registry username. ,
Required: False ,
}
string ,
registryPassword:
{
Description: registry secret. ,
Required: False ,
}
string ,
}
,
azureCredentials:
{
Description: AzureCredentials configurations. ,
Required: False ,
}
{
clientId:
{
Description: Client Id. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of auth github does for deploying the template ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
contextPath:
{
Description: Context path ,
Required: False ,
}
string ,
githubPersonalAccessToken:
{
Description: One time Github PAT to configure github environment ,
Required: False ,
}
string ,
image:
{
Description: Image name ,
Required: False ,
}
string ,
publishType:
{
Description: Code or Image ,
Required: False ,
}
string ,
os:
{
Description: Operation system ,
Required: False ,
}
string ,
runtimeStack:
{
Description: Runtime stack ,
Required: False ,
}
string ,
runtimeVersion:
{
Description: Runtime version ,
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 ,
}
,
}
ContainerAppsSourceControls_Delete (new)
Description :  Delete a Container App SourceControl.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{sourceControlName}
{
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 ,
sourceControlName:
{
Description: Name of the Container App SourceControl. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
,
}
GetCustomDomainVerificationId (new)
Description :  Get the verification id of a subscription used for verifying custom domains
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
$schema:
{
Description: Custom domain verification Id of a subscription ,
}
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 ,
}
,
}
Usages_List (new)
Description :  Gets, for the specified location, the current resource usage information as well as the limits under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/usages
{
location:
{
Description: The location for which resource usage is queried. ,
Required: True ,
}
string ,
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: The list of compute resource usages. ,
Required: False ,
}
[
{
unit:
{
Description: An enum describing the unit of usage measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: True ,
}
enum ,
currentValue:
{
Description: The current usage of the resource. ,
Format: float ,
Required: True ,
}
number ,
limit:
{
Description: The maximum permitted usage of the resource. ,
Format: float ,
Required: True ,
}
number ,
name:
{
Description: The name of the type of usage. ,
Required: True ,
}
{
value:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized name of the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information. ,
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 ,
}
,
}
ManagedEnvironmentUsages_List (new)
Description :  Gets the current usage information as well as the limits for environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/usages
{
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: The list of compute resource usages. ,
Required: False ,
}
[
{
unit:
{
Description: An enum describing the unit of usage measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: True ,
}
enum ,
currentValue:
{
Description: The current usage of the resource. ,
Format: float ,
Required: True ,
}
number ,
limit:
{
Description: The maximum permitted usage of the resource. ,
Format: float ,
Required: True ,
}
number ,
name:
{
Description: The name of the type of usage. ,
Required: True ,
}
{
value:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized name of the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information. ,
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 ,
}
,
}