Поделиться через


@azure/arm-deviceregistry package

Классы

DeviceRegistryManagementClient

Интерфейсы

Asset

Определение актива.

AssetEndpointProfile

Определение профиля конечной точки ресурса.

AssetEndpointProfileProperties

Определяет свойства профиля конечной точки ресурса.

AssetEndpointProfileStatus

Определяет свойства состояния профиля конечной точки ресурса.

AssetEndpointProfileStatusError

Определяет свойства ошибки состояния профиля конечной точки ресурса.

AssetEndpointProfileUpdate

Тип, используемый для операций обновления объекта AssetEndpointProfile.

AssetEndpointProfileUpdateProperties

Обновляемые свойства AssetEndpointProfile.

AssetEndpointProfilesCreateOrReplaceOptionalParams

Необязательные параметры.

AssetEndpointProfilesDeleteOptionalParams

Необязательные параметры.

AssetEndpointProfilesGetOptionalParams

Необязательные параметры.

AssetEndpointProfilesListByResourceGroupOptionalParams

Необязательные параметры.

AssetEndpointProfilesListBySubscriptionOptionalParams

Необязательные параметры.

AssetEndpointProfilesOperations

Интерфейс, представляющий операции AssetEndpointProfiles.

AssetEndpointProfilesUpdateOptionalParams

Необязательные параметры.

AssetProperties

Определяет свойства ресурса.

AssetStatus

Определяет свойства состояния ресурса.

AssetStatusDataset

Определяет свойства набора данных состояния ресурса.

AssetStatusError

Определяет свойства ошибки состояния ресурса.

AssetStatusEvent

Определяет свойства события состояния ресурса.

AssetUpdate

Тип, используемый для операций обновления ресурса.

AssetUpdateProperties

Обновляемые свойства ресурса.

AssetsCreateOrReplaceOptionalParams

Необязательные параметры.

AssetsDeleteOptionalParams

Необязательные параметры.

AssetsGetOptionalParams

Необязательные параметры.

AssetsListByResourceGroupOptionalParams

Необязательные параметры.

AssetsListBySubscriptionOptionalParams

Необязательные параметры.

AssetsOperations

Интерфейс, представляющий операции с ресурсами.

AssetsUpdateOptionalParams

Необязательные параметры.

Authentication

Определение механизма проверки подлинности клиента на сервере.

BillingContainer

Модель выставления счетовContainer в качестве ресурса Azure, единственная цель которой — отслеживать оплачиваемые ресурсы в рамках подписки.

BillingContainerProperties

Определяет свойства billingContainer.

BillingContainersGetOptionalParams

Необязательные параметры.

BillingContainersListBySubscriptionOptionalParams

Необязательные параметры.

BillingContainersOperations

Интерфейс, представляющий операции BillingContainers.

BrokerStateStoreDestinationConfiguration

Конфигурация для назначения хранилища состояний брокера MQTT.

DataPoint

Определяет свойства точки данных.

DataPointBase

Определяет свойства точки данных.

Dataset

Определяет свойства набора данных.

DatasetBrokerStateStoreDestination

Тип назначения хранилища состояний брокера MQTT.

DatasetDestination

Тип назначения.

DatasetMqttDestination

Тип назначения MQTT.

DatasetStorageDestination

Тип места назначения хранилища.

DeviceMessagingEndpoint

Модель конечной точки обмена сообщениями на устройстве.

DeviceRef

Определяет, какое устройство и конечную точку следует использовать для этого ресурса

DeviceRegistryManagementClientOptionalParams

Необязательные параметры для клиента.

DeviceStatus

Определяет свойства состояния устройства.

DeviceStatusEndpoint

Определяет свойства состояния устройства.

DeviceStatusEndpoints

Определяет состояние устройства для входящих и исходящих конечных точек.

DiscoveredInboundEndpoints

Конечная точка для подключения к устройству.

DiscoveredMessagingEndpoints

URL-адрес конечной точки подключения, который устройство может использовать для подключения к службе.

DiscoveredOutboundEndpoints

Контейнер свойств содержит исходящие конечные точки устройства

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorDetails

Определяет свойства сведений об ошибке.

ErrorResponse

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций.

Event

Определяет свойства события.

EventBase

Определяет свойства события.

EventDestination

Тип назначения.

EventMqttDestination

Тип назначения MQTT.

EventStorageDestination

Тип места назначения хранилища.

ExtendedLocation

Расширенное расположение.

HostAuthentication

Определение механизма аутентификации клиента для хоста.

InboundEndpoints

Конечная точка для подключения к устройству.

ManagementAction

Определяет свойства действия.

ManagementGroup

Определяет свойства группы управления.

MessageSchemaReference

Определяет свойства ссылок на схему сообщений.

Messaging

Модель конечных точек обмена сообщениями в пространстве имен.

MessagingEndpoint

Модель конечной точки обмена сообщениями в пространстве имен, используемая устройством для подключения к службе.

MessagingEndpoints

URL-адрес конечной точки подключения, который устройство может использовать для подключения к службе.

MqttDestinationConfiguration

Конфигурация для назначения MQTT.

Namespace

Определение пространства имен.

NamespaceAsset

Определение актива.

NamespaceAssetProperties

Определяет свойства ресурса.

NamespaceAssetStatus

Определяет свойства состояния ресурса.

NamespaceAssetStatusDataset

Определяет свойства набора данных состояния ресурса.

NamespaceAssetStatusEvent

Определяет свойства события состояния ресурса.

NamespaceAssetStatusEventGroup

Определяет свойства группы событий статуса актива.

NamespaceAssetStatusManagementAction

Определяет свойства действия статуса актива.

NamespaceAssetStatusManagementGroup

Определяет свойства группы управления статусом активов.

NamespaceAssetStatusStream

Определяет свойства потока состояния активов.

NamespaceAssetUpdate

Тип, используемый для операций обновления ресурса NamespaceAsset.

NamespaceAssetUpdateProperties

Обновляемые свойства NamespaceAsset.

NamespaceAssetsCreateOrReplaceOptionalParams

Необязательные параметры.

NamespaceAssetsDeleteOptionalParams

Необязательные параметры.

NamespaceAssetsGetOptionalParams

Необязательные параметры.

NamespaceAssetsListByResourceGroupOptionalParams

Необязательные параметры.

NamespaceAssetsOperations

Интерфейс, представляющий операции NamespaceAssets.

NamespaceAssetsUpdateOptionalParams

Необязательные параметры.

NamespaceDataset

Определяет свойства набора данных.

NamespaceDatasetDataPoint

Определяет свойства точки данных набора данных.

NamespaceDevice

Определение устройства.

NamespaceDeviceProperties

Определяет свойства устройства.

NamespaceDeviceUpdate

Тип, используемый для операций обновления NamespaceDevice.

NamespaceDeviceUpdateProperties

Обновляемые свойства объекта NamespaceDevice.

NamespaceDevicesCreateOrReplaceOptionalParams

Необязательные параметры.

NamespaceDevicesDeleteOptionalParams

Необязательные параметры.

NamespaceDevicesGetOptionalParams

Необязательные параметры.

NamespaceDevicesListByResourceGroupOptionalParams

Необязательные параметры.

NamespaceDevicesOperations

Интерфейс, представляющий операции NamespaceDevices.

NamespaceDevicesUpdateOptionalParams

Необязательные параметры.

NamespaceDiscoveredAsset

Определение обнаруженного актива.

NamespaceDiscoveredAssetProperties

Определяет обнаруженные свойства актива.

NamespaceDiscoveredAssetUpdate

Тип, используемый для операций обновления объекта NamespaceDiscoveredAsset.

NamespaceDiscoveredAssetUpdateProperties

Обновляемые свойства объекта NamespaceDiscoveredAsset.

NamespaceDiscoveredAssetsCreateOrReplaceOptionalParams

Необязательные параметры.

NamespaceDiscoveredAssetsDeleteOptionalParams

Необязательные параметры.

NamespaceDiscoveredAssetsGetOptionalParams

Необязательные параметры.

NamespaceDiscoveredAssetsListByResourceGroupOptionalParams

Необязательные параметры.

NamespaceDiscoveredAssetsOperations

Интерфейс, представляющий операции NamespaceDiscoveredAssets.

NamespaceDiscoveredAssetsUpdateOptionalParams

Необязательные параметры.

NamespaceDiscoveredDataset

Определяет свойства набора данных.

NamespaceDiscoveredDatasetDataPoint

Определяет свойства точки данных обнаруженного набора данных.

NamespaceDiscoveredDevice

Обнаруженное определение устройства.

NamespaceDiscoveredDeviceProperties

Определяет свойства обнаруженного устройства.

NamespaceDiscoveredDeviceUpdate

Тип, используемый для операций обновления NamespaceDiscoveredDevice.

NamespaceDiscoveredDeviceUpdateProperties

Обновляемые свойства NamespaceDiscoveredDevice.

NamespaceDiscoveredDevicesCreateOrReplaceOptionalParams

Необязательные параметры.

NamespaceDiscoveredDevicesDeleteOptionalParams

Необязательные параметры.

NamespaceDiscoveredDevicesGetOptionalParams

Необязательные параметры.

NamespaceDiscoveredDevicesListByResourceGroupOptionalParams

Необязательные параметры.

NamespaceDiscoveredDevicesOperations

Интерфейс, представляющий операции NamespaceDiscoveredDevices.

NamespaceDiscoveredDevicesUpdateOptionalParams

Необязательные параметры.

NamespaceDiscoveredEvent

Определяет свойства события.

NamespaceDiscoveredEventGroup

Определяет свойства обнаруженной группы событий.

NamespaceDiscoveredManagementAction

Определяет свойства действия.

NamespaceDiscoveredManagementGroup

Определяет свойства группы управления.

NamespaceDiscoveredStream

Определяет свойства потока.

NamespaceEvent

Определяет свойства события.

NamespaceEventGroup

Определяет свойства группы событий.

NamespaceMessageSchemaReference

Определяет свойства ссылок на схему сообщений.

NamespaceMigrateRequest

Текст запроса для операции переноса ресурсов в ресурс пространства имен.

NamespaceProperties

Модель свойств пространства имен.

NamespaceStream

Определяет свойства потока.

NamespaceUpdate

Тип, используемый для операций обновления пространства имен.

NamespaceUpdateProperties

Обновляемые свойства пространства имен.

NamespacesCreateOrReplaceOptionalParams

Необязательные параметры.

NamespacesDeleteOptionalParams

Необязательные параметры.

NamespacesGetOptionalParams

Необязательные параметры.

NamespacesListByResourceGroupOptionalParams

Необязательные параметры.

NamespacesListBySubscriptionOptionalParams

Необязательные параметры.

NamespacesMigrateOptionalParams

Необязательные параметры.

NamespacesOperations

Интерфейс, представляющий операции с пространствами имен.

NamespacesUpdateOptionalParams

Необязательные параметры.

Operation

Сведения об операции REST API, возвращаемой из API операций поставщика ресурсов

OperationDisplay

Локализованные сведения о отображении и операции.

OperationStatusGetOptionalParams

Необязательные параметры.

OperationStatusOperations

Интерфейс, представляющий операции OperationStatus.

OperationStatusResult

Текущее состояние асинхронной операции.

OperationsListOptionalParams

Необязательные параметры.

OperationsOperations

Интерфейс, представляющий операции операций.

OutboundEndpoints

Контейнер свойств содержит исходящие конечные точки устройства

PageSettings

Параметры метода byPage

PagedAsyncIterableIterator

Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам.

ProxyResource

Определение модели ресурсов для ресурса прокси-сервера Azure Resource Manager. У него не будут теги и расположение

Resource

Общие поля, возвращаемые в ответе для всех ресурсов Azure Resource Manager

RestorePollerOptions
Schema

Определение схемы.

SchemaProperties

Определяет свойства схемы.

SchemaRegistriesCreateOrReplaceOptionalParams

Необязательные параметры.

SchemaRegistriesDeleteOptionalParams

Необязательные параметры.

SchemaRegistriesGetOptionalParams

Необязательные параметры.

SchemaRegistriesListByResourceGroupOptionalParams

Необязательные параметры.

SchemaRegistriesListBySubscriptionOptionalParams

Необязательные параметры.

SchemaRegistriesOperations

Интерфейс, представляющий операции SchemaRegistries.

SchemaRegistriesUpdateOptionalParams

Необязательные параметры.

SchemaRegistry

Определение схемы реестра.

SchemaRegistryProperties

Определяет свойства реестра схемы.

SchemaRegistryUpdate

Тип, используемый для операций обновления SchemaRegistry.

SchemaRegistryUpdateProperties

Обновляемые свойства SchemaRegistry.

SchemaVersion

Определение версии схемы.

SchemaVersionProperties

Определяет свойства версии схемы.

SchemaVersionsCreateOrReplaceOptionalParams

Необязательные параметры.

SchemaVersionsDeleteOptionalParams

Необязательные параметры.

SchemaVersionsGetOptionalParams

Необязательные параметры.

SchemaVersionsListBySchemaOptionalParams

Необязательные параметры.

SchemaVersionsOperations

Интерфейс, представляющий операции SchemaVersions.

SchemasCreateOrReplaceOptionalParams

Необязательные параметры.

SchemasDeleteOptionalParams

Необязательные параметры.

SchemasGetOptionalParams

Необязательные параметры.

SchemasListBySchemaRegistryOptionalParams

Необязательные параметры.

SchemasOperations

Интерфейс, представляющий операции со схемами.

StatusConfig

Определяет свойства конфигурации статуса.

StatusError

Определяет свойства ошибки конфигурации статуса.

StorageDestinationConfiguration

Конфигурация для места назначения хранилища.

StreamDestination

Тип назначения.

StreamMqttDestination

Тип назначения MQTT.

StreamStorageDestination

Тип места назначения хранилища.

SystemAssignedServiceIdentity

Удостоверение управляемой службы (назначено системой или не назначено)

SystemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Topic

Объект, описывающий сведения о разделе.

TrackedResource

Определение модели ресурсов для отслеживаемого ресурса Azure Resource Manager с тегами верхнего уровня и расположением

TrustSettings

Определяет параметры доверия к серверу для конечной точки.

UsernamePasswordCredentials

Учетные данные для режима проверки подлинности UsernamePassword.

X509CertificateCredentials

Сертификат x509 для сертификата режима проверки подлинности.

X509Credentials

Сертификат x509 для сертификата режима проверки подлинности.

Псевдонимы типа

ActionType

Расширяемый перечисление. Указывает тип действия. "Внутренний" относится к действиям, которые предназначены только для внутренних API.
KnownActionType можно использовать взаимозаменяемо с ActionType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

внутренних: действия предназначены для внутренних API.

AuthenticationMethod

Метод проверки подлинности пользователя клиента на сервере.
KnownAuthenticationMethod можно использовать взаимозаменяемо с AuthenticationMethod, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

анонимных: метод проверки подлинности пользователя является анонимным.
сертификат. Метод проверки подлинности пользователя — это сертификат x509.
UsernamePassword: метод проверки подлинности пользователя — это имя пользователя и пароль.

AzureSupportedClouds

Поддерживаемые значения для настройки облака в виде строкового литерала

ContinuablePage

Интерфейс, описывающий страницу результатов.

CreatedByType

Тип сущности, создающей ресурс.
KnownCreatedByType можно использовать взаимозаменяемо с CreatedByType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

user: сущность была создана пользователем.
приложения: сущность была создана приложением.
ManagedIdentity: сущность была создана управляемым удостоверением.
ключ: сущность была создана ключом.

DataPointObservabilityMode

Определяет режим наблюдаемости точки данных.
KnownDataPointObservabilityMode можно использовать взаимозаменяемо с DataPointObservabilityMode, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

None: нет сопоставления с OpenTelemetry.
счетчика: сопоставление как счетчик с OpenTelemetry.
датчик: сопоставление с датчиком с OpenTelemetry.
гистограмма: сопоставление с гистограммой с OpenTelemetry.
журнал: сопоставление с журналом с OpenTelemetry.

DatasetDestinationTarget

Набор поддерживаемых назначений набора данных для ресурса.
KnownDatasetDestinationTarget можно использовать взаимозаменяемо с DatasetDestinationTarget, это перечисление содержит известные значения, которые поддерживает служба.

Известные значения, поддерживаемые службой

Mqtt: цель MQTT.
BrokerStateStore: целевой объект хранилища состояний брокера.
Хранилище: Целевое хранилище.

DatasetDestinationUnion

Псевдоним для DatasetDestinationUnion

EventDestinationTarget

Набор поддерживаемых мест назначения событий для ресурса.
KnownEventDestinationTarget можно использовать взаимозаменяемо с EventDestinationTarget, это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Mqtt: цель MQTT.
Хранилище: Целевое хранилище.

EventDestinationUnion

Псевдоним для EventDestinationUnion

EventObservabilityMode

Определяет режим наблюдаемости событий.
KnownEventObservabilityMode можно использовать взаимозаменяемо с EventObservabilityMode, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

None: нет сопоставления с OpenTelemetry.
журнал: сопоставление с журналом с OpenTelemetry.

Format

Определяет формат схемы.
KnownFormat можно использовать взаимозаменяемо с форматом, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

JsonSchema/draft-07: Версия схемы JSON в формате draft 7
Delta/1.0: Дельта-формат

ManagementActionType

Определяет тип ManagementAction.
KnownManagementActionType можно использовать взаимозаменяемо с ManagementActionType, это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Вызов: тип действия вызова.
Чтение: тип действия чтения.
Write: Тип действия Write.

MqttDestinationQos

Набор поддерживаемых типов QoS для назначения MQTT.
KnownMqttDestinationQos можно использовать взаимозаменяемо с MqttDestinationQos, это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Qos0: QoS 0.
Qos1: QoS 1.

NamespaceDiscoveredManagementActionType

Определяет тип ManagementAction.
KnownNamespaceDiscoveredManagementActionType можно использовать взаимозаменяемо с NamespaceDiscoveredManagementActionType, это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Вызов: тип действия вызова.
Чтение: тип действия чтения.
Write: Тип действия Write.

Origin

Предполагаемый исполнитель операции; как и в RBAC, а также в журналах аудита. Значение по умолчанию — user, system
KnownOrigin можно использовать взаимозаменяемо с Origin, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

пользователя. Указывает, что операция инициируется пользователем.
системный: указывает, что операция инициируется системой.
пользователя, системная: указывает, что операция инициируется пользователем или системой.

ProvisioningState

Состояние подготовки ресурса.
KnownProvisioningState можно использовать взаимозаменяемо с ProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

успешно создан: ресурс создан.
сбой: сбой создания ресурса.
отменено: создание ресурса было отменено.
принято: ресурс был принят сервером.
удаление: ресурс удаляется.

SchemaType

Определяет тип схемы.
KnownSchemaType может использоваться взаимозаменяемо с SchemaType, это перечисление содержит известные значения, которые поддерживает служба.

Известные значения, поддерживаемые службой

MessageSchema: тип схемы схемы сообщения

Scope

Область операции миграции ресурсов.
KnownScope может использоваться взаимозаменяемо с Scope, это перечисление содержит известные значения, которые поддерживает служба.

Известные значения, поддерживаемые службой

Ресурсы: определение области миграции на предоставленные resourceIds

StreamDestinationTarget

Набор поддерживаемых назначений потока для ресурса.
KnownStreamDestinationTarget может использоваться взаимозаменяемо с StreamDestinationTarget, это перечисление содержит известные значения, которые поддерживает служба.

Известные значения, поддерживаемые службой

Mqtt: цель MQTT.
Хранилище: Целевое хранилище.

StreamDestinationUnion

Псевдоним для StreamDestinationUnion

SystemAssignedServiceIdentityType

Тип управляемого удостоверения службы (назначенный системой или нет).
KnownSystemAssignedServiceIdentityType можно использовать взаимозаменяемо с SystemAssignedServiceIdentityType, это перечисление содержит известные значения, которые поддерживает служба.

Известные значения, поддерживаемые службой

Нет: отсутствует идентификация управляемой системы.
SystemAssigned: Назначенное системой удостоверение управляемой системы.

TopicRetainType

Раздел сохраняет типы.
KnownTopicRetainType можно использовать взаимозаменяемо с TopicRetainType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Сохранить: сохранить сообщения.
никогда не: никогда не сохраняйте сообщения.

Перечисления

AzureClouds

Перечисление для описания облачных сред Azure.

KnownActionType

Расширяемый перечисление. Указывает тип действия. "Внутренний" относится к действиям, которые предназначены только для внутренних API.

KnownAuthenticationMethod

Метод проверки подлинности пользователя клиента на сервере.

KnownCreatedByType

Тип сущности, создающей ресурс.

KnownDataPointObservabilityMode

Определяет режим наблюдаемости точки данных.

KnownDatasetDestinationTarget

Набор поддерживаемых назначений набора данных для ресурса.

KnownEventDestinationTarget

Набор поддерживаемых мест назначения событий для ресурса.

KnownEventObservabilityMode

Определяет режим наблюдаемости событий.

KnownFormat

Определяет формат схемы.

KnownManagementActionType

Определяет тип ManagementAction.

KnownMqttDestinationQos

Набор поддерживаемых типов QoS для назначения MQTT.

KnownNamespaceDiscoveredManagementActionType

Определяет тип ManagementAction.

KnownOrigin

Предполагаемый исполнитель операции; как и в RBAC, а также в журналах аудита. Значение по умолчанию — user, system

KnownProvisioningState

Состояние подготовки ресурса.

KnownSchemaType

Определяет тип схемы.

KnownScope

Область операции миграции ресурсов.

KnownStreamDestinationTarget

Набор поддерживаемых назначений потока для ресурса.

KnownSystemAssignedServiceIdentityType

Тип управляемого удостоверения службы (назначенный системой или нет).

KnownTopicRetainType

Раздел сохраняет типы.

KnownVersions

Поддерживаемые версии API поставщика ресурсов Microsoft.DeviceRegistry.

Функции

restorePoller<TResponse, TResult>(DeviceRegistryManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Создает опрашиватель из сериализованного состояния другого опрашителя. Это может быть полезно, если вы хотите создать опросы на другом узле или опросщике необходимо создать после того, как исходный не находится в области.

Сведения о функции

restorePoller<TResponse, TResult>(DeviceRegistryManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Создает опрашиватель из сериализованного состояния другого опрашителя. Это может быть полезно, если вы хотите создать опросы на другом узле или опросщике необходимо создать после того, как исходный не находится в области.

function restorePoller<TResponse, TResult>(client: DeviceRegistryManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Параметры

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Возвращаемое значение

PollerLike<OperationState<TResult>, TResult>