Informatie over het lokale configuratie bestandC# (agent)Understanding the local configuration file (C# agent)

In de Azure Security Center voor IoT-beveiligings agent worden configuraties van een lokaal configuratie bestand gebruikt.The Azure Security Center for IoT security agent uses configurations from a local configuration file.

De beveiligings agent leest het configuratie bestand eenmaal wanneer de agent wordt gestart.The security agent reads the configuration file once when the agent starts up. Configuraties die in het lokale configuratie bestand worden gevonden, bevatten zowel de verificatie configuratie als andere aan de agent gerelateerde configuraties.Configurations found in the local configuration file contains both authentication configuration and other agent related configurations.

De C# beveiligings agent maakt gebruik van meerdere configuratie bestanden:The C# security agent uses multiple configuration files:

  • Algemeen. config -gerelateerde configuraties van agent.General.config - Agent related configurations.
  • Verificatie. config -gerelateerde configuratie van authenticatie (inclusief verificatie gegevens).Authentication.config - Authentication related configuration (including authentication details).
  • Configuratie van SecurityIotInterface. config -gerelateerde IOT.SecurityIotInterface.config - IoT related configurations.

De configuratie bestanden bevatten de standaard configuratie.The configuration files contain the default configuration. Verificatie configuratie wordt ingevuld tijdens de installatie van de agent en wijzigingen in het configuratie bestand worden gemaakt wanneer de agent opnieuw wordt gestart.Authentication configuration is populated during agent installation and changes to the configuration file are made when the agent is restarted.

Locatie van configuratie bestandConfiguration file location

Voor Linux:For Linux:

  • Configuratie bestanden voor het besturings systeem bevinden zich in /var/ASCIoTAgent.Operating system configuration files are located in /var/ASCIoTAgent.

Voor Windows:For Windows:

  • Configuratie bestanden voor het besturings systeem bevinden zich in de map van de beveiligings agent.Operating system configuration files are located within the directory of the security agent.

Algemene configuratie configuratiesGeneral.config configurations

Configuratie naamConfiguration Name Mogelijke waardenPossible values DetailsDetails
agentIdagentId GPTGUID Unieke id van agentAgent unique identifier
readRemoteConfigurationTimeoutreadRemoteConfigurationTimeout DuurTimeSpan De tijds periode voor het ophalen van de externe configuratie van IoT Hub.Time period for fetching remote configuration from IoT Hub. Als de agent de configuratie niet binnen de opgegeven tijd kan ophalen, wordt er een time-out van de bewerking uitgevoerd.If the agent can't fetch the configuration within the specified time, the operation will time out.
schedulerIntervalschedulerInterval DuurTimeSpan Intern scheduler-interval.Internal scheduler interval.
producerIntervalproducerInterval DuurTimeSpan Werk interval van de gebeurtenis producent.Event producer worker interval.
consumerIntervalconsumerInterval DuurTimeSpan Interval van gebeurtenis verbruiker werk nemer.Event consumer worker interval.
highPriorityQueueSizePercentagehighPriorityQueueSizePercentage 0 < getal < 10 < number < 1 Het gedeelte van het totale cache geheugen dat is toegewezen voor berichten met een hoge prioriteit.The portion of total cache dedicated for high priority messages.
LogLevellogLevel "Off", "onherstelbare", "fout", "waarschuwing", "informatie", "fouten opsporen""Off", "Fatal", "Error", "Warning", "Information", "Debug" Logboek berichten die gelijk zijn aan deze Ernst, worden vastgelegd in de console fout opsporing (syslog in Linux).Log messages equal and above this severity are logged to debug console (Syslog in Linux).
fileLogLevelfileLogLevel "Off", "onherstelbare", "fout", "waarschuwing", "informatie", "fouten opsporen""Off", "Fatal", "Error", "Warning", "Information", "Debug" Logboek berichten die gelijk zijn aan deze Ernst, worden geregistreerd in een bestand (syslog in Linux).Log messages equal and above this severity are logged to file (Syslog in Linux).
diagnosticVerbosityLeveldiagnosticVerbosityLevel "Geen", "enkele", "alle","None", "Some", "All", Uitgebreidheids niveau van diagnostische gebeurtenissen.Verbosity level of diagnostic events. Geen: er worden geen diagnostische gebeurtenissen verzonden, alleen bepaalde diagnostische gebeurtenissen met hoge urgentie worden verzonden, alle-alle logboeken worden ook als diagnostische gebeurtenissen verzonden.None - diagnostic events are not sent, Some - Only diagnostic events with high importance are sent, All - all logs are also sent as diagnostic events.
logFilePathlogFilePath Pad naar bestandPath to file Als fileLogLevel > uit, worden logboeken naar dit bestand geschreven.If fileLogLevel > Off, logs are written to this file.
defaultEventPrioritydefaultEventPriority ' Hoog ', ' laag ', ' uit '"High", "Low", "Off" Standaard prioriteit van gebeurtenis.Default event priority.

Algemeen. config-voor beeldGeneral.config example

<?xml version="1.0" encoding="utf-8"?>
<General>
  <add key="agentId" value="da00006c-dae9-4273-9abc-bcb7b7b4a987" />
  <add key="readRemoteConfigurationTimeout" value="00:00:30" />
  <add key="schedulerInterval" value="00:00:01" />
  <add key="producerInterval" value="00:02:00" />
  <add key="consumerInterval" value="00:02:00" />
  <add key="highPriorityQueueSizePercentage" value="0.5" />
  <add key="logLevel" value="Information" />
  <add key="fileLogLevel" value="Off"/>
  <add key="diagnosticVerbosityLevel" value="Some" />
  <add key="logFilePath" value="IotAgentLog.log" />
  <add key="defaultEventPriority" value="Low"/>
</General>

Verificatie. configAuthentication.config

Configuratie naamConfiguration name Mogelijke waardenPossible values DetailsDetails
moduleNamemoduleName stringstring De naam van de identiteit van de beveiligings module.Name of the security module identity. Deze naam moet overeenkomen met de naam van de module-id in het apparaat.This name must correspond to the module identity name in the device.
deviceIddeviceId stringstring ID van het apparaat (zoals geregistreerd in azure IoT Hub).ID of the device (as registered in Azure IoT Hub). schedulerIntervalschedulerInterval Time span-teken reeksTimeSpan string Intern scheduler-interval.Internal scheduler interval.
gatewayHostnamegatewayHostname stringstring De hostnaam van de Azure IOT hub.Host name of the Azure Iot Hub. Doorgaans < mijn hub >. Azure-devices.netUsually .azure-devices.net
BestandspadfilePath teken reeks-pad naar bestandstring - path to file Het pad naar het bestand dat het verificatie geheim bevat.Path to the file that contains the authentication secret.
typetype "SymmetricKey", "SelfSignedCertificate""SymmetricKey", "SelfSignedCertificate" Het gebruikers geheim voor authenticatie.The user secret for authentication. Kies SymmetricKey als het gebruikers geheim een symmetrische sleutel is, kies het zelfondertekende certificaat als het geheim een zelf ondertekend certificaat is.Choose SymmetricKey if the user secret is a Symmetric key, choose self-signed certificate if the secret is a self signed certificate.
identiteitidentity ' DPS ', ' module ', ' apparaat '"DPS", "Module", "Device" Verificatie-identiteit: DPS als verificatie wordt uitgevoerd via DPS, module als verificatie wordt uitgevoerd met behulp van de module referenties of het apparaat als verificatie wordt uitgevoerd met behulp van de referenties van het apparaat.Authentication identity - DPS if authentication is made through DPS, Module if authentication is made using module credentials, or device if authentication is made using device credentials.
certificateLocationKindcertificateLocationKind "LocalFile", "Store""LocalFile", "Store" LocalFile als het certificaat wordt opgeslagen in een bestand, opslaan als het certificaat zich in een certificaat archief bevindt.LocalFile if the certificate is stored in a file, store if the certificate is located in a certificate store.
idScopeidScope stringstring ID-bereik van DPSID scope of DPS
RegistratieregistrationId stringstring Registratie-ID van DPS-apparaat.DPS device registration ID.

Verificatie. config-voor beeldAuthentication.config example

<?xml version="1.0" encoding="utf-8"?>
<Authentication>
  <add key="moduleName" value="azureiotsecurity"/>
  <add key="deviceId" value="d1"/>
  <add key="gatewayHostname" value=""/>
  <add key="filePath" value="c:\p-dps-d1.pfx"/>
  <add key="type" value="SelfSignedCertificate" />                     <!-- SymmetricKey, SelfSignedCertificate-->
  <add key="identity" value="DPS" />                 <!-- Device, Module, DPS -->
  <add key="certificateLocationKind" value="LocalFile" />  <!-- LocalFile, Store -->
  <add key="idScope" value="0ne0005335B"/>
  <add key="registrationId" value="d1"/>
</Authentication>

SecurityIotInterface. configSecurityIotInterface.config

Configuratie naamConfiguration Name Mogelijke waardenPossible values DetailsDetails
Transport typetransportType "Ampq" "Mqtt""Ampq" "Mqtt" Transport type IoT Hub.IoT Hub transport type.

Voor beeld van SecurityIotInterface. configSecurityIotInterface.config example

<ExternalInterface>
  <add key="facadeType"  value="Microsoft.Azure.Security.IoT.Agent.Common.SecurityIoTHubInterface, Security.Common" />
  <add key="transportType" value="Amqp"/>
</ExternalInterface>

Volgende stappenNext steps