Devices - Claim

Service:

Azure Sphere Public API

API Version:

v2

Startet einen asynchronen Vorgang, um ein Gerät für den angegebenen Mandanten zu beanspruchen.

PUT https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/devices/{deviceId}/claim

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
deviceId	path	True	string	Die ID des Geräts.
tenantId	path	True	string uuid	Die Azure Sphere-Mandanten-ID.

Antworten

Name	Typ	Beschreibung
202 Accepted	Operation	Der Vorgang wurde erfolgreich gestartet.

Definitionen

Name	Beschreibung
ErrorResponse
Operation

ErrorResponse

Name	Typ	Beschreibung
Code	enum: 0 - OperationFailed 1 - TenantInMigration 2 - TenantMigrationRequired 3 - ClientUpdateRequired 4 - InternalServerError 5 - BadRequest 6 - Forbidden 7 - Conflict 8 - NotFound	Ruft den Code ab.
Message	string	Ruft die lesbare Fehlermeldung ab.

Operation

Name	Typ	Beschreibung
CompletedDateUTC	string	Ruft das Datum in UTC ab, an dem der Vorgang abgeschlossen wurde.
CreatedDateUTC	string	Ruft das Erstellungsdatum des Vorgangs in UTC ab.
DetailsLocation	string	Ruft den Speicherort zum Abrufen von Details des Vorgangs ab.
Error	ErrorResponse
OperationId	string	Ruft den eindeutigen Vorgangsbezeichner ab.
OperationType	enum: 0 - DeviceClaim 1 - DeviceUnclaim 10 - DeleteProduct 11 - BulkDeviceClaim 2 - DeviceUpdateDeviceGroup 3 - MigrateTenant 4 - CreateProduct 5 - DeployToDeviceGroup 6 - DeployToOSFeed 7 - ImageUpload 8 - TenantCreation 9 - DeleteDeviceGroup	Ruft den Vorgangstypbezeichner ab.
ResourceLocation	string	Ruft den Speicherort der Ressourcen ab, die während der Ausführung des Vorgangs erstellt wurden.
StartedDateUTC	string	Ruft das Datum in UTC ab, an dem der Vorgang mit der Verarbeitung begonnen hat.
State	enum: 0 - NotStarted 1 - InProgress 2 - Complete 3 - Failed 4 - CompleteWithErrors	Ruft den Status des Vorgangs ab.
TenantId	string	Ruft den Mandantenbezeichner ab.