Releases
1.9.0PRE Deployment

PRE Deployment v1.9.0

Creation of a secret in an app registration

Create the secret

For the update of this version, we need to create a secret in the app registration SharePoint Online Client Extensibility Web Application Principal.

  1. Sign in to the Azure portal.
  2. On the Azure portal menu, search for and select Microsoft Entra ID.
  3. Select App registrations and select SharePoint Online Client Extensibility Web Application Principal application from the list.
  4. Select Certificates & secrets.
  5. Select Client secrets, and then select New client secret.
  6. Provide a description of the secret, and a duration (we recommend 2 years).
  7. Select Add. After saving the client secret, you will see its value displayed. Please make sure to copy this value as it cannot be retrieved later. The next step is to store it in the Key Vault.

Store the secret in the Key Vault

To use the secret that you just created in the previous step, you need to update the corresponding value in the Key Vault.

  1. Sign in to the Azure portal.
  2. On the Azure portal menu, search for and select Key vaults.
  3. Select the Syntphony key vault. It is the one with the tenant’s name.
  4. On the left menu, under Objects, select Secrets.
  5. Select TogoFrontendApp, and then select New Version.
  6. Provide the secret of previous step in Secret value.
  7. Select Create.

Add permission to an app registration

For Search to work properly, we need to add the Bookmark.Read.All permission to the SyntphonyBackendAPI app registration.

  1. Sign in to the Azure portal.
  2. On the Azure portal menu, search for and select Microsoft Entra ID.
  3. Select App registrations and select SyntphonyBackendAPI application from the list.
  4. Select API permissions.
  5. Select Add a permission.
  6. Select Microsoft Graph, then Delegated permissions and select Bookmark.Read.All.
  7. Select Add permissions.

Add new secret in the Key Vault

For the deployment to work correctly, the ID of an application record must be added to the Key Vault.

Get the app registration ID

First, let’s retrieve the application registry ID.

  1. Sign in to the Azure portal.
  2. On the Azure portal menu, search for and select Microsoft Entra ID.
  3. Select App registrations and select SPN_Syntphony_Azure application from the list.
  4. Copy the Application (client) ID.

Store the secret in the Key Vault

To use the app registration ID that you just got in the previous step, you need to create a secret value in the Key Vault.

  1. Sign in to the Azure portal.
  2. On the Azure portal menu, search for and select Key vaults.
  3. Select the Syntphony key vault. It is the one with the tenant’s name.
  4. On the left menu, under Objects, select Secrets.
  5. Select Generate/Import.
  6. Provide TogoIACAppId in the Name field and the Application ID from the previous step in the Secret value field.
  7. Select Create.

Register resource provider

To deploy all the resources in the release, the Microsoft.Network resource provider must be registered in the subscription where Syntphony is installed.

  1. Sign in to the Azure portal.
  2. On the Azure portal menu, search for and select Subscriptions.
  3. Select the subscription where Syntphony is installed.
  4. On the left menu, under Settings, select Resource providers.
  5. Find the resource provider Microsoft.Network and select Register.

Add an access policy to the Key Vault

We need to give Key Vault access permissions to the application with the App ID ‘abfa0a7c-a6b6-4736-8310-5855508787cd’ (Microsoft Azure App Service) before deployment.

  1. Sign in to the Azure portal.
  2. On the Azure portal menu, search for and select Key vaults.
  3. Select the Syntphony key vault. It is the one with the tenant’s name.
  4. On the left menu, select Access policies.
  5. Create a new one.
  6. Select the following Permissions: Key vault configuration
  7. In the Principal step, search for abfa0a7c-a6b6-4736-8310-5855508787cd (Microsoft Azure App Service).
  8. Select Create.

Update the permissions of an app registration

Get the app registration ID

Get the app registration ID from Key vault.

  1. Sign in to the Azure portal.
  2. On the Azure portal menu, search for and select Key vaults.
  3. Select the Syntphony key vault. It is the one with the tenant’s name.
  4. On the left menu, under Objects, select Secrets.
  5. Select TogoLegacyBackendAppId.
  6. Select the Current version.
  7. Copy the Secret value.

Grant permission

This granting can only be done via the appinv.aspx page on the tenant administration site. You can reach this site via https://contoso-admin.sharepoint.com/_layouts/15/appinv.aspx.

Once the page has loaded, add the Client ID you obtained in the previous step and Lookup the created Principal.

To grant permissions, you will need to provide the following permissions:

<AppPermissionRequests AllowAppOnlyPolicy="true">
    <AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl" />
    <AppPermissionRequest Scope="http://sharepoint/social/tenant" Right="FullControl" />
</AppPermissionRequests>

When you click on Create, you will be presented with a permission consent dialog. Press Trust It to grant the permissions.

Scaling the cache

Before running the installation, we need to manually scale the Azure Cache for Redis.

  1. Sign in to the Azure portal.
  2. On the Azure portal menu, search for and select Azure Cache for Redis.
  3. Select the Syntphony cache. It is the one with the tenant’s name.
  4. On the left menu, select Scale.
  5. Select Standard C0. It is the green colour option.
  6. Press Select to save the new configuration.

Get the installation configuration

To execute the installation of the version, the Syntphony team requires the environment configuration stored in the Storage account.

  1. Sign in to the Azure portal.
  2. On the Azure portal menu, search for and select Storage accounts.
  3. Select the Syntphony storage account. It is the one with the tenant’s name.
  4. On the left menu, select Storage browser.
  5. Select Tables.
  6. Select Releases table.
  7. Search for the latest version. It is the one with the RowKey 1.8.4 or 1.8.5.
  8. Provide the Configuration value to the Syntphony team.