Microsoft.App (preview:2022-01-01)

2025/09/05 • 43 new, 43 deleted 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 ,
}
,
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 ,
}
,
}
,
}
,
}
,
]
,
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/{name}
{
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 ,
name:
{
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 ,
}
,
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 ,
}
,
}
,
}
,
}

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

⚐ 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/{name}
{
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 ,
name:
{
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 ,
}
,
}
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 ,
}
[
{
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 ,
}
,
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 ,
managedEnvironmentId:
{
Description: Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
latestRevisionName:
{
Description: Name of the latest 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 ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode ,
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 ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: 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 ,
}
,
]
,
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. ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for 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 ,
}
[
{
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 ,
}
,
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 ,
managedEnvironmentId:
{
Description: Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
latestRevisionName:
{
Description: Name of the latest 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 ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode ,
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 ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: 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 ,
}
,
]
,
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. ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for 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/{name}
{
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 ,
name:
{
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)

{
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 ,
}
,
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 ,
managedEnvironmentId:
{
Description: Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
latestRevisionName:
{
Description: Name of the latest 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 ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode ,
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 ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: 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 ,
}
,
]
,
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. ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for 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/{name}
{
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 ,
name:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
containerAppEnvelope:
{
Description: Properties used to create a container app ,
Required: True ,
}
{
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 ,
}
,
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 ,
managedEnvironmentId:
{
Description: Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
latestRevisionName:
{
Description: Name of the latest 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 ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode ,
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 ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: 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 ,
}
,
]
,
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. ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
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 ,
managedEnvironmentId:
{
Description: Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
latestRevisionName:
{
Description: Name of the latest 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 ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode ,
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 ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: 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 ,
}
,
]
,
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. ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
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 ,
}
,
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 ,
managedEnvironmentId:
{
Description: Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
latestRevisionName:
{
Description: Name of the latest 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 ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode ,
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 ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: 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 ,
}
,
]
,
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. ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for 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/{name}
{
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 ,
name:
{
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)

{}

⚐ 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. Currently only patching of tags is supported
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{name}
{
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 ,
name:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
containerAppEnvelope:
{
Description: Properties of a container app 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)

{
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 ,
}
,
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 ,
managedEnvironmentId:
{
Description: Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
latestRevisionName:
{
Description: Name of the latest 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 ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode ,
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 ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: 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 ,
}
,
]
,
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. ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for 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_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/{name}/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 ,
name:
{
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 ,
}
,
]
,
}

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

⚐ 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 ,
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 ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
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 ,
}
,
}
,
]
,
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/{name}
{
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 ,
name:
{
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 ,
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 ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
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 ,
}
,
}

⚐ 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/{name}/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 ,
name:
{
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/{name}/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 ,
name:
{
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/{name}
{
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 ,
name:
{
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 ,
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 ,
}
,
]
,
}
,
}

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

⚐ 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/{name}/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 ,
name:
{
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 ,
}
,
}
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 ,
}
,
]
,
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/{name}
{
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 ,
name:
{
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 ,
}
,
]
,
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/{name}
{
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 ,
name:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
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/{name}
{
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 ,
name:
{
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 ,
}
,
}
Operations_List (new)
Description :  Lists all of the available RP operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.App/operations
{
api-version:
{
Description: API Version ,
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 ,
}
,
}
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 ,
}
[
{
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 ,
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 runtimeSubnetId and infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
runtimeSubnetId:
{
Description: This field is deprecated and not used. If you wish to provide your own subnet that Container App containers are injected into, then you should leverage the infrastructureSubnetId. ,
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 ,
}
,
}
,
}
,
}
,
]
,
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 ,
}
[
{
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 ,
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 runtimeSubnetId and infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
runtimeSubnetId:
{
Description: This field is deprecated and not used. If you wish to provide your own subnet that Container App containers are injected into, then you should leverage the infrastructureSubnetId. ,
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 ,
}
,
}
,
}
,
}
,
]
,
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/{name}
{
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 ,
name:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
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 runtimeSubnetId and infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
runtimeSubnetId:
{
Description: This field is deprecated and not used. If you wish to provide your own subnet that Container App containers are injected into, then you should leverage the infrastructureSubnetId. ,
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 ,
}
,
}
,
}
,
}

⚐ 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/{name}
{
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 ,
name:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
environmentEnvelope:
{
Description: Configuration details of the Environment. ,
Required: True ,
}
{
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 ,
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 runtimeSubnetId and infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
runtimeSubnetId:
{
Description: This field is deprecated and not used. If you wish to provide your own subnet that Container App containers are injected into, then you should leverage the infrastructureSubnetId. ,
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 ,
}
,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
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 runtimeSubnetId and infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
runtimeSubnetId:
{
Description: This field is deprecated and not used. If you wish to provide your own subnet that Container App containers are injected into, then you should leverage the infrastructureSubnetId. ,
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 ,
}
,
}
,
}
,
}

⚐ Response (201)

{
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 ,
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 runtimeSubnetId and infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
runtimeSubnetId:
{
Description: This field is deprecated and not used. If you wish to provide your own subnet that Container App containers are injected into, then you should leverage the infrastructureSubnetId. ,
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 ,
}
,
}
,
}
,
}

⚐ 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/{name}
{
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 ,
name:
{
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. Only patching of tags is supported currently
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{name}
{
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 ,
name:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
environmentEnvelope:
{
Description: Configuration details of the Environment. ,
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: 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 ,
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 runtimeSubnetId and infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
runtimeSubnetId:
{
Description: This field is deprecated and not used. If you wish to provide your own subnet that Container App containers are injected into, then you should leverage the infrastructureSubnetId. ,
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 ,
}
,
}
,
}
,
}

⚐ 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/{managedEnvironmentName}/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 ,
managedEnvironmentName:
{
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 ,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
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/{managedEnvironmentName}/certificates/{name}
{
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 ,
managedEnvironmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
name:
{
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 ,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
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/{managedEnvironmentName}/certificates/{name}
{
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 ,
managedEnvironmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
name:
{
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 ,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
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 ,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
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/{managedEnvironmentName}/certificates/{name}
{
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 ,
managedEnvironmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
name:
{
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/{managedEnvironmentName}/certificates/{name}
{
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 ,
managedEnvironmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
name:
{
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 ,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
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 ,
}
,
}
ManagedEnvironmentsStorages_List (new)
Description :  Get all storages for a managedEnvironment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{envName}/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 ,
envName:
{
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 ,
}
,
}
ManagedEnvironmentsStorages_Get (new)
Description :  Get storage for a managedEnvironment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{envName}/storages/{name}
{
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 ,
envName:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
name:
{
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 ,
}
,
}
ManagedEnvironmentsStorages_CreateOrUpdate (new)
Description :  Create or update storage for a managedEnvironment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{envName}/storages/{name}
{
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 ,
envName:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
name:
{
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 ,
}
,
}
ManagedEnvironmentsStorages_Delete (new)
Description :  Delete storage for a managedEnvironment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{envName}/storages/{name}
{
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 ,
envName:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
name:
{
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 ,
}
,
}
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 ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
dockerfilePath:
{
Description: Docker file path ,
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/{name}
{
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 ,
name:
{
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 ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
dockerfilePath:
{
Description: Docker file path ,
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/{name}
{
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 ,
name:
{
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 ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
dockerfilePath:
{
Description: Docker file path ,
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 ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
dockerfilePath:
{
Description: Docker file path ,
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 ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
dockerfilePath:
{
Description: Docker file path ,
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/{name}
{
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 ,
name:
{
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 ,
}
,
}
ContainerAppsAuthConfigs_ListByContainerApp (removed)
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 ,
}
,
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 ,
}
,
}
,
}
,
}
,
]
,
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 (removed)
Description :  Get a AuthConfig of a Container App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{name}
{
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 ,
name:
{
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 ,
}
,
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 ,
}
,
}
,
}
,
}

⚐ 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 (removed)
Description :  Create or update the AuthConfig for a Container App.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{name}
{
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 ,
name:
{
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 ,
}
,
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 ,
}
,
}
,
}
,
}
,
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 ,
}
,
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 ,
}
,
}
,
}
,
}

⚐ 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 (removed)
Description :  Delete a Container App AuthConfig.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{name}
{
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 ,
name:
{
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 ,
}
,
}
ContainerApps_ListBySubscription (removed)
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 ,
}
[
{
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 ,
}
,
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 ,
managedEnvironmentId:
{
Description: Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
latestRevisionName:
{
Description: Name of the latest 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 ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode ,
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 ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: 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 ,
}
,
]
,
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. ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for 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 (removed)
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 ,
}
[
{
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 ,
}
,
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 ,
managedEnvironmentId:
{
Description: Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
latestRevisionName:
{
Description: Name of the latest 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 ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode ,
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 ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: 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 ,
}
,
]
,
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. ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for 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 (removed)
Description :  Get the properties of a Container App.
Reference :  Link ¶

⚼ Request

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

{
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 ,
}
,
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 ,
managedEnvironmentId:
{
Description: Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
latestRevisionName:
{
Description: Name of the latest 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 ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode ,
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 ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: 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 ,
}
,
]
,
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. ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for 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 (removed)
Description :  Create or update a Container App.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{name}
{
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 ,
name:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
containerAppEnvelope:
{
Description: Properties used to create a container app ,
Required: True ,
}
{
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 ,
}
,
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 ,
managedEnvironmentId:
{
Description: Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
latestRevisionName:
{
Description: Name of the latest 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 ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode ,
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 ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: 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 ,
}
,
]
,
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. ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
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 ,
managedEnvironmentId:
{
Description: Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
latestRevisionName:
{
Description: Name of the latest 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 ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode ,
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 ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: 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 ,
}
,
]
,
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. ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for container app. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
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 ,
}
,
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 ,
managedEnvironmentId:
{
Description: Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
latestRevisionName:
{
Description: Name of the latest 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 ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode ,
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 ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: 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 ,
}
,
]
,
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. ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for 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 (removed)
Description :  Delete a Container App.
Reference :  Link ¶

⚼ Request

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

{}

⚐ 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 (removed)
Description :  Patches a Container App. Currently only patching of tags is supported
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{name}
{
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 ,
name:
{
Description: Name of the Container App. ,
Required: True ,
}
string ,
containerAppEnvelope:
{
Description: Properties of a container app 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)

{
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 ,
}
,
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 ,
managedEnvironmentId:
{
Description: Resource ID of the Container App's environment. ,
Required: False ,
}
string ,
latestRevisionName:
{
Description: Name of the latest 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 ,
}
,
]
,
activeRevisionsMode:
{
Description: ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode ,
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 ,
transport:
{
Description: Ingress transport protocol ,
Enum:
{
auto: No description available. ,
http: No description available. ,
http2: 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 ,
}
,
]
,
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. ,
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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
template:
{
Description: Container App versioned application definition. ,
Required: False ,
}
{
revisionSuffix:
{
Description: User friendly suffix that is appended to the revision name ,
Required: False ,
}
string ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
Required: False ,
}
string ,
}
,
]
,
}
,
outboundIpAddresses:
{
Description: Outbound IP Addresses for 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_ListCustomHostNameAnalysis (removed)
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 (removed)
Description :  List secrets for a container app
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{name}/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 ,
name:
{
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 ,
}
,
]
,
}

⚐ 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 (removed)
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 ,
}

⚐ 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 ,
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 ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
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 ,
}
,
}
,
]
,
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 (removed)
Description :  Get a revision of a Container App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{name}
{
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 ,
name:
{
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 ,
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 ,
containers:
{
Description: List of container definitions for the Container App. ,
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 ,
}
,
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 ,
}
,
]
,
volumeMounts:
{
Description: Container volume mounts. ,
Required: False ,
}
[
{
volumeName:
{
Description: This must match the Name of a Volume. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path within the container at which the volume should be mounted.Must not contain ':'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
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 ,
rules:
{
Description: Scaling rules. ,
Required: False ,
}
[
{
name:
{
Description: Scale Rule Name ,
Required: False ,
}
string ,
azureQueue:
{
Description: Azure Queue based scaling. ,
Required: False ,
}
{
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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 Container App secret from which to pull the auth params. ,
Required: False ,
}
string ,
triggerParameter:
{
Description: Trigger Parameter that uses the secret ,
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. ,
}
,
Required: False ,
}
enum ,
storageName:
{
Description: Name of storage resource. No need to provide for EmptyDir. ,
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 ,
}
,
}

⚐ 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 (removed)
Description :  Activates a revision for a Container App
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{name}/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 ,
name:
{
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 (removed)
Description :  Deactivates a revision for a Container App
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{name}/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 ,
name:
{
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 (removed)
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/{name}
{
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 ,
name:
{
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 ,
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 ,
}
,
]
,
}
,
}

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

⚐ 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 (removed)
Description :  Restarts a revision for a Container App
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{name}/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 ,
name:
{
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 ,
}
,
}
DaprComponents_List (removed)
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 ,
}
,
]
,
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 (removed)
Description :  Get a dapr component.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{name}
{
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 ,
name:
{
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 ,
}
,
]
,
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 (removed)
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/{name}
{
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 ,
name:
{
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 ,
}
,
]
,
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 ,
}
,
]
,
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 (removed)
Description :  Delete a Dapr Component from a Managed Environment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{name}
{
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 ,
name:
{
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 ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available RP operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.App/operations
{
api-version:
{
Description: API Version ,
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 ,
}
,
}
ManagedEnvironments_ListBySubscription (removed)
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 ,
}
[
{
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 ,
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 runtimeSubnetId and infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
runtimeSubnetId:
{
Description: This field is deprecated and not used. If you wish to provide your own subnet that Container App containers are injected into, then you should leverage the infrastructureSubnetId. ,
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 ,
}
,
}
,
}
,
}
,
]
,
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 (removed)
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 ,
}
[
{
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 ,
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 runtimeSubnetId and infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
runtimeSubnetId:
{
Description: This field is deprecated and not used. If you wish to provide your own subnet that Container App containers are injected into, then you should leverage the infrastructureSubnetId. ,
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 ,
}
,
}
,
}
,
}
,
]
,
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 (removed)
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/{name}
{
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 ,
name:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
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 runtimeSubnetId and infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
runtimeSubnetId:
{
Description: This field is deprecated and not used. If you wish to provide your own subnet that Container App containers are injected into, then you should leverage the infrastructureSubnetId. ,
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 ,
}
,
}
,
}
,
}

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{name}
{
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 ,
name:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
environmentEnvelope:
{
Description: Configuration details of the Environment. ,
Required: True ,
}
{
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 ,
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 runtimeSubnetId and infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
runtimeSubnetId:
{
Description: This field is deprecated and not used. If you wish to provide your own subnet that Container App containers are injected into, then you should leverage the infrastructureSubnetId. ,
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 ,
}
,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
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 runtimeSubnetId and infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
runtimeSubnetId:
{
Description: This field is deprecated and not used. If you wish to provide your own subnet that Container App containers are injected into, then you should leverage the infrastructureSubnetId. ,
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 ,
}
,
}
,
}
,
}

⚐ Response (201)

{
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 ,
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 runtimeSubnetId and infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
runtimeSubnetId:
{
Description: This field is deprecated and not used. If you wish to provide your own subnet that Container App containers are injected into, then you should leverage the infrastructureSubnetId. ,
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 ,
}
,
}
,
}
,
}

⚐ 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 (removed)
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/{name}
{
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 ,
name:
{
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 (removed)
Description :  Patches a Managed Environment. Only patching of tags is supported currently
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{name}
{
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 ,
name:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
environmentEnvelope:
{
Description: Configuration details of the Environment. ,
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: 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 ,
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 runtimeSubnetId and infrastructureSubnetId if enabling this property ,
Required: False ,
}
boolean ,
infrastructureSubnetId:
{
Description: Resource ID of a subnet for infrastructure components. This subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must not overlap with any other provided IP ranges. ,
Required: False ,
}
string ,
runtimeSubnetId:
{
Description: This field is deprecated and not used. If you wish to provide your own subnet that Container App containers are injected into, then you should leverage the infrastructureSubnetId. ,
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 ,
}
,
}
,
}
,
}

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}/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 ,
managedEnvironmentName:
{
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 ,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
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 (removed)
Description :  Get the specified Certificate.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}/certificates/{name}
{
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 ,
managedEnvironmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
name:
{
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 ,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
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 (removed)
Description :  Create or Update a Certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}/certificates/{name}
{
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 ,
managedEnvironmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
name:
{
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 ,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
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 ,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
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 (removed)
Description :  Deletes the specified Certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}/certificates/{name}
{
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 ,
managedEnvironmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
name:
{
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 (removed)
Description :  Patches a certificate. Currently only patching of tags is supported
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}/certificates/{name}
{
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 ,
managedEnvironmentName:
{
Description: Name of the Managed Environment. ,
Required: True ,
}
string ,
name:
{
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 ,
password:
{
Description: Certificate password. ,
Required: False ,
}
string ,
subjectName:
{
Description: Subject name of the certificate. ,
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 ,
}
,
}
ManagedEnvironmentsStorages_List (removed)
Description :  Get all storages for a managedEnvironment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{envName}/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 ,
envName:
{
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 ,
}
,
}
ManagedEnvironmentsStorages_Get (removed)
Description :  Get storage for a managedEnvironment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{envName}/storages/{name}
{
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 ,
envName:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
name:
{
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 ,
}
,
}
ManagedEnvironmentsStorages_CreateOrUpdate (removed)
Description :  Create or update storage for a managedEnvironment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{envName}/storages/{name}
{
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 ,
envName:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
name:
{
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 ,
}
,
}
ManagedEnvironmentsStorages_Delete (removed)
Description :  Delete storage for a managedEnvironment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{envName}/storages/{name}
{
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 ,
envName:
{
Description: Name of the Environment. ,
Required: True ,
}
string ,
name:
{
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 ,
}
,
}
ContainerAppsSourceControls_ListByContainerApp (removed)
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 ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
dockerfilePath:
{
Description: Docker file path ,
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 (removed)
Description :  Get a SourceControl of a Container App.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{name}
{
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 ,
name:
{
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 ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
dockerfilePath:
{
Description: Docker file path ,
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 (removed)
Description :  Create or update the SourceControl for a Container App.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{name}
{
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 ,
name:
{
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 ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
dockerfilePath:
{
Description: Docker file path ,
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 ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
dockerfilePath:
{
Description: Docker file path ,
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 ,
subscriptionId:
{
Description: Subscription Id. ,
Required: False ,
}
string ,
}
,
dockerfilePath:
{
Description: Docker file path ,
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 (removed)
Description :  Delete a Container App SourceControl.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{name}
{
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 ,
name:
{
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 ,
}
,
}