Name: pcs-config-dotnet
Owner: Microsoft Azure
Description: The configuration microservice for Azure IoT Solutions
Created: 2017-06-23 08:27:18.0
Updated: 2018-03-20 17:31:29.0
Pushed: 2018-03-30 23:08:59.0
Size: 242
Language: C#
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
This service handles communication with the Storage Adapter microservice to complete tasks.
The microservice provides a RESTful endpoint to make CRUD operations for “devicegroups”, “solution-settings”, and “user-settings”. The data will be stored by the Storage Adapter microservice.
This microservice was built as part of the Azure IoT Remote Monitoring project to provide a generic implementation for an end-to-end IoT solution. More information here.
You can run the microservice and its dependencies using Docker with the instructions here.
This service has a dependency on the following Azure resources. Follow the instructions for Deploy the Azure services.
This service depends on the following repositories. Run those services from the instructions in their READMEs in the following order.
In order to run the service, some environment variables need to be created at least once. See specific instructions for IDE or command line setup below for more information. More information on environment variables here.
PCS_STORAGEADAPTER_WEBSERVICE_URL
- the url for
the Storage Adapter Webservice
used for key value storagePCS_TELEMETRY_WEBSERVICE_URL
- the url for
the Telemetry Webservice
used for key value storagePCS_DEVICESIMULATION_WEBSERVICE_URL
- the url for
the Device Simulation Webservice
used for key value storagePCS_IOTHUBMANAGER_WEBSERVICE_URL
- the url for
the IOT Hub Manager Webservice
used for key value storagePCS_AZUREMAPS_KEY
- the Azure Maps
API Key. This can be set to “static” if you do not have one.PCS_STORAGEADAPTER_WEBSERVICE_URL
= http://localhost:9022/v1PCS_DEVICESIMULATION_WEBSERVICE_URL
= http://localhost:9003/v1PCS_IOTHUBMANAGER_WEBSERVICE_URL
= http://localhost:9002/v1PCS_TELEMETRY_WEBSERVICE_URL
= http://localhost:9004/v1PCS_AZUREMAPS_KEY
= staticPCS_STORAGEADAPTER_WEBSERVICE_URL
= http://localhost:9022/v1PCS_DEVICESIMULATION_WEBSERVICE_URL
= http://localhost:9003/v1PCS_IOTHUBMANAGER_WEBSERVICE_URL
= http://localhost:9002/v1PCS_TELEMETRY_WEBSERVICE_URL
= http://localhost:9004/v1PCS_AZUREMAPS_KEY
= staticbuild
: compile all the projects and run the tests.compile
: compile all the projects.run
: compile the projects and run the service. This will prompt for
elevated privileges in Windows to run the web service.This microservice contains the following projects:
The scripts
folder includes a docker subfolder with the files
required to package the service into a Docker image:
Dockerfile
: docker images specificationsbuild
: build a Docker container and store the image in the local registryrun
: run the Docker container from the image stored in the local registrycontent
: a folder with files copied into the image, including the entry point scriptThe service configuration is stored using ASP.NET Core configuration adapters, in appsettings.ini. The INI format allows to store values in a readable format, with comments. The application also supports references to environment variables, which is used to import credentials and networking details.
The configuration files in the repository reference some environment variables that need to be created at least once. Depending on your OS and the IDE, there are several ways to manage environment variables:
Please follow our contribution guildelines and code style conventions.
Please enter issues, bugs, or suggestions as GitHub Issues.
Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License.