Catalogs interface

Paket:

@azure/arm-sphere

Schnittstelle, die einen Katalog darstellt.

Methoden

beginCreateOrUpdate(string, string, Catalog, CatalogsCreateOrUpdateOptionalParams)	Erstellen eines Katalogs
beginCreateOrUpdateAndWait(string, string, Catalog, CatalogsCreateOrUpdateOptionalParams)	Erstellen eines Katalogs
beginDelete(string, string, CatalogsDeleteOptionalParams)	Löschen eines Katalogs
beginDeleteAndWait(string, string, CatalogsDeleteOptionalParams)	Löschen eines Katalogs
beginUploadImage(string, string, Image_2, CatalogsUploadImageOptionalParams)	Erstellt ein Image. Verwenden Sie diese Aktion, wenn die Image-ID unbekannt ist.
beginUploadImageAndWait(string, string, Image_2, CatalogsUploadImageOptionalParams)	Erstellt ein Image. Verwenden Sie diese Aktion, wenn die Image-ID unbekannt ist.
countDevices(string, string, CatalogsCountDevicesOptionalParams)	Zählt Geräte im Katalog.
get(string, string, CatalogsGetOptionalParams)	Abrufen eines Katalogs
listByResourceGroup(string, CatalogsListByResourceGroupOptionalParams)	Auflisten von Katalogressourcen nach Ressourcengruppe
listBySubscription(CatalogsListBySubscriptionOptionalParams)	Auflisten von Katalogressourcen nach Abonnement-ID
listDeployments(string, string, CatalogsListDeploymentsOptionalParams)	Listen Bereitstellungen für den Katalog.
listDeviceGroups(string, string, ListDeviceGroupsRequest, CatalogsListDeviceGroupsOptionalParams)	Listen Sie die Gerätegruppen für den Katalog auf.
listDeviceInsights(string, string, CatalogsListDeviceInsightsOptionalParams)	Listen Device Insights für den Katalog.
listDevices(string, string, CatalogsListDevicesOptionalParams)	Listen Geräte für den Katalog.
update(string, string, CatalogUpdate, CatalogsUpdateOptionalParams)	Aktualisieren eines Katalogs

Details zur Methode

beginCreateOrUpdate(string, string, Catalog, CatalogsCreateOrUpdateOptionalParams)

Erstellen eines Katalogs

function beginCreateOrUpdate(resourceGroupName: string, catalogName: string, resource: Catalog, options?: CatalogsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Catalog>, Catalog>>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

resource

Catalog

Ressourcenerstellungsparameter.

options

CatalogsCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginCreateOrUpdateAndWait(string, string, Catalog, CatalogsCreateOrUpdateOptionalParams)

Erstellen eines Katalogs

function beginCreateOrUpdateAndWait(resourceGroupName: string, catalogName: string, resource: Catalog, options?: CatalogsCreateOrUpdateOptionalParams): Promise<Catalog>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

resource

Catalog

Ressourcenerstellungsparameter.

options

CatalogsCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Catalog>

beginDelete(string, string, CatalogsDeleteOptionalParams)

Löschen eines Katalogs

function beginDelete(resourceGroupName: string, catalogName: string, options?: CatalogsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

options

CatalogsDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginDeleteAndWait(string, string, CatalogsDeleteOptionalParams)

Löschen eines Katalogs

function beginDeleteAndWait(resourceGroupName: string, catalogName: string, options?: CatalogsDeleteOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

options

CatalogsDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

beginUploadImage(string, string, Image_2, CatalogsUploadImageOptionalParams)

Erstellt ein Image. Verwenden Sie diese Aktion, wenn die Image-ID unbekannt ist.

function beginUploadImage(resourceGroupName: string, catalogName: string, uploadImageRequest: Image_2, options?: CatalogsUploadImageOptionalParams): Promise<SimplePollerLike<OperationState<CatalogsUploadImageHeaders>, CatalogsUploadImageHeaders>>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

uploadImageRequest

Image

Bilduploadanforderungstext.

options

CatalogsUploadImageOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginUploadImageAndWait(string, string, Image_2, CatalogsUploadImageOptionalParams)

Erstellt ein Image. Verwenden Sie diese Aktion, wenn die Image-ID unbekannt ist.

function beginUploadImageAndWait(resourceGroupName: string, catalogName: string, uploadImageRequest: Image_2, options?: CatalogsUploadImageOptionalParams): Promise<CatalogsUploadImageHeaders>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

uploadImageRequest

Image

Bilduploadanforderungstext.

options

CatalogsUploadImageOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<CatalogsUploadImageHeaders>

countDevices(string, string, CatalogsCountDevicesOptionalParams)

Zählt Geräte im Katalog.

function countDevices(resourceGroupName: string, catalogName: string, options?: CatalogsCountDevicesOptionalParams): Promise<CountDevicesResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

options

CatalogsCountDevicesOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<CountDevicesResponse>

get(string, string, CatalogsGetOptionalParams)

Abrufen eines Katalogs

function get(resourceGroupName: string, catalogName: string, options?: CatalogsGetOptionalParams): Promise<Catalog>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

options

CatalogsGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Catalog>

listByResourceGroup(string, CatalogsListByResourceGroupOptionalParams)

Auflisten von Katalogressourcen nach Ressourcengruppe

function listByResourceGroup(resourceGroupName: string, options?: CatalogsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

options

CatalogsListByResourceGroupOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>

listBySubscription(CatalogsListBySubscriptionOptionalParams)

Auflisten von Katalogressourcen nach Abonnement-ID

function listBySubscription(options?: CatalogsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>

Parameter

options

CatalogsListBySubscriptionOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>

listDeployments(string, string, CatalogsListDeploymentsOptionalParams)

Listen Bereitstellungen für den Katalog.

function listDeployments(resourceGroupName: string, catalogName: string, options?: CatalogsListDeploymentsOptionalParams): PagedAsyncIterableIterator<Deployment, Deployment[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

options

CatalogsListDeploymentsOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<Deployment, Deployment[], PageSettings>

listDeviceGroups(string, string, ListDeviceGroupsRequest, CatalogsListDeviceGroupsOptionalParams)

Listen Sie die Gerätegruppen für den Katalog auf.

function listDeviceGroups(resourceGroupName: string, catalogName: string, listDeviceGroupsRequest: ListDeviceGroupsRequest, options?: CatalogsListDeviceGroupsOptionalParams): PagedAsyncIterableIterator<DeviceGroup, DeviceGroup[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

listDeviceGroupsRequest

ListDeviceGroupsRequest

Auflisten von Gerätegruppen für den Katalog.

options

CatalogsListDeviceGroupsOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<DeviceGroup, DeviceGroup[], PageSettings>

listDeviceInsights(string, string, CatalogsListDeviceInsightsOptionalParams)

Listen Device Insights für den Katalog.

function listDeviceInsights(resourceGroupName: string, catalogName: string, options?: CatalogsListDeviceInsightsOptionalParams): PagedAsyncIterableIterator<DeviceInsight, DeviceInsight[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

options

CatalogsListDeviceInsightsOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<DeviceInsight, DeviceInsight[], PageSettings>

listDevices(string, string, CatalogsListDevicesOptionalParams)

Listen Geräte für den Katalog.

function listDevices(resourceGroupName: string, catalogName: string, options?: CatalogsListDevicesOptionalParams): PagedAsyncIterableIterator<Device, Device[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

options

CatalogsListDevicesOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<Device, Device[], PageSettings>

update(string, string, CatalogUpdate, CatalogsUpdateOptionalParams)

Aktualisieren eines Katalogs

function update(resourceGroupName: string, catalogName: string, properties: CatalogUpdate, options?: CatalogsUpdateOptionalParams): Promise<Catalog>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

catalogName

string

Name des Katalogs

properties

CatalogUpdate

Die zu aktualisierenden Ressourceneigenschaften.

options

CatalogsUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Catalog>