Ingress Class

  • Reference

Container App Ingress configuration.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.appcontainers._serialization.Model
Ingress

Constructor

Ingress(*, external: bool = False, target_port: int | None = None, exposed_port: int | None = None, transport: str | _models.IngressTransportMethod = 'auto', traffic: List[_models.TrafficWeight] | None = None, custom_domains: List[_models.CustomDomain] | None = None, allow_insecure: bool = False, ip_security_restrictions: List[_models.IpSecurityRestrictionRule] | None = None, sticky_sessions: _models.IngressStickySessions | None = None, client_certificate_mode: str | _models.IngressClientCertificateMode | None = None, cors_policy: _models.CorsPolicy | None = None, additional_port_mappings: List[_models.IngressPortMapping] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
external
bool

Bool indicating if app exposes an external http endpoint.
target_port
int

Target Port in containers for traffic from ingress.
exposed_port
int

Exposed Port in containers for TCP traffic from ingress.
transport
str or IngressTransportMethod

Ingress transport protocol. Known values are: "auto", "http", "http2", and "tcp".

Default value: auto
traffic
list[TrafficWeight]

Traffic weights for app's revisions.
custom_domains
list[CustomDomain]

custom domain bindings for Container Apps' hostnames.
allow_insecure
bool

Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections.
ip_security_restrictions
list[IpSecurityRestrictionRule]

Rules to restrict incoming IP address.
sticky_sessions
IngressStickySessions

Sticky Sessions for Single Revision Mode.
client_certificate_mode
str or IngressClientCertificateMode

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. Known values are: "ignore", "accept", and "require".
cors_policy
CorsPolicy

CORS policy for container app.
additional_port_mappings
list[IngressPortMapping]

Settings to expose additional ports on container app.

Variables

Name Description
fqdn
str

Hostname.
external
bool

Bool indicating if app exposes an external http endpoint.
target_port
int

Target Port in containers for traffic from ingress.
exposed_port
int

Exposed Port in containers for TCP traffic from ingress.
transport
str or IngressTransportMethod

Ingress transport protocol. Known values are: "auto", "http", "http2", and "tcp".
traffic
list[TrafficWeight]

Traffic weights for app's revisions.
custom_domains
list[CustomDomain]

custom domain bindings for Container Apps' hostnames.
allow_insecure
bool

Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections.
ip_security_restrictions
list[IpSecurityRestrictionRule]

Rules to restrict incoming IP address.
sticky_sessions
IngressStickySessions

Sticky Sessions for Single Revision Mode.
client_certificate_mode
str or IngressClientCertificateMode

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. Known values are: "ignore", "accept", and "require".
cors_policy
CorsPolicy

CORS policy for container app.
additional_port_mappings
list[IngressPortMapping]

Settings to expose additional ports on container app.