app.azure.com/v1api20240301
app.azure.com/v1api20240301
Package v1api20240301 contains API Schema definitions for the app v1api20240301 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2024-03-01" |
AllowedAudiencesValidation
(Appears on:Google)
The configuration settings of the Allowed Audiences validation flow.
Field | Description |
---|---|
allowedAudiences []string |
AllowedAudiences: The configuration settings of the allowed list of audiences from which to validate the JWT token. |
AllowedAudiencesValidation_STATUS
(Appears on:Google_STATUS)
The configuration settings of the Allowed Audiences validation flow.
Field | Description |
---|---|
allowedAudiences []string |
AllowedAudiences: The configuration settings of the allowed list of audiences from which to validate the JWT token. |
AllowedPrincipals
(Appears on:DefaultAuthorizationPolicy)
The configuration settings of the Azure Active Directory allowed principals.
Field | Description |
---|---|
groups []string |
Groups: The list of the allowed groups. |
identities []string |
Identities: The list of the allowed identities. |
AllowedPrincipals_STATUS
(Appears on:DefaultAuthorizationPolicy_STATUS)
The configuration settings of the Azure Active Directory allowed principals.
Field | Description |
---|---|
groups []string |
Groups: The list of the allowed groups. |
identities []string |
Identities: The list of the allowed identities. |
AppLogsConfiguration
(Appears on:ManagedEnvironment_Spec)
Configuration of application logs
Field | Description |
---|---|
destination string |
Destination: Logs destination, can be ‘log-analytics’, ‘azure-monitor’ or ‘none’ |
logAnalyticsConfiguration LogAnalyticsConfiguration |
LogAnalyticsConfiguration: Log Analytics configuration, must only be provided when destination is configured as ‘log-analytics’ |
AppLogsConfiguration_STATUS
(Appears on:ManagedEnvironment_STATUS)
Configuration of application logs
Field | Description |
---|---|
destination string |
Destination: Logs destination, can be ‘log-analytics’, ‘azure-monitor’ or ‘none’ |
logAnalyticsConfiguration LogAnalyticsConfiguration_STATUS |
LogAnalyticsConfiguration: Log Analytics configuration, must only be provided when destination is configured as ‘log-analytics’ |
AppRegistration
(Appears on:Facebook)
The configuration settings of the app registration for providers that have app ids and app secrets
Field | Description |
---|---|
appId string |
AppId: The App ID of the app used for login. |
appSecretSettingName string |
AppSecretSettingName: The app setting name that contains the app secret. |
AppRegistration_STATUS
(Appears on:Facebook_STATUS)
The configuration settings of the app registration for providers that have app ids and app secrets
Field | Description |
---|---|
appId string |
AppId: The App ID of the app used for login. |
appSecretSettingName string |
AppSecretSettingName: The app setting name that contains the app secret. |
Apple
(Appears on:IdentityProviders)
The configuration settings of the Apple provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
login LoginScopes |
Login: The configuration settings of the login flow. |
registration AppleRegistration |
Registration: The configuration settings of the Apple registration. |
AppleRegistration
(Appears on:Apple)
The configuration settings of the registration for the Apple provider
Field | Description |
---|---|
clientId string |
ClientId: The Client ID of the app used for login. |
clientSecretSettingName string |
ClientSecretSettingName: The app setting name that contains the client secret. |
AppleRegistration_STATUS
(Appears on:Apple_STATUS)
The configuration settings of the registration for the Apple provider
Field | Description |
---|---|
clientId string |
ClientId: The Client ID of the app used for login. |
clientSecretSettingName string |
ClientSecretSettingName: The app setting name that contains the client secret. |
Apple_STATUS
(Appears on:IdentityProviders_STATUS)
The configuration settings of the Apple provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
login LoginScopes_STATUS |
Login: The configuration settings of the login flow. |
registration AppleRegistration_STATUS |
Registration: The configuration settings of the Apple registration. |
AuthConfig
Generator information: - Generated from: /app/resource-manager/Microsoft.App/stable/2024-03-01/AuthConfigs.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{authConfigName}p>
Field | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||
spec AuthConfig_Spec |
|
||||||||||||||||||
status AuthConfig_STATUS |
AuthConfigOperatorSpec
(Appears on:AuthConfig_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
AuthConfig_STATUS
(Appears on:AuthConfig)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
encryptionSettings EncryptionSettings_STATUS |
EncryptionSettings: The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization. |
globalValidation GlobalValidation_STATUS |
GlobalValidation: The configuration settings that determines the validation flow of users using Service Authentication/Authorization. |
httpSettings HttpSettings_STATUS |
HttpSettings: The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
identityProviders IdentityProviders_STATUS |
IdentityProviders: The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. |
login Login_STATUS |
Login: The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. |
name string |
Name: The name of the resource |
platform AuthPlatform_STATUS |
Platform: The configuration settings of the platform of ContainerApp Service Authentication/Authorization. |
systemData SystemData_STATUS |
SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
AuthConfig_Spec
(Appears on:AuthConfig)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
encryptionSettings EncryptionSettings |
EncryptionSettings: The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization. |
globalValidation GlobalValidation |
GlobalValidation: The configuration settings that determines the validation flow of users using Service Authentication/Authorization. |
httpSettings HttpSettings |
HttpSettings: The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. |
identityProviders IdentityProviders |
IdentityProviders: The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. |
login Login |
Login: The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. |
operatorSpec AuthConfigOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a app.azure.com/ContainerApp resource |
platform AuthPlatform |
Platform: The configuration settings of the platform of ContainerApp Service Authentication/Authorization. |
AuthPlatform
(Appears on:AuthConfig_Spec)
The configuration settings of the platform of ContainerApp Service Authentication/Authorization.
Field | Description |
---|---|
enabled bool |
Enabled: |
runtimeVersion string |
RuntimeVersion: 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. |
AuthPlatform_STATUS
(Appears on:AuthConfig_STATUS)
The configuration settings of the platform of ContainerApp Service Authentication/Authorization.
Field | Description |
---|---|
enabled bool |
Enabled: |
runtimeVersion string |
RuntimeVersion: 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. |
AzureActiveDirectory
(Appears on:IdentityProviders)
The configuration settings of the Azure Active directory provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
isAutoProvisioned bool |
IsAutoProvisioned: 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. |
login AzureActiveDirectoryLogin |
Login: The configuration settings of the Azure Active Directory login flow. |
registration AzureActiveDirectoryRegistration |
Registration: The configuration settings of the Azure Active Directory app registration. |
validation AzureActiveDirectoryValidation |
Validation: The configuration settings of the Azure Active Directory token validation flow. |
AzureActiveDirectoryLogin
(Appears on:AzureActiveDirectory)
The configuration settings of the Azure Active Directory login flow.
Field | Description |
---|---|
disableWWWAuthenticate bool |
DisableWWWAuthenticate: |
loginParameters []string |
LoginParameters: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”. |
AzureActiveDirectoryLogin_STATUS
(Appears on:AzureActiveDirectory_STATUS)
The configuration settings of the Azure Active Directory login flow.
Field | Description |
---|---|
disableWWWAuthenticate bool |
DisableWWWAuthenticate: |
loginParameters []string |
LoginParameters: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”. |
AzureActiveDirectoryRegistration
(Appears on:AzureActiveDirectory)
The configuration settings of the Azure Active Directory app registration.
Field | Description |
---|---|
clientId string |
ClientId: 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 |
clientSecretCertificateIssuer string |
ClientSecretCertificateIssuer: 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. |
clientSecretCertificateSubjectAlternativeName string |
ClientSecretCertificateSubjectAlternativeName: 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. |
clientSecretCertificateThumbprint string |
ClientSecretCertificateThumbprint: 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. |
clientSecretSettingName string |
ClientSecretSettingName: The app setting name that contains the client secret of the relying party application. |
openIdIssuer string |
OpenIdIssuer: 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 |
AzureActiveDirectoryRegistration_STATUS
(Appears on:AzureActiveDirectory_STATUS)
The configuration settings of the Azure Active Directory app registration.
Field | Description |
---|---|
clientId string |
ClientId: 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 |
clientSecretCertificateIssuer string |
ClientSecretCertificateIssuer: 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. |
clientSecretCertificateSubjectAlternativeName string |
ClientSecretCertificateSubjectAlternativeName: 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. |
clientSecretCertificateThumbprint string |
ClientSecretCertificateThumbprint: 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. |
clientSecretSettingName string |
ClientSecretSettingName: The app setting name that contains the client secret of the relying party application. |
openIdIssuer string |
OpenIdIssuer: 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 |
AzureActiveDirectoryValidation
(Appears on:AzureActiveDirectory)
The configuration settings of the Azure Active Directory token validation flow.
Field | Description |
---|---|
allowedAudiences []string |
AllowedAudiences: The list of audiences that can make successful authentication/authorization requests. |
defaultAuthorizationPolicy DefaultAuthorizationPolicy |
DefaultAuthorizationPolicy: The configuration settings of the default authorization policy. |
jwtClaimChecks JwtClaimChecks |
JwtClaimChecks: The configuration settings of the checks that should be made while validating the JWT Claims. |
AzureActiveDirectoryValidation_STATUS
(Appears on:AzureActiveDirectory_STATUS)
The configuration settings of the Azure Active Directory token validation flow.
Field | Description |
---|---|
allowedAudiences []string |
AllowedAudiences: The list of audiences that can make successful authentication/authorization requests. |
defaultAuthorizationPolicy DefaultAuthorizationPolicy_STATUS |
DefaultAuthorizationPolicy: The configuration settings of the default authorization policy. |
jwtClaimChecks JwtClaimChecks_STATUS |
JwtClaimChecks: The configuration settings of the checks that should be made while validating the JWT Claims. |
AzureActiveDirectory_STATUS
(Appears on:IdentityProviders_STATUS)
The configuration settings of the Azure Active directory provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
isAutoProvisioned bool |
IsAutoProvisioned: 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. |
login AzureActiveDirectoryLogin_STATUS |
Login: The configuration settings of the Azure Active Directory login flow. |
registration AzureActiveDirectoryRegistration_STATUS |
Registration: The configuration settings of the Azure Active Directory app registration. |
validation AzureActiveDirectoryValidation_STATUS |
Validation: The configuration settings of the Azure Active Directory token validation flow. |
AzureStaticWebApps
(Appears on:IdentityProviders)
The configuration settings of the Azure Static Web Apps provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
registration AzureStaticWebAppsRegistration |
Registration: The configuration settings of the Azure Static Web Apps registration. |
AzureStaticWebAppsRegistration
(Appears on:AzureStaticWebApps)
The configuration settings of the registration for the Azure Static Web Apps provider
Field | Description |
---|---|
clientId string |
ClientId: The Client ID of the app used for login. |
AzureStaticWebAppsRegistration_STATUS
(Appears on:AzureStaticWebApps_STATUS)
The configuration settings of the registration for the Azure Static Web Apps provider
Field | Description |
---|---|
clientId string |
ClientId: The Client ID of the app used for login. |
AzureStaticWebApps_STATUS
(Appears on:IdentityProviders_STATUS)
The configuration settings of the Azure Static Web Apps provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
registration AzureStaticWebAppsRegistration_STATUS |
Registration: The configuration settings of the Azure Static Web Apps registration. |
BaseContainer
(Appears on:JobTemplate, Template)
Container App base container definition.
Field | Description |
---|---|
args []string |
Args: Container start command arguments. |
command []string |
Command: Container start command. |
env []EnvironmentVar |
Env: Container environment variables. |
image string |
Image: Container image tag. |
name string |
Name: Custom container name. |
resources ContainerResources |
Resources: Container resource requirements. |
volumeMounts []VolumeMount |
VolumeMounts: Container volume mounts. |
BaseContainer_STATUS
(Appears on:JobTemplate_STATUS, Template_STATUS)
Container App base container definition.
Field | Description |
---|---|
args []string |
Args: Container start command arguments. |
command []string |
Command: Container start command. |
env []EnvironmentVar_STATUS |
Env: Container environment variables. |
image string |
Image: Container image tag. |
name string |
Name: Custom container name. |
resources ContainerResources_STATUS |
Resources: Container resource requirements. |
volumeMounts []VolumeMount_STATUS |
VolumeMounts: Container volume mounts. |
BlobStorageTokenStore
(Appears on:TokenStore)
The configuration settings of the storage of the tokens if blob storage is used.
Field | Description |
---|---|
sasUrlSettingName string |
SasUrlSettingName: The name of the app secrets containing the SAS URL of the blob storage containing the tokens. |
BlobStorageTokenStore_STATUS
(Appears on:TokenStore_STATUS)
The configuration settings of the storage of the tokens if blob storage is used.
Field | Description |
---|---|
sasUrlSettingName string |
SasUrlSettingName: The name of the app secrets containing the SAS URL of the blob storage containing the tokens. |
ClientRegistration
The configuration settings of the app registration for providers that have client ids and client secrets
Field | Description |
---|---|
clientId string |
ClientId: The Client ID of the app used for login. |
clientSecretSettingName string |
ClientSecretSettingName: The app setting name that contains the client secret. |
ClientRegistration_STATUS
(Appears on:GitHub_STATUS, Google_STATUS)
The configuration settings of the app registration for providers that have client ids and client secrets
Field | Description |
---|---|
clientId string |
ClientId: The Client ID of the app used for login. |
clientSecretSettingName string |
ClientSecretSettingName: The app setting name that contains the client secret. |
Configuration
(Appears on:ContainerApp_Spec)
Non versioned Container App configuration properties that define the mutable settings of a Container app
Field | Description |
---|---|
activeRevisionsMode Configuration_ActiveRevisionsMode |
ActiveRevisionsMode: ActiveRevisionsMode controls how active revisions are handled for the Container app:
|
dapr Dapr |
Dapr: Dapr configuration for the Container App. |
ingress Ingress |
Ingress: Ingress configurations. |
maxInactiveRevisions int |
MaxInactiveRevisions: Optional. Max inactive revisions a Container App can have. |
registries []RegistryCredentials |
Registries: Collection of private container registry credentials for containers used by the Container app |
secrets []Secret |
Secrets: Collection of secrets used by a Container app |
service Service |
Service: Container App to be a dev Container App Service |
Configuration_ActiveRevisionsMode
(string
alias)
(Appears on:Configuration)
Value | Description |
---|---|
"Multiple" |
|
"Single" |
Configuration_ActiveRevisionsMode_STATUS
(string
alias)
(Appears on:Configuration_STATUS)
Value | Description |
---|---|
"Multiple" |
|
"Single" |
Configuration_STATUS
(Appears on:ContainerApp_STATUS)
Non versioned Container App configuration properties that define the mutable settings of a Container app
Field | Description |
---|---|
activeRevisionsMode Configuration_ActiveRevisionsMode_STATUS |
ActiveRevisionsMode: ActiveRevisionsMode controls how active revisions are handled for the Container app:
|
dapr Dapr_STATUS |
Dapr: Dapr configuration for the Container App. |
ingress Ingress_STATUS |
Ingress: Ingress configurations. |
maxInactiveRevisions int |
MaxInactiveRevisions: Optional. Max inactive revisions a Container App can have. |
registries []RegistryCredentials_STATUS |
Registries: Collection of private container registry credentials for containers used by the Container app |
secrets []Secret_STATUS |
Secrets: Collection of secrets used by a Container app |
service Service_STATUS |
Service: Container App to be a dev Container App Service |
Container
(Appears on:JobTemplate, Template)
Container App container definition
Field | Description |
---|---|
args []string |
Args: Container start command arguments. |
command []string |
Command: Container start command. |
env []EnvironmentVar |
Env: Container environment variables. |
image string |
Image: Container image tag. |
name string |
Name: Custom container name. |
probes []ContainerAppProbe |
Probes: List of probes for the container. |
resources ContainerResources |
Resources: Container resource requirements. |
volumeMounts []VolumeMount |
VolumeMounts: Container volume mounts. |
ContainerApp
Generator information: - Generated from: /app/resource-manager/Microsoft.App/stable/2024-03-01/ContainerApps.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}p>
Field | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||
spec ContainerApp_Spec |
|
||||||||||||||||||||||||||
status ContainerApp_STATUS |
ContainerAppOperatorConfigMaps
(Appears on:ContainerAppOperatorSpec)
Field | Description |
---|---|
eventStreamEndpoint genruntime.ConfigMapDestination |
EventStreamEndpoint: indicates where the EventStreamEndpoint config map should be placed. If omitted, no config map will be created. |
fqdn genruntime.ConfigMapDestination |
Fqdn: indicates where the Fqdn config map should be placed. If omitted, no config map will be created. |
ContainerAppOperatorSpec
(Appears on:ContainerApp_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
configMaps ContainerAppOperatorConfigMaps |
ConfigMaps: configures where to place operator written ConfigMaps. |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
ContainerAppProbe
(Appears on:Container)
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
Field | Description |
---|---|
failureThreshold int |
FailureThreshold: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10. |
httpGet ContainerAppProbe_HttpGet |
HttpGet: HTTPGet specifies the http request to perform. |
initialDelaySeconds int |
InitialDelaySeconds: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. |
periodSeconds int |
PeriodSeconds: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. |
successThreshold int |
SuccessThreshold: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10. |
tcpSocket ContainerAppProbe_TcpSocket |
TcpSocket: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. |
terminationGracePeriodSeconds int |
TerminationGracePeriodSeconds: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour) |
timeoutSeconds int |
TimeoutSeconds: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. |
type ContainerAppProbe_Type |
Type: The type of probe. |
ContainerAppProbe_HttpGet
(Appears on:ContainerAppProbe)
Field | Description |
---|---|
host string |
Host: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead. |
httpHeaders []ContainerAppProbe_HttpGet_HttpHeaders |
HttpHeaders: Custom headers to set in the request. HTTP allows repeated headers. |
path string |
Path: Path to access on the HTTP server. |
port int |
Port: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
scheme ContainerAppProbe_HttpGet_Scheme |
Scheme: Scheme to use for connecting to the host. Defaults to HTTP. |
ContainerAppProbe_HttpGet_HttpHeaders
(Appears on:ContainerAppProbe_HttpGet)
Field | Description |
---|---|
name string |
Name: The header field name |
value string |
Value: The header field value |
ContainerAppProbe_HttpGet_HttpHeaders_STATUS
(Appears on:ContainerAppProbe_HttpGet_STATUS)
Field | Description |
---|---|
name string |
Name: The header field name |
value string |
Value: The header field value |
ContainerAppProbe_HttpGet_STATUS
(Appears on:ContainerAppProbe_STATUS)
Field | Description |
---|---|
host string |
Host: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead. |
httpHeaders []ContainerAppProbe_HttpGet_HttpHeaders_STATUS |
HttpHeaders: Custom headers to set in the request. HTTP allows repeated headers. |
path string |
Path: Path to access on the HTTP server. |
port int |
Port: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
scheme ContainerAppProbe_HttpGet_Scheme_STATUS |
Scheme: Scheme to use for connecting to the host. Defaults to HTTP. |
ContainerAppProbe_HttpGet_Scheme
(string
alias)
(Appears on:ContainerAppProbe_HttpGet)
Value | Description |
---|---|
"HTTP" |
|
"HTTPS" |
ContainerAppProbe_HttpGet_Scheme_STATUS
(string
alias)
(Appears on:ContainerAppProbe_HttpGet_STATUS)
Value | Description |
---|---|
"HTTP" |
|
"HTTPS" |
ContainerAppProbe_STATUS
(Appears on:Container_STATUS)
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
Field | Description |
---|---|
failureThreshold int |
FailureThreshold: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10. |
httpGet ContainerAppProbe_HttpGet_STATUS |
HttpGet: HTTPGet specifies the http request to perform. |
initialDelaySeconds int |
InitialDelaySeconds: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. |
periodSeconds int |
PeriodSeconds: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. |
successThreshold int |
SuccessThreshold: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10. |
tcpSocket ContainerAppProbe_TcpSocket_STATUS |
TcpSocket: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. |
terminationGracePeriodSeconds int |
TerminationGracePeriodSeconds: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour) |
timeoutSeconds int |
TimeoutSeconds: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. |
type ContainerAppProbe_Type_STATUS |
Type: The type of probe. |
ContainerAppProbe_TcpSocket
(Appears on:ContainerAppProbe)
Field | Description |
---|---|
host string |
Host: Optional: Host name to connect to, defaults to the pod IP. |
port int |
Port: 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. |
ContainerAppProbe_TcpSocket_STATUS
(Appears on:ContainerAppProbe_STATUS)
Field | Description |
---|---|
host string |
Host: Optional: Host name to connect to, defaults to the pod IP. |
port int |
Port: 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. |
ContainerAppProbe_Type
(string
alias)
(Appears on:ContainerAppProbe)
Value | Description |
---|---|
"Liveness" |
|
"Readiness" |
|
"Startup" |
ContainerAppProbe_Type_STATUS
(string
alias)
(Appears on:ContainerAppProbe_STATUS)
Value | Description |
---|---|
"Liveness" |
|
"Readiness" |
|
"Startup" |
ContainerApp_Properties_ProvisioningState_STATUS
(string
alias)
(Appears on:ContainerApp_STATUS)
Value | Description |
---|---|
"Canceled" |
|
"Deleting" |
|
"Failed" |
|
"InProgress" |
|
"Succeeded" |
ContainerApp_STATUS
(Appears on:ContainerApp)
Container App.
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
configuration Configuration_STATUS |
Configuration: Non versioned Container App configuration properties. |
customDomainVerificationId string |
CustomDomainVerificationId: Id used to verify domain name ownership |
environmentId string |
EnvironmentId: Resource ID of environment. |
eventStreamEndpoint string |
EventStreamEndpoint: The endpoint of the eventstream of the container app. |
extendedLocation ExtendedLocation_STATUS |
ExtendedLocation: The complex type of the extended location. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
identity ManagedServiceIdentity_STATUS |
Identity: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. |
latestReadyRevisionName string |
LatestReadyRevisionName: Name of the latest ready revision of the Container App. |
latestRevisionFqdn string |
LatestRevisionFqdn: Fully Qualified Domain Name of the latest revision of the Container App. |
latestRevisionName string |
LatestRevisionName: Name of the latest revision of the Container App. |
location string |
Location: The geo-location where the resource lives |
managedBy string |
ManagedBy: The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. |
managedEnvironmentId string |
ManagedEnvironmentId: Deprecated. Resource ID of the Container App’s environment. |
name string |
Name: The name of the resource |
outboundIpAddresses []string |
OutboundIpAddresses: Outbound IP Addresses for container app. |
provisioningState ContainerApp_Properties_ProvisioningState_STATUS |
ProvisioningState: Provisioning state of the Container App. |
systemData SystemData_STATUS |
SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. |
tags map[string]string |
Tags: Resource tags. |
template Template_STATUS |
Template: Container App versioned application definition. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
workloadProfileName string |
WorkloadProfileName: Workload profile name to pin for container app execution. |
ContainerApp_Spec
(Appears on:ContainerApp)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
configuration Configuration |
Configuration: Non versioned Container App configuration properties. |
environmentReference genruntime.ResourceReference |
EnvironmentReference: Resource ID of environment. |
extendedLocation ExtendedLocation |
ExtendedLocation: The complex type of the extended location. |
identity ManagedServiceIdentity |
Identity: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. |
location string |
Location: The geo-location where the resource lives |
managedByReference genruntime.ResourceReference |
ManagedByReference: The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. |
managedEnvironmentReference genruntime.ResourceReference |
ManagedEnvironmentReference: Deprecated. Resource ID of the Container App’s environment. |
operatorSpec ContainerAppOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
tags map[string]string |
Tags: Resource tags. |
template Template |
Template: Container App versioned application definition. |
workloadProfileName string |
WorkloadProfileName: Workload profile name to pin for container app execution. |
ContainerResources
(Appears on:BaseContainer, Container)
Container App container resource requirements.
Field | Description |
---|---|
cpu float64 |
Cpu: Required CPU in cores, e.g. 0.5 |
memory string |
Memory: Required memory, e.g. “250Mb” |
ContainerResources_STATUS
(Appears on:BaseContainer_STATUS, Container_STATUS)
Container App container resource requirements.
Field | Description |
---|---|
cpu float64 |
Cpu: Required CPU in cores, e.g. 0.5 |
ephemeralStorage string |
EphemeralStorage: Ephemeral Storage, e.g. “1Gi” |
memory string |
Memory: Required memory, e.g. “250Mb” |
Container_STATUS
(Appears on:JobTemplate_STATUS, Template_STATUS)
Container App container definition
Field | Description |
---|---|
args []string |
Args: Container start command arguments. |
command []string |
Command: Container start command. |
env []EnvironmentVar_STATUS |
Env: Container environment variables. |
image string |
Image: Container image tag. |
name string |
Name: Custom container name. |
probes []ContainerAppProbe_STATUS |
Probes: List of probes for the container. |
resources ContainerResources_STATUS |
Resources: Container resource requirements. |
volumeMounts []VolumeMount_STATUS |
VolumeMounts: Container volume mounts. |
CookieExpiration
(Appears on:Login)
The configuration settings of the session cookie’s expiration.
Field | Description |
---|---|
convention CookieExpiration_Convention |
Convention: The convention used when determining the session cookie’s expiration. |
timeToExpiration string |
TimeToExpiration: The time after the request is made when the session cookie should expire. |
CookieExpiration_Convention
(string
alias)
(Appears on:CookieExpiration)
Value | Description |
---|---|
"FixedTime" |
|
"IdentityProviderDerived" |
CookieExpiration_Convention_STATUS
(string
alias)
(Appears on:CookieExpiration_STATUS)
Value | Description |
---|---|
"FixedTime" |
|
"IdentityProviderDerived" |
CookieExpiration_STATUS
(Appears on:Login_STATUS)
The configuration settings of the session cookie’s expiration.
Field | Description |
---|---|
convention CookieExpiration_Convention_STATUS |
Convention: The convention used when determining the session cookie’s expiration. |
timeToExpiration string |
TimeToExpiration: The time after the request is made when the session cookie should expire. |
CorsPolicy
(Appears on:Ingress)
Cross-Origin-Resource-Sharing policy
Field | Description |
---|---|
allowCredentials bool |
AllowCredentials: Specifies whether the resource allows credentials |
allowedHeaders []string |
AllowedHeaders: Specifies the content for the access-control-allow-headers header |
allowedMethods []string |
AllowedMethods: Specifies the content for the access-control-allow-methods header |
allowedOrigins []string |
AllowedOrigins: Specifies the content for the access-control-allow-origins header |
exposeHeaders []string |
ExposeHeaders: Specifies the content for the access-control-expose-headers header |
maxAge int |
MaxAge: Specifies the content for the access-control-max-age header |
CorsPolicy_STATUS
(Appears on:Ingress_STATUS)
Cross-Origin-Resource-Sharing policy
Field | Description |
---|---|
allowCredentials bool |
AllowCredentials: Specifies whether the resource allows credentials |
allowedHeaders []string |
AllowedHeaders: Specifies the content for the access-control-allow-headers header |
allowedMethods []string |
AllowedMethods: Specifies the content for the access-control-allow-methods header |
allowedOrigins []string |
AllowedOrigins: Specifies the content for the access-control-allow-origins header |
exposeHeaders []string |
ExposeHeaders: Specifies the content for the access-control-expose-headers header |
maxAge int |
MaxAge: Specifies the content for the access-control-max-age header |
CustomDomain
(Appears on:Ingress)
Custom Domain of a Container App
Field | Description |
---|---|
bindingType CustomDomain_BindingType |
BindingType: Custom Domain binding type. |
certificateReference genruntime.ResourceReference |
CertificateReference: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. |
name string |
Name: Hostname. |
CustomDomainConfiguration
(Appears on:ManagedEnvironment_Spec)
Configuration properties for apps environment custom domain
Field | Description |
---|---|
certificatePassword genruntime.SecretReference |
CertificatePassword: Certificate password |
certificateValue genruntime.SecretReference |
CertificateValue: PFX or PEM blob |
dnsSuffix string |
DnsSuffix: Dns suffix for the environment domain |
CustomDomainConfiguration_STATUS
(Appears on:ManagedEnvironment_STATUS)
Configuration properties for apps environment custom domain
Field | Description |
---|---|
customDomainVerificationId string |
CustomDomainVerificationId: Id used to verify domain name ownership |
dnsSuffix string |
DnsSuffix: Dns suffix for the environment domain |
expirationDate string |
ExpirationDate: Certificate expiration date. |
subjectName string |
SubjectName: Subject name of the certificate. |
thumbprint string |
Thumbprint: Certificate thumbprint. |
CustomDomain_BindingType
(string
alias)
(Appears on:CustomDomain)
Value | Description |
---|---|
"Disabled" |
|
"SniEnabled" |
CustomDomain_BindingType_STATUS
(string
alias)
(Appears on:CustomDomain_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"SniEnabled" |
CustomDomain_STATUS
(Appears on:Ingress_STATUS)
Custom Domain of a Container App
Field | Description |
---|---|
bindingType CustomDomain_BindingType_STATUS |
BindingType: Custom Domain binding type. |
certificateId string |
CertificateId: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. |
name string |
Name: Hostname. |
CustomOpenIdConnectProvider
(Appears on:IdentityProviders)
The configuration settings of the custom Open ID Connect provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
login OpenIdConnectLogin |
Login: The configuration settings of the login flow of the custom Open ID Connect provider. |
registration OpenIdConnectRegistration |
Registration: The configuration settings of the app registration for the custom Open ID Connect provider. |
CustomOpenIdConnectProvider_STATUS
(Appears on:IdentityProviders_STATUS)
The configuration settings of the custom Open ID Connect provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
login OpenIdConnectLogin_STATUS |
Login: The configuration settings of the login flow of the custom Open ID Connect provider. |
registration OpenIdConnectRegistration_STATUS |
Registration: The configuration settings of the app registration for the custom Open ID Connect provider. |
CustomScaleRule
(Appears on:ScaleRule)
Container App container Custom scaling rule.
Field | Description |
---|---|
auth []ScaleRuleAuth |
Auth: Authentication secrets for the custom scale rule. |
metadata map[string]string |
Metadata: Metadata properties to describe custom scale rule. |
type string |
Type: Type of the custom scale rule eg: azure-servicebus, redis etc. |
CustomScaleRule_STATUS
(Appears on:ScaleRule_STATUS)
Container App container Custom scaling rule.
Field | Description |
---|---|
auth []ScaleRuleAuth_STATUS |
Auth: Authentication secrets for the custom scale rule. |
metadata map[string]string |
Metadata: Metadata properties to describe custom scale rule. |
type string |
Type: Type of the custom scale rule eg: azure-servicebus, redis etc. |
Dapr
(Appears on:Configuration)
Container App Dapr configuration.
Field | Description |
---|---|
appId string |
AppId: Dapr application identifier |
appPort int |
AppPort: Tells Dapr which port your application is listening on |
appProtocol Dapr_AppProtocol |
AppProtocol: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http |
enableApiLogging bool |
EnableApiLogging: Enables API logging for the Dapr sidecar |
enabled bool |
Enabled: Boolean indicating if the Dapr side car is enabled |
httpMaxRequestSize int |
HttpMaxRequestSize: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. |
httpReadBufferSize int |
HttpReadBufferSize: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. |
logLevel Dapr_LogLevel |
LogLevel: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. |
DaprConfiguration_STATUS
(Appears on:ManagedEnvironment_STATUS)
Configuration properties Dapr component
Field | Description |
---|---|
version string |
Version: The version of Dapr |
Dapr_AppProtocol
(string
alias)
(Appears on:Dapr)
Value | Description |
---|---|
"grpc" |
|
"http" |
Dapr_AppProtocol_STATUS
(string
alias)
(Appears on:Dapr_STATUS)
Value | Description |
---|---|
"grpc" |
|
"http" |
Dapr_LogLevel
(string
alias)
(Appears on:Dapr)
Value | Description |
---|---|
"debug" |
|
"error" |
|
"info" |
|
"warn" |
Dapr_LogLevel_STATUS
(string
alias)
(Appears on:Dapr_STATUS)
Value | Description |
---|---|
"debug" |
|
"error" |
|
"info" |
|
"warn" |
Dapr_STATUS
(Appears on:Configuration_STATUS)
Container App Dapr configuration.
Field | Description |
---|---|
appId string |
AppId: Dapr application identifier |
appPort int |
AppPort: Tells Dapr which port your application is listening on |
appProtocol Dapr_AppProtocol_STATUS |
AppProtocol: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http |
enableApiLogging bool |
EnableApiLogging: Enables API logging for the Dapr sidecar |
enabled bool |
Enabled: Boolean indicating if the Dapr side car is enabled |
httpMaxRequestSize int |
HttpMaxRequestSize: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. |
httpReadBufferSize int |
HttpReadBufferSize: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. |
logLevel Dapr_LogLevel_STATUS |
LogLevel: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. |
DefaultAuthorizationPolicy
(Appears on:AzureActiveDirectoryValidation)
The configuration settings of the Azure Active Directory default authorization policy.
Field | Description |
---|---|
allowedApplications []string |
AllowedApplications: The configuration settings of the Azure Active Directory allowed applications. |
allowedPrincipals AllowedPrincipals |
AllowedPrincipals: The configuration settings of the Azure Active Directory allowed principals. |
DefaultAuthorizationPolicy_STATUS
(Appears on:AzureActiveDirectoryValidation_STATUS)
The configuration settings of the Azure Active Directory default authorization policy.
Field | Description |
---|---|
allowedApplications []string |
AllowedApplications: The configuration settings of the Azure Active Directory allowed applications. |
allowedPrincipals AllowedPrincipals_STATUS |
AllowedPrincipals: The configuration settings of the Azure Active Directory allowed principals. |
EncryptionSettings
(Appears on:AuthConfig_Spec)
The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.
Field | Description |
---|---|
containerAppAuthEncryptionSecretName string |
ContainerAppAuthEncryptionSecretName: The secret name which is referenced for EncryptionKey. |
containerAppAuthSigningSecretName string |
ContainerAppAuthSigningSecretName: The secret name which is referenced for SigningKey. |
EncryptionSettings_STATUS
(Appears on:AuthConfig_STATUS)
The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.
Field | Description |
---|---|
containerAppAuthEncryptionSecretName string |
ContainerAppAuthEncryptionSecretName: The secret name which is referenced for EncryptionKey. |
containerAppAuthSigningSecretName string |
ContainerAppAuthSigningSecretName: The secret name which is referenced for SigningKey. |
EnvironmentVar
(Appears on:BaseContainer, Container)
Container App container environment variable.
Field | Description |
---|---|
name string |
Name: Environment variable name. |
secretRef string |
SecretRef: Name of the Container App secret from which to pull the environment variable value. |
value string |
Value: Non-secret environment variable value. |
EnvironmentVar_STATUS
(Appears on:BaseContainer_STATUS, Container_STATUS)
Container App container environment variable.
Field | Description |
---|---|
name string |
Name: Environment variable name. |
secretRef string |
SecretRef: Name of the Container App secret from which to pull the environment variable value. |
value string |
Value: Non-secret environment variable value. |
ExtendedLocation
(Appears on:ContainerApp_Spec)
The complex type of the extended location.
Field | Description |
---|---|
name string |
Name: The name of the extended location. |
type ExtendedLocationType |
Type: The type of the extended location. |
ExtendedLocationType
(string
alias)
(Appears on:ExtendedLocation)
The type of extendedLocation.
Value | Description |
---|---|
"CustomLocation" |
ExtendedLocationType_STATUS
(string
alias)
(Appears on:ExtendedLocation_STATUS)
The type of extendedLocation.
Value | Description |
---|---|
"CustomLocation" |
ExtendedLocation_STATUS
(Appears on:ContainerApp_STATUS)
The complex type of the extended location.
Field | Description |
---|---|
name string |
Name: The name of the extended location. |
type ExtendedLocationType_STATUS |
Type: The type of the extended location. |
(Appears on:IdentityProviders)
The configuration settings of the Facebook provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
graphApiVersion string |
GraphApiVersion: The version of the Facebook api to be used while logging in. |
login LoginScopes |
Login: The configuration settings of the login flow. |
registration AppRegistration |
Registration: The configuration settings of the app registration for the Facebook provider. |
Facebook_STATUS
(Appears on:IdentityProviders_STATUS)
The configuration settings of the Facebook provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
graphApiVersion string |
GraphApiVersion: The version of the Facebook api to be used while logging in. |
login LoginScopes_STATUS |
Login: The configuration settings of the login flow. |
registration AppRegistration_STATUS |
Registration: The configuration settings of the app registration for the Facebook provider. |
ForwardProxy
(Appears on:HttpSettings)
The configuration settings of a forward proxy used to make the requests.
Field | Description |
---|---|
convention ForwardProxy_Convention |
Convention: The convention used to determine the url of the request made. |
customHostHeaderName string |
CustomHostHeaderName: The name of the header containing the host of the request. |
customProtoHeaderName string |
CustomProtoHeaderName: The name of the header containing the scheme of the request. |
ForwardProxy_Convention
(string
alias)
(Appears on:ForwardProxy)
Value | Description |
---|---|
"Custom" |
|
"NoProxy" |
|
"Standard" |
ForwardProxy_Convention_STATUS
(string
alias)
(Appears on:ForwardProxy_STATUS)
Value | Description |
---|---|
"Custom" |
|
"NoProxy" |
|
"Standard" |
ForwardProxy_STATUS
(Appears on:HttpSettings_STATUS)
The configuration settings of a forward proxy used to make the requests.
Field | Description |
---|---|
convention ForwardProxy_Convention_STATUS |
Convention: The convention used to determine the url of the request made. |
customHostHeaderName string |
CustomHostHeaderName: The name of the header containing the host of the request. |
customProtoHeaderName string |
CustomProtoHeaderName: The name of the header containing the scheme of the request. |
GitHub
(Appears on:IdentityProviders)
The configuration settings of the GitHub provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
login LoginScopes |
Login: The configuration settings of the login flow. |
registration ClientRegistration |
Registration: The configuration settings of the app registration for the GitHub provider. |
GitHub_STATUS
(Appears on:IdentityProviders_STATUS)
The configuration settings of the GitHub provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
login LoginScopes_STATUS |
Login: The configuration settings of the login flow. |
registration ClientRegistration_STATUS |
Registration: The configuration settings of the app registration for the GitHub provider. |
GlobalValidation
(Appears on:AuthConfig_Spec)
The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization.
Field | Description |
---|---|
excludedPaths []string |
ExcludedPaths: The paths for which unauthenticated flow would not be redirected to the login page. |
redirectToProvider string |
RedirectToProvider: 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”. |
unauthenticatedClientAction GlobalValidation_UnauthenticatedClientAction |
UnauthenticatedClientAction: The action to take when an unauthenticated client attempts to access the app. |
GlobalValidation_STATUS
(Appears on:AuthConfig_STATUS)
The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization.
Field | Description |
---|---|
excludedPaths []string |
ExcludedPaths: The paths for which unauthenticated flow would not be redirected to the login page. |
redirectToProvider string |
RedirectToProvider: 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”. |
unauthenticatedClientAction GlobalValidation_UnauthenticatedClientAction_STATUS |
UnauthenticatedClientAction: The action to take when an unauthenticated client attempts to access the app. |
GlobalValidation_UnauthenticatedClientAction
(string
alias)
(Appears on:GlobalValidation)
Value | Description |
---|---|
"AllowAnonymous" |
|
"RedirectToLoginPage" |
|
"Return401" |
|
"Return403" |
GlobalValidation_UnauthenticatedClientAction_STATUS
(string
alias)
(Appears on:GlobalValidation_STATUS)
Value | Description |
---|---|
"AllowAnonymous" |
|
"RedirectToLoginPage" |
|
"Return401" |
|
"Return403" |
(Appears on:IdentityProviders)
The configuration settings of the Google provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
login LoginScopes |
Login: The configuration settings of the login flow. |
registration ClientRegistration |
Registration: The configuration settings of the app registration for the Google provider. |
validation AllowedAudiencesValidation |
Validation: The configuration settings of the Azure Active Directory token validation flow. |
Google_STATUS
(Appears on:IdentityProviders_STATUS)
The configuration settings of the Google provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
login LoginScopes_STATUS |
Login: The configuration settings of the login flow. |
registration ClientRegistration_STATUS |
Registration: The configuration settings of the app registration for the Google provider. |
validation AllowedAudiencesValidation_STATUS |
Validation: The configuration settings of the Azure Active Directory token validation flow. |
HttpScaleRule
(Appears on:ScaleRule)
Container App container Http scaling rule.
Field | Description |
---|---|
auth []ScaleRuleAuth |
Auth: Authentication secrets for the custom scale rule. |
metadata map[string]string |
Metadata: Metadata properties to describe http scale rule. |
HttpScaleRule_STATUS
(Appears on:ScaleRule_STATUS)
Container App container Http scaling rule.
Field | Description |
---|---|
auth []ScaleRuleAuth_STATUS |
Auth: Authentication secrets for the custom scale rule. |
metadata map[string]string |
Metadata: Metadata properties to describe http scale rule. |
HttpSettings
(Appears on:AuthConfig_Spec)
The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.
Field | Description |
---|---|
forwardProxy ForwardProxy |
ForwardProxy: The configuration settings of a forward proxy used to make the requests. |
requireHttps bool |
RequireHttps: |
routes HttpSettingsRoutes |
Routes: The configuration settings of the paths HTTP requests. |
HttpSettingsRoutes
(Appears on:HttpSettings)
The configuration settings of the paths HTTP requests.
Field | Description |
---|---|
apiPrefix string |
ApiPrefix: The prefix that should precede all the authentication/authorization paths. |
HttpSettingsRoutes_STATUS
(Appears on:HttpSettings_STATUS)
The configuration settings of the paths HTTP requests.
Field | Description |
---|---|
apiPrefix string |
ApiPrefix: The prefix that should precede all the authentication/authorization paths. |
HttpSettings_STATUS
(Appears on:AuthConfig_STATUS)
The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.
Field | Description |
---|---|
forwardProxy ForwardProxy_STATUS |
ForwardProxy: The configuration settings of a forward proxy used to make the requests. |
requireHttps bool |
RequireHttps: |
routes HttpSettingsRoutes_STATUS |
Routes: The configuration settings of the paths HTTP requests. |
IdentityProviders
(Appears on:AuthConfig_Spec)
The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.
Field | Description |
---|---|
apple Apple |
Apple: The configuration settings of the Apple provider. |
azureActiveDirectory AzureActiveDirectory |
AzureActiveDirectory: The configuration settings of the Azure Active directory provider. |
azureStaticWebApps AzureStaticWebApps |
AzureStaticWebApps: The configuration settings of the Azure Static Web Apps provider. |
customOpenIdConnectProviders map[string]./api/app/v1api20240301.CustomOpenIdConnectProvider |
CustomOpenIdConnectProviders: 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. |
facebook |
Facebook: The configuration settings of the Facebook provider. |
gitHub GitHub |
GitHub: The configuration settings of the GitHub provider. |
google |
Google: The configuration settings of the Google provider. |
twitter |
Twitter: The configuration settings of the Twitter provider. |
IdentityProviders_STATUS
(Appears on:AuthConfig_STATUS)
The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.
Field | Description |
---|---|
apple Apple_STATUS |
Apple: The configuration settings of the Apple provider. |
azureActiveDirectory AzureActiveDirectory_STATUS |
AzureActiveDirectory: The configuration settings of the Azure Active directory provider. |
azureStaticWebApps AzureStaticWebApps_STATUS |
AzureStaticWebApps: The configuration settings of the Azure Static Web Apps provider. |
customOpenIdConnectProviders map[string]./api/app/v1api20240301.CustomOpenIdConnectProvider_STATUS |
CustomOpenIdConnectProviders: 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. |
facebook Facebook_STATUS |
Facebook: The configuration settings of the Facebook provider. |
gitHub GitHub_STATUS |
GitHub: The configuration settings of the GitHub provider. |
google Google_STATUS |
Google: The configuration settings of the Google provider. |
twitter Twitter_STATUS |
Twitter: The configuration settings of the Twitter provider. |
Ingress
(Appears on:Configuration)
Container App Ingress configuration.
Field | Description |
---|---|
additionalPortMappings []IngressPortMapping |
AdditionalPortMappings: Settings to expose additional ports on container app |
allowInsecure bool |
AllowInsecure: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections |
clientCertificateMode Ingress_ClientCertificateMode |
ClientCertificateMode: Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate. |
corsPolicy CorsPolicy |
CorsPolicy: CORS policy for container app |
customDomains []CustomDomain |
CustomDomains: custom domain bindings for Container Apps’ hostnames. |
exposedPort int |
ExposedPort: Exposed Port in containers for TCP traffic from ingress |
external bool |
External: Bool indicating if app exposes an external http endpoint |
ipSecurityRestrictions []IpSecurityRestrictionRule |
IpSecurityRestrictions: Rules to restrict incoming IP address. |
stickySessions Ingress_StickySessions |
StickySessions: Sticky Sessions for Single Revision Mode |
targetPort int |
TargetPort: Target Port in containers for traffic from ingress |
traffic []TrafficWeight |
Traffic: Traffic weights for app’s revisions |
transport Ingress_Transport |
Transport: Ingress transport protocol |
IngressPortMapping
(Appears on:Ingress)
Port mappings of container app ingress
Field | Description |
---|---|
exposedPort int |
ExposedPort: Specifies the exposed port for the target port. If not specified, it defaults to target port |
external bool |
External: Specifies whether the app port is accessible outside of the environment |
targetPort int |
TargetPort: Specifies the port user’s container listens on |
IngressPortMapping_STATUS
(Appears on:Ingress_STATUS)
Port mappings of container app ingress
Field | Description |
---|---|
exposedPort int |
ExposedPort: Specifies the exposed port for the target port. If not specified, it defaults to target port |
external bool |
External: Specifies whether the app port is accessible outside of the environment |
targetPort int |
TargetPort: Specifies the port user’s container listens on |
Ingress_ClientCertificateMode
(string
alias)
(Appears on:Ingress)
Value | Description |
---|---|
"accept" |
|
"ignore" |
|
"require" |
Ingress_ClientCertificateMode_STATUS
(string
alias)
(Appears on:Ingress_STATUS)
Value | Description |
---|---|
"accept" |
|
"ignore" |
|
"require" |
Ingress_STATUS
(Appears on:Configuration_STATUS)
Container App Ingress configuration.
Field | Description |
---|---|
additionalPortMappings []IngressPortMapping_STATUS |
AdditionalPortMappings: Settings to expose additional ports on container app |
allowInsecure bool |
AllowInsecure: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections |
clientCertificateMode Ingress_ClientCertificateMode_STATUS |
ClientCertificateMode: Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate. |
corsPolicy CorsPolicy_STATUS |
CorsPolicy: CORS policy for container app |
customDomains []CustomDomain_STATUS |
CustomDomains: custom domain bindings for Container Apps’ hostnames. |
exposedPort int |
ExposedPort: Exposed Port in containers for TCP traffic from ingress |
external bool |
External: Bool indicating if app exposes an external http endpoint |
fqdn string |
Fqdn: Hostname. |
ipSecurityRestrictions []IpSecurityRestrictionRule_STATUS |
IpSecurityRestrictions: Rules to restrict incoming IP address. |
stickySessions Ingress_StickySessions_STATUS |
StickySessions: Sticky Sessions for Single Revision Mode |
targetPort int |
TargetPort: Target Port in containers for traffic from ingress |
traffic []TrafficWeight_STATUS |
Traffic: Traffic weights for app’s revisions |
transport Ingress_Transport_STATUS |
Transport: Ingress transport protocol |
Ingress_StickySessions
(Appears on:Ingress)
Field | Description |
---|---|
affinity Ingress_StickySessions_Affinity |
Affinity: Sticky Session Affinity |
Ingress_StickySessions_Affinity
(string
alias)
(Appears on:Ingress_StickySessions)
Value | Description |
---|---|
"none" |
|
"sticky" |
Ingress_StickySessions_Affinity_STATUS
(string
alias)
(Appears on:Ingress_StickySessions_STATUS)
Value | Description |
---|---|
"none" |
|
"sticky" |
Ingress_StickySessions_STATUS
(Appears on:Ingress_STATUS)
Field | Description |
---|---|
affinity Ingress_StickySessions_Affinity_STATUS |
Affinity: Sticky Session Affinity |
Ingress_Transport
(string
alias)
(Appears on:Ingress)
Value | Description |
---|---|
"auto" |
|
"http" |
|
"http2" |
|
"tcp" |
Ingress_Transport_STATUS
(string
alias)
(Appears on:Ingress_STATUS)
Value | Description |
---|---|
"auto" |
|
"http" |
|
"http2" |
|
"tcp" |
IpSecurityRestrictionRule
(Appears on:Ingress)
Rule to restrict incoming IP address.
Field | Description |
---|---|
action IpSecurityRestrictionRule_Action |
Action: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny |
description string |
Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. |
ipAddressRange string |
IpAddressRange: CIDR notation to match incoming IP address |
name string |
Name: Name for the IP restriction rule. |
IpSecurityRestrictionRule_Action
(string
alias)
(Appears on:IpSecurityRestrictionRule)
Value | Description |
---|---|
"Allow" |
|
"Deny" |
IpSecurityRestrictionRule_Action_STATUS
(string
alias)
(Appears on:IpSecurityRestrictionRule_STATUS)
Value | Description |
---|---|
"Allow" |
|
"Deny" |
IpSecurityRestrictionRule_STATUS
(Appears on:Ingress_STATUS)
Rule to restrict incoming IP address.
Field | Description |
---|---|
action IpSecurityRestrictionRule_Action_STATUS |
Action: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny |
description string |
Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. |
ipAddressRange string |
IpAddressRange: CIDR notation to match incoming IP address |
name string |
Name: Name for the IP restriction rule. |
Job
Generator information: - Generated from: /app/resource-manager/Microsoft.App/stable/2024-03-01/Jobs.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}p>
Field | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||
spec Job_Spec |
|
||||||||||||||||||||
status Job_STATUS |
JobConfiguration
(Appears on:Job_Spec)
Non versioned Container Apps Job configuration properties
Field | Description |
---|---|
eventTriggerConfig JobConfiguration_EventTriggerConfig |
EventTriggerConfig: Trigger configuration of an event driven job. |
manualTriggerConfig JobConfiguration_ManualTriggerConfig |
ManualTriggerConfig: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default |
registries []RegistryCredentials |
Registries: Collection of private container registry credentials used by a Container apps job |
replicaRetryLimit int |
ReplicaRetryLimit: Maximum number of retries before failing the job. |
replicaTimeout int |
ReplicaTimeout: Maximum number of seconds a replica is allowed to run. |
scheduleTriggerConfig JobConfiguration_ScheduleTriggerConfig |
ScheduleTriggerConfig: Cron formatted repeating trigger schedule (“* * * * *”) for cronjobs. Properties completions and parallelism would be set to 1 by default |
secrets []Secret |
Secrets: Collection of secrets used by a Container Apps Job |
triggerType JobConfiguration_TriggerType |
TriggerType: Trigger type of the job |
JobConfiguration_EventTriggerConfig
(Appears on:JobConfiguration)
Field | Description |
---|---|
parallelism int |
|
replicaCompletionCount int |
|
scale JobScale |
Scale: Scaling configurations for event driven jobs. |
JobConfiguration_EventTriggerConfig_STATUS
(Appears on:JobConfiguration_STATUS)
Field | Description |
---|---|
parallelism int |
|
replicaCompletionCount int |
|
scale JobScale_STATUS |
Scale: Scaling configurations for event driven jobs. |
JobConfiguration_ManualTriggerConfig
(Appears on:JobConfiguration)
Field | Description |
---|---|
parallelism int |
|
replicaCompletionCount int |
JobConfiguration_ManualTriggerConfig_STATUS
(Appears on:JobConfiguration_STATUS)
Field | Description |
---|---|
parallelism int |
|
replicaCompletionCount int |
JobConfiguration_STATUS
(Appears on:Job_STATUS)
Non versioned Container Apps Job configuration properties
Field | Description |
---|---|
eventTriggerConfig JobConfiguration_EventTriggerConfig_STATUS |
EventTriggerConfig: Trigger configuration of an event driven job. |
manualTriggerConfig JobConfiguration_ManualTriggerConfig_STATUS |
ManualTriggerConfig: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default |
registries []RegistryCredentials_STATUS |
Registries: Collection of private container registry credentials used by a Container apps job |
replicaRetryLimit int |
ReplicaRetryLimit: Maximum number of retries before failing the job. |
replicaTimeout int |
ReplicaTimeout: Maximum number of seconds a replica is allowed to run. |
scheduleTriggerConfig JobConfiguration_ScheduleTriggerConfig_STATUS |
ScheduleTriggerConfig: Cron formatted repeating trigger schedule (“* * * * *”) for cronjobs. Properties completions and parallelism would be set to 1 by default |
secrets []Secret_STATUS |
Secrets: Collection of secrets used by a Container Apps Job |
triggerType JobConfiguration_TriggerType_STATUS |
TriggerType: Trigger type of the job |
JobConfiguration_ScheduleTriggerConfig
(Appears on:JobConfiguration)
Field | Description |
---|---|
cronExpression string |
CronExpression: Cron formatted repeating schedule (“* * * * *”) of a Cron Job. |
parallelism int |
|
replicaCompletionCount int |
JobConfiguration_ScheduleTriggerConfig_STATUS
(Appears on:JobConfiguration_STATUS)
Field | Description |
---|---|
cronExpression string |
CronExpression: Cron formatted repeating schedule (“* * * * *”) of a Cron Job. |
parallelism int |
|
replicaCompletionCount int |
JobConfiguration_TriggerType
(string
alias)
(Appears on:JobConfiguration)
Value | Description |
---|---|
"Event" |
|
"Manual" |
|
"Schedule" |
JobConfiguration_TriggerType_STATUS
(string
alias)
(Appears on:JobConfiguration_STATUS)
Value | Description |
---|---|
"Event" |
|
"Manual" |
|
"Schedule" |
JobOperatorSpec
(Appears on:Job_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
JobScale
(Appears on:JobConfiguration_EventTriggerConfig)
Scaling configurations for event driven jobs.
Field | Description |
---|---|
maxExecutions int |
MaxExecutions: Maximum number of job executions that are created for a trigger, default 100. |
minExecutions int |
MinExecutions: Minimum number of job executions that are created for a trigger, default 0 |
pollingInterval int |
|
rules []JobScaleRule |
Rules: Scaling rules. |
JobScaleRule
(Appears on:JobScale)
Scaling rule.
Field | Description |
---|---|
auth []ScaleRuleAuth |
Auth: Authentication secrets for the scale rule. |
metadata map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
Metadata: Metadata properties to describe the scale rule. |
name string |
Name: Scale Rule Name |
type string |
Type: Type of the scale rule eg: azure-servicebus, redis etc. |
JobScaleRule_STATUS
(Appears on:JobScale_STATUS)
Scaling rule.
Field | Description |
---|---|
auth []ScaleRuleAuth_STATUS |
Auth: Authentication secrets for the scale rule. |
metadata map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
Metadata: Metadata properties to describe the scale rule. |
name string |
Name: Scale Rule Name |
type string |
Type: Type of the scale rule eg: azure-servicebus, redis etc. |
JobScale_STATUS
(Appears on:JobConfiguration_EventTriggerConfig_STATUS)
Scaling configurations for event driven jobs.
Field | Description |
---|---|
maxExecutions int |
MaxExecutions: Maximum number of job executions that are created for a trigger, default 100. |
minExecutions int |
MinExecutions: Minimum number of job executions that are created for a trigger, default 0 |
pollingInterval int |
|
rules []JobScaleRule_STATUS |
Rules: Scaling rules. |
JobTemplate
(Appears on:Job_Spec)
Container Apps Job versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created
Field | Description |
---|---|
containers []Container |
Containers: List of container definitions for the Container App. |
initContainers []BaseContainer |
InitContainers: List of specialized containers that run before app containers. |
volumes []Volume |
Volumes: List of volume definitions for the Container App. |
JobTemplate_STATUS
(Appears on:Job_STATUS)
Container Apps Job versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created
Field | Description |
---|---|
containers []Container_STATUS |
Containers: List of container definitions for the Container App. |
initContainers []BaseContainer_STATUS |
InitContainers: List of specialized containers that run before app containers. |
volumes []Volume_STATUS |
Volumes: List of volume definitions for the Container App. |
Job_Properties_ProvisioningState_STATUS
(string
alias)
(Appears on:Job_STATUS)
Value | Description |
---|---|
"Canceled" |
|
"Deleting" |
|
"Failed" |
|
"InProgress" |
|
"Succeeded" |
Job_STATUS
(Appears on:Job)
Container App Job
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
configuration JobConfiguration_STATUS |
Configuration: Container Apps Job configuration properties. |
environmentId string |
EnvironmentId: Resource ID of environment. |
eventStreamEndpoint string |
EventStreamEndpoint: The endpoint of the eventstream of the container apps job. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
identity ManagedServiceIdentity_STATUS |
Identity: Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code. |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the resource |
outboundIpAddresses []string |
OutboundIpAddresses: Outbound IP Addresses of a container apps job. |
provisioningState Job_Properties_ProvisioningState_STATUS |
ProvisioningState: Provisioning state of the Container Apps Job. |
systemData SystemData_STATUS |
SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. |
tags map[string]string |
Tags: Resource tags. |
template JobTemplate_STATUS |
Template: Container Apps job definition. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
workloadProfileName string |
WorkloadProfileName: Workload profile name to pin for container apps job execution. |
Job_Spec
(Appears on:Job)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
configuration JobConfiguration |
Configuration: Container Apps Job configuration properties. |
environmentReference genruntime.ResourceReference |
EnvironmentReference: Resource ID of environment. |
identity ManagedServiceIdentity |
Identity: Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code. |
location string |
Location: The geo-location where the resource lives |
operatorSpec JobOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
tags map[string]string |
Tags: Resource tags. |
template JobTemplate |
Template: Container Apps job definition. |
workloadProfileName string |
WorkloadProfileName: Workload profile name to pin for container apps job execution. |
JwtClaimChecks
(Appears on:AzureActiveDirectoryValidation)
The configuration settings of the checks that should be made while validating the JWT Claims.
Field | Description |
---|---|
allowedClientApplications []string |
AllowedClientApplications: The list of the allowed client applications. |
allowedGroups []string |
AllowedGroups: The list of the allowed groups. |
JwtClaimChecks_STATUS
(Appears on:AzureActiveDirectoryValidation_STATUS)
The configuration settings of the checks that should be made while validating the JWT Claims.
Field | Description |
---|---|
allowedClientApplications []string |
AllowedClientApplications: The list of the allowed client applications. |
allowedGroups []string |
AllowedGroups: The list of the allowed groups. |
KedaConfiguration_STATUS
(Appears on:ManagedEnvironment_STATUS)
Configuration properties Keda component
Field | Description |
---|---|
version string |
Version: The version of Keda |
LogAnalyticsConfiguration
(Appears on:AppLogsConfiguration)
Log Analytics configuration, must only be provided when destination is configured as ‘log-analytics’
Field | Description |
---|---|
customerId string |
CustomerId: Log analytics customer id |
sharedKey genruntime.SecretReference |
SharedKey: Log analytics customer key |
LogAnalyticsConfiguration_STATUS
(Appears on:AppLogsConfiguration_STATUS)
Log Analytics configuration, must only be provided when destination is configured as ‘log-analytics’
Field | Description |
---|---|
customerId string |
CustomerId: Log analytics customer id |
Login
(Appears on:AuthConfig_Spec)
The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.
Field | Description |
---|---|
allowedExternalRedirectUrls []string |
AllowedExternalRedirectUrls: 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. |
cookieExpiration CookieExpiration |
CookieExpiration: The configuration settings of the session cookie’s expiration. |
nonce Nonce |
Nonce: The configuration settings of the nonce used in the login flow. |
preserveUrlFragmentsForLogins bool |
PreserveUrlFragmentsForLogins: |
routes LoginRoutes |
Routes: The routes that specify the endpoints used for login and logout requests. |
tokenStore TokenStore |
TokenStore: The configuration settings of the token store. |
LoginRoutes
(Appears on:Login)
The routes that specify the endpoints used for login and logout requests.
Field | Description |
---|---|
logoutEndpoint string |
LogoutEndpoint: The endpoint at which a logout request should be made. |
LoginRoutes_STATUS
(Appears on:Login_STATUS)
The routes that specify the endpoints used for login and logout requests.
Field | Description |
---|---|
logoutEndpoint string |
LogoutEndpoint: The endpoint at which a logout request should be made. |
LoginScopes
(Appears on:Apple, Facebook, GitHub, Google)
The configuration settings of the login flow, including the scopes that should be requested.
Field | Description |
---|---|
scopes []string |
Scopes: A list of the scopes that should be requested while authenticating. |
LoginScopes_STATUS
(Appears on:Apple_STATUS, Facebook_STATUS, GitHub_STATUS, Google_STATUS)
The configuration settings of the login flow, including the scopes that should be requested.
Field | Description |
---|---|
scopes []string |
Scopes: A list of the scopes that should be requested while authenticating. |
Login_STATUS
(Appears on:AuthConfig_STATUS)
The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.
Field | Description |
---|---|
allowedExternalRedirectUrls []string |
AllowedExternalRedirectUrls: 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. |
cookieExpiration CookieExpiration_STATUS |
CookieExpiration: The configuration settings of the session cookie’s expiration. |
nonce Nonce_STATUS |
Nonce: The configuration settings of the nonce used in the login flow. |
preserveUrlFragmentsForLogins bool |
PreserveUrlFragmentsForLogins: |
routes LoginRoutes_STATUS |
Routes: The routes that specify the endpoints used for login and logout requests. |
tokenStore TokenStore_STATUS |
TokenStore: The configuration settings of the token store. |
ManagedEnvironment
Generator information: - Generated from: /app/resource-manager/Microsoft.App/stable/2024-03-01/ManagedEnvironments.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}p>
Field | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||
spec ManagedEnvironment_Spec |
|
||||||||||||||||||||||||||||||||
status ManagedEnvironment_STATUS |
ManagedEnvironmentOperatorSpec
(Appears on:ManagedEnvironment_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
ManagedEnvironment_Properties_PeerAuthentication_STATUS
(Appears on:ManagedEnvironment_STATUS)
Field | Description |
---|---|
mtls Mtls_STATUS |
Mtls: Mutual TLS authentication settings for the Managed Environment |
ManagedEnvironment_Properties_PeerAuthentication_Spec
(Appears on:ManagedEnvironment_Spec)
Field | Description |
---|---|
mtls Mtls |
Mtls: Mutual TLS authentication settings for the Managed Environment |
ManagedEnvironment_Properties_PeerTrafficConfiguration_Encryption_STATUS
(Appears on:ManagedEnvironment_Properties_PeerTrafficConfiguration_STATUS)
Field | Description |
---|---|
enabled bool |
Enabled: Boolean indicating whether the peer traffic encryption is enabled |
ManagedEnvironment_Properties_PeerTrafficConfiguration_Encryption_Spec
(Appears on:ManagedEnvironment_Properties_PeerTrafficConfiguration_Spec)
Field | Description |
---|---|
enabled bool |
Enabled: Boolean indicating whether the peer traffic encryption is enabled |
ManagedEnvironment_Properties_PeerTrafficConfiguration_STATUS
(Appears on:ManagedEnvironment_STATUS)
Field | Description |
---|---|
encryption ManagedEnvironment_Properties_PeerTrafficConfiguration_Encryption_STATUS |
Encryption: Peer traffic encryption settings for the Managed Environment |
ManagedEnvironment_Properties_PeerTrafficConfiguration_Spec
(Appears on:ManagedEnvironment_Spec)
Field | Description |
---|---|
encryption ManagedEnvironment_Properties_PeerTrafficConfiguration_Encryption_Spec |
Encryption: Peer traffic encryption settings for the Managed Environment |
ManagedEnvironment_Properties_ProvisioningState_STATUS
(string
alias)
(Appears on:ManagedEnvironment_STATUS)
Value | Description |
---|---|
"Canceled" |
|
"Failed" |
|
"InfrastructureSetupComplete" |
|
"InfrastructureSetupInProgress" |
|
"InitializationInProgress" |
|
"ScheduledForDelete" |
|
"Succeeded" |
|
"UpgradeFailed" |
|
"UpgradeRequested" |
|
"Waiting" |
ManagedEnvironment_STATUS
(Appears on:ManagedEnvironment)
An environment for hosting container apps
Field | Description |
---|---|
appLogsConfiguration AppLogsConfiguration_STATUS |
AppLogsConfiguration: Cluster configuration which enables the log daemon to export app logs to configured destination. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
customDomainConfiguration CustomDomainConfiguration_STATUS |
CustomDomainConfiguration: Custom domain configuration for the environment |
daprConfiguration DaprConfiguration_STATUS |
DaprConfiguration: The configuration of Dapr component. |
defaultDomain string |
DefaultDomain: Default Domain Name for the cluster |
deploymentErrors string |
DeploymentErrors: Any errors that occurred during deployment or deployment validation |
eventStreamEndpoint string |
EventStreamEndpoint: The endpoint of the eventstream of the Environment. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
infrastructureResourceGroup string |
InfrastructureResourceGroup: Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet. |
kedaConfiguration KedaConfiguration_STATUS |
KedaConfiguration: The configuration of Keda component. |
kind string |
Kind: Kind of the Environment. |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the resource |
peerAuthentication ManagedEnvironment_Properties_PeerAuthentication_STATUS |
PeerAuthentication: Peer authentication settings for the Managed Environment |
peerTrafficConfiguration ManagedEnvironment_Properties_PeerTrafficConfiguration_STATUS |
PeerTrafficConfiguration: Peer traffic settings for the Managed Environment |
provisioningState ManagedEnvironment_Properties_ProvisioningState_STATUS |
ProvisioningState: Provisioning state of the Environment. |
staticIp string |
StaticIp: Static IP of the Environment |
systemData SystemData_STATUS |
SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
vnetConfiguration VnetConfiguration_STATUS |
VnetConfiguration: Vnet configuration for the environment |
workloadProfiles []WorkloadProfile_STATUS |
WorkloadProfiles: Workload profiles configured for the Managed Environment. |
zoneRedundant bool |
ZoneRedundant: Whether or not this Managed Environment is zone-redundant. |
ManagedEnvironment_Spec
(Appears on:ManagedEnvironment)
Field | Description |
---|---|
appLogsConfiguration AppLogsConfiguration |
AppLogsConfiguration: Cluster configuration which enables the log daemon to export app logs to configured destination. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
customDomainConfiguration CustomDomainConfiguration |
CustomDomainConfiguration: Custom domain configuration for the environment |
daprAIConnectionString genruntime.SecretReference |
DaprAIConnectionString: Application Insights connection string used by Dapr to export Service to Service communication telemetry |
daprAIInstrumentationKey genruntime.SecretReference |
DaprAIInstrumentationKey: Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry |
infrastructureResourceGroup string |
InfrastructureResourceGroup: Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet. |
kind string |
Kind: Kind of the Environment. |
location string |
Location: The geo-location where the resource lives |
operatorSpec ManagedEnvironmentOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
peerAuthentication ManagedEnvironment_Properties_PeerAuthentication_Spec |
PeerAuthentication: Peer authentication settings for the Managed Environment |
peerTrafficConfiguration ManagedEnvironment_Properties_PeerTrafficConfiguration_Spec |
PeerTrafficConfiguration: Peer traffic settings for the Managed Environment |
tags map[string]string |
Tags: Resource tags. |
vnetConfiguration VnetConfiguration |
VnetConfiguration: Vnet configuration for the environment |
workloadProfiles []WorkloadProfile |
WorkloadProfiles: Workload profiles configured for the Managed Environment. |
zoneRedundant bool |
ZoneRedundant: Whether or not this Managed Environment is zone-redundant. |
ManagedServiceIdentity
(Appears on:ContainerApp_Spec, Job_Spec)
Managed service identity (system assigned and/or user assigned identities)
Field | Description |
---|---|
type ManagedServiceIdentityType |
Type: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
userAssignedIdentities []UserAssignedIdentityDetails |
ManagedServiceIdentityType
(string
alias)
(Appears on:ManagedServiceIdentity)
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned,UserAssigned" |
|
"UserAssigned" |
ManagedServiceIdentityType_STATUS
(string
alias)
(Appears on:ManagedServiceIdentity_STATUS)
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned,UserAssigned" |
|
"UserAssigned" |
ManagedServiceIdentity_STATUS
(Appears on:ContainerApp_STATUS, Job_STATUS)
Managed service identity (system assigned and/or user assigned identities)
Field | Description |
---|---|
principalId string |
PrincipalId: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
tenantId string |
TenantId: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
type ManagedServiceIdentityType_STATUS |
Type: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
userAssignedIdentities map[string]./api/app/v1api20240301.UserAssignedIdentity_STATUS |
Mtls
(Appears on:ManagedEnvironment_Properties_PeerAuthentication_Spec)
Configuration properties for mutual TLS authentication
Field | Description |
---|---|
enabled bool |
Enabled: Boolean indicating whether the mutual TLS authentication is enabled |
Mtls_STATUS
(Appears on:ManagedEnvironment_Properties_PeerAuthentication_STATUS)
Configuration properties for mutual TLS authentication
Field | Description |
---|---|
enabled bool |
Enabled: Boolean indicating whether the mutual TLS authentication is enabled |
Nonce
(Appears on:Login)
The configuration settings of the nonce used in the login flow.
Field | Description |
---|---|
nonceExpirationInterval string |
NonceExpirationInterval: The time after the request is made when the nonce should expire. |
validateNonce bool |
ValidateNonce: |
Nonce_STATUS
(Appears on:Login_STATUS)
The configuration settings of the nonce used in the login flow.
Field | Description |
---|---|
nonceExpirationInterval string |
NonceExpirationInterval: The time after the request is made when the nonce should expire. |
validateNonce bool |
ValidateNonce: |
OpenIdConnectClientCredential
(Appears on:OpenIdConnectRegistration)
The authentication client credentials of the custom Open ID Connect provider.
Field | Description |
---|---|
clientSecretSettingName string |
ClientSecretSettingName: The app setting that contains the client secret for the custom Open ID Connect provider. |
method OpenIdConnectClientCredential_Method |
Method: The method that should be used to authenticate the user. |
OpenIdConnectClientCredential_Method
(string
alias)
(Appears on:OpenIdConnectClientCredential)
Value | Description |
---|---|
"ClientSecretPost" |
OpenIdConnectClientCredential_Method_STATUS
(string
alias)
(Appears on:OpenIdConnectClientCredential_STATUS)
Value | Description |
---|---|
"ClientSecretPost" |
OpenIdConnectClientCredential_STATUS
(Appears on:OpenIdConnectRegistration_STATUS)
The authentication client credentials of the custom Open ID Connect provider.
Field | Description |
---|---|
clientSecretSettingName string |
ClientSecretSettingName: The app setting that contains the client secret for the custom Open ID Connect provider. |
method OpenIdConnectClientCredential_Method_STATUS |
Method: The method that should be used to authenticate the user. |
OpenIdConnectConfig
(Appears on:OpenIdConnectRegistration)
The configuration settings of the endpoints used for the custom Open ID Connect provider.
Field | Description |
---|---|
authorizationEndpoint string |
AuthorizationEndpoint: The endpoint to be used to make an authorization request. |
certificationUri string |
CertificationUri: The endpoint that provides the keys necessary to validate the token. |
issuer string |
Issuer: The endpoint that issues the token. |
tokenEndpoint string |
TokenEndpoint: The endpoint to be used to request a token. |
wellKnownOpenIdConfiguration string |
WellKnownOpenIdConfiguration: The endpoint that contains all the configuration endpoints for the provider. |
OpenIdConnectConfig_STATUS
(Appears on:OpenIdConnectRegistration_STATUS)
The configuration settings of the endpoints used for the custom Open ID Connect provider.
Field | Description |
---|---|
authorizationEndpoint string |
AuthorizationEndpoint: The endpoint to be used to make an authorization request. |
certificationUri string |
CertificationUri: The endpoint that provides the keys necessary to validate the token. |
issuer string |
Issuer: The endpoint that issues the token. |
tokenEndpoint string |
TokenEndpoint: The endpoint to be used to request a token. |
wellKnownOpenIdConfiguration string |
WellKnownOpenIdConfiguration: The endpoint that contains all the configuration endpoints for the provider. |
OpenIdConnectLogin
(Appears on:CustomOpenIdConnectProvider)
The configuration settings of the login flow of the custom Open ID Connect provider.
Field | Description |
---|---|
nameClaimType string |
NameClaimType: The name of the claim that contains the users name. |
scopes []string |
Scopes: A list of the scopes that should be requested while authenticating. |
OpenIdConnectLogin_STATUS
(Appears on:CustomOpenIdConnectProvider_STATUS)
The configuration settings of the login flow of the custom Open ID Connect provider.
Field | Description |
---|---|
nameClaimType string |
NameClaimType: The name of the claim that contains the users name. |
scopes []string |
Scopes: A list of the scopes that should be requested while authenticating. |
OpenIdConnectRegistration
(Appears on:CustomOpenIdConnectProvider)
The configuration settings of the app registration for the custom Open ID Connect provider.
Field | Description |
---|---|
clientCredential OpenIdConnectClientCredential |
ClientCredential: The authentication credentials of the custom Open ID Connect provider. |
clientId string |
ClientId: The client id of the custom Open ID Connect provider. |
openIdConnectConfiguration OpenIdConnectConfig |
OpenIdConnectConfiguration: The configuration settings of the endpoints used for the custom Open ID Connect provider. |
OpenIdConnectRegistration_STATUS
(Appears on:CustomOpenIdConnectProvider_STATUS)
The configuration settings of the app registration for the custom Open ID Connect provider.
Field | Description |
---|---|
clientCredential OpenIdConnectClientCredential_STATUS |
ClientCredential: The authentication credentials of the custom Open ID Connect provider. |
clientId string |
ClientId: The client id of the custom Open ID Connect provider. |
openIdConnectConfiguration OpenIdConnectConfig_STATUS |
OpenIdConnectConfiguration: The configuration settings of the endpoints used for the custom Open ID Connect provider. |
QueueScaleRule
(Appears on:ScaleRule)
Container App container Azure Queue based scaling rule.
Field | Description |
---|---|
auth []ScaleRuleAuth |
Auth: Authentication secrets for the queue scale rule. |
queueLength int |
QueueLength: Queue length. |
queueName string |
QueueName: Queue name. |
QueueScaleRule_STATUS
(Appears on:ScaleRule_STATUS)
Container App container Azure Queue based scaling rule.
Field | Description |
---|---|
auth []ScaleRuleAuth_STATUS |
Auth: Authentication secrets for the queue scale rule. |
queueLength int |
QueueLength: Queue length. |
queueName string |
QueueName: Queue name. |
RegistryCredentials
(Appears on:Configuration, JobConfiguration)
Container App Private Registry
Field | Description |
---|---|
identityReference genruntime.ResourceReference |
IdentityReference: A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use ‘system’ |
passwordSecretRef string |
PasswordSecretRef: The name of the Secret that contains the registry login password |
server string |
Server: Container Registry Server |
username string |
Username: Container Registry Username |
RegistryCredentials_STATUS
(Appears on:Configuration_STATUS, JobConfiguration_STATUS)
Container App Private Registry
Field | Description |
---|---|
identity string |
Identity: A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use ‘system’ |
passwordSecretRef string |
PasswordSecretRef: The name of the Secret that contains the registry login password |
server string |
Server: Container Registry Server |
username string |
Username: Container Registry Username |
Scale
(Appears on:Template)
Container App scaling configurations.
Field | Description |
---|---|
maxReplicas int |
MaxReplicas: Optional. Maximum number of container replicas. Defaults to 10 if not set. |
minReplicas int |
MinReplicas: Optional. Minimum number of container replicas. |
rules []ScaleRule |
Rules: Scaling rules. |
ScaleRule
(Appears on:Scale)
Container App container scaling rule.
Field | Description |
---|---|
azureQueue QueueScaleRule |
AzureQueue: Azure Queue based scaling. |
custom CustomScaleRule |
Custom: Custom scale rule. |
http HttpScaleRule |
Http: HTTP requests based scaling. |
name string |
Name: Scale Rule Name |
tcp TcpScaleRule |
Tcp: Tcp requests based scaling. |
ScaleRuleAuth
(Appears on:CustomScaleRule, HttpScaleRule, JobScaleRule, QueueScaleRule, TcpScaleRule)
Auth Secrets for Scale Rule
Field | Description |
---|---|
secretRef string |
SecretRef: Name of the secret from which to pull the auth params. |
triggerParameter string |
TriggerParameter: Trigger Parameter that uses the secret |
ScaleRuleAuth_STATUS
(Appears on:CustomScaleRule_STATUS, HttpScaleRule_STATUS, JobScaleRule_STATUS, QueueScaleRule_STATUS, TcpScaleRule_STATUS)
Auth Secrets for Scale Rule
Field | Description |
---|---|
secretRef string |
SecretRef: Name of the secret from which to pull the auth params. |
triggerParameter string |
TriggerParameter: Trigger Parameter that uses the secret |
ScaleRule_STATUS
(Appears on:Scale_STATUS)
Container App container scaling rule.
Field | Description |
---|---|
azureQueue QueueScaleRule_STATUS |
AzureQueue: Azure Queue based scaling. |
custom CustomScaleRule_STATUS |
Custom: Custom scale rule. |
http HttpScaleRule_STATUS |
Http: HTTP requests based scaling. |
name string |
Name: Scale Rule Name |
tcp TcpScaleRule_STATUS |
Tcp: Tcp requests based scaling. |
Scale_STATUS
(Appears on:Template_STATUS)
Container App scaling configurations.
Field | Description |
---|---|
maxReplicas int |
MaxReplicas: Optional. Maximum number of container replicas. Defaults to 10 if not set. |
minReplicas int |
MinReplicas: Optional. Minimum number of container replicas. |
rules []ScaleRule_STATUS |
Rules: Scaling rules. |
Secret
(Appears on:Configuration, JobConfiguration)
Secret definition.
Field | Description |
---|---|
identityReference genruntime.ResourceReference |
IdentityReference: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. |
keyVaultUrl string |
KeyVaultUrl: Azure Key Vault URL pointing to the secret referenced by the container app. |
name string |
Name: Secret Name. |
value genruntime.SecretReference |
Value: Secret Value. |
SecretVolumeItem
(Appears on:Volume)
Secret to be added to volume.
Field | Description |
---|---|
path string |
Path: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. |
secretRef string |
SecretRef: Name of the Container App secret from which to pull the secret value. |
SecretVolumeItem_STATUS
(Appears on:Volume_STATUS)
Secret to be added to volume.
Field | Description |
---|---|
path string |
Path: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. |
secretRef string |
SecretRef: Name of the Container App secret from which to pull the secret value. |
Secret_STATUS
(Appears on:Configuration_STATUS, JobConfiguration_STATUS)
Secret definition.
Field | Description |
---|---|
identity string |
Identity: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. |
keyVaultUrl string |
KeyVaultUrl: Azure Key Vault URL pointing to the secret referenced by the container app. |
name string |
Name: Secret Name. |
Service
(Appears on:Configuration)
Container App to be a dev service
Field | Description |
---|---|
type string |
Type: Dev ContainerApp service type |
ServiceBind
(Appears on:Template)
Configuration to bind a ContainerApp to a dev ContainerApp Service
Field | Description |
---|---|
name string |
Name: Name of the service bind |
serviceReference genruntime.ResourceReference |
ServiceReference: Resource id of the target service |
ServiceBind_STATUS
(Appears on:Template_STATUS)
Configuration to bind a ContainerApp to a dev ContainerApp Service
Field | Description |
---|---|
name string |
Name: Name of the service bind |
serviceId string |
ServiceId: Resource id of the target service |
Service_STATUS
(Appears on:Configuration_STATUS)
Container App to be a dev service
Field | Description |
---|---|
type string |
Type: Dev ContainerApp service type |
SystemData_CreatedByType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_LastModifiedByType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_STATUS
(Appears on:AuthConfig_STATUS, ContainerApp_STATUS, Job_STATUS, ManagedEnvironment_STATUS)
Metadata pertaining to creation and last modification of the resource.
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemData_CreatedByType_STATUS |
CreatedByType: The type of identity that created the resource. |
lastModifiedAt string |
LastModifiedAt: The timestamp of resource last modification (UTC) |
lastModifiedBy string |
LastModifiedBy: The identity that last modified the resource. |
lastModifiedByType SystemData_LastModifiedByType_STATUS |
LastModifiedByType: The type of identity that last modified the resource. |
TcpScaleRule
(Appears on:ScaleRule)
Container App container Tcp scaling rule.
Field | Description |
---|---|
auth []ScaleRuleAuth |
Auth: Authentication secrets for the tcp scale rule. |
metadata map[string]string |
Metadata: Metadata properties to describe tcp scale rule. |
TcpScaleRule_STATUS
(Appears on:ScaleRule_STATUS)
Container App container Tcp scaling rule.
Field | Description |
---|---|
auth []ScaleRuleAuth_STATUS |
Auth: Authentication secrets for the tcp scale rule. |
metadata map[string]string |
Metadata: Metadata properties to describe tcp scale rule. |
Template
(Appears on:ContainerApp_Spec)
Container App versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created
Field | Description |
---|---|
containers []Container |
Containers: List of container definitions for the Container App. |
initContainers []BaseContainer |
InitContainers: List of specialized containers that run before app containers. |
revisionSuffix string |
RevisionSuffix: User friendly suffix that is appended to the revision name |
scale Scale |
Scale: Scaling properties for the Container App. |
serviceBinds []ServiceBind |
ServiceBinds: List of container app services bound to the app |
terminationGracePeriodSeconds int |
TerminationGracePeriodSeconds: Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. |
volumes []Volume |
Volumes: List of volume definitions for the Container App. |
Template_STATUS
(Appears on:ContainerApp_STATUS)
Container App versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created
Field | Description |
---|---|
containers []Container_STATUS |
Containers: List of container definitions for the Container App. |
initContainers []BaseContainer_STATUS |
InitContainers: List of specialized containers that run before app containers. |
revisionSuffix string |
RevisionSuffix: User friendly suffix that is appended to the revision name |
scale Scale_STATUS |
Scale: Scaling properties for the Container App. |
serviceBinds []ServiceBind_STATUS |
ServiceBinds: List of container app services bound to the app |
terminationGracePeriodSeconds int |
TerminationGracePeriodSeconds: Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. |
volumes []Volume_STATUS |
Volumes: List of volume definitions for the Container App. |
TokenStore
(Appears on:Login)
The configuration settings of the token store.
Field | Description |
---|---|
azureBlobStorage BlobStorageTokenStore |
AzureBlobStorage: The configuration settings of the storage of the tokens if blob storage is used. |
enabled bool |
Enabled: |
tokenRefreshExtensionHours float64 |
TokenRefreshExtensionHours: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. |
TokenStore_STATUS
(Appears on:Login_STATUS)
The configuration settings of the token store.
Field | Description |
---|---|
azureBlobStorage BlobStorageTokenStore_STATUS |
AzureBlobStorage: The configuration settings of the storage of the tokens if blob storage is used. |
enabled bool |
Enabled: |
tokenRefreshExtensionHours float64 |
TokenRefreshExtensionHours: The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. |
TrafficWeight
(Appears on:Ingress)
Traffic weight assigned to a revision
Field | Description |
---|---|
label string |
Label: Associates a traffic label with a revision |
latestRevision bool |
LatestRevision: Indicates that the traffic weight belongs to a latest stable revision |
revisionName string |
RevisionName: Name of a revision |
weight int |
Weight: Traffic weight assigned to a revision |
TrafficWeight_STATUS
(Appears on:Ingress_STATUS)
Traffic weight assigned to a revision
Field | Description |
---|---|
label string |
Label: Associates a traffic label with a revision |
latestRevision bool |
LatestRevision: Indicates that the traffic weight belongs to a latest stable revision |
revisionName string |
RevisionName: Name of a revision |
weight int |
Weight: Traffic weight assigned to a revision |
(Appears on:IdentityProviders)
The configuration settings of the Twitter provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
registration TwitterRegistration |
Registration: The configuration settings of the app registration for the Twitter provider. |
TwitterRegistration
(Appears on:Twitter)
The configuration settings of the app registration for the Twitter provider.
Field | Description |
---|---|
consumerKey string |
ConsumerKey: 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 |
consumerSecretSettingName string |
ConsumerSecretSettingName: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. |
TwitterRegistration_STATUS
(Appears on:Twitter_STATUS)
The configuration settings of the app registration for the Twitter provider.
Field | Description |
---|---|
consumerKey string |
ConsumerKey: 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 |
consumerSecretSettingName string |
ConsumerSecretSettingName: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. |
Twitter_STATUS
(Appears on:IdentityProviders_STATUS)
The configuration settings of the Twitter provider.
Field | Description |
---|---|
enabled bool |
Enabled: |
registration TwitterRegistration_STATUS |
Registration: The configuration settings of the app registration for the Twitter provider. |
UserAssignedIdentityDetails
(Appears on:ManagedServiceIdentity)
Information about the user assigned identity for the resource
Field | Description |
---|---|
reference genruntime.ResourceReference |
UserAssignedIdentity_STATUS
(Appears on:ManagedServiceIdentity_STATUS)
User assigned identity properties
Field | Description |
---|---|
clientId string |
ClientId: The client ID of the assigned identity. |
principalId string |
PrincipalId: The principal ID of the assigned identity. |
VnetConfiguration
(Appears on:ManagedEnvironment_Spec)
Configuration properties for apps environment to join a Virtual Network
Field | Description |
---|---|
dockerBridgeCidr string |
DockerBridgeCidr: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. |
infrastructureSubnetReference genruntime.ResourceReference |
InfrastructureSubnetReference: Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. |
internal bool |
Internal: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property |
platformReservedCidr string |
PlatformReservedCidr: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. |
platformReservedDnsIP string |
PlatformReservedDnsIP: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. |
VnetConfiguration_STATUS
(Appears on:ManagedEnvironment_STATUS)
Configuration properties for apps environment to join a Virtual Network
Field | Description |
---|---|
dockerBridgeCidr string |
DockerBridgeCidr: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. |
infrastructureSubnetId string |
InfrastructureSubnetId: Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. |
internal bool |
Internal: Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property |
platformReservedCidr string |
PlatformReservedCidr: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. |
platformReservedDnsIP string |
PlatformReservedDnsIP: An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. |
Volume
(Appears on:JobTemplate, Template)
Volume definitions for the Container App.
Field | Description |
---|---|
mountOptions string |
MountOptions: Mount options used while mounting the AzureFile. Must be a comma-separated string. |
name string |
Name: Volume name. |
secrets []SecretVolumeItem |
Secrets: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. |
storageName string |
StorageName: Name of storage resource. No need to provide for EmptyDir and Secret. |
storageType Volume_StorageType |
StorageType: Storage type for the volume. If not provided, use EmptyDir. |
VolumeMount
(Appears on:BaseContainer, Container)
Volume mount for the Container App.
Field | Description |
---|---|
mountPath string |
MountPath: Path within the container at which the volume should be mounted.Must not contain ‘:’. |
subPath string |
SubPath: Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root). |
volumeName string |
VolumeName: This must match the Name of a Volume. |
VolumeMount_STATUS
(Appears on:BaseContainer_STATUS, Container_STATUS)
Volume mount for the Container App.
Field | Description |
---|---|
mountPath string |
MountPath: Path within the container at which the volume should be mounted.Must not contain ‘:’. |
subPath string |
SubPath: Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root). |
volumeName string |
VolumeName: This must match the Name of a Volume. |
Volume_STATUS
(Appears on:JobTemplate_STATUS, Template_STATUS)
Volume definitions for the Container App.
Field | Description |
---|---|
mountOptions string |
MountOptions: Mount options used while mounting the AzureFile. Must be a comma-separated string. |
name string |
Name: Volume name. |
secrets []SecretVolumeItem_STATUS |
Secrets: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. |
storageName string |
StorageName: Name of storage resource. No need to provide for EmptyDir and Secret. |
storageType Volume_StorageType_STATUS |
StorageType: Storage type for the volume. If not provided, use EmptyDir. |
Volume_StorageType
(string
alias)
(Appears on:Volume)
Value | Description |
---|---|
"AzureFile" |
|
"EmptyDir" |
|
"Secret" |
Volume_StorageType_STATUS
(string
alias)
(Appears on:Volume_STATUS)
Value | Description |
---|---|
"AzureFile" |
|
"EmptyDir" |
|
"Secret" |
WorkloadProfile
(Appears on:ManagedEnvironment_Spec)
Workload profile to scope container app execution.
Field | Description |
---|---|
maximumCount int |
MaximumCount: The maximum capacity. |
minimumCount int |
MinimumCount: The minimum capacity. |
name string |
Name: Workload profile type for the workloads to run on. |
workloadProfileType string |
WorkloadProfileType: Workload profile type for the workloads to run on. |
WorkloadProfile_STATUS
(Appears on:ManagedEnvironment_STATUS)
Workload profile to scope container app execution.
Field | Description |
---|---|
maximumCount int |
MaximumCount: The maximum capacity. |
minimumCount int |
MinimumCount: The minimum capacity. |
name string |
Name: Workload profile type for the workloads to run on. |
workloadProfileType string |
WorkloadProfileType: Workload profile type for the workloads to run on. |