Skip to main content

API Variables

API pipeline variables

VariableDescriptionExample
CreateNewWebAppCreates the App Service if it does not exist. Set to false for subsequent deployments.true
ApiAppNameName of the Azure App Service for the API.whatif-api-prod
ApiResourceGroupNameAzure resource group containing the API App Service.rg-whatif-prod
AppServicePlanNameName of the App Service Plan.asp-whatif-prod
AppServicePlanSizeSKU size of the App Service Plan.P1v3
CorsAllowedOriginsComma-separated list of origins permitted by the API CORS policy.https://whatif-web-prod.azurewebsites.net
LoggingLevelAPI log verbosity.Warning
LogToLog output target.Cloud
LogCloudConnectionStringConnection string for the cloud logging sink.DefaultEndpointsProtocol=https;AccountName=...
DefaultConnectionSQL Server connection string for the primary scenario database.Server=sql-prod.database.windows.net;Database=ScenarioDB;...
BookDataLakehouseConnectionConnection string for the Book Data Lakehouse SQL endpoint.Server=<lakehouse-sql-endpoint>;Database=...
DashboardSummaryLakehouseConnectionConnection string for the Dashboard Summary Lakehouse SQL endpoint.Server=<lakehouse-sql-endpoint>;Database=...
RatingOutputLakeHouseConnectionConnection string for the Rating Output Lakehouse SQL endpoint.Server=<lakehouse-sql-endpoint>;Database=...
JwtSecretSecret key used to sign JWT tokens.<secret>
JwtIssuerIssuer claim for JWT tokens.https://whatif-api-prod.azurewebsites.net
JwtAudienceAudience claim for JWT tokens.whatif-client
JwtExpirationMinutesAccess token lifetime in minutes.60
JwtRefreshTokenExpirationDaysRefresh token lifetime in days.7
FabricTenantIdEntra ID tenant ID for Fabric authentication.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
FabricClientIdService principal client ID for Fabric.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
FabricClientSecretService principal client secret for Fabric.<secret>
FabricUseKeyVaultWhen true, client ID and secret are read from Key Vault instead of pipeline variables.true
FabricKeyVaultUrlURL of the Azure Key Vault instance.https://kv-whatif-prod.vault.azure.net/
FabricClientIdSecretNameKey Vault secret name for the Fabric client ID.fabric-client-id
FabricClientKeySecretNameKey Vault secret name for the Fabric client secret.fabric-client-secret
FabricTenantIdSecretNameKey Vault secret name for the Fabric tenant ID.fabric-tenant-id
FabricEnableCapacityResumeEnables automatic Fabric capacity resume before execution.true
FabricEnableCapacitySuspendEnables automatic Fabric capacity suspend after execution.true
FabricSubscriptionIdAzure subscription ID containing the Fabric capacity.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
FabricResourceGroupNameResource group containing the Fabric capacity.rg-whatif-prod
FabricApiVersionAzure REST API version used for Fabric capacity management calls.2023-05-01
FabricCapacityResumeDelayMsDelay in milliseconds after capacity resume before execution proceeds.30000
MailSmtpServerSMTP server hostname for outbound email.smtp.office365.com
MailIdEmail address used as the sender account.noreply@example.com
MailPasswordPassword for the sender email account.<secret>
MailFromDisplay address shown in the From field.noreply@example.com
MailSubjectDefault subject line for system-generated emails.WhatIF Notification
MailPortSMTP port.587
AppBaseUrlPublic base URL of the API, used for self-referencing links.https://whatif-api-prod.azurewebsites.net
ScenarioDBName of the scenario SQL database.ScenarioDB