Here's the list of all configurations supported by the applications. Required configurations are defined in the ARM templates and automatically created during the Azure resources deployment process.
Authentication__Provider: The name of the authentication provider used to authenticate/authorize incoming requests.Authentication__AzureAD__Instance: The Azure Active Directory URL used for logging in.Authentication__AzureAD__TenantId: The ID of the Azure Active Directory tenant.Authentication__AzureAD__ClientId: The ID assigned to the API once the app is registered.Authentication__AzureAD__Roles: The array of application permissions which specify role-based access using the client application's identity (optional).Authentication__AzureAD__Scopes: The space-separated list of delegated permissions which specify scope-based access using delegated authorization from the signed-in user (optional).APPINSIGHTS_INSTRUMENTATIONKEY: The instrumentation key of the Azure Application Insights used for monitoring.DeviceCommunication__IoTHub__MethodName: The Azure IoT Hub DirectMethod name that will be invoked by the API.DeviceCommunication__IoTHub__ResponseTimeout: The number of seconds to wait for a response from a DirectMethod invocation. This value can be overriden on a per request basis using the responseTimeout URL query string parameter.DeviceCommunication__IoTHub__MessageSizeThreshold: The size in bytes above which messages are buffered to file storage prior to being forwarded to the device.FileStorage__DeviceFileUploadFolder: The Azure storage account container name where devices will upload their files.FileStorage__ServerFileUploadFolder: The Azure storage account container name where the API will upload its files.NOTE: As of today, the only supported authentication provider is
AzureAD. Any other provider name will not enforce authentication/authorization and therefore allow anonymous access. If you plan to use your own authentication solution, make sure to implement required components around the Cloud Relay API.
IoTHub__Service: The Azure IoT Hub used to forward requests to the device. This connection string needs to be granted with the Service Connect permissions.StorageAccount: The Azure IoT Hub underlying Storage Account used to store files uploaded by/intended to the device.
APPINSIGHTS_INSTRUMENTATIONKEY: The instrumentation key of the Azure Application Insights used for monitoring.FileStorage__ConnectionString: The Azure IoT Hub underlying Storage Account used to store files uploaded by/intended to the device.FileStorage__DeviceFileUploadFolder: The Azure storage account container name where devices will upload their files.FileStorage__ServerFileUploadFolder: The Azure storage account container name where the API will upload its files.FileStorage__ServerFileUploadSubFolder: The Azure storage account virtual folder name where the API will upload its files. This value must match the API DeviceCommunication__IoTHub__MethodName application setting.FileStorage__Cleanup__Disabled: Whether the automatic blob clean-up is enabled for blobs generated by API queries. Optional, default value is true if not set.FileStorage__Cleanup__MinutesExpirationDelay: The delay, in minutes, for blobs to be considered expired and deleted by the automatic clean-up function. Delay is computed based on blob last modified time. Optional, default value is 10080 minutes (7 days) if not set.