Package-level declarations

Types

Link copied to clipboard
data class AllowedAudiencesValidationResponse(val allowedAudiences: List<String>? = null)

The configuration settings of the Allowed Audiences validation flow.

Link copied to clipboard
data class AllowedPrincipalsResponse(val groups: List<String>? = null, val identities: List<String>? = null)

The configuration settings of the Azure Active Directory allowed principals.

Link copied to clipboard
data class AppleRegistrationResponse(val clientId: String? = null, val clientSecretSettingName: String? = null)

The configuration settings of the registration for the Apple provider

Link copied to clipboard
data class AppleResponse(val enabled: Boolean? = null, val login: LoginScopesResponse? = null, val registration: AppleRegistrationResponse? = null)

The configuration settings of the Apple provider.

Link copied to clipboard
data class AppLogsConfigurationResponse(val destination: String? = null, val logAnalyticsConfiguration: LogAnalyticsConfigurationResponse? = null)

Configuration of application logs

Link copied to clipboard
data class AppRegistrationResponse(val appId: String? = null, val appSecretSettingName: String? = null)

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

Link copied to clipboard
data class AuthPlatformResponse(val enabled: Boolean? = null, val runtimeVersion: String? = null)

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

Link copied to clipboard
data class AzureActiveDirectoryLoginResponse(val disableWWWAuthenticate: Boolean? = null, val loginParameters: List<String>? = null)

The configuration settings of the Azure Active Directory login flow.

Link copied to clipboard
data class AzureActiveDirectoryRegistrationResponse(val clientId: String? = null, val clientSecretCertificateIssuer: String? = null, val clientSecretCertificateSubjectAlternativeName: String? = null, val clientSecretCertificateThumbprint: String? = null, val clientSecretSettingName: String? = null, val openIdIssuer: String? = null)

The configuration settings of the Azure Active Directory app registration.

Link copied to clipboard
data class AzureActiveDirectoryResponse(val enabled: Boolean? = null, val isAutoProvisioned: Boolean? = null, val login: AzureActiveDirectoryLoginResponse? = null, val registration: AzureActiveDirectoryRegistrationResponse? = null, val validation: AzureActiveDirectoryValidationResponse? = null)

The configuration settings of the Azure Active directory provider.

Link copied to clipboard
data class AzureActiveDirectoryValidationResponse(val allowedAudiences: List<String>? = null, val defaultAuthorizationPolicy: DefaultAuthorizationPolicyResponse? = null, val jwtClaimChecks: JwtClaimChecksResponse? = null)

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

Link copied to clipboard
data class AzureCredentialsResponse(val subscriptionId: String? = null)

Container App credentials.

Link copied to clipboard
data class AzureFilePropertiesResponse(val accessMode: String? = null, val accountKey: String? = null, val accountName: String? = null, val shareName: String? = null)

Azure File Properties.

Link copied to clipboard
data class AzureStaticWebAppsRegistrationResponse(val clientId: String? = null)

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

Link copied to clipboard
data class AzureStaticWebAppsResponse(val enabled: Boolean? = null, val registration: AzureStaticWebAppsRegistrationResponse? = null)

The configuration settings of the Azure Static Web Apps provider.

Link copied to clipboard
data class CertificateResponseProperties(val expirationDate: String, val issueDate: String, val issuer: String, val provisioningState: String, val publicKeyHash: String, val subjectName: String, val thumbprint: String, val valid: Boolean)

Certificate resource specific properties

Link copied to clipboard
data class ClientRegistrationResponse(val clientId: String? = null, val clientSecretSettingName: String? = null)

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

Link copied to clipboard
data class ConfigurationResponse(val activeRevisionsMode: String? = null, val dapr: DaprResponse? = null, val ingress: IngressResponse? = null, val registries: List<RegistryCredentialsResponse>? = null, val secrets: List<SecretResponse>? = null)

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

Link copied to clipboard
data class ContainerAppProbeResponse(val failureThreshold: Int? = null, val httpGet: ContainerAppProbeResponseHttpGet? = null, val initialDelaySeconds: Int? = null, val periodSeconds: Int? = null, val successThreshold: Int? = null, val tcpSocket: ContainerAppProbeResponseTcpSocket? = null, val terminationGracePeriodSeconds: Double? = null, val timeoutSeconds: Int? = null, val type: String? = null)

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

Link copied to clipboard
data class ContainerAppProbeResponseHttpGet(val host: String? = null, val httpHeaders: List<ContainerAppProbeResponseHttpHeaders>? = null, val path: String? = null, val port: Int, val scheme: String? = null)

HTTPGet specifies the http request to perform.

Link copied to clipboard
data class ContainerAppProbeResponseHttpHeaders(val name: String, val value: String)

HTTPHeader describes a custom header to be used in HTTP probes

Link copied to clipboard
data class ContainerAppProbeResponseTcpSocket(val host: String? = null, val port: Int)

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

Link copied to clipboard
data class ContainerAppSecretResponse(val name: String, val value: String)

Container App Secret.

Link copied to clipboard
data class ContainerResourcesResponse(val cpu: Double? = null, val ephemeralStorage: String, val memory: String? = null)

Container App container resource requirements.

Link copied to clipboard
data class ContainerResponse(val args: List<String>? = null, val command: List<String>? = null, val env: List<EnvironmentVarResponse>? = null, val image: String? = null, val name: String? = null, val probes: List<ContainerAppProbeResponse>? = null, val resources: ContainerResourcesResponse? = null, val volumeMounts: List<VolumeMountResponse>? = null)

Container App container definition.

Link copied to clipboard
data class CookieExpirationResponse(val convention: String? = null, val timeToExpiration: String? = null)

The configuration settings of the session cookie's expiration.

Link copied to clipboard
data class CustomDomainResponse(val bindingType: String? = null, val certificateId: String? = null, val name: String)

Custom Domain of a Container App

Raw failure information if DNS verification fails.

data class CustomHostnameAnalysisResultResponseDetails(val code: String, val message: String, val target: String)

Detailed errors.

Link copied to clipboard
data class CustomOpenIdConnectProviderResponse(val enabled: Boolean? = null, val login: OpenIdConnectLoginResponse? = null, val registration: OpenIdConnectRegistrationResponse? = null)

The configuration settings of the custom Open ID Connect provider.

Link copied to clipboard
data class CustomScaleRuleResponse(val auth: List<ScaleRuleAuthResponse>? = null, val metadata: Map<String, String>? = null, val type: String? = null)

Container App container Custom scaling rule.

Link copied to clipboard
data class DaprMetadataResponse(val name: String? = null, val secretRef: String? = null, val value: String? = null)

Dapr component metadata.

Link copied to clipboard
data class DaprResponse(val appId: String? = null, val appPort: Int? = null, val appProtocol: String? = null, val enabled: Boolean? = null)

Container App Dapr configuration.

Link copied to clipboard
data class DaprSecretResponse(val name: String, val value: String)

Dapr component Secret for ListSecrets Action

Link copied to clipboard
data class DefaultAuthorizationPolicyResponse(val allowedApplications: List<String>? = null, val allowedPrincipals: AllowedPrincipalsResponse? = null)

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

Link copied to clipboard
data class EnvironmentVarResponse(val name: String? = null, val secretRef: String? = null, val value: String? = null)

Container App container environment variable.

Link copied to clipboard
data class FacebookResponse(val enabled: Boolean? = null, val graphApiVersion: String? = null, val login: LoginScopesResponse? = null, val registration: AppRegistrationResponse? = null)

The configuration settings of the Facebook provider.

Link copied to clipboard
data class ForwardProxyResponse(val convention: String? = null, val customHostHeaderName: String? = null, val customProtoHeaderName: String? = null)

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

Link copied to clipboard
data class GetCertificateResult(val id: String, val location: String, val name: String, val properties: CertificateResponseProperties, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

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

Link copied to clipboard
data class GetContainerAppResult(val configuration: ConfigurationResponse? = null, val customDomainVerificationId: String, val id: String, val identity: ManagedServiceIdentityResponse? = null, val latestRevisionFqdn: String, val latestRevisionName: String, val location: String, val managedEnvironmentId: String? = null, val name: String, val outboundIpAddresses: List<String>, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val template: TemplateResponse? = null, val type: String)

Container App.

Link copied to clipboard
data class GetContainerAppsAuthConfigResult(val globalValidation: GlobalValidationResponse? = null, val httpSettings: HttpSettingsResponse? = null, val id: String, val identityProviders: IdentityProvidersResponse? = null, val login: LoginResponse? = null, val name: String, val platform: AuthPlatformResponse? = null, val systemData: SystemDataResponse, val type: String)

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

Link copied to clipboard
data class GetContainerAppsSourceControlResult(val branch: String? = null, val githubActionConfiguration: GithubActionConfigurationResponse? = null, val id: String, val name: String, val operationState: String, val repoUrl: String? = null, val systemData: SystemDataResponse, val type: String)

Container App SourceControl.

Link copied to clipboard
data class GetDaprComponentResult(val componentType: String? = null, val id: String, val ignoreErrors: Boolean? = null, val initTimeout: String? = null, val metadata: List<DaprMetadataResponse>? = null, val name: String, val scopes: List<String>? = null, val secrets: List<SecretResponse>? = null, val systemData: SystemDataResponse, val type: String, val version: String? = null)

Dapr Component.

Link copied to clipboard
data class GetManagedEnvironmentResult(val appLogsConfiguration: AppLogsConfigurationResponse? = null, val daprAIConnectionString: String? = null, val daprAIInstrumentationKey: String? = null, val defaultDomain: String, val deploymentErrors: String, val id: String, val location: String, val name: String, val provisioningState: String, val staticIp: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val vnetConfiguration: VnetConfigurationResponse? = null, val zoneRedundant: Boolean? = null)

An environment for hosting container apps

Link copied to clipboard
data class GetManagedEnvironmentsStorageResult(val id: String, val name: String, val properties: ManagedEnvironmentStorageResponseProperties, val systemData: SystemDataResponse, val type: String)

Storage resource for managedEnvironment.

Link copied to clipboard
data class GithubActionConfigurationResponse(val azureCredentials: AzureCredentialsResponse? = null, val contextPath: String? = null, val image: String? = null, val os: String? = null, val publishType: String? = null, val registryInfo: RegistryInfoResponse? = null, val runtimeStack: String? = null, val runtimeVersion: String? = null)

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

Link copied to clipboard
data class GitHubResponse(val enabled: Boolean? = null, val login: LoginScopesResponse? = null, val registration: ClientRegistrationResponse? = null)

The configuration settings of the GitHub provider.

Link copied to clipboard
data class GlobalValidationResponse(val excludedPaths: List<String>? = null, val redirectToProvider: String? = null, val unauthenticatedClientAction: String? = null)

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

Link copied to clipboard
data class GoogleResponse(val enabled: Boolean? = null, val login: LoginScopesResponse? = null, val registration: ClientRegistrationResponse? = null, val validation: AllowedAudiencesValidationResponse? = null)

The configuration settings of the Google provider.

Link copied to clipboard
data class HttpScaleRuleResponse(val auth: List<ScaleRuleAuthResponse>? = null, val metadata: Map<String, String>? = null)

Container App container Custom scaling rule.

Link copied to clipboard
data class HttpSettingsResponse(val forwardProxy: ForwardProxyResponse? = null, val requireHttps: Boolean? = null, val routes: HttpSettingsRoutesResponse? = null)

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

Link copied to clipboard
data class HttpSettingsRoutesResponse(val apiPrefix: String? = null)

The configuration settings of the paths HTTP requests.

Link copied to clipboard
data class IdentityProvidersResponse(val apple: AppleResponse? = null, val azureActiveDirectory: AzureActiveDirectoryResponse? = null, val azureStaticWebApps: AzureStaticWebAppsResponse? = null, val customOpenIdConnectProviders: Map<String, CustomOpenIdConnectProviderResponse>? = null, val facebook: FacebookResponse? = null, val gitHub: GitHubResponse? = null, val google: GoogleResponse? = null, val twitter: TwitterResponse? = null)

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

Link copied to clipboard
data class IngressResponse(val allowInsecure: Boolean? = null, val customDomains: List<CustomDomainResponse>? = null, val external: Boolean? = null, val fqdn: String, val targetPort: Int? = null, val traffic: List<TrafficWeightResponse>? = null, val transport: String? = null)

Container App Ingress configuration.

Link copied to clipboard
data class JwtClaimChecksResponse(val allowedClientApplications: List<String>? = null, val allowedGroups: List<String>? = null)

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

data class ListContainerAppCustomHostNameAnalysisResult(val aRecords: List<String>? = null, val alternateCNameRecords: List<String>? = null, val alternateTxtRecords: List<String>? = null, val cNameRecords: List<String>? = null, val conflictWithEnvironmentCustomDomain: Boolean, val conflictingContainerAppResourceId: String, val customDomainVerificationFailureInfo: CustomHostnameAnalysisResultResponseCustomDomainVerificationFailureInfo, val customDomainVerificationTest: String, val hasConflictOnManagedEnvironment: Boolean, val hostName: String, val isHostnameAlreadyVerified: Boolean, val txtRecords: List<String>? = null)

Custom domain analysis.

Link copied to clipboard

Container App Secrets Collection ARM resource.

Link copied to clipboard

Dapr component Secrets Collection for ListSecrets Action

Link copied to clipboard
data class LogAnalyticsConfigurationResponse(val customerId: String? = null)

Log analytics configuration

Link copied to clipboard
data class LoginResponse(val allowedExternalRedirectUrls: List<String>? = null, val cookieExpiration: CookieExpirationResponse? = null, val nonce: NonceResponse? = null, val preserveUrlFragmentsForLogins: Boolean? = null, val routes: LoginRoutesResponse? = null)

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

Link copied to clipboard
data class LoginRoutesResponse(val logoutEndpoint: String? = null)

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

Link copied to clipboard
data class LoginScopesResponse(val scopes: List<String>? = null)

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

Storage properties

Link copied to clipboard
data class ManagedServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

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

Link copied to clipboard
data class NonceResponse(val nonceExpirationInterval: String? = null, val validateNonce: Boolean? = null)

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

Link copied to clipboard
data class OpenIdConnectClientCredentialResponse(val clientSecretSettingName: String? = null, val method: String? = null)

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

Link copied to clipboard
data class OpenIdConnectConfigResponse(val authorizationEndpoint: String? = null, val certificationUri: String? = null, val issuer: String? = null, val tokenEndpoint: String? = null, val wellKnownOpenIdConfiguration: String? = null)

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

Link copied to clipboard
data class OpenIdConnectLoginResponse(val nameClaimType: String? = null, val scopes: List<String>? = null)

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

Link copied to clipboard
data class OpenIdConnectRegistrationResponse(val clientCredential: OpenIdConnectClientCredentialResponse? = null, val clientId: String? = null, val openIdConnectConfiguration: OpenIdConnectConfigResponse? = null)

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

Link copied to clipboard
data class QueueScaleRuleResponse(val auth: List<ScaleRuleAuthResponse>? = null, val queueLength: Int? = null, val queueName: String? = null)

Container App container Azure Queue based scaling rule.

Link copied to clipboard
data class RegistryCredentialsResponse(val identity: String? = null, val passwordSecretRef: String? = null, val server: String? = null, val username: String? = null)

Container App Private Registry

Link copied to clipboard
data class RegistryInfoResponse(val registryUrl: String? = null, val registryUserName: String? = null)

Container App registry information.

Link copied to clipboard
data class ScaleResponse(val maxReplicas: Int? = null, val minReplicas: Int? = null, val rules: List<ScaleRuleResponse>? = null)

Container App scaling configurations.

Link copied to clipboard
data class ScaleRuleAuthResponse(val secretRef: String? = null, val triggerParameter: String? = null)

Auth Secrets for Container App Scale Rule

Link copied to clipboard
data class ScaleRuleResponse(val azureQueue: QueueScaleRuleResponse? = null, val custom: CustomScaleRuleResponse? = null, val http: HttpScaleRuleResponse? = null, val name: String? = null)

Container App container scaling rule.

Link copied to clipboard
data class SecretResponse(val name: String? = null)

Secret definition.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TemplateResponse(val containers: List<ContainerResponse>? = null, val revisionSuffix: String? = null, val scale: ScaleResponse? = null, val volumes: List<VolumeResponse>? = null)

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

Link copied to clipboard
data class TrafficWeightResponse(val label: String? = null, val latestRevision: Boolean? = null, val revisionName: String? = null, val weight: Int? = null)

Traffic weight assigned to a revision

Link copied to clipboard
data class TwitterRegistrationResponse(val consumerKey: String? = null, val consumerSecretSettingName: String? = null)

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

Link copied to clipboard
data class TwitterResponse(val enabled: Boolean? = null, val registration: TwitterRegistrationResponse? = null)

The configuration settings of the Twitter provider.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties

Link copied to clipboard
data class VnetConfigurationResponse(val dockerBridgeCidr: String? = null, val infrastructureSubnetId: String? = null, val internal: Boolean? = null, val platformReservedCidr: String? = null, val platformReservedDnsIP: String? = null, val runtimeSubnetId: String? = null)

Configuration properties for apps environment to join a Virtual Network

Link copied to clipboard
data class VolumeMountResponse(val mountPath: String? = null, val volumeName: String? = null)

Volume mount for the Container App.

Link copied to clipboard
data class VolumeResponse(val name: String? = null, val storageName: String? = null, val storageType: String? = null)

Volume definitions for the Container App.