models Package

Classes

AllowedAudiencesValidation

The configuration settings of the Allowed Audiences validation flow.

AllowedPrincipals

The configuration settings of the Azure Active Directory allowed principals.

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.

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

AuthConfigCollection

AuthConfig collection ARM resource.

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

All required parameters must be populated in order to send to Azure.

AuthPlatform

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

AvailableOperations

Available operations of the service.

AvailableWorkloadProfile

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

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

AvailableWorkloadProfileProperties

Revision resource specific properties.

AvailableWorkloadProfilesCollection

Collection of available workload profiles in the location.

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

All required parameters must be populated in order to send to Azure.

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.

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

BillingMeterCollection

Collection of billing meters.

All required parameters must be populated in order to send to Azure.

BillingMeterProperties

Revision resource specific properties.

Certificate

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

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

All required parameters must be populated in order to send to Azure.

CertificateCollection

Collection of Certificates.

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

All required parameters must be populated in order to send to Azure.

CertificatePatch

A certificate to update.

CertificateProperties

Certificate resource specific properties.

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

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.

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

All required parameters must be populated in order to send to Azure.

ConnectedEnvironmentCollection

Collection of connectedEnvironments.

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

ConnectedEnvironmentStorage

Storage resource for connectedEnvironment.

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

ConnectedEnvironmentStorageProperties

Storage properties.

ConnectedEnvironmentStoragesCollection

Collection of Storage for Environments.

All required parameters must be populated in order to send to Azure.

Container

Container App container definition.

ContainerApp

Container App.

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

All required parameters must be populated in order to send to Azure.

ContainerAppAuthToken

Container App Auth Token.

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

All required parameters must be populated in order to send to Azure.

ContainerAppCollection

Container App collection ARM resource.

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

All required parameters must be populated in order to send to Azure.

ContainerAppJobExecutions

Container App executions collection ARM resource.

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

All required parameters must be populated in order to send to Azure.

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.

All required parameters must be populated in order to send to Azure.

ContainerAppProbeHttpGetHttpHeadersItem

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

All required parameters must be populated in order to send to Azure.

ContainerAppProbeTcpSocket

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

All required parameters must be populated in order to send to Azure.

ContainerAppSecret

Container App Secret.

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

ContainerResources

Container App container resource requirements.

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

CookieExpiration

The configuration settings of the session cookie's expiration.

CorsPolicy

Cross-Origin-Resource-Sharing policy.

All required parameters must be populated in order to send to Azure.

CustomDomain

Custom Domain of a Container App.

All required parameters must be populated in order to send to Azure.

CustomDomainConfiguration

Configuration properties for apps environment custom domain.

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

CustomHostnameAnalysisResult

Custom domain analysis.

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

CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo

Raw failure information if DNS verification fails.

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

CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem

Detailed errors.

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

CustomOpenIdConnectProvider

The configuration settings of the custom Open ID Connect provider.

CustomScaleRule

Container App container Custom scaling rule.

Dapr

Container App Dapr configuration.

DaprComponent

Dapr Component.

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

DaprComponentsCollection

Dapr Components ARM resource.

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

All required parameters must be populated in order to send to Azure.

DaprConfiguration

Configuration properties Dapr component.

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

DaprMetadata

Dapr component metadata.

DaprSecret

Dapr component Secret for ListSecrets Action.

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

DaprSecretsCollection

Dapr component Secrets Collection for ListSecrets Action.

All required parameters must be populated in order to send to Azure.

DefaultAuthorizationPolicy

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

DefaultErrorResponse

App Service error response.

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

DefaultErrorResponseError

Error model.

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

DefaultErrorResponseErrorDetailsItem

Detailed errors.

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

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.

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

Diagnostics

Diagnostics data for a resource.

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

DiagnosticsCollection

Diagnostics data collection for a resource.

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

All required parameters must be populated in order to send to Azure.

DiagnosticsDataApiResponse

Diagnostics data returned from a detector.

DiagnosticsDefinition

Metadata of the diagnostics response.

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

DiagnosticsProperties

Diagnostics resource specific properties.

DiagnosticsStatus

Rendering details of a diagnostics table.

EnvironmentAuthToken

Environment Auth Token.

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

All required parameters must be populated in order to send to Azure.

EnvironmentVar

Container App container environment variable.

ErrorAdditionalInfo

The resource management error additional info.

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

ErrorDetail

The error detail.

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

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

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.

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.

Ingress

Container App Ingress configuration.

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

IngressStickySessions

Sticky Sessions for Single Revision Mode.

InitContainer

Container App init container definition.

IpSecurityRestrictionRule

Rule to restrict incoming IP address.

All required parameters must be populated in order to send to Azure.

Job

Container App Job.

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

All required parameters must be populated in order to send to Azure.

JobConfiguration

Non versioned Container Apps Job configuration properties.

All required parameters must be populated in order to send to Azure.

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.

All required parameters must be populated in order to send to Azure.

JobExecution

Container Apps Job execution.

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

JobExecutionBase

Container App's Job execution name.

JobExecutionContainer

Container Apps Jobs execution container definition.

JobExecutionNamesCollection

Container App executions names list.

All required parameters must be populated in order to send to Azure.

JobExecutionTemplate

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

JobPatchProperties

Container Apps Job resource specific properties.

JobPatchPropertiesProperties

JobPatchPropertiesProperties.

JobScale

Scaling configurations for event driven jobs.

JobScaleRule

Scaling rule.

JobSecretsCollection

Container Apps Job Secrets Collection ARM resource.

All required parameters must be populated in order to send to Azure.

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.

JobsCollection

Container Apps Jobs collection ARM resource.

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

All required parameters must be populated in order to send to Azure.

JwtClaimChecks

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

KedaConfiguration

Configuration properties Keda component.

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

LogAnalyticsConfiguration

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

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.

ManagedCertificate

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

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

All required parameters must be populated in order to send to Azure.

ManagedCertificateCollection

Collection of Managed Certificates.

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

All required parameters must be populated in order to send to Azure.

ManagedCertificatePatch

A managed certificate to update.

ManagedCertificateProperties

Certificate resource specific properties.

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

ManagedEnvironment

An environment for hosting container apps.

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

All required parameters must be populated in order to send to Azure.

ManagedEnvironmentPropertiesPeerAuthentication

Peer authentication settings for the Managed Environment.

ManagedEnvironmentStorage

Storage resource for managedEnvironment.

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

ManagedEnvironmentStorageProperties

Storage properties.

ManagedEnvironmentStoragesCollection

Collection of Storage for Environments.

All required parameters must be populated in order to send to Azure.

ManagedEnvironmentsCollection

Collection of Environments.

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

All required parameters must be populated in order to send to Azure.

ManagedServiceIdentity

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

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

All required parameters must be populated in order to send to Azure.

Mtls

Configuration properties for mutual TLS authentication.

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.

OperationDetail

Operation detail payload.

OperationDisplay

Operation display payload.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

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

QueueScaleRule

Container App container Azure Queue based scaling rule.

RegistryCredentials

Container App Private Registry.

RegistryInfo

Container App registry information.

Replica

Container App Revision Replica.

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

ReplicaCollection

Container App Revision Replicas collection ARM resource.

All required parameters must be populated in order to send to Azure.

ReplicaContainer

Container object under Container App Revision Replica.

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

Resource

Common fields that are returned in the response for all Azure Resource Manager resources.

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

Revision

Container App Revision.

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

RevisionCollection

Container App Revisions collection ARM resource.

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

All required parameters must be populated in order to send to Azure.

Scale

Container App scaling configurations.

ScaleRule

Container App container scaling rule.

ScaleRuleAuth

Auth Secrets for Scale Rule.

Secret

Secret definition.

SecretVolumeItem

Secret to be added to volume.

SecretsCollection

Container App Secrets Collection ARM resource.

All required parameters must be populated in order to send to Azure.

Service

Container App to be a dev service.

All required parameters must be populated in order to send to Azure.

ServiceBind

Configuration to bind a ContainerApp to a dev ContainerApp Service.

SourceControl

Container App SourceControl.

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

SourceControlCollection

SourceControl collection ARM resource.

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

All required parameters must be populated in order to send to Azure.

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.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'.

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

All required parameters must be populated in order to send to Azure.

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.

UserAssignedIdentity

User assigned identity properties.

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

VnetConfiguration

Configuration properties for apps environment to join a Virtual Network.

Volume

Volume definitions for the Container App.

VolumeMount

Volume mount for the Container App.

WorkloadProfile

Workload profile to scope container app execution.

All required parameters must be populated in order to send to Azure.

WorkloadProfileStates

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

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

WorkloadProfileStatesCollection

Collection of workloadProfileStates.

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

All required parameters must be populated in order to send to Azure.

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

ActiveRevisionsMode controls how active revisions are handled for the Container app:

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

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

The reason why the given name is not available.

ConnectedEnvironmentProvisioningState

Provisioning state of the Kubernetes Environment.

ContainerAppContainerRunningState

Current running state of the container.

ContainerAppProvisioningState

Provisioning state of the Container App.

ContainerAppReplicaRunningState

Current running state of the replica.

CookieExpirationConvention

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

CreatedByType

The type of identity that created the resource.

DnsVerificationTestResult

DNS verification test result.

EnvironmentProvisioningState

Provisioning state of the Environment.

ExtendedLocationTypes

The type of extendedLocation.

ForwardProxyConvention

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

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.

JobExecutionRunningState

Current running State of the job.

JobProvisioningState

Provisioning state of the Container Apps Job.

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.

ManagedServiceIdentityType

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

RevisionHealthState

Current health State of the revision.

RevisionProvisioningState

Current provisioning State of the revision.

RevisionRunningState

Current running state of the revision.

Scheme

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

SourceControlOperationState

Current provisioning State of the operation.

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.