@azure/arm-appcontainers package

Classes

ContainerAppsAPIClient

Interfaces

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.

AuthConfigCollection

AuthConfig collection ARM resource.

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.

AvailableWorkloadProfileProperties

Revision resource specific properties

AvailableWorkloadProfiles

Interface representing a AvailableWorkloadProfiles.

AvailableWorkloadProfilesCollection

Collection of available workload profiles in the location.

AvailableWorkloadProfilesGetNextOptionalParams

Optional parameters.

AvailableWorkloadProfilesGetOptionalParams

Optional parameters.

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

BillingMeters

Interface representing a BillingMeters.

BillingMetersGetOptionalParams

Optional parameters.

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

CertificateCollection

Collection of Certificates.

CertificatePatch

A certificate to update

CertificateProperties

Certificate resource specific properties

Certificates

Interface representing a Certificates.

CertificatesCreateOrUpdateOptionalParams

Optional parameters.

CertificatesDeleteOptionalParams

Optional parameters.

CertificatesGetOptionalParams

Optional parameters.

CertificatesListNextOptionalParams

Optional parameters.

CertificatesListOptionalParams

Optional parameters.

CertificatesUpdateOptionalParams

Optional parameters.

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

ConnectedEnvironmentCollection

Collection of connectedEnvironments

ConnectedEnvironmentStorage

Storage resource for connectedEnvironment.

ConnectedEnvironmentStorageProperties

Storage properties

ConnectedEnvironmentStoragesCollection

Collection of Storage for Environments

ConnectedEnvironments

Interface representing a ConnectedEnvironments.

ConnectedEnvironmentsCertificates

Interface representing a ConnectedEnvironmentsCertificates.

ConnectedEnvironmentsCertificatesCreateOrUpdateOptionalParams

Optional parameters.

ConnectedEnvironmentsCertificatesDeleteOptionalParams

Optional parameters.

ConnectedEnvironmentsCertificatesGetOptionalParams

Optional parameters.

ConnectedEnvironmentsCertificatesListNextOptionalParams

Optional parameters.

ConnectedEnvironmentsCertificatesListOptionalParams

Optional parameters.

ConnectedEnvironmentsCertificatesUpdateOptionalParams

Optional parameters.

ConnectedEnvironmentsCheckNameAvailabilityOptionalParams

Optional parameters.

ConnectedEnvironmentsCreateOrUpdateOptionalParams

Optional parameters.

ConnectedEnvironmentsDaprComponents

Interface representing a ConnectedEnvironmentsDaprComponents.

ConnectedEnvironmentsDaprComponentsCreateOrUpdateOptionalParams

Optional parameters.

ConnectedEnvironmentsDaprComponentsDeleteOptionalParams

Optional parameters.

ConnectedEnvironmentsDaprComponentsGetOptionalParams

Optional parameters.

ConnectedEnvironmentsDaprComponentsListNextOptionalParams

Optional parameters.

ConnectedEnvironmentsDaprComponentsListOptionalParams

Optional parameters.

ConnectedEnvironmentsDaprComponentsListSecretsOptionalParams

Optional parameters.

ConnectedEnvironmentsDeleteHeaders

Defines headers for ConnectedEnvironments_delete operation.

ConnectedEnvironmentsDeleteOptionalParams

Optional parameters.

ConnectedEnvironmentsGetOptionalParams

Optional parameters.

ConnectedEnvironmentsListByResourceGroupNextOptionalParams

Optional parameters.

ConnectedEnvironmentsListByResourceGroupOptionalParams

Optional parameters.

ConnectedEnvironmentsListBySubscriptionNextOptionalParams

Optional parameters.

ConnectedEnvironmentsListBySubscriptionOptionalParams

Optional parameters.

ConnectedEnvironmentsStorages

Interface representing a ConnectedEnvironmentsStorages.

ConnectedEnvironmentsStoragesCreateOrUpdateOptionalParams

Optional parameters.

ConnectedEnvironmentsStoragesDeleteOptionalParams

Optional parameters.

ConnectedEnvironmentsStoragesGetOptionalParams

Optional parameters.

ConnectedEnvironmentsStoragesListOptionalParams

Optional parameters.

ConnectedEnvironmentsUpdateOptionalParams

Optional parameters.

Container

Container App container definition

ContainerApp

Container App.

ContainerAppAuthToken

Container App Auth Token.

ContainerAppCollection

Container App collection ARM resource.

ContainerAppJobExecutions

Container App executions collection ARM resource.

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.

ContainerAppSecret

Container App Secret.

ContainerApps

Interface representing a ContainerApps.

ContainerAppsAPIClientOptionalParams

Optional parameters.

ContainerAppsAuthConfigs

Interface representing a ContainerAppsAuthConfigs.

ContainerAppsAuthConfigsCreateOrUpdateOptionalParams

Optional parameters.

ContainerAppsAuthConfigsDeleteOptionalParams

Optional parameters.

ContainerAppsAuthConfigsGetOptionalParams

Optional parameters.

ContainerAppsAuthConfigsListByContainerAppNextOptionalParams

Optional parameters.

ContainerAppsAuthConfigsListByContainerAppOptionalParams

Optional parameters.

ContainerAppsCreateOrUpdateOptionalParams

Optional parameters.

ContainerAppsDeleteHeaders

Defines headers for ContainerApps_delete operation.

ContainerAppsDeleteOptionalParams

Optional parameters.

ContainerAppsDiagnostics

Interface representing a ContainerAppsDiagnostics.

ContainerAppsDiagnosticsGetDetectorOptionalParams

Optional parameters.

ContainerAppsDiagnosticsGetRevisionOptionalParams

Optional parameters.

ContainerAppsDiagnosticsGetRootOptionalParams

Optional parameters.

ContainerAppsDiagnosticsListDetectorsNextOptionalParams

Optional parameters.

ContainerAppsDiagnosticsListDetectorsOptionalParams

Optional parameters.

ContainerAppsDiagnosticsListRevisionsNextOptionalParams

Optional parameters.

ContainerAppsDiagnosticsListRevisionsOptionalParams

Optional parameters.

ContainerAppsGetAuthTokenOptionalParams

Optional parameters.

ContainerAppsGetOptionalParams

Optional parameters.

ContainerAppsListByResourceGroupNextOptionalParams

Optional parameters.

ContainerAppsListByResourceGroupOptionalParams

Optional parameters.

ContainerAppsListBySubscriptionNextOptionalParams

Optional parameters.

ContainerAppsListBySubscriptionOptionalParams

Optional parameters.

ContainerAppsListCustomHostNameAnalysisOptionalParams

Optional parameters.

ContainerAppsListSecretsOptionalParams

Optional parameters.

ContainerAppsRevisionReplicas

Interface representing a ContainerAppsRevisionReplicas.

ContainerAppsRevisionReplicasGetReplicaOptionalParams

Optional parameters.

ContainerAppsRevisionReplicasListReplicasOptionalParams

Optional parameters.

ContainerAppsRevisions

Interface representing a ContainerAppsRevisions.

ContainerAppsRevisionsActivateRevisionOptionalParams

Optional parameters.

ContainerAppsRevisionsDeactivateRevisionOptionalParams

Optional parameters.

ContainerAppsRevisionsGetRevisionOptionalParams

Optional parameters.

ContainerAppsRevisionsListRevisionsNextOptionalParams

Optional parameters.

ContainerAppsRevisionsListRevisionsOptionalParams

Optional parameters.

ContainerAppsRevisionsRestartRevisionOptionalParams

Optional parameters.

ContainerAppsSourceControls

Interface representing a ContainerAppsSourceControls.

ContainerAppsSourceControlsCreateOrUpdateOptionalParams

Optional parameters.

ContainerAppsSourceControlsDeleteOptionalParams

Optional parameters.

ContainerAppsSourceControlsGetOptionalParams

Optional parameters.

ContainerAppsSourceControlsListByContainerAppNextOptionalParams

Optional parameters.

ContainerAppsSourceControlsListByContainerAppOptionalParams

Optional parameters.

ContainerAppsStartHeaders

Defines headers for ContainerApps_start operation.

ContainerAppsStartOptionalParams

Optional parameters.

ContainerAppsStopHeaders

Defines headers for ContainerApps_stop operation.

ContainerAppsStopOptionalParams

Optional parameters.

ContainerAppsUpdateHeaders

Defines headers for ContainerApps_update operation.

ContainerAppsUpdateOptionalParams

Optional parameters.

ContainerResources

Container App container resource requirements.

CookieExpiration

The configuration settings of the session cookie's expiration.

CorsPolicy

Cross-Origin-Resource-Sharing policy

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.

DaprComponent

Dapr Component.

DaprComponents

Interface representing a DaprComponents.

DaprComponentsCollection

Dapr Components ARM resource.

DaprComponentsCreateOrUpdateOptionalParams

Optional parameters.

DaprComponentsDeleteOptionalParams

Optional parameters.

DaprComponentsGetOptionalParams

Optional parameters.

DaprComponentsListNextOptionalParams

Optional parameters.

DaprComponentsListOptionalParams

Optional parameters.

DaprComponentsListSecretsOptionalParams

Optional parameters.

DaprConfiguration

Configuration properties Dapr component

DaprMetadata

Dapr component metadata.

DaprSecret

Dapr component Secret for ListSecrets Action

DaprSecretsCollection

Dapr component Secrets Collection for ListSecrets Action.

DefaultAuthorizationPolicy

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

DefaultErrorResponse

App Service error response.

DefaultErrorResponseError

Error model.

DefaultErrorResponseErrorDetailsItem

Detailed errors.

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

EncryptionSettings

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

EnvironmentAuthToken

Environment Auth Token.

EnvironmentVar

Container App container environment variable.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

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.

GetCustomDomainVerificationIdOptionalParams

Optional parameters.

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.

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.

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.

JobExecutionNamesCollection

Container App executions names list.

JobExecutionOptionalParams

Optional parameters.

JobExecutionTemplate

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

JobPatchProperties

Container Apps Job resource specific properties.

JobPatchPropertiesProperties
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

Jobs

Interface representing a Jobs.

JobsCollection

Container Apps Jobs collection ARM resource.

JobsCreateOrUpdateOptionalParams

Optional parameters.

JobsDeleteHeaders

Defines headers for Jobs_delete operation.

JobsDeleteOptionalParams

Optional parameters.

JobsExecutions

Interface representing a JobsExecutions.

JobsExecutionsListNextOptionalParams

Optional parameters.

JobsExecutionsListOptionalParams

Optional parameters.

JobsGetDetectorOptionalParams

Optional parameters.

JobsGetOptionalParams

Optional parameters.

JobsListByResourceGroupNextOptionalParams

Optional parameters.

JobsListByResourceGroupOptionalParams

Optional parameters.

JobsListBySubscriptionNextOptionalParams

Optional parameters.

JobsListBySubscriptionOptionalParams

Optional parameters.

JobsListDetectorsNextOptionalParams

Optional parameters.

JobsListDetectorsOptionalParams

Optional parameters.

JobsListSecretsOptionalParams

Optional parameters.

JobsProxyGetOptionalParams

Optional parameters.

JobsStartHeaders

Defines headers for Jobs_start operation.

JobsStartOptionalParams

Optional parameters.

JobsStopExecutionHeaders

Defines headers for Jobs_stopExecution operation.

JobsStopExecutionOptionalParams

Optional parameters.

JobsStopMultipleExecutionsHeaders

Defines headers for Jobs_stopMultipleExecutions operation.

JobsStopMultipleExecutionsOptionalParams

Optional parameters.

JobsUpdateHeaders

Defines headers for Jobs_update operation.

JobsUpdateOptionalParams

Optional parameters.

JwtClaimChecks

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

KedaConfiguration

Configuration properties Keda component

ListUsagesResult
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

ManagedCertificateCollection

Collection of Managed Certificates.

ManagedCertificatePatch

A managed certificate to update

ManagedCertificateProperties

Certificate resource specific properties

ManagedCertificates

Interface representing a ManagedCertificates.

ManagedCertificatesCreateOrUpdateOptionalParams

Optional parameters.

ManagedCertificatesDeleteOptionalParams

Optional parameters.

ManagedCertificatesGetOptionalParams

Optional parameters.

ManagedCertificatesListNextOptionalParams

Optional parameters.

ManagedCertificatesListOptionalParams

Optional parameters.

ManagedCertificatesUpdateOptionalParams

Optional parameters.

ManagedEnvironment

An environment for hosting container apps

ManagedEnvironmentDiagnostics

Interface representing a ManagedEnvironmentDiagnostics.

ManagedEnvironmentDiagnosticsGetDetectorOptionalParams

Optional parameters.

ManagedEnvironmentDiagnosticsListDetectorsOptionalParams

Optional parameters.

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

ManagedEnvironmentUsages

Interface representing a ManagedEnvironmentUsages.

ManagedEnvironmentUsagesListNextOptionalParams

Optional parameters.

ManagedEnvironmentUsagesListOptionalParams

Optional parameters.

ManagedEnvironments

Interface representing a ManagedEnvironments.

ManagedEnvironmentsCollection

Collection of Environments

ManagedEnvironmentsCreateOrUpdateOptionalParams

Optional parameters.

ManagedEnvironmentsDeleteOptionalParams

Optional parameters.

ManagedEnvironmentsDiagnostics

Interface representing a ManagedEnvironmentsDiagnostics.

ManagedEnvironmentsDiagnosticsGetRootOptionalParams

Optional parameters.

ManagedEnvironmentsGetAuthTokenOptionalParams

Optional parameters.

ManagedEnvironmentsGetOptionalParams

Optional parameters.

ManagedEnvironmentsListByResourceGroupNextOptionalParams

Optional parameters.

ManagedEnvironmentsListByResourceGroupOptionalParams

Optional parameters.

ManagedEnvironmentsListBySubscriptionNextOptionalParams

Optional parameters.

ManagedEnvironmentsListBySubscriptionOptionalParams

Optional parameters.

ManagedEnvironmentsListWorkloadProfileStatesNextOptionalParams

Optional parameters.

ManagedEnvironmentsListWorkloadProfileStatesOptionalParams

Optional parameters.

ManagedEnvironmentsStorages

Interface representing a ManagedEnvironmentsStorages.

ManagedEnvironmentsStoragesCreateOrUpdateOptionalParams

Optional parameters.

ManagedEnvironmentsStoragesDeleteOptionalParams

Optional parameters.

ManagedEnvironmentsStoragesGetOptionalParams

Optional parameters.

ManagedEnvironmentsStoragesListOptionalParams

Optional parameters.

ManagedEnvironmentsUpdateOptionalParams

Optional parameters.

ManagedServiceIdentity

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

Mtls

Configuration properties for mutual TLS authentication

Namespaces

Interface representing a Namespaces.

NamespacesCheckNameAvailabilityOptionalParams

Optional parameters.

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

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

ProxyResource

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

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.

Resource

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

Revision

Container App Revision.

RevisionCollection

Container App Revisions collection ARM resource.

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.

Service

Container App to be a dev service

ServiceBind

Configuration to bind a ContainerApp to a dev ContainerApp Service

SourceControl

Container App SourceControl.

SourceControlCollection

SourceControl collection ARM resource.

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.

TrackedResource

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

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.

Usages

Interface representing a Usages.

UsagesListNextOptionalParams

Optional parameters.

UsagesListOptionalParams

Optional parameters.

UserAssignedIdentity

User assigned identity properties

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.

WorkloadProfileStates

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

WorkloadProfileStatesCollection

Collection of workloadProfileStates

WorkloadProfileStatesProperties

Workload Profile resource specific properties.

Type Aliases

AccessMode

Defines values for AccessMode.
KnownAccessMode can be used interchangeably with AccessMode, this enum contains the known values that the service supports.

Known values supported by the service

ReadOnly
ReadWrite

Action

Defines values for Action.
KnownAction can be used interchangeably with Action, this enum contains the known values that the service supports.

Known values supported by the service

Allow
Deny

ActiveRevisionsMode

Defines values for ActiveRevisionsMode.
KnownActiveRevisionsMode can be used interchangeably with ActiveRevisionsMode, this enum contains the known values that the service supports.

Known values supported by the service

Multiple
Single

Affinity

Defines values for Affinity.
KnownAffinity can be used interchangeably with Affinity, this enum contains the known values that the service supports.

Known values supported by the service

sticky
none

AppProtocol

Defines values for AppProtocol.
KnownAppProtocol can be used interchangeably with AppProtocol, this enum contains the known values that the service supports.

Known values supported by the service

http
grpc

Applicability

Defines values for Applicability.
KnownApplicability can be used interchangeably with Applicability, this enum contains the known values that the service supports.

Known values supported by the service

LocationDefault
Custom

AvailableWorkloadProfilesGetNextResponse

Contains response data for the getNext operation.

AvailableWorkloadProfilesGetResponse

Contains response data for the get operation.

BillingMetersGetResponse

Contains response data for the get operation.

BindingType

Defines values for BindingType.
KnownBindingType can be used interchangeably with BindingType, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
SniEnabled

CertificateProvisioningState

Defines values for CertificateProvisioningState.
KnownCertificateProvisioningState can be used interchangeably with CertificateProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Failed
Canceled
DeleteFailed
Pending

CertificatesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

CertificatesGetResponse

Contains response data for the get operation.

CertificatesListNextResponse

Contains response data for the listNext operation.

CertificatesListResponse

Contains response data for the list operation.

CertificatesUpdateResponse

Contains response data for the update operation.

CheckNameAvailabilityReason

Defines values for CheckNameAvailabilityReason.
KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
AlreadyExists

ConnectedEnvironmentProvisioningState

Defines values for ConnectedEnvironmentProvisioningState.
KnownConnectedEnvironmentProvisioningState can be used interchangeably with ConnectedEnvironmentProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Failed
Canceled
Waiting
InitializationInProgress
InfrastructureSetupInProgress
InfrastructureSetupComplete
ScheduledForDelete

ConnectedEnvironmentsCertificatesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ConnectedEnvironmentsCertificatesGetResponse

Contains response data for the get operation.

ConnectedEnvironmentsCertificatesListNextResponse

Contains response data for the listNext operation.

ConnectedEnvironmentsCertificatesListResponse

Contains response data for the list operation.

ConnectedEnvironmentsCertificatesUpdateResponse

Contains response data for the update operation.

ConnectedEnvironmentsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

ConnectedEnvironmentsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ConnectedEnvironmentsDaprComponentsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ConnectedEnvironmentsDaprComponentsGetResponse

Contains response data for the get operation.

ConnectedEnvironmentsDaprComponentsListNextResponse

Contains response data for the listNext operation.

ConnectedEnvironmentsDaprComponentsListResponse

Contains response data for the list operation.

ConnectedEnvironmentsDaprComponentsListSecretsResponse

Contains response data for the listSecrets operation.

ConnectedEnvironmentsGetResponse

Contains response data for the get operation.

ConnectedEnvironmentsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

ConnectedEnvironmentsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ConnectedEnvironmentsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

ConnectedEnvironmentsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

ConnectedEnvironmentsStoragesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ConnectedEnvironmentsStoragesGetResponse

Contains response data for the get operation.

ConnectedEnvironmentsStoragesListResponse

Contains response data for the list operation.

ConnectedEnvironmentsUpdateResponse

Contains response data for the update operation.

ContainerAppContainerRunningState

Defines values for ContainerAppContainerRunningState.
KnownContainerAppContainerRunningState can be used interchangeably with ContainerAppContainerRunningState, this enum contains the known values that the service supports.

Known values supported by the service

Running
Terminated
Waiting

ContainerAppProvisioningState

Defines values for ContainerAppProvisioningState.
KnownContainerAppProvisioningState can be used interchangeably with ContainerAppProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

InProgress
Succeeded
Failed
Canceled
Deleting

ContainerAppReplicaRunningState

Defines values for ContainerAppReplicaRunningState.
KnownContainerAppReplicaRunningState can be used interchangeably with ContainerAppReplicaRunningState, this enum contains the known values that the service supports.

Known values supported by the service

Running
NotRunning
Unknown

ContainerAppsAuthConfigsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ContainerAppsAuthConfigsGetResponse

Contains response data for the get operation.

ContainerAppsAuthConfigsListByContainerAppNextResponse

Contains response data for the listByContainerAppNext operation.

ContainerAppsAuthConfigsListByContainerAppResponse

Contains response data for the listByContainerApp operation.

ContainerAppsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ContainerAppsDiagnosticsGetDetectorResponse

Contains response data for the getDetector operation.

ContainerAppsDiagnosticsGetRevisionResponse

Contains response data for the getRevision operation.

ContainerAppsDiagnosticsGetRootResponse

Contains response data for the getRoot operation.

ContainerAppsDiagnosticsListDetectorsNextResponse

Contains response data for the listDetectorsNext operation.

ContainerAppsDiagnosticsListDetectorsResponse

Contains response data for the listDetectors operation.

ContainerAppsDiagnosticsListRevisionsNextResponse

Contains response data for the listRevisionsNext operation.

ContainerAppsDiagnosticsListRevisionsResponse

Contains response data for the listRevisions operation.

ContainerAppsGetAuthTokenResponse

Contains response data for the getAuthToken operation.

ContainerAppsGetResponse

Contains response data for the get operation.

ContainerAppsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

ContainerAppsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ContainerAppsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

ContainerAppsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

ContainerAppsListCustomHostNameAnalysisResponse

Contains response data for the listCustomHostNameAnalysis operation.

ContainerAppsListSecretsResponse

Contains response data for the listSecrets operation.

ContainerAppsRevisionReplicasGetReplicaResponse

Contains response data for the getReplica operation.

ContainerAppsRevisionReplicasListReplicasResponse

Contains response data for the listReplicas operation.

ContainerAppsRevisionsGetRevisionResponse

Contains response data for the getRevision operation.

ContainerAppsRevisionsListRevisionsNextResponse

Contains response data for the listRevisionsNext operation.

ContainerAppsRevisionsListRevisionsResponse

Contains response data for the listRevisions operation.

ContainerAppsSourceControlsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ContainerAppsSourceControlsGetResponse

Contains response data for the get operation.

ContainerAppsSourceControlsListByContainerAppNextResponse

Contains response data for the listByContainerAppNext operation.

ContainerAppsSourceControlsListByContainerAppResponse

Contains response data for the listByContainerApp operation.

ContainerAppsStartResponse

Contains response data for the start operation.

ContainerAppsStopResponse

Contains response data for the stop operation.

ContainerAppsUpdateResponse

Contains response data for the update operation.

CookieExpirationConvention

Defines values for CookieExpirationConvention.

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

DaprComponentsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

DaprComponentsGetResponse

Contains response data for the get operation.

DaprComponentsListNextResponse

Contains response data for the listNext operation.

DaprComponentsListResponse

Contains response data for the list operation.

DaprComponentsListSecretsResponse

Contains response data for the listSecrets operation.

DnsVerificationTestResult

Defines values for DnsVerificationTestResult.

EnvironmentProvisioningState

Defines values for EnvironmentProvisioningState.
KnownEnvironmentProvisioningState can be used interchangeably with EnvironmentProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Failed
Canceled
Waiting
InitializationInProgress
InfrastructureSetupInProgress
InfrastructureSetupComplete
ScheduledForDelete
UpgradeRequested
UpgradeFailed

ExtendedLocationTypes

Defines values for ExtendedLocationTypes.
KnownExtendedLocationTypes can be used interchangeably with ExtendedLocationTypes, this enum contains the known values that the service supports.

Known values supported by the service

CustomLocation

ForwardProxyConvention

Defines values for ForwardProxyConvention.

GetCustomDomainVerificationIdResponse

Contains response data for the getCustomDomainVerificationId operation.

IngressClientCertificateMode

Defines values for IngressClientCertificateMode.
KnownIngressClientCertificateMode can be used interchangeably with IngressClientCertificateMode, this enum contains the known values that the service supports.

Known values supported by the service

ignore
accept
require

IngressTransportMethod

Defines values for IngressTransportMethod.
KnownIngressTransportMethod can be used interchangeably with IngressTransportMethod, this enum contains the known values that the service supports.

Known values supported by the service

auto
http
http2
tcp

JobExecutionResponse

Contains response data for the jobExecution operation.

JobExecutionRunningState

Defines values for JobExecutionRunningState.
KnownJobExecutionRunningState can be used interchangeably with JobExecutionRunningState, this enum contains the known values that the service supports.

Known values supported by the service

Running
Processing
Stopped
Degraded
Failed
Unknown
Succeeded

JobProvisioningState

Defines values for JobProvisioningState.
KnownJobProvisioningState can be used interchangeably with JobProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

InProgress
Succeeded
Failed
Canceled
Deleting

JobsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

JobsExecutionsListNextResponse

Contains response data for the listNext operation.

JobsExecutionsListResponse

Contains response data for the list operation.

JobsGetDetectorResponse

Contains response data for the getDetector operation.

JobsGetResponse

Contains response data for the get operation.

JobsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

JobsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

JobsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

JobsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

JobsListDetectorsNextResponse

Contains response data for the listDetectorsNext operation.

JobsListDetectorsResponse

Contains response data for the listDetectors operation.

JobsListSecretsResponse

Contains response data for the listSecrets operation.

JobsProxyGetResponse

Contains response data for the proxyGet operation.

JobsStartResponse

Contains response data for the start operation.

JobsStopMultipleExecutionsResponse

Contains response data for the stopMultipleExecutions operation.

JobsUpdateResponse

Contains response data for the update operation.

LogLevel

Defines values for LogLevel.
KnownLogLevel can be used interchangeably with LogLevel, this enum contains the known values that the service supports.

Known values supported by the service

info
debug
warn
error

ManagedCertificateDomainControlValidation

Defines values for ManagedCertificateDomainControlValidation.
KnownManagedCertificateDomainControlValidation can be used interchangeably with ManagedCertificateDomainControlValidation, this enum contains the known values that the service supports.

Known values supported by the service

CNAME
HTTP
TXT

ManagedCertificatesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ManagedCertificatesGetResponse

Contains response data for the get operation.

ManagedCertificatesListNextResponse

Contains response data for the listNext operation.

ManagedCertificatesListResponse

Contains response data for the list operation.

ManagedCertificatesUpdateResponse

Contains response data for the update operation.

ManagedEnvironmentDiagnosticsGetDetectorResponse

Contains response data for the getDetector operation.

ManagedEnvironmentDiagnosticsListDetectorsResponse

Contains response data for the listDetectors operation.

ManagedEnvironmentUsagesListNextResponse

Contains response data for the listNext operation.

ManagedEnvironmentUsagesListResponse

Contains response data for the list operation.

ManagedEnvironmentsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ManagedEnvironmentsDiagnosticsGetRootResponse

Contains response data for the getRoot operation.

ManagedEnvironmentsGetAuthTokenResponse

Contains response data for the getAuthToken operation.

ManagedEnvironmentsGetResponse

Contains response data for the get operation.

ManagedEnvironmentsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

ManagedEnvironmentsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ManagedEnvironmentsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

ManagedEnvironmentsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

ManagedEnvironmentsListWorkloadProfileStatesNextResponse

Contains response data for the listWorkloadProfileStatesNext operation.

ManagedEnvironmentsListWorkloadProfileStatesResponse

Contains response data for the listWorkloadProfileStates operation.

ManagedEnvironmentsStoragesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ManagedEnvironmentsStoragesGetResponse

Contains response data for the get operation.

ManagedEnvironmentsStoragesListResponse

Contains response data for the list operation.

ManagedEnvironmentsUpdateResponse

Contains response data for the update operation.

ManagedServiceIdentityType

Defines values for ManagedServiceIdentityType.
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

NamespacesCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

RevisionHealthState

Defines values for RevisionHealthState.
KnownRevisionHealthState can be used interchangeably with RevisionHealthState, this enum contains the known values that the service supports.

Known values supported by the service

Healthy
Unhealthy
None

RevisionProvisioningState

Defines values for RevisionProvisioningState.
KnownRevisionProvisioningState can be used interchangeably with RevisionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Provisioning
Provisioned
Failed
Deprovisioning
Deprovisioned

RevisionRunningState

Defines values for RevisionRunningState.
KnownRevisionRunningState can be used interchangeably with RevisionRunningState, this enum contains the known values that the service supports.

Known values supported by the service

Running
Processing
Stopped
Degraded
Failed
Unknown

Scheme

Defines values for Scheme.
KnownScheme can be used interchangeably with Scheme, this enum contains the known values that the service supports.

Known values supported by the service

HTTP
HTTPS

SourceControlOperationState

Defines values for SourceControlOperationState.
KnownSourceControlOperationState can be used interchangeably with SourceControlOperationState, this enum contains the known values that the service supports.

Known values supported by the service

InProgress
Succeeded
Failed
Canceled

StorageType

Defines values for StorageType.
KnownStorageType can be used interchangeably with StorageType, this enum contains the known values that the service supports.

Known values supported by the service

AzureFile
EmptyDir
Secret

TriggerType

Defines values for TriggerType.
KnownTriggerType can be used interchangeably with TriggerType, this enum contains the known values that the service supports.

Known values supported by the service

Schedule
Event
Manual

Type

Defines values for Type.
KnownType can be used interchangeably with Type, this enum contains the known values that the service supports.

Known values supported by the service

Liveness
Readiness
Startup

UnauthenticatedClientActionV2

Defines values for UnauthenticatedClientActionV2.

UsagesListNextResponse

Contains response data for the listNext operation.

UsagesListResponse

Contains response data for the list operation.

Enums

KnownAccessMode

Known values of AccessMode that the service accepts.

KnownAction

Known values of Action that the service accepts.

KnownActiveRevisionsMode

Known values of ActiveRevisionsMode that the service accepts.

KnownAffinity

Known values of Affinity that the service accepts.

KnownAppProtocol

Known values of AppProtocol that the service accepts.

KnownApplicability

Known values of Applicability that the service accepts.

KnownBindingType

Known values of BindingType that the service accepts.

KnownCertificateProvisioningState

Known values of CertificateProvisioningState that the service accepts.

KnownCheckNameAvailabilityReason

Known values of CheckNameAvailabilityReason that the service accepts.

KnownConnectedEnvironmentProvisioningState

Known values of ConnectedEnvironmentProvisioningState that the service accepts.

KnownContainerAppContainerRunningState

Known values of ContainerAppContainerRunningState that the service accepts.

KnownContainerAppProvisioningState

Known values of ContainerAppProvisioningState that the service accepts.

KnownContainerAppReplicaRunningState

Known values of ContainerAppReplicaRunningState that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownEnvironmentProvisioningState

Known values of EnvironmentProvisioningState that the service accepts.

KnownExtendedLocationTypes

Known values of ExtendedLocationTypes that the service accepts.

KnownIngressClientCertificateMode

Known values of IngressClientCertificateMode that the service accepts.

KnownIngressTransportMethod

Known values of IngressTransportMethod that the service accepts.

KnownJobExecutionRunningState

Known values of JobExecutionRunningState that the service accepts.

KnownJobProvisioningState

Known values of JobProvisioningState that the service accepts.

KnownLogLevel

Known values of LogLevel that the service accepts.

KnownManagedCertificateDomainControlValidation

Known values of ManagedCertificateDomainControlValidation that the service accepts.

KnownManagedServiceIdentityType

Known values of ManagedServiceIdentityType that the service accepts.

KnownRevisionHealthState

Known values of RevisionHealthState that the service accepts.

KnownRevisionProvisioningState

Known values of RevisionProvisioningState that the service accepts.

KnownRevisionRunningState

Known values of RevisionRunningState that the service accepts.

KnownScheme

Known values of Scheme that the service accepts.

KnownSourceControlOperationState

Known values of SourceControlOperationState that the service accepts.

KnownStorageType

Known values of StorageType that the service accepts.

KnownTriggerType

Known values of TriggerType that the service accepts.

KnownType

Known values of Type that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.