Freigeben über


@azure/iot-device-update package

Klassen

DeviceUpdateClient
DeviceUpdateClientContext

Schnittstellen

AccessCondition

Parametergruppe

Compatibility

Aktualisieren von Kompatibilitätsinformationen.

Deployment

Bereitstellungsmetadaten.

DeploymentDeviceState

Status des Bereitstellungsgeräts.

DeploymentDeviceStatesFilter

Filter für den Status des Bereitstellungsgeräts.

DeploymentFilter

Bereitstellungsfilter.

DeploymentStatus

Metadaten für den Bereitstellungsstatus.

DeploymentsGetAllDeploymentsNextOptionalParams

Optionale Parameter.

DeploymentsGetAllDeploymentsOptionalParams

Optionale Parameter.

DeploymentsGetDeploymentDevicesNextOptionalParams

Optionale Parameter.

DeploymentsGetDeploymentDevicesOptionalParams

Optionale Parameter.

Device

Gerätemetadaten.

DeviceClass

Geräteklassenmetadaten.

DeviceFilter

Filter für den Vorgangsstatus.

DeviceTag

Gerätetageigenschaften.

DeviceUpdateClientOptionalParams

Optionale Parameter.

DevicesGetAllDevicesNextOptionalParams

Optionale Parameter.

DevicesGetAllDevicesOptionalParams

Optionale Parameter.

DevicesGetGroupBestUpdatesNextOptionalParams

Optionale Parameter.

DevicesGetGroupBestUpdatesOptionalParams

Optionale Parameter.

ErrorModel

Fehlerdetails.

File

Aktualisieren von Dateimetadaten.

FileImportMetadata

Metadaten, die eine Aktualisierungsdatei beschreiben.

Group

Gruppendetails.

GroupBestUpdatesFilter

Filter für die besten Updates gruppieren.

ImportManifestMetadata

Metadaten, die das Importmanifest beschreiben, ein Dokument, das die Dateien und andere Metadaten zu einer Updateversion beschreibt.

ImportUpdateInput

Importieren von Aktualisierungseingabemetadaten.

InnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

Operation

Vorgangsmetadaten.

OperationFilter

Filter für den Vorgangsstatus.

PageableListOfDeploymentDeviceStates

Die Liste der Bereitstellungsgerätezustände.

PageableListOfDeployments

Die Liste der Bereitstellungen.

PageableListOfDeviceClasses

Die Liste der Geräteklassen.

PageableListOfDeviceTags

Die Liste der Gerätetags.

PageableListOfDevices

Die Liste der Geräte.

PageableListOfGroups

Die Liste der Gruppen.

PageableListOfOperations

Die Liste der Vorgänge mit Server paging-Unterstützung.

PageableListOfStrings

Die Liste der Zeichenfolgen mit Server paging-Unterstützung.

PageableListOfUpdatableDevices

Die Liste der aktualisierbaren Geräte.

PageableListOfUpdateIds

Die Liste der Updateidentitäten.

UpdatableDevices

Updatebezeichner und die Anzahl der Geräte, für die das Update anwendbar ist.

Update

Aktualisieren von Metadaten.

UpdateCompliance

Aktualisieren von Complianceinformationen.

UpdateId

Updatebezeichner.

UpdatesDeleteUpdateHeaders

Definiert Header für Updates_deleteUpdate Vorgang.

UpdatesGetFileOptionalParams

Optionale Parameter.

UpdatesGetOperationHeaders

Definiert Header für Updates_getOperation Vorgang.

UpdatesGetOperationOptionalParams

Optionale Parameter.

UpdatesGetOperationsNextOptionalParams

Optionale Parameter.

UpdatesGetOperationsOptionalParams

Optionale Parameter.

UpdatesGetUpdateOptionalParams

Optionale Parameter.

UpdatesImportUpdateHeaders

Definiert Header für Updates_importUpdate Vorgang.

Typaliase

DeploymentState

Definiert Werte für DeploymentState.
KnownDeploymentState- austauschbar mit DeploymentState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte Werte kennen

Aktiv: Die Bereitstellung kann an Geräte gesendet werden, auf die in der Bereitstellung abzielt.
Abgelöst: Es gibt eine neuere Bereitstellung mit demselben Targeting, und diese Bereitstellung wird von keinem Gerät erhalten.
Abgebrochen: Die Bereitstellung wurde abgebrochen und wird von keinem Gerät empfangen.

DeploymentType

Definiert Werte für DeploymentType.
KnownDeploymentType kann austauschbar mit DeploymentType verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte Werte kennen

Abgeschlossen: Eine vollständige Bereitstellung, einschließlich Download-, Installations- und Anwendenaktionen.
Download: Eine reine Downloadbereitstellung, die keine Installations- oder Anwendungsaktionen enthält. Wird derzeit nicht unterstützt.
Installieren: Ein Rollout nur für die Installation, das keine Downloadaktionen enthält, sondern nur die Installation und den Abschluss. Wird derzeit nicht unterstützt.

DeploymentsCancelDeploymentResponse

Enthält Antwortdaten für den cancelDeployment-Vorgang.

DeploymentsCreateOrUpdateDeploymentResponse

Enthält Antwortdaten für den createOrUpdateDeployment-Vorgang.

DeploymentsGetAllDeploymentsNextResponse

Enthält Antwortdaten für den getAllDeploymentsNext-Vorgang.

DeploymentsGetAllDeploymentsResponse

Enthält Antwortdaten für den getAllDeployments-Vorgang.

DeploymentsGetDeploymentDevicesNextResponse

Enthält Antwortdaten für den getDeploymentDevicesNext-Vorgang.

DeploymentsGetDeploymentDevicesResponse

Enthält Antwortdaten für den getDeploymentDevices-Vorgang.

DeploymentsGetDeploymentResponse

Enthält Antwortdaten für den getDeployment-Vorgang.

DeploymentsGetDeploymentStatusResponse

Enthält Antwortdaten für den getDeploymentStatus-Vorgang.

DeploymentsRetryDeploymentResponse

Enthält Antwortdaten für den retryDeployment-Vorgang.

DeviceDeploymentState

Definiert Werte für DeviceDeploymentState.
KnownDeviceDeploymentState kann austauschbar mit DeviceDeploymentState verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte Werte kennen

Erfolgreich: Die Bereitstellung wurde erfolgreich abgeschlossen.
InProgress: Die Bereitstellung wird ausgeführt.
Fehler: Die Bereitstellung wurde mit einem Fehler abgeschlossen.
Abgebrochen: Die Bereitstellung wurde abgebrochen.
Inkompatibel: Die Bereitstellung ist nicht mit dem Gerät kompatibel.

DeviceGroupType

Definiert Werte für DeviceGroupType.
KnownDeviceGroupType kann austauschbar mit DeviceGroupType verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte Werte kennen

Alle: Die Bereitstellung sollte an alle Geräte in der Geräteklasse gesendet werden.
Geräte: Die Bereitstellung sollte an die Liste der Geräte in der Gerätegruppendefinition gesendet werden.
DeviceGroupDefinitions: Die Bereitstellung sollte an die Liste der Geräte gesendet werden, die von der Vereinigung aller Gerätegruppendefinitionsabfragen zurückgegeben werden.

DeviceState

Definiert Werte für DeviceState.
KnownDeviceState kann austauschbar mit DeviceState verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte Werte kennen

NotStarted: Nicht gestartet (oder nicht initialisiert)
Inkompatibel: Die Bereitstellung ist für dieses Gerät nicht kompatibel.
AlreadyInDeployment: Eine weitere Bereitstellung für dieses Gerät ist im Gange.
Abgebrochen: Die Bereitstellung für dieses Gerät wurde abgebrochen.
InProgress: Die Bereitstellung ist im Gange.
Fehlgeschlagen: Fehler bei der Bereitstellung.
Erfolgreich: Die Bereitstellung wurde erfolgreich abgeschlossen.

DevicesCreateOrUpdateGroupResponse

Enthält Antwortdaten für den createOrUpdateGroup-Vorgang.

DevicesGetAllDeviceClassesNextResponse

Enthält Antwortdaten für den getAllDeviceClassesNext-Vorgang.

DevicesGetAllDeviceClassesResponse

Enthält Antwortdaten für den getAllDeviceClasses-Vorgang.

DevicesGetAllDeviceTagsNextResponse

Enthält Antwortdaten für den getAllDeviceTagsNext-Vorgang.

DevicesGetAllDeviceTagsResponse

Enthält Antwortdaten für den getAllDeviceTags-Vorgang.

DevicesGetAllDevicesNextResponse

Enthält Antwortdaten für den getAllDevicesNext-Vorgang.

DevicesGetAllDevicesResponse

Enthält Antwortdaten für den getAllDevices-Vorgang.

DevicesGetAllGroupsNextResponse

Enthält Antwortdaten für den getAllGroupsNext-Vorgang.

DevicesGetAllGroupsResponse

Enthält Antwortdaten für den getAllGroups-Vorgang.

DevicesGetDeviceClassDeviceIdsNextResponse

Enthält Antwortdaten für den getDeviceClassDeviceIdsNext-Vorgang.

DevicesGetDeviceClassDeviceIdsResponse

Enthält Antwortdaten für den getDeviceClassDeviceIds-Vorgang.

DevicesGetDeviceClassInstallableUpdatesNextResponse

Enthält Antwortdaten für den getDeviceClassInstallableUpdatesNext-Vorgang.

DevicesGetDeviceClassInstallableUpdatesResponse

Enthält Antwortdaten für den getDeviceClassInstallableUpdates-Vorgang.

DevicesGetDeviceClassResponse

Enthält Antwortdaten für den getDeviceClass-Vorgang.

DevicesGetDeviceResponse

Enthält Antwortdaten für den getDevice-Vorgang.

DevicesGetDeviceTagResponse

Enthält Antwortdaten für den getDeviceTag-Vorgang.

DevicesGetGroupBestUpdatesNextResponse

Enthält Antwortdaten für den getGroupBestUpdatesNext-Vorgang.

DevicesGetGroupBestUpdatesResponse

Enthält Antwortdaten für den getGroupBestUpdates-Vorgang.

DevicesGetGroupResponse

Enthält Antwortdaten für den getGroup-Vorgang.

DevicesGetGroupUpdateComplianceResponse

Enthält Antwortdaten für den getGroupUpdateCompliance-Vorgang.

DevicesGetUpdateComplianceResponse

Enthält Antwortdaten für den getUpdateCompliance-Vorgang.

GroupType

Definiert Werte für GroupType.
KnownGroupType kann austauschbar mit GroupType verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte Werte kennen

IoTHubTag: IoT Hub-Tag-basierte Gruppe.

OperationFilterStatus

Definiert Werte für OperationFilterStatus.
KnownOperationFilterStatus kann austauschbar mit OperationFilterStatus verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte Werte kennen

Ausführen von
NotStarted-

OperationStatus

Definiert Werte für OperationStatus.
KnownOperationStatus- austauschbar mit OperationStatus verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte Werte kennen

Undefiniert: Status eines nicht definierten Vorgangs.
NotStarted: Hintergrundvorgang erstellt, aber noch nicht gestartet.
Wird ausgeführt: Der Hintergrundvorgang wird derzeit ausgeführt.
Erfolgreich: Der Hintergrundvorgang wurde erfolgreich abgeschlossen.
Fehlgeschlagen: Der Hintergrundvorgang wurde mit einem Fehler abgeschlossen.

UpdatesDeleteUpdateResponse

Enthält Antwortdaten für den deleteUpdate-Vorgang.

UpdatesGetFileResponse

Enthält Antwortdaten für den getFile-Vorgang.

UpdatesGetFilesNextResponse

Enthält Antwortdaten für den getFilesNext-Vorgang.

UpdatesGetFilesResponse

Enthält Antwortdaten für den getFiles-Vorgang.

UpdatesGetNamesNextResponse

Enthält Antwortdaten für den getNamesNext-Vorgang.

UpdatesGetNamesResponse

Enthält Antwortdaten für den getNames-Vorgang.

UpdatesGetOperationResponse

Enthält Antwortdaten für den getOperation-Vorgang.

UpdatesGetOperationsNextResponse

Enthält Antwortdaten für den getOperationsNext-Vorgang.

UpdatesGetOperationsResponse

Enthält Antwortdaten für den getOperations-Vorgang.

UpdatesGetProvidersNextResponse

Enthält Antwortdaten für den getProvidersNext-Vorgang.

UpdatesGetProvidersResponse

Enthält Antwortdaten für den getProviders-Vorgang.

UpdatesGetUpdateResponse

Enthält Antwortdaten für den getUpdate-Vorgang.

UpdatesGetVersionsNextResponse

Enthält Antwortdaten für den getVersionsNext-Vorgang.

UpdatesGetVersionsResponse

Enthält Antwortdaten für den getVersions-Vorgang.

UpdatesImportUpdateResponse

Enthält Antwortdaten für den importUpdate-Vorgang.

Enumerationen

KnownDeploymentState

Bekannte Werte von DeploymentState, die der Dienst akzeptiert.

KnownDeploymentType

Bekannte Werte von DeploymentType , die der Dienst akzeptiert.

KnownDeviceDeploymentState

Bekannte Werte von DeviceDeploymentState , die der Dienst akzeptiert.

KnownDeviceGroupType

Bekannte Werte von DeviceGroupType , die der Dienst akzeptiert.

KnownDeviceState

Bekannte Werte von DeviceState , die der Dienst akzeptiert.

KnownGroupType

Bekannte Werte von GroupType , die der Dienst akzeptiert.

KnownOperationFilterStatus

Bekannte Werte von OperationFilterStatus , die der Dienst akzeptiert.

KnownOperationStatus

Bekannte Werte von OperationStatus, die der Dienst akzeptiert.