@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. |
| 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. |
| AvailableEnvironmentModesListOptionalParams |
Optional parameters. |
| AvailableEnvironmentModesOperations |
Interface representing a AvailableEnvironmentModes operations. |
| AvailableWorkloadProfile |
A workload profile with specific hardware configure to run container apps. |
| AvailableWorkloadProfileProperties |
Revision resource specific properties |
| AvailableWorkloadProfilesListOptionalParams |
Optional parameters. |
| AvailableWorkloadProfilesOperations |
Interface representing a AvailableWorkloadProfiles operations. |
| 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 |
| BillingMetersGetOptionalParams |
Optional parameters. |
| BillingMetersOperations |
Interface representing a BillingMeters operations. |
| 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 |
| CertificatesCreateOrUpdateOptionalParams |
Optional parameters. |
| CertificatesDeleteOptionalParams |
Optional parameters. |
| CertificatesGetOptionalParams |
Optional parameters. |
| CertificatesListOptionalParams |
Optional parameters. |
| CertificatesOperations |
Interface representing a Certificates operations. |
| CertificatesUpdateOptionalParams |
Optional parameters. |
| 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 |
| ConnectedEnvironmentsCertificatesCreateOrUpdateOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsCertificatesDeleteOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsCertificatesGetOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsCertificatesListOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsCertificatesOperations |
Interface representing a ConnectedEnvironmentsCertificates operations. |
| ConnectedEnvironmentsCertificatesUpdateOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsCheckNameAvailabilityOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsCreateOrUpdateOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsDaprComponentsCreateOrUpdateOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsDaprComponentsDeleteOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsDaprComponentsGetOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsDaprComponentsListOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsDaprComponentsListSecretsOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsDaprComponentsOperations |
Interface representing a ConnectedEnvironmentsDaprComponents operations. |
| ConnectedEnvironmentsDeleteOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsGetOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsListByResourceGroupOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsListBySubscriptionOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsOperations |
Interface representing a ConnectedEnvironments operations. |
| ConnectedEnvironmentsStoragesCreateOrUpdateOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsStoragesDeleteOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsStoragesGetOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsStoragesListOptionalParams |
Optional parameters. |
| ConnectedEnvironmentsStoragesOperations |
Interface representing a ConnectedEnvironmentsStorages operations. |
| ConnectedEnvironmentsUpdateOptionalParams |
Optional parameters. |
| 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. |
| ContainerAppPrivateEndpointConnectionsCreateOrUpdateOptionalParams |
Optional parameters. |
| ContainerAppPrivateEndpointConnectionsDeleteOptionalParams |
Optional parameters. |
| ContainerAppPrivateEndpointConnectionsGetOptionalParams |
Optional parameters. |
| ContainerAppPrivateEndpointConnectionsListOptionalParams |
Optional parameters. |
| ContainerAppPrivateEndpointConnectionsOperations |
Interface representing a ContainerAppPrivateEndpointConnections operations. |
| ContainerAppPrivateLinkResourcesGetOptionalParams |
Optional parameters. |
| ContainerAppPrivateLinkResourcesListOptionalParams |
Optional parameters. |
| ContainerAppPrivateLinkResourcesOperations |
Interface representing a ContainerAppPrivateLinkResources operations. |
| 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. |
| ContainerAppsAPIClientOptionalParams |
Optional parameters for the client. |
| ContainerAppsAuthConfigsCreateOrUpdateOptionalParams |
Optional parameters. |
| ContainerAppsAuthConfigsDeleteOptionalParams |
Optional parameters. |
| ContainerAppsAuthConfigsGetOptionalParams |
Optional parameters. |
| ContainerAppsAuthConfigsListByContainerAppOptionalParams |
Optional parameters. |
| ContainerAppsAuthConfigsOperations |
Interface representing a ContainerAppsAuthConfigs operations. |
| ContainerAppsCreateOrUpdateOptionalParams |
Optional parameters. |
| ContainerAppsDeleteOptionalParams |
Optional parameters. |
| ContainerAppsDiagnosticsGetDetectorOptionalParams |
Optional parameters. |
| ContainerAppsDiagnosticsGetRevisionOptionalParams |
Optional parameters. |
| ContainerAppsDiagnosticsGetRootOptionalParams |
Optional parameters. |
| ContainerAppsDiagnosticsListDetectorsOptionalParams |
Optional parameters. |
| ContainerAppsDiagnosticsListRevisionsOptionalParams |
Optional parameters. |
| ContainerAppsDiagnosticsOperations |
Interface representing a ContainerAppsDiagnostics operations. |
| ContainerAppsFunction |
Container App Function. |
| ContainerAppsFunctionProperties |
Function resource specific properties |
| ContainerAppsFunctionsGetOptionalParams |
Optional parameters. |
| ContainerAppsFunctionsListOptionalParams |
Optional parameters. |
| ContainerAppsFunctionsOperations |
Interface representing a ContainerAppsFunctions operations. |
| ContainerAppsGetAuthTokenOptionalParams |
Optional parameters. |
| ContainerAppsGetOptionalParams |
Optional parameters. |
| ContainerAppsLabelHistoryDeleteLabelHistoryOptionalParams |
Optional parameters. |
| ContainerAppsLabelHistoryGetLabelHistoryOptionalParams |
Optional parameters. |
| ContainerAppsLabelHistoryListLabelHistoryOptionalParams |
Optional parameters. |
| ContainerAppsLabelHistoryOperations |
Interface representing a ContainerAppsLabelHistory operations. |
| ContainerAppsListByResourceGroupOptionalParams |
Optional parameters. |
| ContainerAppsListBySubscriptionOptionalParams |
Optional parameters. |
| ContainerAppsListCustomHostNameAnalysisOptionalParams |
Optional parameters. |
| ContainerAppsListSecretsOptionalParams |
Optional parameters. |
| ContainerAppsOperations |
Interface representing a ContainerApps operations. |
| ContainerAppsRevisionFunctionsGetOptionalParams |
Optional parameters. |
| ContainerAppsRevisionFunctionsListOptionalParams |
Optional parameters. |
| ContainerAppsRevisionFunctionsOperations |
Interface representing a ContainerAppsRevisionFunctions operations. |
| ContainerAppsRevisionReplicasGetReplicaOptionalParams |
Optional parameters. |
| ContainerAppsRevisionReplicasListReplicasOptionalParams |
Optional parameters. |
| ContainerAppsRevisionReplicasOperations |
Interface representing a ContainerAppsRevisionReplicas operations. |
| ContainerAppsRevisionsActivateRevisionOptionalParams |
Optional parameters. |
| ContainerAppsRevisionsDeactivateRevisionOptionalParams |
Optional parameters. |
| ContainerAppsRevisionsGetRevisionOptionalParams |
Optional parameters. |
| ContainerAppsRevisionsListRevisionsOptionalParams |
Optional parameters. |
| ContainerAppsRevisionsOperations |
Interface representing a ContainerAppsRevisions operations. |
| ContainerAppsRevisionsRestartRevisionOptionalParams |
Optional parameters. |
| ContainerAppsSessionPoolsCreateOrUpdateOptionalParams |
Optional parameters. |
| ContainerAppsSessionPoolsDeleteOptionalParams |
Optional parameters. |
| ContainerAppsSessionPoolsGetOptionalParams |
Optional parameters. |
| ContainerAppsSessionPoolsListByResourceGroupOptionalParams |
Optional parameters. |
| ContainerAppsSessionPoolsListBySubscriptionOptionalParams |
Optional parameters. |
| ContainerAppsSessionPoolsOperations |
Interface representing a ContainerAppsSessionPools operations. |
| ContainerAppsSessionPoolsUpdateOptionalParams |
Optional parameters. |
| ContainerAppsSourceControlsCreateOrUpdateOptionalParams |
Optional parameters. |
| ContainerAppsSourceControlsDeleteOptionalParams |
Optional parameters. |
| ContainerAppsSourceControlsGetOptionalParams |
Optional parameters. |
| ContainerAppsSourceControlsListByContainerAppOptionalParams |
Optional parameters. |
| ContainerAppsSourceControlsOperations |
Interface representing a ContainerAppsSourceControls operations. |
| ContainerAppsStartOptionalParams |
Optional parameters. |
| ContainerAppsStopOptionalParams |
Optional parameters. |
| ContainerAppsUpdateOptionalParams |
Optional parameters. |
| 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 |
| DaprComponentResiliencyPoliciesCreateOrUpdateOptionalParams |
Optional parameters. |
| DaprComponentResiliencyPoliciesDeleteOptionalParams |
Optional parameters. |
| DaprComponentResiliencyPoliciesGetOptionalParams |
Optional parameters. |
| DaprComponentResiliencyPoliciesListOptionalParams |
Optional parameters. |
| DaprComponentResiliencyPoliciesOperations |
Interface representing a DaprComponentResiliencyPolicies operations. |
| 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. |
| DaprComponentsCreateOrUpdateOptionalParams |
Optional parameters. |
| DaprComponentsDeleteOptionalParams |
Optional parameters. |
| DaprComponentsGetOptionalParams |
Optional parameters. |
| DaprComponentsListOptionalParams |
Optional parameters. |
| DaprComponentsListSecretsOptionalParams |
Optional parameters. |
| DaprComponentsOperations |
Interface representing a DaprComponents operations. |
| 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 |
| DotNetComponentsCreateOrUpdateOptionalParams |
Optional parameters. |
| DotNetComponentsDeleteOptionalParams |
Optional parameters. |
| DotNetComponentsGetOptionalParams |
Optional parameters. |
| DotNetComponentsListOptionalParams |
Optional parameters. |
| DotNetComponentsOperations |
Interface representing a DotNetComponents operations. |
| DotNetComponentsUpdateOptionalParams |
Optional parameters. |
| 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 |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. |
| ExecutionStatus |
Container Apps Job execution status. |
| ExtendedLocation |
The complex type of the extended location. |
|
The configuration settings of the Facebook provider. |
|
| ForwardProxy |
The configuration settings of a forward proxy used to make the requests. |
| FunctionsExtensionInvokeFunctionsHostOptionalParams |
Optional parameters. |
| FunctionsExtensionOperations |
Interface representing a FunctionsExtension operations. |
| 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. |
|
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 |
| HttpRouteConfigCreateOrUpdateOptionalParams |
Optional parameters. |
| HttpRouteConfigDeleteOptionalParams |
Optional parameters. |
| HttpRouteConfigGetOptionalParams |
Optional parameters. |
| HttpRouteConfigListOptionalParams |
Optional parameters. |
| HttpRouteConfigOperations |
Interface representing a HttpRouteConfig operations. |
| HttpRouteConfigProperties |
Http Route Config properties |
| HttpRouteConfigUpdateOptionalParams |
Optional parameters. |
| 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. |
| JavaComponentPropertiesScale |
Java component scaling configurations |
| JavaComponentServiceBind |
Configuration to bind a Java Component to another Java Component |
| JavaComponentsCreateOrUpdateOptionalParams |
Optional parameters. |
| JavaComponentsDeleteOptionalParams |
Optional parameters. |
| JavaComponentsGetOptionalParams |
Optional parameters. |
| JavaComponentsListOptionalParams |
Optional parameters. |
| JavaComponentsOperations |
Interface representing a JavaComponents operations. |
| JavaComponentsUpdateOptionalParams |
Optional parameters. |
| 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. |
| JobExecutionOptionalParams |
Optional parameters. |
| 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 |
| JobsCreateOrUpdateOptionalParams |
Optional parameters. |
| JobsDeleteOptionalParams |
Optional parameters. |
| JobsExecutionsListOptionalParams |
Optional parameters. |
| JobsExecutionsOperations |
Interface representing a JobsExecutions operations. |
| JobsGetDetectorOptionalParams |
Optional parameters. |
| JobsGetOptionalParams |
Optional parameters. |
| JobsListByResourceGroupOptionalParams |
Optional parameters. |
| JobsListBySubscriptionOptionalParams |
Optional parameters. |
| JobsListDetectorsOptionalParams |
Optional parameters. |
| JobsListSecretsOptionalParams |
Optional parameters. |
| JobsOperations |
Interface representing a Jobs operations. |
| JobsProxyGetOptionalParams |
Optional parameters. |
| JobsResumeOptionalParams |
Optional parameters. |
| JobsStartOptionalParams |
Optional parameters. |
| JobsStopExecutionOptionalParams |
Optional parameters. |
| JobsStopMultipleExecutionsOptionalParams |
Optional parameters. |
| JobsSuspendOptionalParams |
Optional parameters. |
| JobsUpdateOptionalParams |
Optional parameters. |
| 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 |
| LogicAppsCreateOrUpdateOptionalParams |
Optional parameters. |
| LogicAppsDeleteOptionalParams |
Optional parameters. |
| LogicAppsGetOptionalParams |
Optional parameters. |
| LogicAppsGetWorkflowOptionalParams |
Optional parameters. |
| LogicAppsListWorkflowsConnectionsOptionalParams |
Optional parameters. |
| LogicAppsListWorkflowsOptionalParams |
Optional parameters. |
| LogicAppsOperations |
Interface representing a LogicApps operations. |
| 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. |
| MaintenanceConfigurationsCreateOrUpdateOptionalParams |
Optional parameters. |
| MaintenanceConfigurationsDeleteOptionalParams |
Optional parameters. |
| MaintenanceConfigurationsGetOptionalParams |
Optional parameters. |
| MaintenanceConfigurationsListOptionalParams |
Optional parameters. |
| MaintenanceConfigurationsOperations |
Interface representing a MaintenanceConfigurations operations. |
| 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 |
| ManagedCertificatesCreateOrUpdateOptionalParams |
Optional parameters. |
| ManagedCertificatesDeleteOptionalParams |
Optional parameters. |
| ManagedCertificatesGetOptionalParams |
Optional parameters. |
| ManagedCertificatesListOptionalParams |
Optional parameters. |
| ManagedCertificatesOperations |
Interface representing a ManagedCertificates operations. |
| ManagedCertificatesUpdateOptionalParams |
Optional parameters. |
| ManagedEnvironment |
An environment for hosting container apps |
| ManagedEnvironmentDiagnosticsGetDetectorOptionalParams |
Optional parameters. |
| ManagedEnvironmentDiagnosticsListDetectorsOptionalParams |
Optional parameters. |
| ManagedEnvironmentDiagnosticsOperations |
Interface representing a ManagedEnvironmentDiagnostics operations. |
| ManagedEnvironmentPrivateEndpointConnectionsCreateOrUpdateOptionalParams |
Optional parameters. |
| ManagedEnvironmentPrivateEndpointConnectionsDeleteOptionalParams |
Optional parameters. |
| ManagedEnvironmentPrivateEndpointConnectionsGetOptionalParams |
Optional parameters. |
| ManagedEnvironmentPrivateEndpointConnectionsListOptionalParams |
Optional parameters. |
| ManagedEnvironmentPrivateEndpointConnectionsOperations |
Interface representing a ManagedEnvironmentPrivateEndpointConnections operations. |
| ManagedEnvironmentPrivateLinkResourcesGetOptionalParams |
Optional parameters. |
| ManagedEnvironmentPrivateLinkResourcesListOptionalParams |
Optional parameters. |
| ManagedEnvironmentPrivateLinkResourcesOperations |
Interface representing a ManagedEnvironmentPrivateLinkResources operations. |
| 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 |
| ManagedEnvironmentUsagesListOptionalParams |
Optional parameters. |
| ManagedEnvironmentUsagesOperations |
Interface representing a ManagedEnvironmentUsages operations. |
| ManagedEnvironmentsCheckMigrationEligibilityOptionalParams |
Optional parameters. |
| ManagedEnvironmentsCreateOrUpdateOptionalParams |
Optional parameters. |
| ManagedEnvironmentsDeleteOptionalParams |
Optional parameters. |
| ManagedEnvironmentsDiagnosticsGetRootOptionalParams |
Optional parameters. |
| ManagedEnvironmentsDiagnosticsOperations |
Interface representing a ManagedEnvironmentsDiagnostics operations. |
| ManagedEnvironmentsGetAuthTokenOptionalParams |
Optional parameters. |
| ManagedEnvironmentsGetOptionalParams |
Optional parameters. |
| ManagedEnvironmentsListByResourceGroupOptionalParams |
Optional parameters. |
| ManagedEnvironmentsListBySubscriptionOptionalParams |
Optional parameters. |
| ManagedEnvironmentsListWorkloadProfileStatesOptionalParams |
Optional parameters. |
| ManagedEnvironmentsOperations |
Interface representing a ManagedEnvironments operations. |
| ManagedEnvironmentsStoragesCreateOrUpdateOptionalParams |
Optional parameters. |
| ManagedEnvironmentsStoragesDeleteOptionalParams |
Optional parameters. |
| ManagedEnvironmentsStoragesGetOptionalParams |
Optional parameters. |
| ManagedEnvironmentsStoragesListOptionalParams |
Optional parameters. |
| ManagedEnvironmentsStoragesOperations |
Interface representing a ManagedEnvironmentsStorages operations. |
| ManagedEnvironmentsUpdateOptionalParams |
Optional parameters. |
| 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 |
| NamespacesCheckNameAvailabilityOptionalParams |
Optional parameters. |
| NamespacesOperations |
Interface representing a Namespaces operations. |
| 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 |
| OperationsListOptionalParams |
Optional parameters. |
| OperationsOperations |
Interface representing a Operations operations. |
| OtlpConfiguration |
Configuration of otlp |
| PageSettings |
Options for the byPage method |
| PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
| 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 |
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. |
| ReplicaExecutionStatus |
Container Apps Job execution replica status. |
| ReplicaProperties |
Replica resource specific properties |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| ResourceTags |
List of key value pairs that describe the resource. This will overwrite the existing tags. |
| RestorePollerOptions | |
| 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. |
| SandboxGroupsCreateOrUpdateOptionalParams |
Optional parameters. |
| SandboxGroupsDeleteOptionalParams |
Optional parameters. |
| SandboxGroupsGetOptionalParams |
Optional parameters. |
| SandboxGroupsListByResourceGroupOptionalParams |
Optional parameters. |
| SandboxGroupsListBySubscriptionOptionalParams |
Optional parameters. |
| SandboxGroupsOperations |
Interface representing a SandboxGroups operations. |
| SandboxGroupsUpdateOptionalParams |
Optional parameters. |
| 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. |
| SimplePollerLike |
A simple poller that can be used to poll a long running operation. |
| 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 |
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 |
|
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. |
| UsagesListOptionalParams |
Optional parameters. |
| UsagesOperations |
Interface representing a Usages operations. |
| 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. |
| VnetConnectionsCreateOrUpdateOptionalParams |
Optional parameters. |
| VnetConnectionsDeleteOptionalParams |
Optional parameters. |
| VnetConnectionsGetOptionalParams |
Optional parameters. |
| VnetConnectionsListBySandboxGroupOptionalParams |
Optional parameters. |
| VnetConnectionsOperations |
Interface representing a VnetConnections operations. |
| 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. |
Type Aliases
| AccessMode |
Access mode for storage Known values supported by the serviceReadOnly: ReadOnly |
| Action |
Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny Known values supported by the serviceAllow: Allow |
| ActiveRevisionsMode |
Controls how active revisions are handled for the Container app. Known values supported by the serviceMultiple: Multiple |
| Affinity |
Sticky Session Affinity Known values supported by the servicesticky: sticky |
| AppProtocol |
Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http Known values supported by the servicehttp: http |
| Applicability |
indicates whether the profile is default for the location. Known values supported by the serviceLocationDefault: LocationDefault |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| BindingType |
Custom Domain binding type. Known values supported by the serviceDisabled: Disabled |
| CertificateProvisioningState |
Provisioning state of the certificate. Known values supported by the serviceSucceeded: Succeeded |
| CheckNameAvailabilityReason |
Possible reasons for a name not being available. Known values supported by the serviceInvalid: Name is invalid. |
| ConnectedEnvironmentProvisioningState |
Provisioning state of the Kubernetes Environment. Known values supported by the serviceSucceeded: Succeeded |
| ConnectedEnvironmentStorageProvisioningState |
Provisioning state of the storage. Known values supported by the serviceSucceeded: Succeeded |
| ContainerAppContainerRunningState |
Current running state of the container Known values supported by the serviceRunning: Running |
| ContainerAppProvisioningState |
Provisioning state of the Container App. Known values supported by the serviceInProgress: InProgress |
| ContainerAppReplicaRunningState |
Current running state of the replica Known values supported by the serviceRunning: Running |
| ContainerAppRunningStatus |
Running status of the Container App. Known values supported by the serviceProgressing: Container App is transitioning between Stopped and Running states. |
| ContainerAppsFunctionState |
The state of a Container App function. Known values supported by the serviceEnabled: The function is enabled. |
| 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. Known values supported by the serviceCustomContainer: CustomContainer |
| ContinuablePage |
An interface that describes a page of results. |
| CookieExpirationConvention |
The convention used when determining the session cookie's expiration. |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| DaprComponentProvisioningState |
Provisioning state of the Connected Environment Dapr Component. Known values supported by the serviceSucceeded: Succeeded |
| DnsVerificationTestResult |
DNS verification test result. |
| DotNetComponentProvisioningState |
Provisioning state of the .NET Component. Known values supported by the serviceSucceeded: The .NET component was provisioned successfully. |
| DotNetComponentType |
Type of the .NET Component. Known values supported by the serviceAspireDashboard: An Aspire dashboard component. |
| EnvironmentProvisioningState |
Provisioning state of the Environment. Known values supported by the serviceSucceeded: Succeeded |
| ExtendedLocationTypes |
The type of extendedLocation. Known values supported by the serviceCustomLocation: CustomLocation |
| ForwardProxyConvention |
The convention used to determine the url of the request made. |
| FunctionsExtensionInvokeFunctionsHostResponse | |
| GetCustomDomainVerificationIdResponse | |
| HttpRouteProvisioningState |
The current provisioning state. Known values supported by the serviceSucceeded: Succeeded |
| IdentitySettingsLifeCycle |
Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. Known values supported by the serviceNone: Do not use managed identity during any lifecycle stage. |
| IngressClientCertificateMode |
Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate. Known values supported by the serviceignore: ignore |
| IngressTransportMethod |
Ingress transport protocol Known values supported by the serviceauto: auto |
| JavaComponentPropertiesUnion |
Alias for JavaComponentPropertiesUnion |
| JavaComponentProvisioningState |
Provisioning state of the Java Component. Known values supported by the serviceSucceeded: Succeeded |
| JavaComponentType |
Type of the Java Component. Known values supported by the serviceSpringBootAdmin: SpringBootAdmin |
| JobExecutionRunningState |
Current running State of the job Known values supported by the serviceRunning: Running |
| JobProvisioningState |
Provisioning state of the Container Apps Job. Known values supported by the serviceInProgress: InProgress |
| JobRunningState |
Current running state of the job Known values supported by the serviceReady: The job is ready to run. |
| Kind |
Metadata to represent the container app kind, representing if a container app is workflowapp or functionapp. Known values supported by the serviceworkflowapp: workflowapp |
| LifecycleType |
The lifecycle type of the session pool. Known values supported by the serviceTimed: Timed |
| LogLevel |
Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. Known values supported by the serviceinfo: info |
| ManagedCertificateDomainControlValidation |
Selected type of domain control validation for managed certificates. Known values supported by the serviceCNAME: CNAME |
| ManagedEnvironmentMode |
Mode of the managed environment. Known values supported by the serviceConsumptionOnly: The environment supports consumption-only workloads. |
| ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No managed identity. |
| PoolManagementType |
The pool management type of the session pool. Known values supported by the serviceManual: Manual |
| PrivateEndpointConnectionProvisioningState |
The current provisioning state. Known values supported by the serviceSucceeded: Succeeded |
| PrivateEndpointServiceConnectionStatus |
The private endpoint connection status. Known values supported by the servicePending: Pending |
| PublicNetworkAccess |
Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled'. Known values supported by the serviceEnabled: Enabled |
| RevisionHealthState |
Current health State of the revision Known values supported by the serviceHealthy: Healthy |
| RevisionProvisioningState |
Current provisioning State of the revision Known values supported by the serviceProvisioning: Provisioning |
| RevisionRunningState |
Current running state of the revision Known values supported by the serviceRunning: Running |
| SandboxGroupProvisioningState |
Provisioning state of the SandboxGroup. Known values supported by the serviceSucceeded: Resource has been created. |
| Scheme |
Scheme to use for connecting to the host. Defaults to HTTP. Known values supported by the serviceHTTP: HTTP |
| SessionNetworkStatus |
Network status for the sessions. Known values supported by the serviceEgressEnabled: EgressEnabled |
| SessionPoolIdentityLifeCycle |
Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available. Known values supported by the serviceNone: Do not use managed identity during any lifecycle stage. |
| SessionPoolProvisioningState |
Provisioning state of the session pool. Known values supported by the serviceInProgress: InProgress |
| 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). Known values supported by the serviceLiveness: Checks whether the session is still running and healthy. |
| SourceControlOperationState |
Current provisioning State of the operation Known values supported by the serviceInProgress: InProgress |
| Status |
Status of the label history record. Known values supported by the serviceSucceeded: The label operation completed successfully. |
| StorageType |
Storage type for the volume. If not provided, use EmptyDir. Known values supported by the serviceAzureFile: AzureFile |
| TriggerType |
Trigger type of the job Known values supported by the serviceSchedule: Schedule |
| Type |
The type of probe. Known values supported by the serviceLiveness: Liveness |
| UnauthenticatedClientActionV2 |
The action to take when an unauthenticated client attempts to access the app. |
| VnetConnectionProvisioningState |
Provisioning state of the VnetConnection. Known values supported by the serviceSucceeded: Resource has been created. |
| 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. Known values supported by the serviceStateful: Stateful |
| WorkflowState |
The workflow state. Known values supported by the serviceNotSpecified: NotSpecified |
Enums
| AzureClouds |
An enum to describe Azure Cloud environments. |
| KnownAccessMode |
Access mode for storage |
| KnownAction |
Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny |
| KnownActiveRevisionsMode |
Controls how active revisions are handled for the Container app. |
| KnownAffinity |
Sticky Session Affinity |
| KnownApplicability |
indicates whether the profile is default for the location. |
| KnownAppProtocol |
Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http |
| KnownBindingType |
Custom Domain binding type. |
| KnownCertificateProvisioningState |
Provisioning state of the certificate. |
| KnownCheckNameAvailabilityReason |
Possible reasons for a name not being available. |
| KnownConnectedEnvironmentProvisioningState |
Provisioning state of the Kubernetes Environment. |
| KnownConnectedEnvironmentStorageProvisioningState |
Provisioning state of the storage. |
| KnownContainerAppContainerRunningState |
Current running state of the container |
| KnownContainerAppProvisioningState |
Provisioning state of the Container App. |
| KnownContainerAppReplicaRunningState |
Current running state of the replica |
| KnownContainerAppRunningStatus |
Running status of the Container App. |
| KnownContainerAppsFunctionState |
The state of a Container App function. |
| KnownContainerType |
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. |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownDaprComponentProvisioningState |
Provisioning state of the Connected Environment Dapr Component. |
| KnownDotNetComponentProvisioningState |
Provisioning state of the .NET Component. |
| KnownDotNetComponentType |
Type of the .NET Component. |
| KnownEnvironmentProvisioningState |
Provisioning state of the Environment. |
| KnownExtendedLocationTypes |
The type of extendedLocation. |
| KnownHttpRouteProvisioningState |
The current provisioning state. |
| KnownIdentitySettingsLifeCycle |
Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. |
| KnownIngressClientCertificateMode |
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. |
| KnownIngressTransportMethod |
Ingress transport protocol |
| KnownJavaComponentProvisioningState |
Provisioning state of the Java Component. |
| KnownJavaComponentType |
Type of the Java Component. |
| KnownJobExecutionRunningState |
Current running State of the job |
| KnownJobProvisioningState |
Provisioning state of the Container Apps Job. |
| KnownJobRunningState |
Current running state of the job |
| KnownKind |
Metadata to represent the container app kind, representing if a container app is workflowapp or functionapp. |
| KnownLifecycleType |
The lifecycle type of the session pool. |
| KnownLogLevel |
Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. |
| KnownManagedCertificateDomainControlValidation |
Selected type of domain control validation for managed certificates. |
| KnownManagedEnvironmentMode |
Mode of the managed environment. |
| KnownManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
| KnownPoolManagementType |
The pool management type of the session pool. |
| KnownPrivateEndpointConnectionProvisioningState |
The current provisioning state. |
| KnownPrivateEndpointServiceConnectionStatus |
The private endpoint connection status. |
| KnownPublicNetworkAccess |
Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled'. |
| KnownRevisionHealthState |
Current health State of the revision |
| KnownRevisionProvisioningState |
Current provisioning State of the revision |
| KnownRevisionRunningState |
Current running state of the revision |
| KnownSandboxGroupProvisioningState |
Provisioning state of the SandboxGroup. |
| KnownScheme |
Scheme to use for connecting to the host. Defaults to HTTP. |
| KnownSessionNetworkStatus |
Network status for the sessions. |
| KnownSessionPoolIdentityLifeCycle |
Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available. |
| KnownSessionPoolProvisioningState |
Provisioning state of the session pool. |
| KnownSessionProbeType |
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). |
| KnownSourceControlOperationState |
Current provisioning State of the operation |
| KnownStatus |
Status of the label history record. |
| KnownStorageType |
Storage type for the volume. If not provided, use EmptyDir. |
| KnownTriggerType |
Trigger type of the job |
| KnownType |
The type of probe. |
| KnownVersions |
The available API versions. |
| KnownVnetConnectionProvisioningState |
Provisioning state of the VnetConnection. |
| KnownWorkflowKind |
Gets the logic app hybrid workflow kind. |
| KnownWorkflowState |
The workflow state. |
Functions
| is |
Typeguard for RestError |
| restore |
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope. |
Variables
| Rest |
A custom error type for failed pipeline requests. |
Function Details
isRestError(unknown)
Typeguard for RestError
function isRestError(e: unknown): e is RestError
Parameters
- e
-
unknown
Something caught by a catch clause.
Returns
e is RestError
restorePoller<TResponse, TResult>(ContainerAppsAPIClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.
function restorePoller<TResponse, TResult>(client: ContainerAppsAPIClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- client
- ContainerAppsAPIClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>
Variable Details
RestError
A custom error type for failed pipeline requests.
RestError: RestErrorConstructor