Devices interface

Paket:

@azure/arm-sphere

Schnittstelle, die ein Gerät darstellt.

Methoden

beginCreateOrUpdate(string, string, string, string, string, Device, DevicesCreateOrUpdateOptionalParams)	Erstellen Sie ein Gerät. Verwenden Sie ".unassigned" oder ".default" für die Gerätegruppe und produktnamen, um nur ein Gerät für den Katalog zu beanspruchen.
beginCreateOrUpdateAndWait(string, string, string, string, string, Device, DevicesCreateOrUpdateOptionalParams)	Erstellen Sie ein Gerät. Verwenden Sie ".unassigned" oder ".default" für die Gerätegruppe und produktnamen, um nur ein Gerät für den Katalog zu beanspruchen.
beginDelete(string, string, string, string, string, DevicesDeleteOptionalParams)	Löschen eines Geräts
beginDeleteAndWait(string, string, string, string, string, DevicesDeleteOptionalParams)	Löschen eines Geräts
beginGenerateCapabilityImage(string, string, string, string, string, GenerateCapabilityImageRequest, DevicesGenerateCapabilityImageOptionalParams)	Generiert das Funktionsbild für das Gerät. Verwenden Sie ".unassigned" oder ".default" für die Gerätegruppe und die Produktnamen, um das Bild für ein Gerät zu generieren, das nicht zu einer bestimmten Gerätegruppe und einem bestimmten Produkt gehört.
beginGenerateCapabilityImageAndWait(string, string, string, string, string, GenerateCapabilityImageRequest, DevicesGenerateCapabilityImageOptionalParams)	Generiert das Funktionsbild für das Gerät. Verwenden Sie ".unassigned" oder ".default" für die Gerätegruppe und die Produktnamen, um das Bild für ein Gerät zu generieren, das nicht zu einer bestimmten Gerätegruppe und einem bestimmten Produkt gehört.
beginUpdate(string, string, string, string, string, DeviceUpdate, DevicesUpdateOptionalParams)	Aktualisieren eines Geräts. Verwenden Sie ".unassigned" oder ".default" für die Gerätegruppe und die Produktnamen, um ein Gerät auf die Katalogebene zu verschieben.
beginUpdateAndWait(string, string, string, string, string, DeviceUpdate, DevicesUpdateOptionalParams)	Aktualisieren eines Geräts. Verwenden Sie ".unassigned" oder ".default" für die Gerätegruppe und die Produktnamen, um ein Gerät auf die Katalogebene zu verschieben.
get(string, string, string, string, string, DevicesGetOptionalParams)	Rufen Sie ein Gerät ab. Verwenden Sie ".unassigned" oder ".default" für die Gerätegruppe und die Produktnamen, wenn ein Gerät nicht zu einer Gerätegruppe und einem Produkt gehört.
listByDeviceGroup(string, string, string, string, DevicesListByDeviceGroupOptionalParams)	Geräteressourcen nach DeviceGroup auflisten. '.default' und '.unassigned' sind systemdefinierte Werte und können nicht für den Produkt- oder Gerätegruppennamen verwendet werden.

Details zur Methode

beginCreateOrUpdate(string, string, string, string, string, Device, DevicesCreateOrUpdateOptionalParams)

Erstellen Sie ein Gerät. Verwenden Sie ".unassigned" oder ".default" für die Gerätegruppe und produktnamen, um nur ein Gerät für den Katalog zu beanspruchen.

function beginCreateOrUpdate(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, resource: Device, options?: DevicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Device>, Device>>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

productName

string

Name des Produkts.

deviceGroupName

string

Name der Gerätegruppe.

deviceName

string

Gerätename

resource

Device

Parameter zum Erstellen von Ressourcen.

options

DevicesCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<@azure/core-lro.SimplePollerLike<OperationState<Device>, Device>>

beginCreateOrUpdateAndWait(string, string, string, string, string, Device, DevicesCreateOrUpdateOptionalParams)

Erstellen Sie ein Gerät. Verwenden Sie ".unassigned" oder ".default" für die Gerätegruppe und produktnamen, um nur ein Gerät für den Katalog zu beanspruchen.

function beginCreateOrUpdateAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, resource: Device, options?: DevicesCreateOrUpdateOptionalParams): Promise<Device>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

productName

string

Name des Produkts.

deviceGroupName

string

Name der Gerätegruppe.

deviceName

string

Gerätename

resource

Device

Parameter zum Erstellen von Ressourcen.

options

DevicesCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Device>

beginDelete(string, string, string, string, string, DevicesDeleteOptionalParams)

Löschen eines Geräts

function beginDelete(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, options?: DevicesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

productName

string

Name des Produkts.

deviceGroupName

string

Name der Gerätegruppe.

deviceName

string

Gerätename

options

DevicesDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, string, DevicesDeleteOptionalParams)

Löschen eines Geräts

function beginDeleteAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, options?: DevicesDeleteOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

productName

string

Name des Produkts.

deviceGroupName

string

Name der Gerätegruppe.

deviceName

string

Gerätename

options

DevicesDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

beginGenerateCapabilityImage(string, string, string, string, string, GenerateCapabilityImageRequest, DevicesGenerateCapabilityImageOptionalParams)

Generiert das Funktionsbild für das Gerät. Verwenden Sie ".unassigned" oder ".default" für die Gerätegruppe und die Produktnamen, um das Bild für ein Gerät zu generieren, das nicht zu einer bestimmten Gerätegruppe und einem bestimmten Produkt gehört.

function beginGenerateCapabilityImage(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, generateDeviceCapabilityRequest: GenerateCapabilityImageRequest, options?: DevicesGenerateCapabilityImageOptionalParams): Promise<SimplePollerLike<OperationState<SignedCapabilityImageResponse>, SignedCapabilityImageResponse>>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

productName

string

Name des Produkts.

deviceGroupName

string

Name der Gerätegruppe.

deviceName

string

Gerätename

generateDeviceCapabilityRequest

GenerateCapabilityImageRequest

Generieren des Anforderungstexts der Funktion.

options

DevicesGenerateCapabilityImageOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<@azure/core-lro.SimplePollerLike<OperationState<SignedCapabilityImageResponse>, SignedCapabilityImageResponse>>

beginGenerateCapabilityImageAndWait(string, string, string, string, string, GenerateCapabilityImageRequest, DevicesGenerateCapabilityImageOptionalParams)

Generiert das Funktionsbild für das Gerät. Verwenden Sie ".unassigned" oder ".default" für die Gerätegruppe und die Produktnamen, um das Bild für ein Gerät zu generieren, das nicht zu einer bestimmten Gerätegruppe und einem bestimmten Produkt gehört.

function beginGenerateCapabilityImageAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, generateDeviceCapabilityRequest: GenerateCapabilityImageRequest, options?: DevicesGenerateCapabilityImageOptionalParams): Promise<SignedCapabilityImageResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

productName

string

Name des Produkts.

deviceGroupName

string

Name der Gerätegruppe.

deviceName

string

Gerätename

generateDeviceCapabilityRequest

GenerateCapabilityImageRequest

Generieren des Anforderungstexts der Funktion.

options

DevicesGenerateCapabilityImageOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<SignedCapabilityImageResponse>

beginUpdate(string, string, string, string, string, DeviceUpdate, DevicesUpdateOptionalParams)

Aktualisieren eines Geräts. Verwenden Sie ".unassigned" oder ".default" für die Gerätegruppe und die Produktnamen, um ein Gerät auf die Katalogebene zu verschieben.

function beginUpdate(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, properties: DeviceUpdate, options?: DevicesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Device>, Device>>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

productName

string

Name des Produkts.

deviceGroupName

string

Name der Gerätegruppe.

deviceName

string

Gerätename

properties

DeviceUpdate

Die zu aktualisierenden Ressourceneigenschaften.

options

DevicesUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<@azure/core-lro.SimplePollerLike<OperationState<Device>, Device>>

beginUpdateAndWait(string, string, string, string, string, DeviceUpdate, DevicesUpdateOptionalParams)

Aktualisieren eines Geräts. Verwenden Sie ".unassigned" oder ".default" für die Gerätegruppe und die Produktnamen, um ein Gerät auf die Katalogebene zu verschieben.

function beginUpdateAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, properties: DeviceUpdate, options?: DevicesUpdateOptionalParams): Promise<Device>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

productName

string

Name des Produkts.

deviceGroupName

string

Name der Gerätegruppe.

deviceName

string

Gerätename

properties

DeviceUpdate

Die zu aktualisierenden Ressourceneigenschaften.

options

DevicesUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Device>

get(string, string, string, string, string, DevicesGetOptionalParams)

Rufen Sie ein Gerät ab. Verwenden Sie ".unassigned" oder ".default" für die Gerätegruppe und die Produktnamen, wenn ein Gerät nicht zu einer Gerätegruppe und einem Produkt gehört.

function get(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, options?: DevicesGetOptionalParams): Promise<Device>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

productName

string

Name des Produkts.

deviceGroupName

string

Name der Gerätegruppe.

deviceName

string

Gerätename

options

DevicesGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Device>

listByDeviceGroup(string, string, string, string, DevicesListByDeviceGroupOptionalParams)

Geräteressourcen nach DeviceGroup auflisten. '.default' und '.unassigned' sind systemdefinierte Werte und können nicht für den Produkt- oder Gerätegruppennamen verwendet werden.

function listByDeviceGroup(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, options?: DevicesListByDeviceGroupOptionalParams): PagedAsyncIterableIterator<Device, Device[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

productName

string

Name des Produkts.

deviceGroupName

string

Name der Gerätegruppe.

options

DevicesListByDeviceGroupOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<Device, Device[], PageSettings>