Skip to content

Override azure environment endpoints of cosmos db spark connector #45245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Override azure environment endpoints of cosmos db spark connector #45245

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion ...cosmos/azure-cosmos-spark_3_2-12/src/main/scala/com/azure/cosmos/spark/CosmosConfig.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ import java.util.{Locale, ServiceLoader}
import scala.collection.concurrent.TrieMap
import scala.collection.immutable.{HashSet, List, Map}
import scala.collection.mutable
import scala.collection.JavaConverters._

// scalastyle:off multiple.string.literals
// scalastyle:off file.size.limit
Expand All @@ -48,6 +49,7 @@ private[spark] object CosmosConfigNames {
val TenantId = "spark.cosmos.account.tenantId"
val ResourceGroupName = "spark.cosmos.account.resourceGroupName"
val AzureEnvironment = "spark.cosmos.account.azureEnvironment"
val AzureEnvironmentEndpointOverride = "spark.cosmos.account.azureEnvironmentEndpointOverride"
val AuthType = "spark.cosmos.auth.type"
val ClientId = "spark.cosmos.auth.aad.clientId"
val ResourceId = "spark.cosmos.auth.aad.resourceId"
Expand Down Expand Up @@ -628,6 +630,21 @@ private object CosmosAccountConfig extends BasicLoggingTrait {
},
helpMessage = "The azure environment of the CosmosDB account: `Azure`, `AzureChina`, `AzureUsGovernment`, `AzureGermany`.")

private val AzureEnvironmentOverrideEndpoints = CosmosConfigEntry[java.util.Map[String, String]](key = CosmosConfigNames.AzureEnvironmentEndpointOverride,
mandatory = false,
parseFromStringFunction = azureEnvironmentOverrideEndpointsAsCommaSeparatedString => {
val endpoints: java.util.Map[String, String] =
azureEnvironmentOverrideEndpointsAsCommaSeparatedString
.split(",")
.flatMap(_.split("=", 2) match {
case Array(k, v) => Some(k -> v)
case _ => throw new IllegalArgumentException(s"Azure environment override endpoint string $azureEnvironmentOverrideEndpointsAsCommaSeparatedString is not valid")
}).toMap

endpoints
},
helpMessage = "The azure environment endpoints to override. e.g. `portalUrl=https://example.com,managementEndpointUrl=https://other.com`")

private val ClientBuilderInterceptors = CosmosConfigEntry[String](key = CosmosConfigNames.ClientBuilderInterceptors,
mandatory = false,
parseFromStringFunction = clientBuilderInterceptorFQDN => clientBuilderInterceptorFQDN,
Expand Down Expand Up @@ -670,6 +687,8 @@ private object CosmosAccountConfig extends BasicLoggingTrait {
val resourceGroupNameOpt = CosmosConfigEntry.parse(cfg, ResourceGroupName)
val tenantIdOpt = CosmosConfigEntry.parse(cfg, TenantId)
val azureEnvironmentOpt = CosmosConfigEntry.parse(cfg, AzureEnvironmentTypeEnum)
val azureEnvironmentOverrideEndpointsOpt = CosmosConfigEntry.parse(cfg, AzureEnvironmentOverrideEndpoints)

val clientBuilderInterceptors = CosmosConfigEntry.parse(cfg, ClientBuilderInterceptors)
val clientInterceptors = CosmosConfigEntry.parse(cfg, ClientInterceptors)

Expand Down Expand Up @@ -747,6 +766,19 @@ private object CosmosAccountConfig extends BasicLoggingTrait {
}
}

val azureEnvironmentEndpoints = azureEnvironmentOverrideEndpointsOpt match {
case Some(overrideMap) =>
// Only override the keys that exist in the azureEnvironment endpoints map
azureEnvironmentOpt.get.asScala.map {
case (k, v) =>
overrideMap.asScala.get(k) match {
case Some(overrideVal) if overrideVal.nonEmpty => k -> overrideVal
case _ => k -> v
}
}.asJava
case None => azureEnvironmentOpt.get
}

CosmosAccountConfig(
endpointOpt.get,
authConfig,
Expand All @@ -762,7 +794,7 @@ private object CosmosAccountConfig extends BasicLoggingTrait {
subscriptionIdOpt,
tenantIdOpt,
resourceGroupNameOpt,
azureEnvironmentOpt.get,
azureEnvironmentEndpoints,
if (clientBuilderInterceptorsList.nonEmpty) { Some(clientBuilderInterceptorsList.toList) } else { None },
if (clientInterceptorsList.nonEmpty) { Some(clientInterceptorsList.toList) } else { None })
}
Expand Down
Loading