ALOpsDockerStart v1
- task: ALOpsDockerStart@1
displayName: 'ALOps Docker Start'
inputs:
fixed_tag: # Fixed name tag assigned to the started container. Use the same value in subsequent ALOps Docker tasks to target this container. $(fixed_tag)
ignore_no_container_warning: False # When enabled, no warning is produced if a container with the given fixed_tag is not found. Useful in conditional pipeline flows where the container may not have been created. $(ignore_no_container_warning)
docker_image: $(ALOPS_BC_IMAGE) # Full name and tag of the Business Central Docker image to start. Supports the $(ALOPS_BC_IMAGE) pipeline variable set by ALOps Docker Create. $(docker_image)
accept_image_eula: True # Accept the end-user license agreement of the Docker image. Required for official Microsoft BC images. $(accept_image_eula)
accept_image_outdated: True # Accept and start images that are marked as outdated by navcontainerhelper. Disable this to enforce the use of fresh images only. $(accept_image_outdated)
enable_symbol_loading: False # Enable the AL symbol loading feature in the Business Central service tier. Required when using this container for compilation with the legacy symbol-download approach. $(enable_symbol_loading)
enable_api_services: False # Enable the Business Central OData and API services endpoint. Required for tasks that interact with BC via REST API. $(enable_api_services)
multitenant: False # Start the container in multi-tenant mode. Each tenant runs in an isolated database. Required for multi-tenant test scenarios. $(multitenant)
docker_pull: True # Force a Docker pull of the image before starting the container to ensure the latest version is used. Disable to use a locally cached image. $(docker_pull)
dockerauthentication: None # Authentication method for the Docker registry. None uses no authentication. Endpoint uses a service connection configured in Azure DevOps. UsernamePassword uses the docker_username and docker_password fields. $(dockerauthentication)
docker_login: # Generic service connection configured in Azure DevOps for Docker registry authentication. Used when dockerauthentication is set to Endpoint. $(docker_login)
docker_username: # Username for authenticating to the Docker registry. Used when dockerauthentication is set to UsernamePassword. $(docker_username)
docker_password: # Password for authenticating to the Docker registry. Store this in a pipeline secret variable. Used when dockerauthentication is set to UsernamePassword. $(docker_password)
docker_registry: # Hostname of the Docker registry to authenticate against, for example bcinsider.azurecr.io. Leave empty to use Docker Hub. $(docker_registry)
memory_gb: -1 # Maximum memory in GB allocated to the container. Set to -1 for no memory limit. Increase this for large databases or memory-intensive BC operations. $(memory_gb)
container_restart: no # Docker restart policy for the container. no means no automatic restart. on-failure restarts on non-zero exit. unless-stopped and always restart unconditionally. $(container_restart)
licensefile: # Path or URL of the Business Central license file to import into the container on startup. Supports .flf and .bclicense formats. $(licensefile)
docker_parameters: # Additional raw Docker run parameters to pass to the container startup command, one per line, for example --env MYVAR=value. $(docker_parameters)
sql_server: # Hostname or IP address of an external SQL Server to use as the BC database server instead of the built-in SQL Express in the container. $(sql_server)
sql_server_instance: # Named instance of the external SQL Server, for example MSSQLSERVER. Leave empty for the default instance. $(sql_server_instance)
sql_database: # Name of the SQL database on the external SQL Server that Business Central will use. $(sql_database)
sql_database_user: # User account on the external SQL Server that Business Central uses to connect to the database. $(sql_database_user)
sql_database_user_password: # Password for the external SQL Server user account. Store this in a pipeline secret variable. $(sql_database_user_password)
sql_backup_file: # Path to a SQL Server .bak backup file to restore into the external SQL database on container startup. Use this to start BC with an existing database. $(sql_backup_file)
encryption_key: # Encryption key used by the Business Central service tier for data encryption. Provide this when connecting to a pre-existing encrypted database. $(encryption_key)
taskscheduler: Keep # Override the Task Scheduler state in Business Central. Keep preserves the image default. Enable starts the scheduler. Disable stops it, which is recommended for pipeline containers to prevent background jobs. $(taskscheduler)
keyvault_pfxfile: # Path to a PFX file used to authenticate the BC service tier to Azure Key Vault for secret retrieval. $(keyvault_pfxfile)
keyvault_pfxpassword: # Password for the Key Vault PFX file. Store this in a pipeline secret variable. $(keyvault_pfxpassword)
keyvault_clientid: # Azure AD application (client) ID that Business Central uses to authenticate to Azure Key Vault. $(keyvault_clientid)
keyvault_publisher_validation: False # When enabled, Business Central validates that app publishers match the allowed list configured in Key Vault before granting secret access. $(keyvault_publisher_validation)