models Package

Classes

AllowedAudiencesValidation

The configuration settings of the Allowed Audiences validation flow.

AllowedPrincipals

The configuration settings of the Azure Active Directory allowed principals.

AppInsightsConfiguration

Configuration of Application Insights.

AppLogsConfiguration

Configuration of application logs.

AppRegistration

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

Apple

The configuration settings of the Apple provider.

AppleRegistration

The configuration settings of the registration for the Apple provider.

AuthConfig

Configuration settings for the Azure ContainerApp Service Authentication / Authorization feature.

AuthConfigProperties

AuthConfig resource specific properties.

AuthPlatform

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

AvailableEnvironmentMode

An environment mode available to the subscription.

AvailableEnvironmentModeProperties

Details that describe an available environment mode.

AvailableWorkloadProfile

A workload profile with specific hardware configure to run container apps.

AvailableWorkloadProfileProperties

Revision resource specific properties.

AzureActiveDirectory

The configuration settings of the Azure Active directory provider.

AzureActiveDirectoryLogin

The configuration settings of the Azure Active Directory login flow.

AzureActiveDirectoryRegistration

The configuration settings of the Azure Active Directory app registration.

AzureActiveDirectoryValidation

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

AzureCredentials

Container App credentials.

AzureFileProperties

Azure File Properties.

AzureStaticWebApps

The configuration settings of the Azure Static Web Apps provider.

AzureStaticWebAppsRegistration

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

BaseContainer

Container App base container definition.

BillingMeter

Billing meter.

BillingMeterCollection

Collection of billing meters.

BillingMeterProperties

Revision resource specific properties.

BlobStorageTokenStore

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

Certificate

Certificate used for Custom Domain bindings of Container Apps in a Managed Environment.

CertificateKeyVaultProperties

Properties for a certificate stored in a Key Vault.

CertificatePatch

A certificate to update.

CertificateProperties

Certificate resource specific properties.

CheckMigrationEligibilityRequest

Request body for checking whether a managed environment can migrate to a target mode.

CheckMigrationEligibilityResponse

Result of a read-only managed environment migration eligibility check.

CheckNameAvailabilityRequest

The check availability request body.

CheckNameAvailabilityResponse

The check availability result.

ClientRegistration

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

Configuration

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

ConnectedEnvironment

An environment for Kubernetes cluster specialized for web workloads by Azure App Service.

ConnectedEnvironmentPatchResource

Connected environment patch properties.

ConnectedEnvironmentProperties

ConnectedEnvironment resource specific properties.

ConnectedEnvironmentStorage

Storage resource for connectedEnvironment.

ConnectedEnvironmentStorageProperties

Storage properties.

ConnectedEnvironmentStoragesCollection

Collection of Storage for Environments.

Container

Container App container definition.

ContainerApp

Container App.

ContainerAppAuthToken

Container App Auth Token.

ContainerAppAuthTokenProperties

Container App auth token resource specific properties.

ContainerAppJobExecutions

Container App executions collection ARM resource.

ContainerAppNetworkingConfiguration

Networking configuration for a Container App. Only supported for Container Apps deployed into an Express managed environment.

ContainerAppProbe

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

ContainerAppProbeHttpGet

HTTPGet specifies the http request to perform.

ContainerAppProbeHttpGetHttpHeadersItem

HTTPHeader describes a custom header to be used in HTTP probes.

ContainerAppProbeTcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.

ContainerAppProperties

ContainerApp resource specific properties.

ContainerAppSecret

Container App Secret.

ContainerAppsFunction

Container App Function.

ContainerAppsFunctionProperties

Function resource specific properties.

ContainerExecutionStatus

Container Apps Job execution container status. Contains status code and reason.

ContainerResources

Container App container resource requirements.

CookieExpiration

The configuration settings of the session cookie's expiration.

CorsPolicy

Cross-Origin-Resource-Sharing policy.

CustomContainerTemplate

Custom container configuration.

CustomDomain

Custom Domain of a Container App.

CustomDomainConfiguration

Configuration properties for apps environment custom domain.

CustomHostnameAnalysisResult

Custom domain analysis.

CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo

Raw failure information if DNS verification fails.

CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem

Detailed errors.

CustomOpenIdConnectProvider

The configuration settings of the custom Open ID Connect provider.

CustomScaleRule

Container App container Custom scaling rule.

Dapr

Container App Dapr configuration.

DaprAppHealth

Dapr application health check configuration.

DaprComponent

Dapr Component.

DaprComponentProperties

Dapr Component resource specific properties.

DaprComponentResiliencyPolicy

Dapr Component Resiliency Policy.

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.

DaprComponentResiliencyPolicyProperties

Dapr Component Resiliency Policy resource specific properties.

DaprComponentResiliencyPolicyTimeoutPolicyConfiguration

Dapr Component Resiliency Policy Timeout Policy Configuration.

DaprConfiguration

Configuration properties Dapr component.

DaprMetadata

Dapr component metadata.

DaprSecret

Dapr component Secret for ListSecrets Action.

DaprSecretsCollection

Dapr component Secrets Collection for ListSecrets Action.

DataDogConfiguration

Configuration of datadog.

DefaultAuthorizationPolicy

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

DefaultErrorResponse

App Service error response.

DefaultErrorResponseError

Error model.

DefaultErrorResponseErrorDetailsItem

Detailed errors.

DestinationsConfiguration

Configuration of Open Telemetry destinations.

DiagnosticDataProviderMetadata

Details of a diagnostics data provider.

DiagnosticDataProviderMetadataPropertyBagItem

Property details.

DiagnosticDataTableResponseColumn

Diagnostics data column.

DiagnosticDataTableResponseObject

Diagnostics data table.

DiagnosticRendering

Rendering details of a diagnostics table.

DiagnosticSupportTopic

Support topic information.

Diagnostics

Diagnostics data for a resource.

DiagnosticsCollection

Diagnostics data collection for a resource.

DiagnosticsDataApiResponse

Diagnostics data returned from a detector.

DiagnosticsDefinition

Metadata of the diagnostics response.

DiagnosticsProperties

Diagnostics resource specific properties.

DiagnosticsStatus

Rendering details of a diagnostics table.

DotNetComponent

.NET Component.

DotNetComponentConfigurationProperty

Configuration properties for a .NET Component.

DotNetComponentProperties

.NET Component resource specific properties.

DotNetComponentServiceBind

Configuration to bind a .NET Component to another .NET Component.

DynamicPoolConfiguration

Dynamic pool configuration.

EncryptionSettings

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

EnvironmentAuthToken

Environment Auth Token.

EnvironmentAuthTokenProperties

Environment auth token resource specific properties.

EnvironmentVar

Container App container environment variable.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorEntity

Body of the error response returned from the API.

ErrorResponse

Error response.

ExecutionStatus

Container Apps Job execution status.

ExtendedLocation

The complex type of the extended location.

Facebook

The configuration settings of the Facebook provider.

ForwardProxy

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

GitHub

The configuration settings of the GitHub provider.

GithubActionConfiguration

Configuration properties that define the mutable settings of a Container App SourceControl.

GlobalValidation

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

Google

The configuration settings of the Google provider.

Header

Header of otlp configuration.

HttpRoute

Http Routes, including paths to match on and whether or not rewrites are to be done.

HttpRouteAction

Action to perform once matching of routes is done.

HttpRouteConfig

A set of host names and http request routing rules for a Container App Environment.

HttpRouteConfigProperties

Http Route Config properties.

HttpRouteMatch

Criteria to match on.

HttpRouteProvisioningErrors

List of provisioning errors for a Http Route Config object.

HttpRouteRule

A set of routing conditions and targets.

HttpRouteTarget

Targets - Container App Names, Revision Names, Labels.

HttpScaleRule

Container App container Http scaling rule.

HttpSettings

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

HttpSettingsRoutes

The configuration settings of the paths HTTP requests.

IdentityProviders

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

IdentitySettings

Optional settings for a Managed Identity that is assigned to the Container App.

Ingress

Container App Ingress configuration.

IngressConfiguration

Settings for the ingress component, including workload profile, scaling, and connection handling.

IngressPortMapping

Port mappings of container app ingress.

IngressStickySessions

Sticky Sessions for Single Revision Mode.

InitContainer

Container App init container definition.

IpSecurityRestrictionRule

Rule to restrict incoming IP address.

JavaComponent

Java Component.

JavaComponentConfigurationProperty

Configuration properties for a Java Component.

JavaComponentIngress

Container App Ingress configuration.

JavaComponentProperties

Java Component common properties.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SpringBootAdminComponent, SpringCloudConfigComponent, SpringCloudEurekaComponent

JavaComponentPropertiesScale

Java component scaling configurations.

JavaComponentServiceBind

Configuration to bind a Java Component to another Java Component.

Job

Container App Job.

JobConfiguration

Non versioned Container Apps Job configuration properties.

JobConfigurationEventTriggerConfig

Trigger configuration of an event driven job.

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.

JobExecution

Container Apps Job execution.

JobExecutionBase

Container App's Job execution name.

JobExecutionContainer

Container Apps Jobs execution container definition.

JobExecutionProperties

Container Apps Job execution specific properties.

JobExecutionTemplate

Job's execution template, containing container configuration for a job's execution.

JobPatchProperties

Container Apps Job resource specific properties.

JobPatchPropertiesProperties

Container Apps Job patch properties.

JobProperties

Container Apps Job resource specific properties.

JobScale

Scaling configurations for event driven jobs.

JobScaleRule

Scaling rule.

JobSecretsCollection

Container Apps Job Secrets Collection ARM resource.

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.

JwtClaimChecks

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

KedaConfiguration

Configuration properties Keda component.

LabelHistory

Container App Label History.

LabelHistoryProperties

Container App Label History resource specific properties.

LabelHistoryRecordItem

Container App Label History Item resource specific properties.

LifecycleConfiguration

The lifecycle configuration properties of a session in the dynamic session pool.

LogAnalyticsConfiguration

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

LogicApp

A logic app extension resource.

Login

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

LoginRoutes

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

LoginScopes

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

LogsConfiguration

Configuration of Open Telemetry logs.

MaintenanceConfigurationResource

Information about the Maintenance Configuration resource.

ManagedCertificate

Managed certificates used for Custom Domain bindings of Container Apps in a Managed Environment.

ManagedCertificatePatch

A managed certificate to update.

ManagedCertificateProperties

Certificate resource specific properties.

ManagedEnvironment

An environment for hosting container apps.

ManagedEnvironmentProperties

Managed environment resource specific properties.

ManagedEnvironmentPropertiesPeerAuthentication

Peer authentication settings for the Managed Environment.

ManagedEnvironmentPropertiesPeerTrafficConfiguration

Peer traffic settings for the Managed Environment.

ManagedEnvironmentPropertiesPeerTrafficConfigurationEncryption

Peer traffic encryption settings for the Managed Environment.

ManagedEnvironmentStorage

Storage resource for managedEnvironment.

ManagedEnvironmentStorageProperties

Storage properties.

ManagedEnvironmentStoragesCollection

Collection of Storage for Environments.

ManagedIdentitySetting

Optional settings for a Managed Identity that is assigned to the Session pool.

ManagedServiceIdentity

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

MetricsConfiguration

Configuration of Open Telemetry metrics.

MigrationEligibilityFailureReason

A blocking reason that prevents a managed environment migration.

Mtls

Configuration properties for mutual TLS authentication.

NfsAzureFileProperties

NFS Azure File Properties.

Nonce

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

OpenIdConnectClientCredential

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

OpenIdConnectConfig

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

OpenIdConnectLogin

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

OpenIdConnectRegistration

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

OpenTelemetryConfiguration

Configuration of Open Telemetry.

OperationDetail

Operation detail payload.

OperationDisplay

Operation display payload.

OtlpConfiguration

Configuration of otlp.

PrivateEndpoint

The Private Endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionProperties

Properties of the private endpoint connection.

PrivateLinkResource

A private link resource.

PrivateLinkResourceProperties

Properties of a private link resource.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

ProxyResource

Proxy Resource.

QueueScaleRule

Container App container Azure Queue based scaling rule.

RegistryCredentials

Container App Private Registry.

RegistryInfo

Container App registry information.

Replica

Container App Revision Replica.

ReplicaCollection

Container App Revision Replicas collection ARM resource.

ReplicaContainer

Container object under Container App Revision Replica.

ReplicaExecutionStatus

Container Apps Job execution replica status.

ReplicaProperties

Replica resource specific properties.

Resource

Resource.

ResourceTags

List of key value pairs that describe the resource. This will overwrite the existing tags.

Revision

Container App Revision.

RevisionProperties

Revision resource specific properties.

Runtime

Container App Runtime configuration.

RuntimeJava

Java app configuration.

SandboxGroup

A SandboxGroup resource, representing a group of sandboxes that share configuration defaults and quotas.

SandboxGroupPatch

A SandboxGroup resource for use in patch requests.

SandboxGroupPatchProperties

SandboxGroup resource specific properties for patch requests.

SandboxGroupProperties

SandboxGroup resource specific properties.

Scale

Container App scaling configurations.

ScaleConfiguration

Scale configuration.

ScaleRule

Container App container scaling rule.

ScaleRuleAuth

Auth Secrets for Scale Rule.

ScheduledEntries

List of maintenance schedules for a managed environment.

ScheduledEntry

Maintenance schedule entry for a managed environment.

Secret

Secret definition.

SecretKeyVaultProperties

Properties for a secret stored in a Key Vault.

SecretVolumeItem

Secret to be added to volume.

SecretsCollection

Container App Secrets Collection ARM resource.

Service

Container App to be a dev service.

ServiceBind

Configuration to bind a ContainerApp to a dev ContainerApp Service.

SessionContainer

Container definitions for the sessions of the session pool.

SessionContainerResources

Container resource requirements for sessions of the session pool.

SessionIngress

Session pool ingress configuration.

SessionNetworkConfiguration

Session network configuration.

SessionPool

Container App session pool.

SessionPoolProperties

Container App session pool resource specific properties.

SessionPoolSecret

Secret definition.

SessionPoolUpdatableProperties

Container App session pool updatable properties.

SessionPoolUpdatablePropertiesProperties

Session pool resource specific updatable properties.

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.

SourceControl

Container App SourceControl.

SourceControlProperties

SourceControl resource specific properties.

SpringBootAdminComponent

Spring Boot Admin properties.

SpringCloudConfigComponent

Spring Cloud Config properties.

SpringCloudEurekaComponent

Spring Cloud Eureka properties.

SystemData

Metadata pertaining to creation and last modification of the resource.

TcpScaleRule

Container App container Tcp scaling rule.

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.

TokenStore

The configuration settings of the token store.

TracesConfiguration

Configuration of Open Telemetry traces.

TrackedResource

Tracked Resource.

TrafficWeight

Traffic weight assigned to a revision.

Twitter

The configuration settings of the Twitter provider.

TwitterRegistration

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

Usage

Describes Compute Resource Usage.

UsageName

The Usage Names.

UserAssignedIdentity

User assigned identity properties.

VnetConfiguration

Configuration properties for apps environment to join a Virtual Network.

VnetConnection

A virtual network connection associated with a SandboxGroup.

VnetConnectionProperties

VnetConnection resource specific properties.

Volume

Volume definitions for the Container App.

VolumeMount

Volume mount for the Container App.

WorkflowEnvelope

Schema for the workflow object.

WorkflowEnvelopeProperties

Additional workflow properties.

WorkflowHealth

Represents the workflow health.

WorkloadProfile

Workload profile to scope container app execution.

WorkloadProfileStates

Collection of all the workload Profile States for a Managed Environment..

WorkloadProfileStatesProperties

Workload Profile resource specific properties.

Enums

AccessMode

Access mode for storage.

Action

Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny.

ActiveRevisionsMode

Controls how active revisions are handled for the Container app.

Affinity

Sticky Session Affinity.

AppProtocol

Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http.

Applicability

indicates whether the profile is default for the location.

BindingType

Custom Domain binding type.

CertificateProvisioningState

Provisioning state of the certificate.

CheckNameAvailabilityReason

Possible reasons for a name not being available.

ConnectedEnvironmentProvisioningState

Provisioning state of the Kubernetes Environment.

ConnectedEnvironmentStorageProvisioningState

Provisioning state of the storage.

ContainerAppContainerRunningState

Current running state of the container.

ContainerAppProvisioningState

Provisioning state of the Container App.

ContainerAppReplicaRunningState

Current running state of the replica.

ContainerAppRunningStatus

Running status of the Container App.

ContainerAppsFunctionState

The state of a Container App function.

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.

CookieExpirationConvention

The convention used when determining the session cookie's expiration.

CreatedByType

The kind of entity that created the resource.

DaprComponentProvisioningState

Provisioning state of the Connected Environment Dapr Component.

DnsVerificationTestResult

DNS verification test result.

DotNetComponentProvisioningState

Provisioning state of the .NET Component.

DotNetComponentType

Type of the .NET Component.

EnvironmentProvisioningState

Provisioning state of the Environment.

ExtendedLocationTypes

The type of extendedLocation.

ForwardProxyConvention

The convention used to determine the url of the request made.

HttpRouteProvisioningState

The current provisioning state.

IdentitySettingsLifeCycle

Use to select the lifecycle stages of a Container App during which the Managed Identity should be available.

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.

IngressTransportMethod

Ingress transport protocol.

JavaComponentProvisioningState

Provisioning state of the Java Component.

JavaComponentType

Type of the Java Component.

JobExecutionRunningState

Current running State of the job.

JobProvisioningState

Provisioning state of the Container Apps Job.

JobRunningState

Current running state of the job.

Kind

Metadata to represent the container app kind, representing if a container app is workflowapp or functionapp.

LifecycleType

The lifecycle type of the session pool.

LogLevel

Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.

ManagedCertificateDomainControlValidation

Selected type of domain control validation for managed certificates.

ManagedEnvironmentMode

Mode of the managed environment.

ManagedServiceIdentityType

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

PoolManagementType

The pool management type of the session pool.

PrivateEndpointConnectionProvisioningState

The current provisioning state.

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

PublicNetworkAccess

Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled'.

RevisionHealthState

Current health State of the revision.

RevisionProvisioningState

Current provisioning State of the revision.

RevisionRunningState

Current running state of the revision.

SandboxGroupProvisioningState

Provisioning state of the SandboxGroup.

Scheme

Scheme to use for connecting to the host. Defaults to HTTP.

SessionNetworkStatus

Network status for the sessions.

SessionPoolIdentityLifeCycle

Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available.

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).

SourceControlOperationState

Current provisioning State of the operation.

Status

Status of the label history record.

StorageType

Storage type for the volume. If not provided, use EmptyDir.

TriggerType

Trigger type of the job.

Type

The type of probe.

UnauthenticatedClientActionV2

The action to take when an unauthenticated client attempts to access the app.

VnetConnectionProvisioningState

Provisioning state of the VnetConnection.

WeekDay

Day of the week when a managed environment can be patched.

WorkflowHealthState

Gets or sets the workflow health state.

WorkflowKind

Gets the logic app hybrid workflow kind.

WorkflowState

The workflow state.