Azure.ResourceManager.AppContainers.Models Namespace

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Classes

Name	Description
AppContainerResources	Container App container resource requirements.
ArmAppContainersModelFactory	A factory class for creating instances of the models for mocking.
BuildConfiguration	Configuration of the build.
BuilderPatch	The type used for update operations of the BuilderResource.
BuildToken	Build Auth Token.
CircuitBreakerPolicy	Policy that defines circuit breaker conditions.
ConnectedEnvironmentStorageProperties	Storage properties.
ContainerAppAllowedPrincipals	The configuration settings of the Azure Active Directory allowed principals.
ContainerAppAppleConfiguration	The configuration settings of the Apple provider.
ContainerAppAppleRegistrationConfiguration	The configuration settings of the registration for the Apple provider.
ContainerAppAuthPlatform	The configuration settings of the platform of ContainerApp Service Authentication/Authorization.
ContainerAppAuthToken	Container App Auth Token.
ContainerAppAvailableWorkloadProfile	A workload profile with specific hardware configure to run container apps.
ContainerAppAvailableWorkloadProfileProperties	A class representing the ContainerAppAvailableWorkloadProfileProperties data model.
ContainerAppAzureActiveDirectoryConfiguration	The configuration settings of the Azure Active directory provider.
ContainerAppAzureActiveDirectoryLoginConfiguration	The configuration settings of the Azure Active Directory login flow.
ContainerAppAzureActiveDirectoryRegistrationConfiguration	The configuration settings of the Azure Active Directory app registration.
ContainerAppAzureActiveDirectoryValidationConfiguration	The configuration settings of the Azure Active Directory token validation flow.
ContainerAppAzureFileProperties	Azure File Properties.
ContainerAppAzureStaticWebAppsConfiguration	The configuration settings of the Azure Static Web Apps provider.
ContainerAppBaseContainer	Container App base container definition.
ContainerAppBillingMeter	Billing meter.
ContainerAppBillingMeterProperties	Revision resource specific properties.
ContainerAppCertificateKeyVaultProperties	Properties for a certificate stored in a Key Vault.
ContainerAppCertificatePatch	A certificate to update.
ContainerAppCertificateProperties	Certificate resource specific properties.
ContainerAppClientRegistration	The configuration settings of the app registration for providers that have client ids and client secrets.
ContainerAppConfiguration	Non versioned Container App configuration properties that define the mutable settings of a Container app.
ContainerAppConnectedEnvironmentPatch	Connected environment patch properties.
ContainerAppContainer	Container App container definition.
ContainerAppCookieExpiration	The configuration settings of the session cookie's expiration.
ContainerAppCorsPolicy	Cross-Origin-Resource-Sharing policy.
ContainerAppCredentials	Container App credentials.
ContainerAppCustomDomain	Custom Domain of a Container App.
ContainerAppCustomDomainConfiguration	Configuration properties for apps environment custom domain.
ContainerAppCustomDomainVerificationFailureInfo	Raw failure information if DNS verification fails.
ContainerAppCustomDomainVerificationFailureInfoDetailsItem	Detailed errors.
ContainerAppCustomHostnameAnalysisResult	Custom domain analysis.
ContainerAppCustomOpenIdConnectProviderConfiguration	The configuration settings of the custom Open ID Connect provider.
ContainerAppCustomScaleRule	Container App container Custom scaling rule.
ContainerAppDaprConfiguration	Container App Dapr configuration.
ContainerAppDaprMetadata	Dapr component metadata.
ContainerAppDaprSecret	Dapr component Secret for ListSecrets Action.
ContainerAppDefaultAuthorizationPolicy	The configuration settings of the Azure Active Directory default authorization policy.
ContainerAppDiagnosticDataColumn	Diagnostics data column.
ContainerAppDiagnosticDataProviderMetadata	Details of a diagnostics data provider.
ContainerAppDiagnosticDataProviderMetadataPropertyBagItem	Property details.
ContainerAppDiagnosticDataTableResult	Diagnostics data table.
ContainerAppDiagnosticRendering	Rendering details of a diagnostics table.
ContainerAppDiagnosticsDataApiResult	Diagnostics data returned from a detector.
ContainerAppDiagnosticsMetadata	C# compatibility replacement for diagnostics metadata.
ContainerAppDiagnosticsProperties	Diagnostics resource specific properties.
ContainerAppDiagnosticsStatus	Rendering details of a diagnostics table.
ContainerAppDiagnosticSupportTopic	Support topic information.
ContainerAppEnvironmentAuthToken	Environment Auth Token.
ContainerAppEnvironmentVariable	Container App container environment variable.
ContainerAppExtendedLocation	The complex type of the extended location.
ContainerAppFacebookConfiguration	The configuration settings of the Facebook provider.
ContainerAppForwardProxy	The configuration settings of a forward proxy used to make the requests.
ContainerAppGitHubActionConfiguration	Configuration properties that define the mutable settings of a Container App SourceControl.
ContainerAppGitHubConfiguration	The configuration settings of the GitHub provider.
ContainerAppGlobalValidation	The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization.
ContainerAppGoogleConfiguration	The configuration settings of the Google provider.
ContainerAppHttpHeaderInfo	HTTPHeader describes a custom header to be used in HTTP probes.
ContainerAppHttpRequestInfo	HTTPGet specifies the http request to perform.
ContainerAppHttpRoute	Http Routes configuration, including paths to match on and whether or not rewrites are to be done.
ContainerAppHttpRouteConfigProperties	Http Route Config properties.
ContainerAppHttpRouteMatch	Criteria to match on.
ContainerAppHttpRouteProvisioningErrors	List of provisioning errors for a http route config object.
ContainerAppHttpRouteRule	Http Route rule.
ContainerAppHttpRouteTarget	Targets - Container App Names, Revision Names, Labels.
ContainerAppHttpScaleRule	Container App container Http scaling rule.
ContainerAppHttpSettings	The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.
ContainerAppIdentityProvidersConfiguration	The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.
ContainerAppIdentitySettings	Optional settings for a Managed Identity that is assigned to the Container App.
ContainerAppIngressConfiguration	Container App Ingress configuration.
ContainerAppInitContainer	Container App init container definition.
ContainerAppIPSecurityRestrictionRule	Rule to restrict incoming IP address.
ContainerAppJavaLoggerSetting	Logger settings for java workloads.
ContainerAppJobConfiguration	Non versioned Container Apps Job configuration properties.
ContainerAppJobExecutionBase	Container App's Job execution name.
ContainerAppJobExecutions	Container App executions collection ARM resource.
ContainerAppJobExecutionTemplate	Job's execution template, containing container configuration for a job's execution.
ContainerAppJobPatch	Container Apps Job resource specific properties.
ContainerAppJobPatchProperties	Container Apps Job patch properties.
ContainerAppJobScale	Scaling configurations for event driven jobs.
ContainerAppJobScaleRule	Scaling rule.
ContainerAppJobTemplate	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.
ContainerAppJwtClaimChecks	The configuration settings of the checks that should be made while validating the JWT Claims.
ContainerAppLogAnalyticsConfiguration	Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'.
ContainerAppLogin	The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.
ContainerAppLoginNonce	The configuration settings of the nonce used in the login flow.
ContainerAppLogsConfiguration	Configuration of application logs.
ContainerAppManagedCertificatePatch	A managed certificate to update.
ContainerAppNameAvailabilityContent	The check availability request body.
ContainerAppNameAvailabilityResult	The check availability result.
ContainerAppNfsAzureFileProperties	NFS Azure File Properties.
ContainerAppOpenIdConnectClientCredential	The authentication client credentials of the custom Open ID Connect provider.
ContainerAppOpenIdConnectConfig	The configuration settings of the endpoints used for the custom Open ID Connect provider.
ContainerAppOpenIdConnectLogin	The configuration settings of the login flow of the custom Open ID Connect provider.
ContainerAppOpenIdConnectRegistration	The configuration settings of the app registration for the custom Open ID Connect provider.
ContainerAppPrivateLink	A private link resource.
ContainerAppPrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ContainerAppProbe	Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
ContainerAppQueueScaleRule	Container App container Azure Queue based scaling rule.
ContainerAppRegistration	The configuration settings of the app registration for providers that have app ids and app secrets.
ContainerAppRegistryCredentials	Container App Private Registry.
ContainerAppRegistryInfo	Container App registry information.
ContainerAppReplicaContainer	Container object under Container App Revision Replica.
ContainerAppResourceTags	List of key value pairs that describe the resource. This will overwrite the existing tags.
ContainerAppRevisionTrafficWeight	Traffic weight assigned to a revision.
ContainerAppRuntimeJavaAgent	Diagnostic capabilities achieved by java agent.
ContainerAppsBuildConfiguration	Configuration of the build.
ContainerAppScale	Container App scaling configurations.
ContainerAppScaleRule	Container App container scaling rule.
ContainerAppScaleRuleAuth	Auth Secrets for Scale Rule.
ContainerAppSecret	Container App Secret.
ContainerAppSecretKeyVaultProperties	Properties for a secret stored in a Key Vault.
ContainerAppServiceBind	Configuration to bind a ContainerApp to a dev ContainerApp Service.
ContainerAppTcpScaleRule	Container App container Tcp scaling rule.
ContainerAppTcpSocketRequestInfo	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.
ContainerAppTemplate	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
ContainerAppTokenStore	The configuration settings of the token store.
ContainerAppTwitterConfiguration	The configuration settings of the Twitter provider.
ContainerAppTwitterRegistration	The configuration settings of the app registration for the Twitter provider.
ContainerAppUsage	Describes Compute Resource Usage.
ContainerAppUsageName	The Usage Names.
ContainerAppVnetConfiguration	Configuration properties for apps environment to join a Virtual Network.
ContainerAppVolume	Volume definitions for the Container App.
ContainerAppVolumeMount	Volume mount for the Container App.
ContainerAppWorkloadProfile	Workload profile to scope container app execution.
ContainerAppWorkloadProfileState	Collection of all the workload Profile States for a Managed Environment..
ContainerAppWorkloadProfileStateProperties	Workload Profile resource specific properties.
ContainerAppWritableSecret	Secret definition.
ContainerExecutionStatus	Container Apps Job execution container status. Contains status code and reason.
ContainerRegistry	Model representing a mapping from a container registry to the identity used to connect to it.
ContainerRegistryWithCustomImage	Container registry that the final image will be uploaded to.
CustomContainerTemplate	Custom container configuration.
DaprAppHealth	Dapr application health check configuration.
DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration	Dapr Component Resiliency Policy Circuit Breaker Policy Configuration.
DaprComponentResiliencyPolicyConfiguration	Dapr Component Resiliency Policy Configuration.
DaprComponentResiliencyPolicyHttpRetryBackOffConfiguration	Dapr Component Resiliency Policy HTTP Retry Backoff Configuration.
DaprComponentResiliencyPolicyHttpRetryPolicyConfiguration	Dapr Component Resiliency Policy HTTP Retry Policy Configuration.
DaprComponentServiceBinding	Configuration to bind a Dapr Component to a dev ContainerApp Service.
DaprServiceBindMetadata	Dapr component metadata.
DaprSubscriptionBulkSubscribeConfig	Dapr PubSub Bulk Subscription Options.
DaprSubscriptionRouteRule	Dapr Pubsub Event Subscription Route Rule is used to specify the condition for sending a message to a specific path.
DaprSubscriptionRoutes	Dapr PubSub Event Subscription Routes configuration.
DataDogConfiguration	Configuration of datadog.
DestinationsConfiguration	Configuration of Open Telemetry destinations.
DiskEncryptionConfigurationKeyVaultConfiguration	The Key Vault that contains your key to use for disk encryption. The Key Vault must be in the same region as the Managed Environment.
DotNetComponentConfigurationProperty	Configuration properties for a .NET Component.
DotNetComponentServiceBind	Configuration to bind a .NET Component to another .NET Component.
EncryptionSettings	The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.
EnvironmentVariable	Model representing an environment variable.
EventTriggerConfiguration	Trigger configuration of an event driven job.
Header	Header of otlp configuration.
HeaderMatch	Conditions required to match a header.
HttpConnectionPool	Defines parameters for http connection pooling.
HttpGet	Model representing a http get request.
HttpRetryPolicy	Policy that defines http request retry conditions.
IngressPortMapping	Port mappings of container app ingress.
JavaComponentConfigurationProperty	Configuration properties for a Java Component.
JavaComponentProperties	Java Component common properties. Please note this is the abstract base class. The derived classes available for instantiation are: SpringCloudGatewayComponent, SpringBootAdminComponent, NacosComponent, SpringCloudEurekaComponent, and SpringCloudConfigComponent.
JavaComponentPropertiesScale	Java component scaling configurations.
JavaComponentServiceBind	Configuration to bind a Java Component to another Java Component.
JobConfigurationManualTriggerConfig	Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default.
JobConfigurationScheduleTriggerConfig	Cron formatted repeating trigger schedule (" *") for cronjobs. Properties completions and parallelism would be set to 1 by default.
JobExecutionContainer	Container Apps Jobs execution container definition.
LabelHistoryRecordItem	Container App Label History Item resource specific properties.
LogicAppWorkflowEnvelopeProperties	Additional workflow properties.
LogicAppWorkflowHealth	Represents the workflow health.
ManagedCertificateProperties	Certificate resource specific properties.
ManagedEnvironmentIngressConfiguration	Settings for the ingress component, including workload profile, scaling, and connection handling.
ManagedEnvironmentScheduledEntry	Maintenance schedule entry for a managed environment.
ManagedEnvironmentStorageProperties	Storage properties.
McpServerCredential	The credentials used for the MCP server endpoint authentication.
McpServerSettings	The settings of the MCP (Model Context Protocol) server for this session pool.
MetricsConfiguration	Configuration of Open Telemetry metrics.
NacosComponent	Nacos properties.
Object	Logic App call response object.
OpenTelemetryConfiguration	Configuration of Open Telemetry.
OtlpConfiguration	Configuration of otlp.
PatchDetails	The detailed info of patch operation performing when applying a patch.
PatchDetailsNewLayer	New layer update details in the target image.
PatchDetailsOldLayer	The old layer details in the target image.
PatchProperties	Top level properties that describes current states of the patch resource.
PatchSkipConfig	The configuration for patcher to skip a patch or not.
PreBuildStep	Model representing a pre-build step.
ReplicaExecutionStatus	Container Apps Job execution replica status.
ScgRoute	Spring Cloud Gateway route definition.
SecretVolumeItem	Secret to be added to volume.
SessionContainer	Container definitions for the sessions of the session pool.
SessionContainerResources	Container resource requirements for sessions of the session pool.
SessionPoolLifecycleConfiguration	The lifecycle configuration properties of a session in the dynamic session pool.
SessionPoolManagedIdentitySetting	Optional settings for a Managed Identity that is assigned to the Session pool.
SessionPoolPatch	Container App session pool updatable properties.
SessionPoolScaleConfiguration	Scale configuration.
SessionPoolSecret	Secret definition.
SessionProbe	Session probe configuration.
SessionProbeHttpGet	HTTPGet specifies the http request to perform.
SessionProbeHttpGetHttpHeadersItem	HTTPHeader describes a custom header to be used in HTTP probes.
SessionProbeTcpSocket	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.
SessionRegistryCredentials	Session pool private registry credentials.
SmbStorage	SMB storage properties.
SpringBootAdminComponent	Spring Boot Admin properties.
SpringCloudConfigComponent	Spring Cloud Config properties.
SpringCloudEurekaComponent	Spring Cloud Eureka properties.
SpringCloudGatewayComponent	Spring Cloud Gateway properties.
TemplatePoolStatus	The status of pods in the pool of this template.
TemplateStatus	The status of the session pool template.
TemplateUpdateStatus	Session pool template update status.
TimeoutPolicy	Policy to set request timeouts.
TracesConfiguration	Configuration of Open Telemetry traces.
WorkflowArtifacts	The workflow filter.
WorkflowErrorEntity	Body of the error response returned from the API.

Structs

Name	Description
Affinity	Sticky Session Affinity.
BuilderProvisioningState	Resource instance provisioning state.
BuildProvisioningState	Resource instance provisioning state.
BuildStatus	Status of the build once it has been provisioned.
CertificateType	The type of the certificate. Allowed values are `ServerSSLCertificate` and `ImagePullTrustedCA`.
ConnectedEnvironmentStorageProvisioningState	Provisioning state of the storage.
ContainerAppAccessMode	Access mode for storage.
ContainerAppActiveRevisionsMode	Controls how active revisions are handled for the Container app.
ContainerAppAvailableWorkloadProfileApplicability	indicates whether the profile is default for the location.
ContainerAppCertificateProvisioningState	Provisioning state of the certificate.
ContainerAppConnectedEnvironmentProvisioningState	Provisioning state of the Kubernetes Environment.
ContainerAppContainerRunningState	Current running state of the container.
ContainerAppCustomDomainBindingType	Custom Domain binding type.
ContainerAppDaprLogLevel	Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.
ContainerAppEnvironmentProvisioningState	Provisioning state of the Environment.
ContainerAppExtendedLocationType	The type of extendedLocation.
ContainerAppHttpRouteProvisioningState	The current provisioning state.
ContainerAppHttpScheme	Scheme to use for connecting to the host. Defaults to HTTP.
ContainerAppIdentitySettingsLifeCycle	Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available.
ContainerAppIngressClientCertificateMode	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.
ContainerAppIngressTransportMethod	Ingress transport protocol.
ContainerAppIPRuleAction	Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny.
ContainerAppJavaLoggerLevel	The specified logger's log level.
ContainerAppJobProvisioningState	Provisioning state of the Container Apps Job.
ContainerAppJobTriggerType	Trigger type of the job.
ContainerAppKind	Metadata to represent the container app kind, representing if a container app is workflowapp or functionapp.
ContainerAppNameUnavailableReason	Possible reasons for a name not being available.
ContainerAppOpenIdConnectClientCredentialMethod	Method used to authenticate the custom OpenID Connect provider client credential.
ContainerAppPrivateEndpointConnectionProvisioningState	The current provisioning state.
ContainerAppPrivateEndpointServiceConnectionStatus	The private endpoint connection status.
ContainerAppProbeType	The type of probe.
ContainerAppProtocol	Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http.
ContainerAppProvisioningState	Provisioning state of the Container App.
ContainerAppPublicNetworkAccess	Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled'.
ContainerAppReplicaRunningState	Current running state of the replica.
ContainerAppRevisionHealthState	Current health State of the revision.
ContainerAppRevisionProvisioningState	Current provisioning State of the revision.
ContainerAppRunningStatus	Running status of the Container App.
ContainerAppSourceControlOperationState	Current provisioning State of the operation.
ContainerAppStorageType	Storage type for the volume. If not provided, use EmptyDir.
ContainerAppUsageUnit	Unit of measurement for Container App usage values.
ContainerType	The container type of the sessions. You can use your own container to build the session pool, or you can use a predefined container to run workload with specific language.
DaprComponentProvisioningState	Provisioning state of the Connected Environment Dapr Component.
DetectionStatus	The status of the patch detection.
DotNetComponentProvisioningState	Provisioning state of the .NET Component.
DotNetComponentType	Type of the .NET Component.
ImageType	The type of the image. Set to CloudBuild to let the system manages the image, where user will not be able to update image through image field. Set to ContainerImage for user provided image.
IngressTargetPortHttpScheme	Whether an http app listens on http or https.
JavaComponentProvisioningState	Provisioning state of the Java Component.
JobExecutionRunningState	Current running State of the job.
JobRunningState	Current running state of the job.
LogicAppsProxyMethod	HTTP method used by the Logic Apps proxy.
LogicAppWorkflowKind	Gets the logic app hybrid workflow kind.
LogicAppWorkflowState	The workflow state.
ManagedCertificateDomainControlValidation	Selected type of domain control validation for managed certificates.
PatchApplyStatus	The status of the patch once it has been provisioned.
PatchingMode	Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching.
PatchType	The type for the patch.
PoolManagementType	The pool management type of the session pool.
RevisionRunningState	Current running state of the revision.
SessionNetworkStatus	Network status for the sessions.
SessionPoolLifecycleType	The lifecycle type of the session pool.
SessionPoolProvisioningState	Provisioning state of the session pool.
SessionProbeType	Denotes the type of probe. Can be Liveness or Startup, Readiness probe is not supported in sessions. Type must be unique for each probe within the context of a list of probes (SessionProbes).
Status	Status of the label history record.

Enums

Name	Description
ContainerAppCookieExpirationConvention	The convention used when determining the session cookie's expiration.
ContainerAppDnsVerificationTestResult	DNS verification test result.
ContainerAppForwardProxyConvention	The convention used to determine the url of the request made.
ContainerAppUnauthenticatedClientActionV2	The action to take when an unauthenticated client attempts to access the app.
LogicAppWorkflowHealthState	Gets or sets the workflow health state.
ManagedEnvironmentWeekDay	Day of the week when a managed environment can be patched.

Feedback

Was this page helpful?