通过


你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@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

表示 Assets 操作的接口。

AssetsUpdateOptionalParams

可选参数。

Authentication

服务器客户端身份验证机制的定义。

BillingContainer

billingContainer Model 作为 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

所有 Azure 资源管理器 API 的常见错误响应,以返回失败作的错误详细信息。

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

从资源提供程序操作 API 返回的 REST API 操作的详细信息

OperationDisplay

本地化的显示信息和操作。

OperationStatusGetOptionalParams

可选参数。

OperationStatusOperations

表示 OperationStatus 操作的接口。

OperationStatusResult

异步操作的当前状态。

OperationsListOptionalParams

可选参数。

OperationsOperations

表示操作操作的接口。

OutboundEndpoints

属性包包含设备的出站终结点

PageSettings

byPage 方法的选项

PagedAsyncIterableIterator

允许异步迭代到完成和逐页迭代的接口。

ProxyResource

Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置

Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

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

表示 Schemas作的接口。

StatusConfig

定义状态配置属性。

StatusError

定义状态配置错误属性。

StorageDestinationConfiguration

存储目标的配置。

StreamDestination

目标的类型。

StreamMqttDestination

MQTT 目标的类型。

StreamStorageDestination

存储目标的类型。

SystemAssignedServiceIdentity

托管服务标识(系统分配或无)

SystemData

与创建和上次修改资源相关的元数据。

Topic

描述主题信息的对象。

TrackedResource

Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源

TrustSettings

定义终结点的服务器信任设置。

UsernamePasswordCredentials

身份验证模式 UsernamePassword 的凭据。

X509CertificateCredentials

身份验证模式证书的 x509 证书。

X509Credentials

身份验证模式证书的 x509 证书。

类型别名

ActionType

可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。
KnownActionType 可与 ActionType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

内部:操作适用于仅限内部的 API。

AuthenticationMethod

在服务器上对客户端的用户进行身份验证的方法。
KnownAuthenticationMethod 可与 AuthenticationMethod 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

匿名:用户身份验证方法是匿名的。
证书:用户身份验证方法是 x509 证书。
UsernamePassword:用户身份验证方法是用户名和密码。

AzureSupportedClouds

云设置为字符串文字类型的支持值

ContinuablePage

描述结果页的接口。

CreatedByType

创建资源的实体类型。
KnownCreatedByType 可与 CreatedByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户:实体是由用户创建的。
应用程序:实体是由应用程序创建的。
ManagedIdentity:实体是由托管标识创建的。
密钥:实体是由密钥创建的。

DataPointObservabilityMode

定义数据点可观测性模式。
KnownDataPointObservabilityMode 可与 DataPointObservabilityMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

:不映射到 OpenTelemetry。
计数器:映射到 OpenTelemetry 的计数器。
仪表:将仪表映射为 OpenTelemetry。
直方图:将直方图映射到 OpenTelemetry。
日志:映射到 OpenTelemetry。

DatasetDestinationTarget

资产支持的数据集目标集。
KnownDatasetDestinationTarget 可以与 DatasetDestinationTarget 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

Mqtt:MQTT 目标。
BrokerStateStore:代理状态存储目标。
存储:存储目标。

DatasetDestinationUnion

DatasetDestinationUnion 的别名

EventDestinationTarget

资产支持的事件目标集。
KnownEventDestinationTarget 可以与 EventDestinationTarget 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

Mqtt:MQTT 目标。
存储:存储目标。

EventDestinationUnion

EventDestinationUnion 的别名

EventObservabilityMode

定义事件可观测性模式。
KnownEventObservabilityMode 可与 EventObservabilityMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

:不映射到 OpenTelemetry。
日志:映射到 OpenTelemetry。

Format

定义架构格式。
KnownFormat 可以与 Format 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

JsonSchema/draft-07:JSON Schema 版本草案 7 格式
Delta/1.0:Delta 格式

ManagementActionType

定义 ManagementAction 的类型。
KnownManagementActionType 可以与 ManagementActionType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

呼叫:呼叫作类型。
读取:读取作类型。
:写入作类型。

MqttDestinationQos

MQTT 目标支持的 QoS 类型集。
KnownMqttDestinationQos 可以与 MqttDestinationQos 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

Qos0:QoS 0。
Qos1:QoS 1。

NamespaceDiscoveredManagementActionType

定义 ManagementAction 的类型。
KnownNamespaceDiscoveredManagementActionType 可以与 NamespaceDiscoveredManagementActionType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

呼叫:呼叫作类型。
读取:读取作类型。
:写入作类型。

Origin

操作的预期执行程序;与基于资源的访问控制 (RBAC) 和审核日志 UX 中一样。 默认值为“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

MQTT 目标支持的 QoS 类型集。

KnownNamespaceDiscoveredManagementActionType

定义 ManagementAction 的类型。

KnownOrigin

操作的预期执行程序;与基于资源的访问控制 (RBAC) 和审核日志 UX 中一样。 默认值为“user,system”

KnownProvisioningState

资源的预配状态。

KnownSchemaType

定义架构类型。

KnownScope

迁移资源作的范围。

KnownStreamDestinationTarget

资产支持的流目标集。

KnownSystemAssignedServiceIdentityType

托管服务标识的类型(系统分配或无)。

KnownTopicRetainType

主题保留类型。

KnownVersions

Microsoft.DeviceRegistry 资源提供程序支持的 API 版本。

函数

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>