Deployment
Follow the steps below to deploy the application:
Warning
This step is required if you want to make any customizations to the solution being deployed
Note
If you performed the step above, this should be done from your new repository
This is required to prevent issues with script ps1 script executions.
The deployment script(s) will be executed from this directory. Make note of where this was stored.
This is the name that is used for the Azure Resource Group that Call Record Insights resources will be deployed to. If this does not exist it will be created.
This is the name of which all resources are based upon. If BaseResourceName is not specified ResourceGroupName is used.
Default: ResourceGroupName
This is the subscription id of the subscription to which the application will be deployed.
This defines the SKUs of each component (Kusto, Function App, Storage Account).
Options are:
- DevTest
- Production
- ProductionRestricted
Default: Production
This is the Azure region location where the application (and all associated resources) will be deployed.
Choose the Right Azure Region for You | Microsoft Azure
Be sure to select a valid region for your Azure Cloud Environment.
Example: centralus or usgovarizona
Default: westus
This is the GIT Repo URL that you are deploying.
If you forked the repo, then this is Required and must be set to the url hosting your repository
Example: https://github.com/{organization}/callrecord-insights.git
If you are using a private repository, then a Personal Access Token must be created and passed in this parameter
Example: https://{username}:{PAT}@github.com/{organization}/callrecord-insights.git
Default: https://github.com/OfficeDev/microsoft-teams-apps-callrecord-insights.git
This is the name of the branch of the repository you wish to deploy
Default: main
This is the domain name associated with your Tenant.
Example: contoso.com
The account name used for Cosmos DB.
Default: BaseResourceName + cdb
The database name used for the Call Records Database in Cosmos DB.
Default: CallRecordInsights
The CallRecords container name in Cosmos DB.
Default: records
The Kusto cluster name if deploying to an existing KustoCluster
The database name inside of the Kusto cluster of the Call Records database
The table name inside of the Kusto database
The name of the view that de-duplicates records in case of duplication due to updated call record ingestion.
Include this switch to use Role-Based Access Control instead of Key Vault + SAS for the Microsoft Graph Change Tracking connection to Event Hub. See here for more information.
Using the parameters defined above
Example:
$DeploymentParameters = @{
ResourceGroupName = 'cridemo1rg'
BaseResourceName = 'cridemo1'
SubscriptionId = 'ba5eba11-beef-ba5e-ba11-beefba5eba11'
TenantDomain = 'contoso.com'
}
.\deploy.ps1 @DeploymentParametersWait for deployment script to complete
Once deployment steps complete (successfully or unsuccessfully) the deployment script calls the admin function to get the health state of the deployment. The output indicates whether all required services are up and healthy.
Once the deployment script is completed, the final output will be the deployment health.
If the output of $HealthState is healthy, then you will receive the following message:
App deployment is healthy.
$HealthState is the variable which will contain details regarding the health state of the deployment
This indicates if the deployment is overall healthy or unhealthy.
This provides the health status of the EventHub and the EventHub Url
This provides the health status of the Cosmos DB and the Cosmos DB Url for the call records db.
This provides the health status of the Azure Storage Queue and the Azure Storage Queue Url for the download queue.
This provides the health status of the subscription to the Call Records Graph API endpoint and the expiration date of the subscription.
Lists all services above that were found to be unhealthy.
From portal.azure.com, Navigate to Resource Group -> Kusto Cluster -> Databases -> Database -> CosmosDB
