app.azure.com/v1api20240301


APIVersion

Value Description
“2024-03-01”

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}

Used by: AuthConfigList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec AuthConfig_Spec
Optional
status AuthConfig_STATUS
Optional

AuthConfig_Spec

Property Description Type
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. string
Optional
encryptionSettings The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization. EncryptionSettings
Optional
globalValidation The configuration settings that determines the validation flow of users using Service Authentication/Authorization. GlobalValidation
Optional
httpSettings The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. HttpSettings
Optional
identityProviders The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. IdentityProviders
Optional
login The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. Login
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure AuthConfigOperatorSpec
Optional
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 genruntime.KnownResourceReference
Required
platform The configuration settings of the platform of ContainerApp Service Authentication/Authorization. AuthPlatform
Optional

AuthConfig_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
encryptionSettings The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization. EncryptionSettings_STATUS
Optional
globalValidation The configuration settings that determines the validation flow of users using Service Authentication/Authorization. GlobalValidation_STATUS
Optional
httpSettings The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. HttpSettings_STATUS
Optional
id Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} string
Optional
identityProviders The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. IdentityProviders_STATUS
Optional
login The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. Login_STATUS
Optional
name The name of the resource string
Optional
platform The configuration settings of the platform of ContainerApp Service Authentication/Authorization. AuthPlatform_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

AuthConfigList

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}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items AuthConfig[]
Optional

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}

Used by: ContainerAppList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec ContainerApp_Spec
Optional
status ContainerApp_STATUS
Optional

ContainerApp_Spec

Property Description Type
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. string
Optional
configuration Non versioned Container App configuration properties. Configuration
Optional
environmentReference Resource ID of environment. genruntime.ResourceReference
Optional
extendedLocation The complex type of the extended location. ExtendedLocation
Optional
identity managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ManagedServiceIdentity
Optional
location The geo-location where the resource lives string
Required
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. genruntime.ResourceReference
Optional
managedEnvironmentReference Deprecated. Resource ID of the Container App’s environment. genruntime.ResourceReference
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure ContainerAppOperatorSpec
Optional
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 genruntime.KnownResourceReference
Required
tags Resource tags. map[string]string
Optional
template Container App versioned application definition. Template
Optional
workloadProfileName Workload profile name to pin for container app execution. string
Optional

ContainerApp_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
configuration Non versioned Container App configuration properties. Configuration_STATUS
Optional
customDomainVerificationId Id used to verify domain name ownership string
Optional
environmentId Resource ID of environment. string
Optional
eventStreamEndpoint The endpoint of the eventstream of the container app. string
Optional
extendedLocation The complex type of the extended location. ExtendedLocation_STATUS
Optional
id Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} string
Optional
identity managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ManagedServiceIdentity_STATUS
Optional
latestReadyRevisionName Name of the latest ready revision of the Container App. string
Optional
latestRevisionFqdn Fully Qualified Domain Name of the latest revision of the Container App. string
Optional
latestRevisionName Name of the latest revision of the Container App. string
Optional
location The geo-location where the resource lives string
Optional
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. string
Optional
managedEnvironmentId Deprecated. Resource ID of the Container App’s environment. string
Optional
name The name of the resource string
Optional
outboundIpAddresses Outbound IP Addresses for container app. string[]
Optional
provisioningState Provisioning state of the Container App. ContainerApp_Properties_ProvisioningState_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
tags Resource tags. map[string]string
Optional
template Container App versioned application definition. Template_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional
workloadProfileName Workload profile name to pin for container app execution. string
Optional

ContainerAppList

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}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items ContainerApp[]
Optional

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}

Used by: JobList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec Job_Spec
Optional
status Job_STATUS
Optional

Job_Spec

Property Description Type
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. string
Optional
configuration Container Apps Job configuration properties. JobConfiguration
Optional
environmentReference Resource ID of environment. genruntime.ResourceReference
Optional
identity Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code. ManagedServiceIdentity
Optional
location The geo-location where the resource lives string
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure JobOperatorSpec
Optional
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 genruntime.KnownResourceReference
Required
tags Resource tags. map[string]string
Optional
template Container Apps job definition. JobTemplate
Optional
workloadProfileName Workload profile name to pin for container apps job execution. string
Optional

Job_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
configuration Container Apps Job configuration properties. JobConfiguration_STATUS
Optional
environmentId Resource ID of environment. string
Optional
eventStreamEndpoint The endpoint of the eventstream of the container apps job. string
Optional
id Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} string
Optional
identity Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code. ManagedServiceIdentity_STATUS
Optional
location The geo-location where the resource lives string
Optional
name The name of the resource string
Optional
outboundIpAddresses Outbound IP Addresses of a container apps job. string[]
Optional
provisioningState Provisioning state of the Container Apps Job. Job_Properties_ProvisioningState_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
tags Resource tags. map[string]string
Optional
template Container Apps job definition. JobTemplate_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional
workloadProfileName Workload profile name to pin for container apps job execution. string
Optional

JobList

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}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items Job[]
Optional

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}

Used by: ManagedEnvironmentList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec ManagedEnvironment_Spec
Optional
status ManagedEnvironment_STATUS
Optional

ManagedEnvironment_Spec

Property Description Type
appLogsConfiguration Cluster configuration which enables the log daemon to export app logs to configured destination. AppLogsConfiguration
Optional
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. string
Optional
customDomainConfiguration Custom domain configuration for the environment CustomDomainConfiguration
Optional
daprAIConnectionString Application Insights connection string used by Dapr to export Service to Service communication telemetry genruntime.SecretReference
Optional
daprAIInstrumentationKey Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry genruntime.SecretReference
Optional
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. string
Optional
kind Kind of the Environment. string
Optional
location The geo-location where the resource lives string
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure ManagedEnvironmentOperatorSpec
Optional
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 genruntime.KnownResourceReference
Required
peerAuthentication Peer authentication settings for the Managed Environment ManagedEnvironment_Properties_PeerAuthentication_Spec
Optional
peerTrafficConfiguration Peer traffic settings for the Managed Environment ManagedEnvironment_Properties_PeerTrafficConfiguration_Spec
Optional
tags Resource tags. map[string]string
Optional
vnetConfiguration Vnet configuration for the environment VnetConfiguration
Optional
workloadProfiles Workload profiles configured for the Managed Environment. WorkloadProfile[]
Optional
zoneRedundant Whether or not this Managed Environment is zone-redundant. bool
Optional

ManagedEnvironment_STATUS

Property Description Type
appLogsConfiguration Cluster configuration which enables the log daemon to export app logs to configured destination. AppLogsConfiguration_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
customDomainConfiguration Custom domain configuration for the environment CustomDomainConfiguration_STATUS
Optional
daprConfiguration The configuration of Dapr component. DaprConfiguration_STATUS
Optional
defaultDomain Default Domain Name for the cluster string
Optional
deploymentErrors Any errors that occurred during deployment or deployment validation string
Optional
eventStreamEndpoint The endpoint of the eventstream of the Environment. string
Optional
id Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} string
Optional
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. string
Optional
kedaConfiguration The configuration of Keda component. KedaConfiguration_STATUS
Optional
kind Kind of the Environment. string
Optional
location The geo-location where the resource lives string
Optional
name The name of the resource string
Optional
peerAuthentication Peer authentication settings for the Managed Environment ManagedEnvironment_Properties_PeerAuthentication_STATUS
Optional
peerTrafficConfiguration Peer traffic settings for the Managed Environment ManagedEnvironment_Properties_PeerTrafficConfiguration_STATUS
Optional
provisioningState Provisioning state of the Environment. ManagedEnvironment_Properties_ProvisioningState_STATUS
Optional
staticIp Static IP of the Environment string
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
tags Resource tags. map[string]string
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional
vnetConfiguration Vnet configuration for the environment VnetConfiguration_STATUS
Optional
workloadProfiles Workload profiles configured for the Managed Environment. WorkloadProfile_STATUS[]
Optional
zoneRedundant Whether or not this Managed Environment is zone-redundant. bool
Optional

ManagedEnvironmentList

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}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items ManagedEnvironment[]
Optional

AuthConfig_Spec

Used by: AuthConfig.

Property Description Type
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. string
Optional
encryptionSettings The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization. EncryptionSettings
Optional
globalValidation The configuration settings that determines the validation flow of users using Service Authentication/Authorization. GlobalValidation
Optional
httpSettings The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. HttpSettings
Optional
identityProviders The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. IdentityProviders
Optional
login The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. Login
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure AuthConfigOperatorSpec
Optional
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 genruntime.KnownResourceReference
Required
platform The configuration settings of the platform of ContainerApp Service Authentication/Authorization. AuthPlatform
Optional

AuthConfig_STATUS

Used by: AuthConfig.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
encryptionSettings The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization. EncryptionSettings_STATUS
Optional
globalValidation The configuration settings that determines the validation flow of users using Service Authentication/Authorization. GlobalValidation_STATUS
Optional
httpSettings The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. HttpSettings_STATUS
Optional
id Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} string
Optional
identityProviders The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. IdentityProviders_STATUS
Optional
login The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. Login_STATUS
Optional
name The name of the resource string
Optional
platform The configuration settings of the platform of ContainerApp Service Authentication/Authorization. AuthPlatform_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

ContainerApp_Spec

Used by: ContainerApp.

Property Description Type
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. string
Optional
configuration Non versioned Container App configuration properties. Configuration
Optional
environmentReference Resource ID of environment. genruntime.ResourceReference
Optional
extendedLocation The complex type of the extended location. ExtendedLocation
Optional
identity managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ManagedServiceIdentity
Optional
location The geo-location where the resource lives string
Required
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. genruntime.ResourceReference
Optional
managedEnvironmentReference Deprecated. Resource ID of the Container App’s environment. genruntime.ResourceReference
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure ContainerAppOperatorSpec
Optional
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 genruntime.KnownResourceReference
Required
tags Resource tags. map[string]string
Optional
template Container App versioned application definition. Template
Optional
workloadProfileName Workload profile name to pin for container app execution. string
Optional

ContainerApp_STATUS

Container App.

Used by: ContainerApp.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
configuration Non versioned Container App configuration properties. Configuration_STATUS
Optional
customDomainVerificationId Id used to verify domain name ownership string
Optional
environmentId Resource ID of environment. string
Optional
eventStreamEndpoint The endpoint of the eventstream of the container app. string
Optional
extendedLocation The complex type of the extended location. ExtendedLocation_STATUS
Optional
id Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} string
Optional
identity managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ManagedServiceIdentity_STATUS
Optional
latestReadyRevisionName Name of the latest ready revision of the Container App. string
Optional
latestRevisionFqdn Fully Qualified Domain Name of the latest revision of the Container App. string
Optional
latestRevisionName Name of the latest revision of the Container App. string
Optional
location The geo-location where the resource lives string
Optional
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. string
Optional
managedEnvironmentId Deprecated. Resource ID of the Container App’s environment. string
Optional
name The name of the resource string
Optional
outboundIpAddresses Outbound IP Addresses for container app. string[]
Optional
provisioningState Provisioning state of the Container App. ContainerApp_Properties_ProvisioningState_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
tags Resource tags. map[string]string
Optional
template Container App versioned application definition. Template_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional
workloadProfileName Workload profile name to pin for container app execution. string
Optional

Job_Spec

Used by: Job.

Property Description Type
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. string
Optional
configuration Container Apps Job configuration properties. JobConfiguration
Optional
environmentReference Resource ID of environment. genruntime.ResourceReference
Optional
identity Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code. ManagedServiceIdentity
Optional
location The geo-location where the resource lives string
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure JobOperatorSpec
Optional
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 genruntime.KnownResourceReference
Required
tags Resource tags. map[string]string
Optional
template Container Apps job definition. JobTemplate
Optional
workloadProfileName Workload profile name to pin for container apps job execution. string
Optional

Job_STATUS

Container App Job

Used by: Job.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
configuration Container Apps Job configuration properties. JobConfiguration_STATUS
Optional
environmentId Resource ID of environment. string
Optional
eventStreamEndpoint The endpoint of the eventstream of the container apps job. string
Optional
id Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} string
Optional
identity Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code. ManagedServiceIdentity_STATUS
Optional
location The geo-location where the resource lives string
Optional
name The name of the resource string
Optional
outboundIpAddresses Outbound IP Addresses of a container apps job. string[]
Optional
provisioningState Provisioning state of the Container Apps Job. Job_Properties_ProvisioningState_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
tags Resource tags. map[string]string
Optional
template Container Apps job definition. JobTemplate_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional
workloadProfileName Workload profile name to pin for container apps job execution. string
Optional

ManagedEnvironment_Spec

Used by: ManagedEnvironment.

Property Description Type
appLogsConfiguration Cluster configuration which enables the log daemon to export app logs to configured destination. AppLogsConfiguration
Optional
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. string
Optional
customDomainConfiguration Custom domain configuration for the environment CustomDomainConfiguration
Optional
daprAIConnectionString Application Insights connection string used by Dapr to export Service to Service communication telemetry genruntime.SecretReference
Optional
daprAIInstrumentationKey Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry genruntime.SecretReference
Optional
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. string
Optional
kind Kind of the Environment. string
Optional
location The geo-location where the resource lives string
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure ManagedEnvironmentOperatorSpec
Optional
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 genruntime.KnownResourceReference
Required
peerAuthentication Peer authentication settings for the Managed Environment ManagedEnvironment_Properties_PeerAuthentication_Spec
Optional
peerTrafficConfiguration Peer traffic settings for the Managed Environment ManagedEnvironment_Properties_PeerTrafficConfiguration_Spec
Optional
tags Resource tags. map[string]string
Optional
vnetConfiguration Vnet configuration for the environment VnetConfiguration
Optional
workloadProfiles Workload profiles configured for the Managed Environment. WorkloadProfile[]
Optional
zoneRedundant Whether or not this Managed Environment is zone-redundant. bool
Optional

ManagedEnvironment_STATUS

An environment for hosting container apps

Used by: ManagedEnvironment.

Property Description Type
appLogsConfiguration Cluster configuration which enables the log daemon to export app logs to configured destination. AppLogsConfiguration_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
customDomainConfiguration Custom domain configuration for the environment CustomDomainConfiguration_STATUS
Optional
daprConfiguration The configuration of Dapr component. DaprConfiguration_STATUS
Optional
defaultDomain Default Domain Name for the cluster string
Optional
deploymentErrors Any errors that occurred during deployment or deployment validation string
Optional
eventStreamEndpoint The endpoint of the eventstream of the Environment. string
Optional
id Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} string
Optional
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. string
Optional
kedaConfiguration The configuration of Keda component. KedaConfiguration_STATUS
Optional
kind Kind of the Environment. string
Optional
location The geo-location where the resource lives string
Optional
name The name of the resource string
Optional
peerAuthentication Peer authentication settings for the Managed Environment ManagedEnvironment_Properties_PeerAuthentication_STATUS
Optional
peerTrafficConfiguration Peer traffic settings for the Managed Environment ManagedEnvironment_Properties_PeerTrafficConfiguration_STATUS
Optional
provisioningState Provisioning state of the Environment. ManagedEnvironment_Properties_ProvisioningState_STATUS
Optional
staticIp Static IP of the Environment string
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
tags Resource tags. map[string]string
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional
vnetConfiguration Vnet configuration for the environment VnetConfiguration_STATUS
Optional
workloadProfiles Workload profiles configured for the Managed Environment. WorkloadProfile_STATUS[]
Optional
zoneRedundant Whether or not this Managed Environment is zone-redundant. bool
Optional

AppLogsConfiguration

Configuration of application logs

Used by: ManagedEnvironment_Spec.

Property Description Type
destination Logs destination, can be ’log-analytics’, ‘azure-monitor’ or ’none’ string
Optional
logAnalyticsConfiguration Log Analytics configuration, must only be provided when destination is configured as ’log-analytics' LogAnalyticsConfiguration
Optional

AppLogsConfiguration_STATUS

Configuration of application logs

Used by: ManagedEnvironment_STATUS.

Property Description Type
destination Logs destination, can be ’log-analytics’, ‘azure-monitor’ or ’none’ string
Optional
logAnalyticsConfiguration Log Analytics configuration, must only be provided when destination is configured as ’log-analytics' LogAnalyticsConfiguration_STATUS
Optional

AuthConfigOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: AuthConfig_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

AuthPlatform

The configuration settings of the platform of ContainerApp Service Authentication/Authorization.

Used by: AuthConfig_Spec.

Property Description Type
enabled true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. bool
Optional
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. string
Optional

AuthPlatform_STATUS

The configuration settings of the platform of ContainerApp Service Authentication/Authorization.

Used by: AuthConfig_STATUS.

Property Description Type
enabled true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. bool
Optional
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. string
Optional

Configuration

Non versioned Container App configuration properties that define the mutable settings of a Container app

Used by: ContainerApp_Spec.

Property Description Type
activeRevisionsMode ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. Configuration_ActiveRevisionsMode
Optional
dapr Dapr configuration for the Container App. Dapr
Optional
ingress Ingress configurations. Ingress
Optional
maxInactiveRevisions Optional. Max inactive revisions a Container App can have. int
Optional
registries Collection of private container registry credentials for containers used by the Container app RegistryCredentials[]
Optional
secrets Collection of secrets used by a Container app Secret[]
Optional
service Container App to be a dev Container App Service Service
Optional

Configuration_STATUS

Non versioned Container App configuration properties that define the mutable settings of a Container app

Used by: ContainerApp_STATUS.

Property Description Type
activeRevisionsMode ActiveRevisionsMode controls how active revisions are handled for the Container app: Multiple: multiple revisions can be active.Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default. Configuration_ActiveRevisionsMode_STATUS
Optional
dapr Dapr configuration for the Container App. Dapr_STATUS
Optional
ingress Ingress configurations. Ingress_STATUS
Optional
maxInactiveRevisions Optional. Max inactive revisions a Container App can have. int
Optional
registries Collection of private container registry credentials for containers used by the Container app RegistryCredentials_STATUS[]
Optional
secrets Collection of secrets used by a Container app Secret_STATUS[]
Optional
service Container App to be a dev Container App Service Service_STATUS
Optional

ContainerApp_Properties_ProvisioningState_STATUS

Used by: ContainerApp_STATUS.

Value Description
“Canceled”
“Deleting”
“Failed”
“InProgress”
“Succeeded”

ContainerAppOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: ContainerApp_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
configMaps configures where to place operator written ConfigMaps. ContainerAppOperatorConfigMaps
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

CustomDomainConfiguration

Configuration properties for apps environment custom domain

Used by: ManagedEnvironment_Spec.

Property Description Type
certificatePassword Certificate password genruntime.SecretReference
Optional
certificateValue PFX or PEM blob genruntime.SecretReference
Optional
dnsSuffix Dns suffix for the environment domain string
Optional

CustomDomainConfiguration_STATUS

Configuration properties for apps environment custom domain

Used by: ManagedEnvironment_STATUS.

Property Description Type
customDomainVerificationId Id used to verify domain name ownership string
Optional
dnsSuffix Dns suffix for the environment domain string
Optional
expirationDate Certificate expiration date. string
Optional
subjectName Subject name of the certificate. string
Optional
thumbprint Certificate thumbprint. string
Optional

DaprConfiguration_STATUS

Configuration properties Dapr component

Used by: ManagedEnvironment_STATUS.

Property Description Type
version The version of Dapr string
Optional

EncryptionSettings

The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.

Used by: AuthConfig_Spec.

Property Description Type
containerAppAuthEncryptionSecretName The secret name which is referenced for EncryptionKey. string
Optional
containerAppAuthSigningSecretName The secret name which is referenced for SigningKey. string
Optional

EncryptionSettings_STATUS

The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.

Used by: AuthConfig_STATUS.

Property Description Type
containerAppAuthEncryptionSecretName The secret name which is referenced for EncryptionKey. string
Optional
containerAppAuthSigningSecretName The secret name which is referenced for SigningKey. string
Optional

ExtendedLocation

The complex type of the extended location.

Used by: ContainerApp_Spec.

Property Description Type
name The name of the extended location. string
Optional
type The type of the extended location. ExtendedLocationType
Optional

ExtendedLocation_STATUS

The complex type of the extended location.

Used by: ContainerApp_STATUS.

Property Description Type
name The name of the extended location. string
Optional
type The type of the extended location. ExtendedLocationType_STATUS
Optional

GlobalValidation

The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization.

Used by: AuthConfig_Spec.

Property Description Type
excludedPaths The paths for which unauthenticated flow would not be redirected to the login page. string[]
Optional
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”. string
Optional
unauthenticatedClientAction The action to take when an unauthenticated client attempts to access the app. GlobalValidation_UnauthenticatedClientAction
Optional

GlobalValidation_STATUS

The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization.

Used by: AuthConfig_STATUS.

Property Description Type
excludedPaths The paths for which unauthenticated flow would not be redirected to the login page. string[]
Optional
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”. string
Optional
unauthenticatedClientAction The action to take when an unauthenticated client attempts to access the app. GlobalValidation_UnauthenticatedClientAction_STATUS
Optional

HttpSettings

The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.

Used by: AuthConfig_Spec.

Property Description Type
forwardProxy The configuration settings of a forward proxy used to make the requests. ForwardProxy
Optional
requireHttps false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. bool
Optional
routes The configuration settings of the paths HTTP requests. HttpSettingsRoutes
Optional

HttpSettings_STATUS

The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.

Used by: AuthConfig_STATUS.

Property Description Type
forwardProxy The configuration settings of a forward proxy used to make the requests. ForwardProxy_STATUS
Optional
requireHttps false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. bool
Optional
routes The configuration settings of the paths HTTP requests. HttpSettingsRoutes_STATUS
Optional

IdentityProviders

The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.

Used by: AuthConfig_Spec.

Property Description Type
apple The configuration settings of the Apple provider. Apple
Optional
azureActiveDirectory The configuration settings of the Azure Active directory provider. AzureActiveDirectory
Optional
azureStaticWebApps The configuration settings of the Azure Static Web Apps provider. AzureStaticWebApps
Optional
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. map[string]CustomOpenIdConnectProvider
Optional
facebook The configuration settings of the Facebook provider. Facebook
Optional
gitHub The configuration settings of the GitHub provider. GitHub
Optional
google The configuration settings of the Google provider. Google
Optional
twitter The configuration settings of the Twitter provider. Twitter
Optional

IdentityProviders_STATUS

The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.

Used by: AuthConfig_STATUS.

Property Description Type
apple The configuration settings of the Apple provider. Apple_STATUS
Optional
azureActiveDirectory The configuration settings of the Azure Active directory provider. AzureActiveDirectory_STATUS
Optional
azureStaticWebApps The configuration settings of the Azure Static Web Apps provider. AzureStaticWebApps_STATUS
Optional
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. map[string]CustomOpenIdConnectProvider_STATUS
Optional
facebook The configuration settings of the Facebook provider. Facebook_STATUS
Optional
gitHub The configuration settings of the GitHub provider. GitHub_STATUS
Optional
google The configuration settings of the Google provider. Google_STATUS
Optional
twitter The configuration settings of the Twitter provider. Twitter_STATUS
Optional

Job_Properties_ProvisioningState_STATUS

Used by: Job_STATUS.

Value Description
“Canceled”
“Deleting”
“Failed”
“InProgress”
“Succeeded”

JobConfiguration

Non versioned Container Apps Job configuration properties

Used by: Job_Spec.

Property Description Type
eventTriggerConfig Trigger configuration of an event driven job. JobConfiguration_EventTriggerConfig
Optional
manualTriggerConfig Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default JobConfiguration_ManualTriggerConfig
Optional
registries Collection of private container registry credentials used by a Container apps job RegistryCredentials[]
Optional
replicaRetryLimit Maximum number of retries before failing the job. int
Optional
replicaTimeout Maximum number of seconds a replica is allowed to run. int
Required
scheduleTriggerConfig Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default JobConfiguration_ScheduleTriggerConfig
Optional
secrets Collection of secrets used by a Container Apps Job Secret[]
Optional
triggerType Trigger type of the job JobConfiguration_TriggerType
Required

JobConfiguration_STATUS

Non versioned Container Apps Job configuration properties

Used by: Job_STATUS.

Property Description Type
eventTriggerConfig Trigger configuration of an event driven job. JobConfiguration_EventTriggerConfig_STATUS
Optional
manualTriggerConfig Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default JobConfiguration_ManualTriggerConfig_STATUS
Optional
registries Collection of private container registry credentials used by a Container apps job RegistryCredentials_STATUS[]
Optional
replicaRetryLimit Maximum number of retries before failing the job. int
Optional
replicaTimeout Maximum number of seconds a replica is allowed to run. int
Optional
scheduleTriggerConfig Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default JobConfiguration_ScheduleTriggerConfig_STATUS
Optional
secrets Collection of secrets used by a Container Apps Job Secret_STATUS[]
Optional
triggerType Trigger type of the job JobConfiguration_TriggerType_STATUS
Optional

JobOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: Job_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

JobTemplate

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

Used by: Job_Spec.

Property Description Type
containers List of container definitions for the Container App. Container[]
Optional
initContainers List of specialized containers that run before app containers. BaseContainer[]
Optional
volumes List of volume definitions for the Container App. Volume[]
Optional

JobTemplate_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

Used by: Job_STATUS.

Property Description Type
containers List of container definitions for the Container App. Container_STATUS[]
Optional
initContainers List of specialized containers that run before app containers. BaseContainer_STATUS[]
Optional
volumes List of volume definitions for the Container App. Volume_STATUS[]
Optional

KedaConfiguration_STATUS

Configuration properties Keda component

Used by: ManagedEnvironment_STATUS.

Property Description Type
version The version of Keda string
Optional

Login

The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.

Used by: AuthConfig_Spec.

Property Description Type
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. string[]
Optional
cookieExpiration The configuration settings of the session cookie’s expiration. CookieExpiration
Optional
nonce The configuration settings of the nonce used in the login flow. Nonce
Optional
preserveUrlFragmentsForLogins true if the fragments from the request are preserved after the login request is made; otherwise, false. bool
Optional
routes The routes that specify the endpoints used for login and logout requests. LoginRoutes
Optional
tokenStore The configuration settings of the token store. TokenStore
Optional

Login_STATUS

The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.

Used by: AuthConfig_STATUS.

Property Description Type
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. string[]
Optional
cookieExpiration The configuration settings of the session cookie’s expiration. CookieExpiration_STATUS
Optional
nonce The configuration settings of the nonce used in the login flow. Nonce_STATUS
Optional
preserveUrlFragmentsForLogins true if the fragments from the request are preserved after the login request is made; otherwise, false. bool
Optional
routes The routes that specify the endpoints used for login and logout requests. LoginRoutes_STATUS
Optional
tokenStore The configuration settings of the token store. TokenStore_STATUS
Optional

ManagedEnvironment_Properties_PeerAuthentication_Spec

Used by: ManagedEnvironment_Spec.

Property Description Type
mtls Mutual TLS authentication settings for the Managed Environment Mtls
Optional

ManagedEnvironment_Properties_PeerAuthentication_STATUS

Used by: ManagedEnvironment_STATUS.

Property Description Type
mtls Mutual TLS authentication settings for the Managed Environment Mtls_STATUS
Optional

ManagedEnvironment_Properties_PeerTrafficConfiguration_Spec

Used by: ManagedEnvironment_Spec.

Property Description Type
encryption Peer traffic encryption settings for the Managed Environment ManagedEnvironment_Properties_PeerTrafficConfiguration_Encryption_Spec
Optional

ManagedEnvironment_Properties_PeerTrafficConfiguration_STATUS

Used by: ManagedEnvironment_STATUS.

Property Description Type
encryption Peer traffic encryption settings for the Managed Environment ManagedEnvironment_Properties_PeerTrafficConfiguration_Encryption_STATUS
Optional

ManagedEnvironment_Properties_ProvisioningState_STATUS

Used by: ManagedEnvironment_STATUS.

Value Description
“Canceled”
“Failed”
“InfrastructureSetupComplete”
“InfrastructureSetupInProgress”
“InitializationInProgress”
“ScheduledForDelete”
“Succeeded”
“UpgradeFailed”
“UpgradeRequested”
“Waiting”

ManagedEnvironmentOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: ManagedEnvironment_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

Used by: ContainerApp_Spec, and Job_Spec.

Property Description Type
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ManagedServiceIdentityType
Required
userAssignedIdentities UserAssignedIdentityDetails[]
Optional

ManagedServiceIdentity_STATUS

Managed service identity (system assigned and/or user assigned identities)

Used by: ContainerApp_STATUS, and Job_STATUS.

Property Description Type
principalId The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. string
Optional
tenantId The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. string
Optional
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ManagedServiceIdentityType_STATUS
Optional
userAssignedIdentities map[string]UserAssignedIdentity_STATUS
Optional

SystemData_STATUS

Metadata pertaining to creation and last modification of the resource.

Used by: AuthConfig_STATUS, ContainerApp_STATUS, Job_STATUS, and ManagedEnvironment_STATUS.

Property Description Type
createdAt The timestamp of resource creation (UTC). string
Optional
createdBy The identity that created the resource. string
Optional
createdByType The type of identity that created the resource. SystemData_CreatedByType_STATUS
Optional
lastModifiedAt The timestamp of resource last modification (UTC) string
Optional
lastModifiedBy The identity that last modified the resource. string
Optional
lastModifiedByType The type of identity that last modified the resource. SystemData_LastModifiedByType_STATUS
Optional

Template

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

Used by: ContainerApp_Spec.

Property Description Type
containers List of container definitions for the Container App. Container[]
Optional
initContainers List of specialized containers that run before app containers. BaseContainer[]
Optional
revisionSuffix User friendly suffix that is appended to the revision name string
Optional
scale Scaling properties for the Container App. Scale
Optional
serviceBinds List of container app services bound to the app ServiceBind[]
Optional
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. int
Optional
volumes List of volume definitions for the Container App. Volume[]
Optional

Template_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

Used by: ContainerApp_STATUS.

Property Description Type
containers List of container definitions for the Container App. Container_STATUS[]
Optional
initContainers List of specialized containers that run before app containers. BaseContainer_STATUS[]
Optional
revisionSuffix User friendly suffix that is appended to the revision name string
Optional
scale Scaling properties for the Container App. Scale_STATUS
Optional
serviceBinds List of container app services bound to the app ServiceBind_STATUS[]
Optional
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. int
Optional
volumes List of volume definitions for the Container App. Volume_STATUS[]
Optional

VnetConfiguration

Configuration properties for apps environment to join a Virtual Network

Used by: ManagedEnvironment_Spec.

Property Description Type
dockerBridgeCidr CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. string
Optional
infrastructureSubnetReference Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. genruntime.ResourceReference
Optional
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 bool
Optional
platformReservedCidr IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. string
Optional
platformReservedDnsIP An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. string
Optional

VnetConfiguration_STATUS

Configuration properties for apps environment to join a Virtual Network

Used by: ManagedEnvironment_STATUS.

Property Description Type
dockerBridgeCidr CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. string
Optional
infrastructureSubnetId Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. string
Optional
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 bool
Optional
platformReservedCidr IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. string
Optional
platformReservedDnsIP An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. string
Optional

WorkloadProfile

Workload profile to scope container app execution.

Used by: ManagedEnvironment_Spec.

Property Description Type
maximumCount The maximum capacity. int
Optional
minimumCount The minimum capacity. int
Optional
name Workload profile type for the workloads to run on. string
Required
workloadProfileType Workload profile type for the workloads to run on. string
Required

WorkloadProfile_STATUS

Workload profile to scope container app execution.

Used by: ManagedEnvironment_STATUS.

Property Description Type
maximumCount The maximum capacity. int
Optional
minimumCount The minimum capacity. int
Optional
name Workload profile type for the workloads to run on. string
Optional
workloadProfileType Workload profile type for the workloads to run on. string
Optional

Apple

The configuration settings of the Apple provider.

Used by: IdentityProviders.

Property Description Type
enabled false if the Apple provider should not be enabled despite the set registration; otherwise, true. bool
Optional
login The configuration settings of the login flow. LoginScopes
Optional
registration The configuration settings of the Apple registration. AppleRegistration
Optional

Apple_STATUS

The configuration settings of the Apple provider.

Used by: IdentityProviders_STATUS.

Property Description Type
enabled false if the Apple provider should not be enabled despite the set registration; otherwise, true. bool
Optional
login The configuration settings of the login flow. LoginScopes_STATUS
Optional
registration The configuration settings of the Apple registration. AppleRegistration_STATUS
Optional

AzureActiveDirectory

The configuration settings of the Azure Active directory provider.

Used by: IdentityProviders.

Property Description Type
enabled false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. bool
Optional
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. bool
Optional
login The configuration settings of the Azure Active Directory login flow. AzureActiveDirectoryLogin
Optional
registration The configuration settings of the Azure Active Directory app registration. AzureActiveDirectoryRegistration
Optional
validation The configuration settings of the Azure Active Directory token validation flow. AzureActiveDirectoryValidation
Optional

AzureActiveDirectory_STATUS

The configuration settings of the Azure Active directory provider.

Used by: IdentityProviders_STATUS.

Property Description Type
enabled false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. bool
Optional
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. bool
Optional
login The configuration settings of the Azure Active Directory login flow. AzureActiveDirectoryLogin_STATUS
Optional
registration The configuration settings of the Azure Active Directory app registration. AzureActiveDirectoryRegistration_STATUS
Optional
validation The configuration settings of the Azure Active Directory token validation flow. AzureActiveDirectoryValidation_STATUS
Optional

AzureStaticWebApps

The configuration settings of the Azure Static Web Apps provider.

Used by: IdentityProviders.

Property Description Type
enabled false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. bool
Optional
registration The configuration settings of the Azure Static Web Apps registration. AzureStaticWebAppsRegistration
Optional

AzureStaticWebApps_STATUS

The configuration settings of the Azure Static Web Apps provider.

Used by: IdentityProviders_STATUS.

Property Description Type
enabled false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. bool
Optional
registration The configuration settings of the Azure Static Web Apps registration. AzureStaticWebAppsRegistration_STATUS
Optional

BaseContainer

Container App base container definition.

Used by: JobTemplate, and Template.

Property Description Type
args Container start command arguments. string[]
Optional
command Container start command. string[]
Optional
env Container environment variables. EnvironmentVar[]
Optional
image Container image tag. string
Optional
name Custom container name. string
Optional
resources Container resource requirements. ContainerResources
Optional
volumeMounts Container volume mounts. VolumeMount[]
Optional

BaseContainer_STATUS

Container App base container definition.

Used by: JobTemplate_STATUS, and Template_STATUS.

Property Description Type
args Container start command arguments. string[]
Optional
command Container start command. string[]
Optional
env Container environment variables. EnvironmentVar_STATUS[]
Optional
image Container image tag. string
Optional
name Custom container name. string
Optional
resources Container resource requirements. ContainerResources_STATUS
Optional
volumeMounts Container volume mounts. VolumeMount_STATUS[]
Optional

Configuration_ActiveRevisionsMode

Used by: Configuration.

Value Description
“Multiple”
“Single”

Configuration_ActiveRevisionsMode_STATUS

Used by: Configuration_STATUS.

Value Description
“Multiple”
“Single”

Container

Container App container definition

Used by: JobTemplate, and Template.

Property Description Type
args Container start command arguments. string[]
Optional
command Container start command. string[]
Optional
env Container environment variables. EnvironmentVar[]
Optional
image Container image tag. string
Optional
name Custom container name. string
Optional
probes List of probes for the container. ContainerAppProbe[]
Optional
resources Container resource requirements. ContainerResources
Optional
volumeMounts Container volume mounts. VolumeMount[]
Optional

Container_STATUS

Container App container definition

Used by: JobTemplate_STATUS, and Template_STATUS.

Property Description Type
args Container start command arguments. string[]
Optional
command Container start command. string[]
Optional
env Container environment variables. EnvironmentVar_STATUS[]
Optional
image Container image tag. string
Optional
name Custom container name. string
Optional
probes List of probes for the container. ContainerAppProbe_STATUS[]
Optional
resources Container resource requirements. ContainerResources_STATUS
Optional
volumeMounts Container volume mounts. VolumeMount_STATUS[]
Optional

ContainerAppOperatorConfigMaps

Used by: ContainerAppOperatorSpec.

Property Description Type
eventStreamEndpoint indicates where the EventStreamEndpoint config map should be placed. If omitted, no config map will be created. genruntime.ConfigMapDestination
Optional
fqdn indicates where the Fqdn config map should be placed. If omitted, no config map will be created. genruntime.ConfigMapDestination
Optional

CookieExpiration

The configuration settings of the session cookie’s expiration.

Used by: Login.

Property Description Type
convention The convention used when determining the session cookie’s expiration. CookieExpiration_Convention
Optional
timeToExpiration The time after the request is made when the session cookie should expire. string
Optional

CookieExpiration_STATUS

The configuration settings of the session cookie’s expiration.

Used by: Login_STATUS.

Property Description Type
convention The convention used when determining the session cookie’s expiration. CookieExpiration_Convention_STATUS
Optional
timeToExpiration The time after the request is made when the session cookie should expire. string
Optional

CustomOpenIdConnectProvider

The configuration settings of the custom Open ID Connect provider.

Used by: IdentityProviders.

Property Description Type
enabled false if the custom Open ID provider provider should not be enabled; otherwise, true. bool
Optional
login The configuration settings of the login flow of the custom Open ID Connect provider. OpenIdConnectLogin
Optional
registration The configuration settings of the app registration for the custom Open ID Connect provider. OpenIdConnectRegistration
Optional

CustomOpenIdConnectProvider_STATUS

The configuration settings of the custom Open ID Connect provider.

Used by: IdentityProviders_STATUS.

Property Description Type
enabled false if the custom Open ID provider provider should not be enabled; otherwise, true. bool
Optional
login The configuration settings of the login flow of the custom Open ID Connect provider. OpenIdConnectLogin_STATUS
Optional
registration The configuration settings of the app registration for the custom Open ID Connect provider. OpenIdConnectRegistration_STATUS
Optional

Dapr

Container App Dapr configuration.

Used by: Configuration.

Property Description Type
appId Dapr application identifier string
Optional
appPort Tells Dapr which port your application is listening on int
Optional
appProtocol Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http Dapr_AppProtocol
Optional
enableApiLogging Enables API logging for the Dapr sidecar bool
Optional
enabled Boolean indicating if the Dapr side car is enabled bool
Optional
httpMaxRequestSize Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. int
Optional
httpReadBufferSize Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. int
Optional
logLevel Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. Dapr_LogLevel
Optional

Dapr_STATUS

Container App Dapr configuration.

Used by: Configuration_STATUS.

Property Description Type
appId Dapr application identifier string
Optional
appPort Tells Dapr which port your application is listening on int
Optional
appProtocol Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http Dapr_AppProtocol_STATUS
Optional
enableApiLogging Enables API logging for the Dapr sidecar bool
Optional
enabled Boolean indicating if the Dapr side car is enabled bool
Optional
httpMaxRequestSize Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. int
Optional
httpReadBufferSize Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. int
Optional
logLevel Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. Dapr_LogLevel_STATUS
Optional

ExtendedLocationType

The type of extendedLocation.

Used by: ExtendedLocation.

Value Description
“CustomLocation”

ExtendedLocationType_STATUS

The type of extendedLocation.

Used by: ExtendedLocation_STATUS.

Value Description
“CustomLocation”

Facebook

The configuration settings of the Facebook provider.

Used by: IdentityProviders.

Property Description Type
enabled false if the Facebook provider should not be enabled despite the set registration; otherwise, true. bool
Optional
graphApiVersion The version of the Facebook api to be used while logging in. string
Optional
login The configuration settings of the login flow. LoginScopes
Optional
registration The configuration settings of the app registration for the Facebook provider. AppRegistration
Optional

Facebook_STATUS

The configuration settings of the Facebook provider.

Used by: IdentityProviders_STATUS.

Property Description Type
enabled false if the Facebook provider should not be enabled despite the set registration; otherwise, true. bool
Optional
graphApiVersion The version of the Facebook api to be used while logging in. string
Optional
login The configuration settings of the login flow. LoginScopes_STATUS
Optional
registration The configuration settings of the app registration for the Facebook provider. AppRegistration_STATUS
Optional

ForwardProxy

The configuration settings of a forward proxy used to make the requests.

Used by: HttpSettings.

Property Description Type
convention The convention used to determine the url of the request made. ForwardProxy_Convention
Optional
customHostHeaderName The name of the header containing the host of the request. string
Optional
customProtoHeaderName The name of the header containing the scheme of the request. string
Optional

ForwardProxy_STATUS

The configuration settings of a forward proxy used to make the requests.

Used by: HttpSettings_STATUS.

Property Description Type
convention The convention used to determine the url of the request made. ForwardProxy_Convention_STATUS
Optional
customHostHeaderName The name of the header containing the host of the request. string
Optional
customProtoHeaderName The name of the header containing the scheme of the request. string
Optional

GitHub

The configuration settings of the GitHub provider.

Used by: IdentityProviders.

Property Description Type
enabled false if the GitHub provider should not be enabled despite the set registration; otherwise, true. bool
Optional
login The configuration settings of the login flow. LoginScopes
Optional
registration The configuration settings of the app registration for the GitHub provider. ClientRegistration
Optional

GitHub_STATUS

The configuration settings of the GitHub provider.

Used by: IdentityProviders_STATUS.

Property Description Type
enabled false if the GitHub provider should not be enabled despite the set registration; otherwise, true. bool
Optional
login The configuration settings of the login flow. LoginScopes_STATUS
Optional
registration The configuration settings of the app registration for the GitHub provider. ClientRegistration_STATUS
Optional

GlobalValidation_UnauthenticatedClientAction

Used by: GlobalValidation.

Value Description
“AllowAnonymous”
“RedirectToLoginPage”
“Return401”
“Return403”

GlobalValidation_UnauthenticatedClientAction_STATUS

Used by: GlobalValidation_STATUS.

Value Description
“AllowAnonymous”
“RedirectToLoginPage”
“Return401”
“Return403”

Google

The configuration settings of the Google provider.

Used by: IdentityProviders.

Property Description Type
enabled false if the Google provider should not be enabled despite the set registration; otherwise, true. bool
Optional
login The configuration settings of the login flow. LoginScopes
Optional
registration The configuration settings of the app registration for the Google provider. ClientRegistration
Optional
validation The configuration settings of the Azure Active Directory token validation flow. AllowedAudiencesValidation
Optional

Google_STATUS

The configuration settings of the Google provider.

Used by: IdentityProviders_STATUS.

Property Description Type
enabled false if the Google provider should not be enabled despite the set registration; otherwise, true. bool
Optional
login The configuration settings of the login flow. LoginScopes_STATUS
Optional
registration The configuration settings of the app registration for the Google provider. ClientRegistration_STATUS
Optional
validation The configuration settings of the Azure Active Directory token validation flow. AllowedAudiencesValidation_STATUS
Optional

HttpSettingsRoutes

The configuration settings of the paths HTTP requests.

Used by: HttpSettings.

Property Description Type
apiPrefix The prefix that should precede all the authentication/authorization paths. string
Optional

HttpSettingsRoutes_STATUS

The configuration settings of the paths HTTP requests.

Used by: HttpSettings_STATUS.

Property Description Type
apiPrefix The prefix that should precede all the authentication/authorization paths. string
Optional

Ingress

Container App Ingress configuration.

Used by: Configuration.

Property Description Type
additionalPortMappings Settings to expose additional ports on container app IngressPortMapping[]
Optional
allowInsecure Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections bool
Optional
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. Ingress_ClientCertificateMode
Optional
corsPolicy CORS policy for container app CorsPolicy
Optional
customDomains custom domain bindings for Container Apps’ hostnames. CustomDomain[]
Optional
exposedPort Exposed Port in containers for TCP traffic from ingress int
Optional
external Bool indicating if app exposes an external http endpoint bool
Optional
ipSecurityRestrictions Rules to restrict incoming IP address. IpSecurityRestrictionRule[]
Optional
stickySessions Sticky Sessions for Single Revision Mode Ingress_StickySessions
Optional
targetPort Target Port in containers for traffic from ingress int
Optional
traffic Traffic weights for app’s revisions TrafficWeight[]
Optional
transport Ingress transport protocol Ingress_Transport
Optional

Ingress_STATUS

Container App Ingress configuration.

Used by: Configuration_STATUS.

Property Description Type
additionalPortMappings Settings to expose additional ports on container app IngressPortMapping_STATUS[]
Optional
allowInsecure Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections bool
Optional
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. Ingress_ClientCertificateMode_STATUS
Optional
corsPolicy CORS policy for container app CorsPolicy_STATUS
Optional
customDomains custom domain bindings for Container Apps’ hostnames. CustomDomain_STATUS[]
Optional
exposedPort Exposed Port in containers for TCP traffic from ingress int
Optional
external Bool indicating if app exposes an external http endpoint bool
Optional
fqdn Hostname. string
Optional
ipSecurityRestrictions Rules to restrict incoming IP address. IpSecurityRestrictionRule_STATUS[]
Optional
stickySessions Sticky Sessions for Single Revision Mode Ingress_StickySessions_STATUS
Optional
targetPort Target Port in containers for traffic from ingress int
Optional
traffic Traffic weights for app’s revisions TrafficWeight_STATUS[]
Optional
transport Ingress transport protocol Ingress_Transport_STATUS
Optional

JobConfiguration_EventTriggerConfig

Used by: JobConfiguration.

Property Description Type
parallelism int
Optional
replicaCompletionCount int
Optional
scale Scaling configurations for event driven jobs. JobScale
Optional

JobConfiguration_EventTriggerConfig_STATUS

Used by: JobConfiguration_STATUS.

Property Description Type
parallelism int
Optional
replicaCompletionCount int
Optional
scale Scaling configurations for event driven jobs. JobScale_STATUS
Optional

JobConfiguration_ManualTriggerConfig

Used by: JobConfiguration.

Property Description Type
parallelism int
Optional
replicaCompletionCount int
Optional

JobConfiguration_ManualTriggerConfig_STATUS

Used by: JobConfiguration_STATUS.

Property Description Type
parallelism int
Optional
replicaCompletionCount int
Optional

JobConfiguration_ScheduleTriggerConfig

Used by: JobConfiguration.

Property Description Type
cronExpression Cron formatted repeating schedule ("* * * * *") of a Cron Job. string
Required
parallelism int
Optional
replicaCompletionCount int
Optional

JobConfiguration_ScheduleTriggerConfig_STATUS

Used by: JobConfiguration_STATUS.

Property Description Type
cronExpression Cron formatted repeating schedule ("* * * * *") of a Cron Job. string
Optional
parallelism int
Optional
replicaCompletionCount int
Optional

JobConfiguration_TriggerType

Used by: JobConfiguration.

Value Description
“Event”
“Manual”
“Schedule”

JobConfiguration_TriggerType_STATUS

Used by: JobConfiguration_STATUS.

Value Description
“Event”
“Manual”
“Schedule”

LogAnalyticsConfiguration

Log Analytics configuration, must only be provided when destination is configured as ’log-analytics'

Used by: AppLogsConfiguration.

Property Description Type
customerId Log analytics customer id string
Optional
sharedKey Log analytics customer key genruntime.SecretReference
Optional

LogAnalyticsConfiguration_STATUS

Log Analytics configuration, must only be provided when destination is configured as ’log-analytics'

Used by: AppLogsConfiguration_STATUS.

Property Description Type
customerId Log analytics customer id string
Optional

LoginRoutes

The routes that specify the endpoints used for login and logout requests.

Used by: Login.

Property Description Type
logoutEndpoint The endpoint at which a logout request should be made. string
Optional

LoginRoutes_STATUS

The routes that specify the endpoints used for login and logout requests.

Used by: Login_STATUS.

Property Description Type
logoutEndpoint The endpoint at which a logout request should be made. string
Optional

ManagedEnvironment_Properties_PeerTrafficConfiguration_Encryption_Spec

Used by: ManagedEnvironment_Properties_PeerTrafficConfiguration_Spec.

Property Description Type
enabled Boolean indicating whether the peer traffic encryption is enabled bool
Optional

ManagedEnvironment_Properties_PeerTrafficConfiguration_Encryption_STATUS

Used by: ManagedEnvironment_Properties_PeerTrafficConfiguration_STATUS.

Property Description Type
enabled Boolean indicating whether the peer traffic encryption is enabled bool
Optional

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Used by: ManagedServiceIdentity.

Value Description
“None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”

ManagedServiceIdentityType_STATUS

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Used by: ManagedServiceIdentity_STATUS.

Value Description
“None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”

Mtls

Configuration properties for mutual TLS authentication

Used by: ManagedEnvironment_Properties_PeerAuthentication_Spec.

Property Description Type
enabled Boolean indicating whether the mutual TLS authentication is enabled bool
Optional

Mtls_STATUS

Configuration properties for mutual TLS authentication

Used by: ManagedEnvironment_Properties_PeerAuthentication_STATUS.

Property Description Type
enabled Boolean indicating whether the mutual TLS authentication is enabled bool
Optional

Nonce

The configuration settings of the nonce used in the login flow.

Used by: Login.

Property Description Type
nonceExpirationInterval The time after the request is made when the nonce should expire. string
Optional
validateNonce false if the nonce should not be validated while completing the login flow; otherwise, true. bool
Optional

Nonce_STATUS

The configuration settings of the nonce used in the login flow.

Used by: Login_STATUS.

Property Description Type
nonceExpirationInterval The time after the request is made when the nonce should expire. string
Optional
validateNonce false if the nonce should not be validated while completing the login flow; otherwise, true. bool
Optional

RegistryCredentials

Container App Private Registry

Used by: Configuration, and JobConfiguration.

Property Description Type
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’ genruntime.ResourceReference
Optional
passwordSecretRef The name of the Secret that contains the registry login password string
Optional
server Container Registry Server string
Optional
username Container Registry Username string
Optional

RegistryCredentials_STATUS

Container App Private Registry

Used by: Configuration_STATUS, and JobConfiguration_STATUS.

Property Description Type
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’ string
Optional
passwordSecretRef The name of the Secret that contains the registry login password string
Optional
server Container Registry Server string
Optional
username Container Registry Username string
Optional

Scale

Container App scaling configurations.

Used by: Template.

Property Description Type
maxReplicas Optional. Maximum number of container replicas. Defaults to 10 if not set. int
Optional
minReplicas Optional. Minimum number of container replicas. int
Optional
rules Scaling rules. ScaleRule[]
Optional

Scale_STATUS

Container App scaling configurations.

Used by: Template_STATUS.

Property Description Type
maxReplicas Optional. Maximum number of container replicas. Defaults to 10 if not set. int
Optional
minReplicas Optional. Minimum number of container replicas. int
Optional
rules Scaling rules. ScaleRule_STATUS[]
Optional

Secret

Secret definition.

Used by: Configuration, and JobConfiguration.

Property Description Type
identityReference Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. genruntime.ResourceReference
Optional
keyVaultUrl Azure Key Vault URL pointing to the secret referenced by the container app. string
Optional
name Secret Name. string
Optional
value Secret Value. genruntime.SecretReference
Optional

Secret_STATUS

Secret definition.

Used by: Configuration_STATUS, and JobConfiguration_STATUS.

Property Description Type
identity Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. string
Optional
keyVaultUrl Azure Key Vault URL pointing to the secret referenced by the container app. string
Optional
name Secret Name. string
Optional

Service

Container App to be a dev service

Used by: Configuration.

Property Description Type
type Dev ContainerApp service type string
Required

Service_STATUS

Container App to be a dev service

Used by: Configuration_STATUS.

Property Description Type
type Dev ContainerApp service type string
Optional

ServiceBind

Configuration to bind a ContainerApp to a dev ContainerApp Service

Used by: Template.

Property Description Type
name Name of the service bind string
Optional
serviceReference Resource id of the target service genruntime.ResourceReference
Optional

ServiceBind_STATUS

Configuration to bind a ContainerApp to a dev ContainerApp Service

Used by: Template_STATUS.

Property Description Type
name Name of the service bind string
Optional
serviceId Resource id of the target service string
Optional

SystemData_CreatedByType_STATUS

Used by: SystemData_STATUS.

Value Description
“Application”
“Key”
“ManagedIdentity”
“User”

SystemData_LastModifiedByType_STATUS

Used by: SystemData_STATUS.

Value Description
“Application”
“Key”
“ManagedIdentity”
“User”

TokenStore

The configuration settings of the token store.

Used by: Login.

Property Description Type
azureBlobStorage The configuration settings of the storage of the tokens if blob storage is used. BlobStorageTokenStore
Optional
enabled true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. bool
Optional
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. float64
Optional

TokenStore_STATUS

The configuration settings of the token store.

Used by: Login_STATUS.

Property Description Type
azureBlobStorage The configuration settings of the storage of the tokens if blob storage is used. BlobStorageTokenStore_STATUS
Optional
enabled true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. bool
Optional
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. float64
Optional

Twitter

The configuration settings of the Twitter provider.

Used by: IdentityProviders.

Property Description Type
enabled false if the Twitter provider should not be enabled despite the set registration; otherwise, true. bool
Optional
registration The configuration settings of the app registration for the Twitter provider. TwitterRegistration
Optional

Twitter_STATUS

The configuration settings of the Twitter provider.

Used by: IdentityProviders_STATUS.

Property Description Type
enabled false if the Twitter provider should not be enabled despite the set registration; otherwise, true. bool
Optional
registration The configuration settings of the app registration for the Twitter provider. TwitterRegistration_STATUS
Optional

UserAssignedIdentity_STATUS

User assigned identity properties

Used by: ManagedServiceIdentity_STATUS.

Property Description Type
clientId The client ID of the assigned identity. string
Optional
principalId The principal ID of the assigned identity. string
Optional

UserAssignedIdentityDetails

Information about the user assigned identity for the resource

Used by: ManagedServiceIdentity.

Property Description Type
reference genruntime.ResourceReference
Optional

Volume

Volume definitions for the Container App.

Used by: JobTemplate, and Template.

Property Description Type
mountOptions Mount options used while mounting the AzureFile. Must be a comma-separated string. string
Optional
name Volume name. string
Optional
secrets List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. SecretVolumeItem[]
Optional
storageName Name of storage resource. No need to provide for EmptyDir and Secret. string
Optional
storageType Storage type for the volume. If not provided, use EmptyDir. Volume_StorageType
Optional

Volume_STATUS

Volume definitions for the Container App.

Used by: JobTemplate_STATUS, and Template_STATUS.

Property Description Type
mountOptions Mount options used while mounting the AzureFile. Must be a comma-separated string. string
Optional
name Volume name. string
Optional
secrets List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. SecretVolumeItem_STATUS[]
Optional
storageName Name of storage resource. No need to provide for EmptyDir and Secret. string
Optional
storageType Storage type for the volume. If not provided, use EmptyDir. Volume_StorageType_STATUS
Optional

AllowedAudiencesValidation

The configuration settings of the Allowed Audiences validation flow.

Used by: Google.

Property Description Type
allowedAudiences The configuration settings of the allowed list of audiences from which to validate the JWT token. string[]
Optional

AllowedAudiencesValidation_STATUS

The configuration settings of the Allowed Audiences validation flow.

Used by: Google_STATUS.

Property Description Type
allowedAudiences The configuration settings of the allowed list of audiences from which to validate the JWT token. string[]
Optional

AppleRegistration

The configuration settings of the registration for the Apple provider

Used by: Apple.

Property Description Type
clientId The Client ID of the app used for login. string
Optional
clientSecretSettingName The app setting name that contains the client secret. string
Optional

AppleRegistration_STATUS

The configuration settings of the registration for the Apple provider

Used by: Apple_STATUS.

Property Description Type
clientId The Client ID of the app used for login. string
Optional
clientSecretSettingName The app setting name that contains the client secret. string
Optional

AppRegistration

The configuration settings of the app registration for providers that have app ids and app secrets

Used by: Facebook.

Property Description Type
appId The App ID of the app used for login. string
Optional
appSecretSettingName The app setting name that contains the app secret. string
Optional

AppRegistration_STATUS

The configuration settings of the app registration for providers that have app ids and app secrets

Used by: Facebook_STATUS.

Property Description Type
appId The App ID of the app used for login. string
Optional
appSecretSettingName The app setting name that contains the app secret. string
Optional

AzureActiveDirectoryLogin

The configuration settings of the Azure Active Directory login flow.

Used by: AzureActiveDirectory.

Property Description Type
disableWWWAuthenticate true if the www-authenticate provider should be omitted from the request; otherwise, false. bool
Optional
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”. string[]
Optional

AzureActiveDirectoryLogin_STATUS

The configuration settings of the Azure Active Directory login flow.

Used by: AzureActiveDirectory_STATUS.

Property Description Type
disableWWWAuthenticate true if the www-authenticate provider should be omitted from the request; otherwise, false. bool
Optional
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”. string[]
Optional

AzureActiveDirectoryRegistration

The configuration settings of the Azure Active Directory app registration.

Used by: AzureActiveDirectory.

Property Description Type
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 string
Optional
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. string
Optional
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. string
Optional
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. string
Optional
clientSecretSettingName The app setting name that contains the client secret of the relying party application. string
Optional
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 string
Optional

AzureActiveDirectoryRegistration_STATUS

The configuration settings of the Azure Active Directory app registration.

Used by: AzureActiveDirectory_STATUS.

Property Description Type
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 string
Optional
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. string
Optional
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. string
Optional
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. string
Optional
clientSecretSettingName The app setting name that contains the client secret of the relying party application. string
Optional
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 string
Optional

AzureActiveDirectoryValidation

The configuration settings of the Azure Active Directory token validation flow.

Used by: AzureActiveDirectory.

Property Description Type
allowedAudiences The list of audiences that can make successful authentication/authorization requests. string[]
Optional
defaultAuthorizationPolicy The configuration settings of the default authorization policy. DefaultAuthorizationPolicy
Optional
jwtClaimChecks The configuration settings of the checks that should be made while validating the JWT Claims. JwtClaimChecks
Optional

AzureActiveDirectoryValidation_STATUS

The configuration settings of the Azure Active Directory token validation flow.

Used by: AzureActiveDirectory_STATUS.

Property Description Type
allowedAudiences The list of audiences that can make successful authentication/authorization requests. string[]
Optional
defaultAuthorizationPolicy The configuration settings of the default authorization policy. DefaultAuthorizationPolicy_STATUS
Optional
jwtClaimChecks The configuration settings of the checks that should be made while validating the JWT Claims. JwtClaimChecks_STATUS
Optional

AzureStaticWebAppsRegistration

The configuration settings of the registration for the Azure Static Web Apps provider

Used by: AzureStaticWebApps.

Property Description Type
clientId The Client ID of the app used for login. string
Optional

AzureStaticWebAppsRegistration_STATUS

The configuration settings of the registration for the Azure Static Web Apps provider

Used by: AzureStaticWebApps_STATUS.

Property Description Type
clientId The Client ID of the app used for login. string
Optional

BlobStorageTokenStore

The configuration settings of the storage of the tokens if blob storage is used.

Used by: TokenStore.

Property Description Type
sasUrlSettingName The name of the app secrets containing the SAS URL of the blob storage containing the tokens. string
Required

BlobStorageTokenStore_STATUS

The configuration settings of the storage of the tokens if blob storage is used.

Used by: TokenStore_STATUS.

Property Description Type
sasUrlSettingName The name of the app secrets containing the SAS URL of the blob storage containing the tokens. string
Optional

ClientRegistration

The configuration settings of the app registration for providers that have client ids and client secrets

Used by: GitHub, and Google.

Property Description Type
clientId The Client ID of the app used for login. string
Optional
clientSecretSettingName The app setting name that contains the client secret. string
Optional

ClientRegistration_STATUS

The configuration settings of the app registration for providers that have client ids and client secrets

Used by: GitHub_STATUS, and Google_STATUS.

Property Description Type
clientId The Client ID of the app used for login. string
Optional
clientSecretSettingName The app setting name that contains the client secret. string
Optional

ContainerAppProbe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Used by: Container.

Property Description Type
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. int
Optional
httpGet HTTPGet specifies the http request to perform. ContainerAppProbe_HttpGet
Optional
initialDelaySeconds Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. int
Optional
periodSeconds How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. int
Optional
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. int
Optional
tcpSocket TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ContainerAppProbe_TcpSocket
Optional
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) int
Optional
timeoutSeconds Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. int
Optional
type The type of probe. ContainerAppProbe_Type
Optional

ContainerAppProbe_STATUS

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Used by: Container_STATUS.

Property Description Type
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. int
Optional
httpGet HTTPGet specifies the http request to perform. ContainerAppProbe_HttpGet_STATUS
Optional
initialDelaySeconds Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. int
Optional
periodSeconds How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. int
Optional
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. int
Optional
tcpSocket TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. ContainerAppProbe_TcpSocket_STATUS
Optional
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) int
Optional
timeoutSeconds Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. int
Optional
type The type of probe. ContainerAppProbe_Type_STATUS
Optional

ContainerResources

Container App container resource requirements.

Used by: BaseContainer, and Container.

Property Description Type
cpu Required CPU in cores, e.g. 0.5 float64
Optional
memory Required memory, e.g. “250Mb” string
Optional

ContainerResources_STATUS

Container App container resource requirements.

Used by: BaseContainer_STATUS, and Container_STATUS.

Property Description Type
cpu Required CPU in cores, e.g. 0.5 float64
Optional
ephemeralStorage Ephemeral Storage, e.g. “1Gi” string
Optional
memory Required memory, e.g. “250Mb” string
Optional

CookieExpiration_Convention

Used by: CookieExpiration.

Value Description
“FixedTime”
“IdentityProviderDerived”

CookieExpiration_Convention_STATUS

Used by: CookieExpiration_STATUS.

Value Description
“FixedTime”
“IdentityProviderDerived”

CorsPolicy

Cross-Origin-Resource-Sharing policy

Used by: Ingress.

Property Description Type
allowCredentials Specifies whether the resource allows credentials bool
Optional
allowedHeaders Specifies the content for the access-control-allow-headers header string[]
Optional
allowedMethods Specifies the content for the access-control-allow-methods header string[]
Optional
allowedOrigins Specifies the content for the access-control-allow-origins header string[]
Required
exposeHeaders Specifies the content for the access-control-expose-headers header string[]
Optional
maxAge Specifies the content for the access-control-max-age header int
Optional

CorsPolicy_STATUS

Cross-Origin-Resource-Sharing policy

Used by: Ingress_STATUS.

Property Description Type
allowCredentials Specifies whether the resource allows credentials bool
Optional
allowedHeaders Specifies the content for the access-control-allow-headers header string[]
Optional
allowedMethods Specifies the content for the access-control-allow-methods header string[]
Optional
allowedOrigins Specifies the content for the access-control-allow-origins header string[]
Optional
exposeHeaders Specifies the content for the access-control-expose-headers header string[]
Optional
maxAge Specifies the content for the access-control-max-age header int
Optional

CustomDomain

Custom Domain of a Container App

Used by: Ingress.

Property Description Type
bindingType Custom Domain binding type. CustomDomain_BindingType
Optional
certificateReference Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. genruntime.ResourceReference
Optional
name Hostname. string
Required

CustomDomain_STATUS

Custom Domain of a Container App

Used by: Ingress_STATUS.

Property Description Type
bindingType Custom Domain binding type. CustomDomain_BindingType_STATUS
Optional
certificateId Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. string
Optional
name Hostname. string
Optional

Dapr_AppProtocol

Used by: Dapr.

Value Description
“grpc”
“http”

Dapr_AppProtocol_STATUS

Used by: Dapr_STATUS.

Value Description
“grpc”
“http”

Dapr_LogLevel

Used by: Dapr.

Value Description
“debug”
“error”
“info”
“warn”

Dapr_LogLevel_STATUS

Used by: Dapr_STATUS.

Value Description
“debug”
“error”
“info”
“warn”

EnvironmentVar

Container App container environment variable.

Used by: BaseContainer, and Container.

Property Description Type
name Environment variable name. string
Optional
secretRef Name of the Container App secret from which to pull the environment variable value. string
Optional
value Non-secret environment variable value. string
Optional

EnvironmentVar_STATUS

Container App container environment variable.

Used by: BaseContainer_STATUS, and Container_STATUS.

Property Description Type
name Environment variable name. string
Optional
secretRef Name of the Container App secret from which to pull the environment variable value. string
Optional
value Non-secret environment variable value. string
Optional

ForwardProxy_Convention

Used by: ForwardProxy.

Value Description
“Custom”
“NoProxy”
“Standard”

ForwardProxy_Convention_STATUS

Used by: ForwardProxy_STATUS.

Value Description
“Custom”
“NoProxy”
“Standard”

Ingress_ClientCertificateMode

Used by: Ingress.

Value Description
“accept”
“ignore”
“require”

Ingress_ClientCertificateMode_STATUS

Used by: Ingress_STATUS.

Value Description
“accept”
“ignore”
“require”

Ingress_StickySessions

Used by: Ingress.

Property Description Type
affinity Sticky Session Affinity Ingress_StickySessions_Affinity
Optional

Ingress_StickySessions_STATUS

Used by: Ingress_STATUS.

Property Description Type
affinity Sticky Session Affinity Ingress_StickySessions_Affinity_STATUS
Optional

Ingress_Transport

Used by: Ingress.

Value Description
“auto”
“http”
“http2”
“tcp”

Ingress_Transport_STATUS

Used by: Ingress_STATUS.

Value Description
“auto”
“http”
“http2”
“tcp”

IngressPortMapping

Port mappings of container app ingress

Used by: Ingress.

Property Description Type
exposedPort Specifies the exposed port for the target port. If not specified, it defaults to target port int
Optional
external Specifies whether the app port is accessible outside of the environment bool
Required
targetPort Specifies the port user’s container listens on int
Required

IngressPortMapping_STATUS

Port mappings of container app ingress

Used by: Ingress_STATUS.

Property Description Type
exposedPort Specifies the exposed port for the target port. If not specified, it defaults to target port int
Optional
external Specifies whether the app port is accessible outside of the environment bool
Optional
targetPort Specifies the port user’s container listens on int
Optional

IpSecurityRestrictionRule

Rule to restrict incoming IP address.

Used by: Ingress.

Property Description Type
action Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny IpSecurityRestrictionRule_Action
Required
description Describe the IP restriction rule that is being sent to the container-app. This is an optional field. string
Optional
ipAddressRange CIDR notation to match incoming IP address string
Required
name Name for the IP restriction rule. string
Required

IpSecurityRestrictionRule_STATUS

Rule to restrict incoming IP address.

Used by: Ingress_STATUS.

Property Description Type
action Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny IpSecurityRestrictionRule_Action_STATUS
Optional
description Describe the IP restriction rule that is being sent to the container-app. This is an optional field. string
Optional
ipAddressRange CIDR notation to match incoming IP address string
Optional
name Name for the IP restriction rule. string
Optional

JobScale

Scaling configurations for event driven jobs.

Used by: JobConfiguration_EventTriggerConfig.

Property Description Type
maxExecutions Maximum number of job executions that are created for a trigger, default 100. int
Optional
minExecutions Minimum number of job executions that are created for a trigger, default 0 int
Optional
pollingInterval int
Optional
rules Scaling rules. JobScaleRule[]
Optional

JobScale_STATUS

Scaling configurations for event driven jobs.

Used by: JobConfiguration_EventTriggerConfig_STATUS.

Property Description Type
maxExecutions Maximum number of job executions that are created for a trigger, default 100. int
Optional
minExecutions Minimum number of job executions that are created for a trigger, default 0 int
Optional
pollingInterval int
Optional
rules Scaling rules. JobScaleRule_STATUS[]
Optional

LoginScopes

The configuration settings of the login flow, including the scopes that should be requested.

Used by: Apple, Facebook, GitHub, and Google.

Property Description Type
scopes A list of the scopes that should be requested while authenticating. string[]
Optional

LoginScopes_STATUS

The configuration settings of the login flow, including the scopes that should be requested.

Used by: Apple_STATUS, Facebook_STATUS, GitHub_STATUS, and Google_STATUS.

Property Description Type
scopes A list of the scopes that should be requested while authenticating. string[]
Optional

OpenIdConnectLogin

The configuration settings of the login flow of the custom Open ID Connect provider.

Used by: CustomOpenIdConnectProvider.

Property Description Type
nameClaimType The name of the claim that contains the users name. string
Optional
scopes A list of the scopes that should be requested while authenticating. string[]
Optional

OpenIdConnectLogin_STATUS

The configuration settings of the login flow of the custom Open ID Connect provider.

Used by: CustomOpenIdConnectProvider_STATUS.

Property Description Type
nameClaimType The name of the claim that contains the users name. string
Optional
scopes A list of the scopes that should be requested while authenticating. string[]
Optional

OpenIdConnectRegistration

The configuration settings of the app registration for the custom Open ID Connect provider.

Used by: CustomOpenIdConnectProvider.

Property Description Type
clientCredential The authentication credentials of the custom Open ID Connect provider. OpenIdConnectClientCredential
Optional
clientId The client id of the custom Open ID Connect provider. string
Optional
openIdConnectConfiguration The configuration settings of the endpoints used for the custom Open ID Connect provider. OpenIdConnectConfig
Optional

OpenIdConnectRegistration_STATUS

The configuration settings of the app registration for the custom Open ID Connect provider.

Used by: CustomOpenIdConnectProvider_STATUS.

Property Description Type
clientCredential The authentication credentials of the custom Open ID Connect provider. OpenIdConnectClientCredential_STATUS
Optional
clientId The client id of the custom Open ID Connect provider. string
Optional
openIdConnectConfiguration The configuration settings of the endpoints used for the custom Open ID Connect provider. OpenIdConnectConfig_STATUS
Optional

ScaleRule

Container App container scaling rule.

Used by: Scale.

Property Description Type
azureQueue Azure Queue based scaling. QueueScaleRule
Optional
custom Custom scale rule. CustomScaleRule
Optional
http HTTP requests based scaling. HttpScaleRule
Optional
name Scale Rule Name string
Optional
tcp Tcp requests based scaling. TcpScaleRule
Optional

ScaleRule_STATUS

Container App container scaling rule.

Used by: Scale_STATUS.

Property Description Type
azureQueue Azure Queue based scaling. QueueScaleRule_STATUS
Optional
custom Custom scale rule. CustomScaleRule_STATUS
Optional
http HTTP requests based scaling. HttpScaleRule_STATUS
Optional
name Scale Rule Name string
Optional
tcp Tcp requests based scaling. TcpScaleRule_STATUS
Optional

SecretVolumeItem

Secret to be added to volume.

Used by: Volume.

Property Description Type
path Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. string
Optional
secretRef Name of the Container App secret from which to pull the secret value. string
Optional

SecretVolumeItem_STATUS

Secret to be added to volume.

Used by: Volume_STATUS.

Property Description Type
path Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. string
Optional
secretRef Name of the Container App secret from which to pull the secret value. string
Optional

TrafficWeight

Traffic weight assigned to a revision

Used by: Ingress.

Property Description Type
label Associates a traffic label with a revision string
Optional
latestRevision Indicates that the traffic weight belongs to a latest stable revision bool
Optional
revisionName Name of a revision string
Optional
weight Traffic weight assigned to a revision int
Optional

TrafficWeight_STATUS

Traffic weight assigned to a revision

Used by: Ingress_STATUS.

Property Description Type
label Associates a traffic label with a revision string
Optional
latestRevision Indicates that the traffic weight belongs to a latest stable revision bool
Optional
revisionName Name of a revision string
Optional
weight Traffic weight assigned to a revision int
Optional

TwitterRegistration

The configuration settings of the app registration for the Twitter provider.

Used by: Twitter.

Property Description Type
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 string
Optional
consumerSecretSettingName The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. string
Optional

TwitterRegistration_STATUS

The configuration settings of the app registration for the Twitter provider.

Used by: Twitter_STATUS.

Property Description Type
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 string
Optional
consumerSecretSettingName The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. string
Optional

Volume_StorageType

Used by: Volume.

Value Description
“AzureFile”
“EmptyDir”
“Secret”

Volume_StorageType_STATUS

Used by: Volume_STATUS.

Value Description
“AzureFile”
“EmptyDir”
“Secret”

VolumeMount

Volume mount for the Container App.

Used by: BaseContainer, and Container.

Property Description Type
mountPath Path within the container at which the volume should be mounted.Must not contain ‘:’. string
Optional
subPath Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). string
Optional
volumeName This must match the Name of a Volume. string
Optional

VolumeMount_STATUS

Volume mount for the Container App.

Used by: BaseContainer_STATUS, and Container_STATUS.

Property Description Type
mountPath Path within the container at which the volume should be mounted.Must not contain ‘:’. string
Optional
subPath Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). string
Optional
volumeName This must match the Name of a Volume. string
Optional

ContainerAppProbe_HttpGet

Used by: ContainerAppProbe.

Property Description Type
host Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead. string
Optional
httpHeaders Custom headers to set in the request. HTTP allows repeated headers. ContainerAppProbe_HttpGet_HttpHeaders[]
Optional
path Path to access on the HTTP server. string
Optional
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. int
Required
scheme Scheme to use for connecting to the host. Defaults to HTTP. ContainerAppProbe_HttpGet_Scheme
Optional

ContainerAppProbe_HttpGet_STATUS

Used by: ContainerAppProbe_STATUS.

Property Description Type
host Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead. string
Optional
httpHeaders Custom headers to set in the request. HTTP allows repeated headers. ContainerAppProbe_HttpGet_HttpHeaders_STATUS[]
Optional
path Path to access on the HTTP server. string
Optional
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. int
Optional
scheme Scheme to use for connecting to the host. Defaults to HTTP. ContainerAppProbe_HttpGet_Scheme_STATUS
Optional

ContainerAppProbe_TcpSocket

Used by: ContainerAppProbe.

Property Description Type
host Optional: Host name to connect to, defaults to the pod IP. string
Optional
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. int
Required

ContainerAppProbe_TcpSocket_STATUS

Used by: ContainerAppProbe_STATUS.

Property Description Type
host Optional: Host name to connect to, defaults to the pod IP. string
Optional
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. int
Optional

ContainerAppProbe_Type

Used by: ContainerAppProbe.

Value Description
“Liveness”
“Readiness”
“Startup”

ContainerAppProbe_Type_STATUS

Used by: ContainerAppProbe_STATUS.

Value Description
“Liveness”
“Readiness”
“Startup”

CustomDomain_BindingType

Used by: CustomDomain.

Value Description
“Disabled”
“SniEnabled”

CustomDomain_BindingType_STATUS

Used by: CustomDomain_STATUS.

Value Description
“Disabled”
“SniEnabled”

CustomScaleRule

Container App container Custom scaling rule.

Used by: ScaleRule.

Property Description Type
auth Authentication secrets for the custom scale rule. ScaleRuleAuth[]
Optional
metadata Metadata properties to describe custom scale rule. map[string]string
Optional
type Type of the custom scale rule eg: azure-servicebus, redis etc. string
Optional

CustomScaleRule_STATUS

Container App container Custom scaling rule.

Used by: ScaleRule_STATUS.

Property Description Type
auth Authentication secrets for the custom scale rule. ScaleRuleAuth_STATUS[]
Optional
metadata Metadata properties to describe custom scale rule. map[string]string
Optional
type Type of the custom scale rule eg: azure-servicebus, redis etc. string
Optional

DefaultAuthorizationPolicy

The configuration settings of the Azure Active Directory default authorization policy.

Used by: AzureActiveDirectoryValidation.

Property Description Type
allowedApplications The configuration settings of the Azure Active Directory allowed applications. string[]
Optional
allowedPrincipals The configuration settings of the Azure Active Directory allowed principals. AllowedPrincipals
Optional

DefaultAuthorizationPolicy_STATUS

The configuration settings of the Azure Active Directory default authorization policy.

Used by: AzureActiveDirectoryValidation_STATUS.

Property Description Type
allowedApplications The configuration settings of the Azure Active Directory allowed applications. string[]
Optional
allowedPrincipals The configuration settings of the Azure Active Directory allowed principals. AllowedPrincipals_STATUS
Optional

HttpScaleRule

Container App container Http scaling rule.

Used by: ScaleRule.

Property Description Type
auth Authentication secrets for the custom scale rule. ScaleRuleAuth[]
Optional
metadata Metadata properties to describe http scale rule. map[string]string
Optional

HttpScaleRule_STATUS

Container App container Http scaling rule.

Used by: ScaleRule_STATUS.

Property Description Type
auth Authentication secrets for the custom scale rule. ScaleRuleAuth_STATUS[]
Optional
metadata Metadata properties to describe http scale rule. map[string]string
Optional

Ingress_StickySessions_Affinity

Used by: Ingress_StickySessions.

Value Description
“none”
“sticky”

Ingress_StickySessions_Affinity_STATUS

Used by: Ingress_StickySessions_STATUS.

Value Description
“none”
“sticky”

IpSecurityRestrictionRule_Action

Used by: IpSecurityRestrictionRule.

Value Description
“Allow”
“Deny”

IpSecurityRestrictionRule_Action_STATUS

Used by: IpSecurityRestrictionRule_STATUS.

Value Description
“Allow”
“Deny”

JobScaleRule

Scaling rule.

Used by: JobScale.

Property Description Type
auth Authentication secrets for the scale rule. ScaleRuleAuth[]
Optional
metadata Metadata properties to describe the scale rule. map[string]v1.JSON
Optional
name Scale Rule Name string
Optional
type Type of the scale rule eg: azure-servicebus, redis etc. string
Optional

JobScaleRule_STATUS

Scaling rule.

Used by: JobScale_STATUS.

Property Description Type
auth Authentication secrets for the scale rule. ScaleRuleAuth_STATUS[]
Optional
metadata Metadata properties to describe the scale rule. map[string]v1.JSON
Optional
name Scale Rule Name string
Optional
type Type of the scale rule eg: azure-servicebus, redis etc. string
Optional

JwtClaimChecks

The configuration settings of the checks that should be made while validating the JWT Claims.

Used by: AzureActiveDirectoryValidation.

Property Description Type
allowedClientApplications The list of the allowed client applications. string[]
Optional
allowedGroups The list of the allowed groups. string[]
Optional

JwtClaimChecks_STATUS

The configuration settings of the checks that should be made while validating the JWT Claims.

Used by: AzureActiveDirectoryValidation_STATUS.

Property Description Type
allowedClientApplications The list of the allowed client applications. string[]
Optional
allowedGroups The list of the allowed groups. string[]
Optional

OpenIdConnectClientCredential

The authentication client credentials of the custom Open ID Connect provider.

Used by: OpenIdConnectRegistration.

Property Description Type
clientSecretSettingName The app setting that contains the client secret for the custom Open ID Connect provider. string
Optional
method The method that should be used to authenticate the user. OpenIdConnectClientCredential_Method
Optional

OpenIdConnectClientCredential_STATUS

The authentication client credentials of the custom Open ID Connect provider.

Used by: OpenIdConnectRegistration_STATUS.

Property Description Type
clientSecretSettingName The app setting that contains the client secret for the custom Open ID Connect provider. string
Optional
method The method that should be used to authenticate the user. OpenIdConnectClientCredential_Method_STATUS
Optional

OpenIdConnectConfig

The configuration settings of the endpoints used for the custom Open ID Connect provider.

Used by: OpenIdConnectRegistration.

Property Description Type
authorizationEndpoint The endpoint to be used to make an authorization request. string
Optional
certificationUri The endpoint that provides the keys necessary to validate the token. string
Optional
issuer The endpoint that issues the token. string
Optional
tokenEndpoint The endpoint to be used to request a token. string
Optional
wellKnownOpenIdConfiguration The endpoint that contains all the configuration endpoints for the provider. string
Optional

OpenIdConnectConfig_STATUS

The configuration settings of the endpoints used for the custom Open ID Connect provider.

Used by: OpenIdConnectRegistration_STATUS.

Property Description Type
authorizationEndpoint The endpoint to be used to make an authorization request. string
Optional
certificationUri The endpoint that provides the keys necessary to validate the token. string
Optional
issuer The endpoint that issues the token. string
Optional
tokenEndpoint The endpoint to be used to request a token. string
Optional
wellKnownOpenIdConfiguration The endpoint that contains all the configuration endpoints for the provider. string
Optional

QueueScaleRule

Container App container Azure Queue based scaling rule.

Used by: ScaleRule.

Property Description Type
auth Authentication secrets for the queue scale rule. ScaleRuleAuth[]
Optional
queueLength Queue length. int
Optional
queueName Queue name. string
Optional

QueueScaleRule_STATUS

Container App container Azure Queue based scaling rule.

Used by: ScaleRule_STATUS.

Property Description Type
auth Authentication secrets for the queue scale rule. ScaleRuleAuth_STATUS[]
Optional
queueLength Queue length. int
Optional
queueName Queue name. string
Optional

TcpScaleRule

Container App container Tcp scaling rule.

Used by: ScaleRule.

Property Description Type
auth Authentication secrets for the tcp scale rule. ScaleRuleAuth[]
Optional
metadata Metadata properties to describe tcp scale rule. map[string]string
Optional

TcpScaleRule_STATUS

Container App container Tcp scaling rule.

Used by: ScaleRule_STATUS.

Property Description Type
auth Authentication secrets for the tcp scale rule. ScaleRuleAuth_STATUS[]
Optional
metadata Metadata properties to describe tcp scale rule. map[string]string
Optional

AllowedPrincipals

The configuration settings of the Azure Active Directory allowed principals.

Used by: DefaultAuthorizationPolicy.

Property Description Type
groups The list of the allowed groups. string[]
Optional
identities The list of the allowed identities. string[]
Optional

AllowedPrincipals_STATUS

The configuration settings of the Azure Active Directory allowed principals.

Used by: DefaultAuthorizationPolicy_STATUS.

Property Description Type
groups The list of the allowed groups. string[]
Optional
identities The list of the allowed identities. string[]
Optional

ContainerAppProbe_HttpGet_HttpHeaders

Used by: ContainerAppProbe_HttpGet.

Property Description Type
name The header field name string
Required
value The header field value string
Required

ContainerAppProbe_HttpGet_HttpHeaders_STATUS

Used by: ContainerAppProbe_HttpGet_STATUS.

Property Description Type
name The header field name string
Optional
value The header field value string
Optional

ContainerAppProbe_HttpGet_Scheme

Used by: ContainerAppProbe_HttpGet.

Value Description
“HTTP”
“HTTPS”

ContainerAppProbe_HttpGet_Scheme_STATUS

Used by: ContainerAppProbe_HttpGet_STATUS.

Value Description
“HTTP”
“HTTPS”

OpenIdConnectClientCredential_Method

Used by: OpenIdConnectClientCredential.

Value Description
“ClientSecretPost”

OpenIdConnectClientCredential_Method_STATUS

Used by: OpenIdConnectClientCredential_STATUS.

Value Description
“ClientSecretPost”

ScaleRuleAuth

Auth Secrets for Scale Rule

Used by: CustomScaleRule, HttpScaleRule, JobScaleRule, QueueScaleRule, and TcpScaleRule.

Property Description Type
secretRef Name of the secret from which to pull the auth params. string
Optional
triggerParameter Trigger Parameter that uses the secret string
Optional

ScaleRuleAuth_STATUS

Auth Secrets for Scale Rule

Used by: CustomScaleRule_STATUS, HttpScaleRule_STATUS, JobScaleRule_STATUS, QueueScaleRule_STATUS, and TcpScaleRule_STATUS.

Property Description Type
secretRef Name of the secret from which to pull the auth params. string
Optional
triggerParameter Trigger Parameter that uses the secret string
Optional