Informatie over het lokale configuratiebestand (C#-agent)

  • Artikel

De Defender for IoT-beveiligingsagent maakt gebruik van configuraties uit een lokaal configuratiebestand.

De beveiligingsagent leest het configuratiebestand eenmaal, wanneer de agent wordt uitgevoerd. Configuraties in het lokale configuratiebestand bevatten zowel configuraties voor verificatie als andere agentconfiguraties.

De C#-beveiligingsagent gebruikt meerdere configuratiebestanden:

  • General.config : agentgerelateerde configuraties.
  • Authentication.config : configuratie met betrekking tot verificatie (inclusief verificatiedetails).
  • SecurityIotInterface.config : ioT-gerelateerde configuraties.

De configuratiebestanden bevatten de standaardconfiguratie. De verificatieconfiguratie wordt ingevuld tijdens de installatie van de agent en wijzigingen in het configuratiebestand worden aangebracht wanneer de agent opnieuw wordt gestart.

Locatie van configuratiebestand

Voor Linux:

  • Configuratiebestanden van het besturingssysteem bevinden zich in /var/ASCIoTAgent.

Voor Windows:

  • Configuratiebestanden van het besturingssysteem bevinden zich in de map van de beveiligingsagent.

General.config configuraties

Configuratienaam Mogelijke waarden Details
agentId GUID Unieke agent-id
readRemoteConfigurationTimeout TimeSpan Tijdsperiode voor het ophalen van externe configuratie van IoT Hub. Als de agent de configuratie niet binnen de opgegeven tijd kan ophalen, treedt er een time-out op voor de bewerking.
schedulerInterval TimeSpan Intern scheduler-interval.
producerInterval TimeSpan Werkrolinterval voor gebeurtenisproducent.
consumerInterval TimeSpan Interval voor werkrol voor gebeurtenisconsumer.
highPriorityQueueSizePercentage 0 < nummer < 1 Het gedeelte van de totale cache dat is toegewezen voor berichten met hoge prioriteit.
Loglevel "Uit", "Fatal", "Error", "Warning", "Information", "Debug" Logboekberichten die gelijk zijn aan deze ernst, worden geregistreerd in de console voor foutopsporing (Syslog in Linux).
fileLogLevel "Uit", "Fatal", "Error", "Warning", "Information", "Debug" Logboekberichten die gelijk zijn aan deze ernst, worden geregistreerd in het bestand (Syslog in Linux).
diagnosticVerbosityLevel "Geen", "Sommige", "Alle", Uitgebreidheidsniveau van diagnostische gebeurtenissen. Geen: diagnostische gebeurtenissen worden niet verzonden. Sommige: alleen diagnostische gebeurtenissen met een hoge urgentie worden verzonden. Alle: alle logboeken worden ook verzonden als diagnostische gebeurtenissen.
logFilePath Pad naar bestand Als fileLogLevel > Is uitgeschakeld, worden logboeken naar dit bestand geschreven.
defaultEventPriority "Hoog", "Laag", "Uit" Standaard gebeurtenisprioriteit.

General.config voorbeeld

<?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>

Authentication.config

Configuratienaam Mogelijke waarden Details
moduleName tekenreeks Naam van de Defender-IoT-micro-agentidentiteit. Deze naam moet overeenkomen met de identiteitsnaam van de module in het apparaat.
deviceId tekenreeks Id van het apparaat (zoals geregistreerd in Azure IoT Hub).
schedulerInterval Tijdspanne-tekenreeks Intern scheduler-interval.
gatewayHostname tekenreeks Hostnaam van de Azure IoT Hub. Meestal <my-hub.azure-devices.net>
Filepath tekenreeks - pad naar bestand Pad naar het bestand dat het verificatiegeheim bevat.
type "SymmetricKey", "SelfSignedCertificate" Het gebruikersgeheim voor verificatie. Kies SymmetricKey als het gebruikersgeheim een symmetrische sleutel is, kies zelfondertekend certificaat als het geheim een zelfondertekend certificaat is.
identity "DPS", "Module", "Apparaat" Verificatie-identiteit: DPS als verificatie wordt uitgevoerd via DPS, module als verificatie wordt uitgevoerd met behulp van modulereferenties of apparaat als verificatie wordt uitgevoerd met behulp van apparaatreferenties.
certificateLocationKind "LocalFile", "Store" LocalFile als het certificaat is opgeslagen in een bestand, slaat u op als het certificaat zich in een certificaatarchief bevindt.
idScope tekenreeks Id-bereik van DPS
registrationId tekenreeks DPS-apparaatregistratie-id.

Authentication.config voorbeeld

<?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.config

Configuratienaam Mogelijke waarden Details
transportType "Ampq" "Mqtt" IoT Hub transporttype.

SecurityIotInterface.config voorbeeld

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

Volgende stappen