@azure/arm-deviceregistry package

Classes

DeviceRegistryManagementClient

Interfaces

Asset	Asset definition.
AssetEndpointProfile	Asset Endpoint Profile definition.
AssetEndpointProfileProperties	Defines the Asset Endpoint Profile properties.
AssetEndpointProfileStatus	Defines the asset endpoint profile status properties.
AssetEndpointProfileStatusError	Defines the asset endpoint profile status error properties.
AssetEndpointProfileUpdate	The type used for update operations of the AssetEndpointProfile.
AssetEndpointProfileUpdateProperties	The updatable properties of the AssetEndpointProfile.
AssetEndpointProfilesCreateOrReplaceOptionalParams	Optional parameters.
AssetEndpointProfilesDeleteOptionalParams	Optional parameters.
AssetEndpointProfilesGetOptionalParams	Optional parameters.
AssetEndpointProfilesListByResourceGroupOptionalParams	Optional parameters.
AssetEndpointProfilesListBySubscriptionOptionalParams	Optional parameters.
AssetEndpointProfilesOperations	Interface representing a AssetEndpointProfiles operations.
AssetEndpointProfilesUpdateOptionalParams	Optional parameters.
AssetProperties	Defines the asset properties.
AssetStatus	Defines the asset status properties.
AssetStatusDataset	Defines the asset status dataset properties.
AssetStatusError	Defines the asset status error properties.
AssetStatusEvent	Defines the asset status event properties.
AssetUpdate	The type used for update operations of the Asset.
AssetUpdateProperties	The updatable properties of the Asset.
AssetsCreateOrReplaceOptionalParams	Optional parameters.
AssetsDeleteOptionalParams	Optional parameters.
AssetsGetOptionalParams	Optional parameters.
AssetsListByResourceGroupOptionalParams	Optional parameters.
AssetsListBySubscriptionOptionalParams	Optional parameters.
AssetsOperations	Interface representing a Assets operations.
AssetsUpdateOptionalParams	Optional parameters.
Authentication	Definition of the client authentication mechanism to the server.
BillingContainer	billingContainer Model as Azure resource whose sole purpose is to keep track of billables resources under a subscription.
BillingContainerProperties	Defines the billingContainer properties.
BillingContainersGetOptionalParams	Optional parameters.
BillingContainersListBySubscriptionOptionalParams	Optional parameters.
BillingContainersOperations	Interface representing a BillingContainers operations.
BrokerStateStoreDestinationConfiguration	The configuration for a MQTT broker state store destination.
DataPoint	Defines the data point properties.
DataPointBase	Defines the data point properties.
Dataset	Defines the dataset properties.
DatasetBrokerStateStoreDestination	The type for a MQTT broker state store destination.
DatasetDestination	The type of the destination.
DatasetMqttDestination	The type for a MQTT destination.
DatasetStorageDestination	The type for a storage destination.
DeviceMessagingEndpoint	Device messaging endpoint model.
DeviceRef	Defines which device and endpoint to use for this asset
DeviceRegistryManagementClientOptionalParams	Optional parameters for the client.
DeviceStatus	Defines the device status properties.
DeviceStatusEndpoint	Defines the device status properties.
DeviceStatusEndpoints	Defines the device status for inbound/outbound endpoints.
DiscoveredInboundEndpoints	An endpoint to connect to the device.
DiscoveredMessagingEndpoints	Connection endpoint URL a device can use to connect to a service.
DiscoveredOutboundEndpoints	Property bag contains the device's outbound endpoints
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorDetails	Defines the error details properties.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
Event	Defines the event properties.
EventBase	Defines the event properties.
EventDestination	The type of the destination.
EventMqttDestination	The type for a MQTT destination.
EventStorageDestination	The type for a storage destination.
ExtendedLocation	The extended location.
HostAuthentication	Definition of the client authentication mechanism to the host.
InboundEndpoints	An endpoint to connect to the device.
ManagementAction	Defines the action properties.
ManagementGroup	Defines the management group properties.
MessageSchemaReference	Defines the message schema reference properties.
Messaging	The namespace messaging endpoints model.
MessagingEndpoint	Namespace messaging endpoint model used by a device to connect to a service.
MessagingEndpoints	Connection endpoint URL a device can use to connect to a service.
MqttDestinationConfiguration	The configuration for a MQTT destination.
Namespace	Namespace definition.
NamespaceAsset	Asset definition.
NamespaceAssetProperties	Defines the asset properties.
NamespaceAssetStatus	Defines the asset status properties.
NamespaceAssetStatusDataset	Defines the asset status dataset properties.
NamespaceAssetStatusEvent	Defines the asset status event properties.
NamespaceAssetStatusEventGroup	Defines the asset status event group properties.
NamespaceAssetStatusManagementAction	Defines the asset status action properties.
NamespaceAssetStatusManagementGroup	Defines the asset status management group properties.
NamespaceAssetStatusStream	Defines the asset status stream properties.
NamespaceAssetUpdate	The type used for update operations of the NamespaceAsset.
NamespaceAssetUpdateProperties	The updatable properties of the NamespaceAsset.
NamespaceAssetsCreateOrReplaceOptionalParams	Optional parameters.
NamespaceAssetsDeleteOptionalParams	Optional parameters.
NamespaceAssetsGetOptionalParams	Optional parameters.
NamespaceAssetsListByResourceGroupOptionalParams	Optional parameters.
NamespaceAssetsOperations	Interface representing a NamespaceAssets operations.
NamespaceAssetsUpdateOptionalParams	Optional parameters.
NamespaceDataset	Defines the dataset properties.
NamespaceDatasetDataPoint	Defines the dataset data point properties.
NamespaceDevice	Device definition.
NamespaceDeviceProperties	Defines the device properties.
NamespaceDeviceUpdate	The type used for update operations of the NamespaceDevice.
NamespaceDeviceUpdateProperties	The updatable properties of the NamespaceDevice.
NamespaceDevicesCreateOrReplaceOptionalParams	Optional parameters.
NamespaceDevicesDeleteOptionalParams	Optional parameters.
NamespaceDevicesGetOptionalParams	Optional parameters.
NamespaceDevicesListByResourceGroupOptionalParams	Optional parameters.
NamespaceDevicesOperations	Interface representing a NamespaceDevices operations.
NamespaceDevicesUpdateOptionalParams	Optional parameters.
NamespaceDiscoveredAsset	Discovered asset definition.
NamespaceDiscoveredAssetProperties	Defines the discovered asset properties.
NamespaceDiscoveredAssetUpdate	The type used for update operations of the NamespaceDiscoveredAsset.
NamespaceDiscoveredAssetUpdateProperties	The updatable properties of the NamespaceDiscoveredAsset.
NamespaceDiscoveredAssetsCreateOrReplaceOptionalParams	Optional parameters.
NamespaceDiscoveredAssetsDeleteOptionalParams	Optional parameters.
NamespaceDiscoveredAssetsGetOptionalParams	Optional parameters.
NamespaceDiscoveredAssetsListByResourceGroupOptionalParams	Optional parameters.
NamespaceDiscoveredAssetsOperations	Interface representing a NamespaceDiscoveredAssets operations.
NamespaceDiscoveredAssetsUpdateOptionalParams	Optional parameters.
NamespaceDiscoveredDataset	Defines the dataset properties.
NamespaceDiscoveredDatasetDataPoint	Defines the discovered dataset data point properties.
NamespaceDiscoveredDevice	Discovered device definition.
NamespaceDiscoveredDeviceProperties	Defines the discovered device properties.
NamespaceDiscoveredDeviceUpdate	The type used for update operations of the NamespaceDiscoveredDevice.
NamespaceDiscoveredDeviceUpdateProperties	The updatable properties of the NamespaceDiscoveredDevice.
NamespaceDiscoveredDevicesCreateOrReplaceOptionalParams	Optional parameters.
NamespaceDiscoveredDevicesDeleteOptionalParams	Optional parameters.
NamespaceDiscoveredDevicesGetOptionalParams	Optional parameters.
NamespaceDiscoveredDevicesListByResourceGroupOptionalParams	Optional parameters.
NamespaceDiscoveredDevicesOperations	Interface representing a NamespaceDiscoveredDevices operations.
NamespaceDiscoveredDevicesUpdateOptionalParams	Optional parameters.
NamespaceDiscoveredEvent	Defines the event properties.
NamespaceDiscoveredEventGroup	Defines the discovered event group properties.
NamespaceDiscoveredManagementAction	Defines the action properties.
NamespaceDiscoveredManagementGroup	Defines the management group properties.
NamespaceDiscoveredStream	Defines the stream properties.
NamespaceEvent	Defines the event properties.
NamespaceEventGroup	Defines the event group properties.
NamespaceMessageSchemaReference	Defines the message schema reference properties.
NamespaceMigrateRequest	Request body for the migrate resources operation in to Namespace resource.
NamespaceProperties	The namespace properties model.
NamespaceStream	Defines the stream properties.
NamespaceUpdate	The type used for update operations of the Namespace.
NamespaceUpdateProperties	The updatable properties of the Namespace.
NamespacesCreateOrReplaceOptionalParams	Optional parameters.
NamespacesDeleteOptionalParams	Optional parameters.
NamespacesGetOptionalParams	Optional parameters.
NamespacesListByResourceGroupOptionalParams	Optional parameters.
NamespacesListBySubscriptionOptionalParams	Optional parameters.
NamespacesMigrateOptionalParams	Optional parameters.
NamespacesOperations	Interface representing a Namespaces operations.
NamespacesUpdateOptionalParams	Optional parameters.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for and operation.
OperationStatusGetOptionalParams	Optional parameters.
OperationStatusOperations	Interface representing a OperationStatus operations.
OperationStatusResult	The current status of an async operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OutboundEndpoints	Property bag contains the device's outbound endpoints
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
Schema	Schema definition.
SchemaProperties	Defines the schema properties.
SchemaRegistriesCreateOrReplaceOptionalParams	Optional parameters.
SchemaRegistriesDeleteOptionalParams	Optional parameters.
SchemaRegistriesGetOptionalParams	Optional parameters.
SchemaRegistriesListByResourceGroupOptionalParams	Optional parameters.
SchemaRegistriesListBySubscriptionOptionalParams	Optional parameters.
SchemaRegistriesOperations	Interface representing a SchemaRegistries operations.
SchemaRegistriesUpdateOptionalParams	Optional parameters.
SchemaRegistry	Schema registry definition.
SchemaRegistryProperties	Defines the schema registry properties.
SchemaRegistryUpdate	The type used for update operations of the SchemaRegistry.
SchemaRegistryUpdateProperties	The updatable properties of the SchemaRegistry.
SchemaVersion	Schema version's definition.
SchemaVersionProperties	Defines the schema version properties.
SchemaVersionsCreateOrReplaceOptionalParams	Optional parameters.
SchemaVersionsDeleteOptionalParams	Optional parameters.
SchemaVersionsGetOptionalParams	Optional parameters.
SchemaVersionsListBySchemaOptionalParams	Optional parameters.
SchemaVersionsOperations	Interface representing a SchemaVersions operations.
SchemasCreateOrReplaceOptionalParams	Optional parameters.
SchemasDeleteOptionalParams	Optional parameters.
SchemasGetOptionalParams	Optional parameters.
SchemasListBySchemaRegistryOptionalParams	Optional parameters.
SchemasOperations	Interface representing a Schemas operations.
StatusConfig	Defines the status config properties.
StatusError	Defines the status config error properties.
StorageDestinationConfiguration	The configuration for a storage destination.
StreamDestination	The type of the destination.
StreamMqttDestination	The type for a MQTT destination.
StreamStorageDestination	The type for a storage destination.
SystemAssignedServiceIdentity	Managed service identity (either system assigned, or none)
SystemData	Metadata pertaining to creation and last modification of the resource.
Topic	Object that describes the topic information.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TrustSettings	Defines server trust settings for an endpoint.
UsernamePasswordCredentials	The credentials for authentication mode UsernamePassword.
X509CertificateCredentials	The x509 certificate for authentication mode Certificate.
X509Credentials	The x509 certificate for authentication mode Certificate.

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AuthenticationMethod	The method to authenticate the user of the client at the server. KnownAuthenticationMethod can be used interchangeably with AuthenticationMethod, this enum contains the known values that the service supports. Known values supported by the service Anonymous: The user authentication method is anonymous. Certificate: The user authentication method is an x509 certificate. UsernamePassword: The user authentication method is a username and password.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DataPointObservabilityMode	Defines the data point observability mode. KnownDataPointObservabilityMode can be used interchangeably with DataPointObservabilityMode, this enum contains the known values that the service supports. Known values supported by the service None: No mapping to OpenTelemetry. Counter: Map as counter to OpenTelemetry. Gauge: Map as gauge to OpenTelemetry. Histogram: Map as histogram to OpenTelemetry. Log: Map as log to OpenTelemetry.
DatasetDestinationTarget	The set of supported dataset destinations for an asset. KnownDatasetDestinationTarget can be used interchangeably with DatasetDestinationTarget, this enum contains the known values that the service supports. Known values supported by the service Mqtt: MQTT target. BrokerStateStore: Broker State Store target. Storage: Storage target.
DatasetDestinationUnion	Alias for DatasetDestinationUnion
EventDestinationTarget	The set of supported event destinations for an asset. KnownEventDestinationTarget can be used interchangeably with EventDestinationTarget, this enum contains the known values that the service supports. Known values supported by the service Mqtt: MQTT target. Storage: Storage target.
EventDestinationUnion	Alias for EventDestinationUnion
EventObservabilityMode	Defines the event observability mode. KnownEventObservabilityMode can be used interchangeably with EventObservabilityMode, this enum contains the known values that the service supports. Known values supported by the service None: No mapping to OpenTelemetry. Log: Map as log to OpenTelemetry.
Format	Defines the schema format. KnownFormat can be used interchangeably with Format, this enum contains the known values that the service supports. Known values supported by the service JsonSchema/draft-07: JSON Schema version draft 7 format Delta/1.0: Delta format
ManagementActionType	Defines the ManagementAction's type. KnownManagementActionType can be used interchangeably with ManagementActionType, this enum contains the known values that the service supports. Known values supported by the service Call: Call action type. Read: Read action type. Write: Write action type.
MqttDestinationQos	The set of supported QoS types for a MQTT destination. KnownMqttDestinationQos can be used interchangeably with MqttDestinationQos, this enum contains the known values that the service supports. Known values supported by the service Qos0: QoS 0. Qos1: QoS 1.
NamespaceDiscoveredManagementActionType	Defines the ManagementAction's type. KnownNamespaceDiscoveredManagementActionType can be used interchangeably with NamespaceDiscoveredManagementActionType, this enum contains the known values that the service supports. Known values supported by the service Call: Call action type. Read: Read action type. Write: Write action type.
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
ProvisioningState	The provisioning status of the resource. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. Accepted: Resource has been accepted by the server. Deleting: Resource is deleting.
SchemaType	Defines the schema type. KnownSchemaType can be used interchangeably with SchemaType, this enum contains the known values that the service supports. Known values supported by the service MessageSchema: Message Schema schema type
Scope	Scope of the migrate resources operation. KnownScope can be used interchangeably with Scope, this enum contains the known values that the service supports. Known values supported by the service Resources: Scoping the migration to resourceIds provided
StreamDestinationTarget	The set of supported stream destinations for an asset. KnownStreamDestinationTarget can be used interchangeably with StreamDestinationTarget, this enum contains the known values that the service supports. Known values supported by the service Mqtt: MQTT target. Storage: Storage target.
StreamDestinationUnion	Alias for StreamDestinationUnion
SystemAssignedServiceIdentityType	Type of managed service identity (either system assigned, or none). KnownSystemAssignedServiceIdentityType can be used interchangeably with SystemAssignedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed system identity. SystemAssigned: System assigned managed system identity.
TopicRetainType	Topic retain types. KnownTopicRetainType can be used interchangeably with TopicRetainType, this enum contains the known values that the service supports. Known values supported by the service Keep: Retain the messages. Never: Never retain messages.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAuthenticationMethod	The method to authenticate the user of the client at the server.
KnownCreatedByType	The kind of entity that created the resource.
KnownDataPointObservabilityMode	Defines the data point observability mode.
KnownDatasetDestinationTarget	The set of supported dataset destinations for an asset.
KnownEventDestinationTarget	The set of supported event destinations for an asset.
KnownEventObservabilityMode	Defines the event observability mode.
KnownFormat	Defines the schema format.
KnownManagementActionType	Defines the ManagementAction's type.
KnownMqttDestinationQos	The set of supported QoS types for a MQTT destination.
KnownNamespaceDiscoveredManagementActionType	Defines the ManagementAction's type.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProvisioningState	The provisioning status of the resource.
KnownSchemaType	Defines the schema type.
KnownScope	Scope of the migrate resources operation.
KnownStreamDestinationTarget	The set of supported stream destinations for an asset.
KnownSystemAssignedServiceIdentityType	Type of managed service identity (either system assigned, or none).
KnownTopicRetainType	Topic retain types.
KnownVersions	Microsoft.DeviceRegistry Resource Provider supported API versions.

Functions

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

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

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

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

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

Parameters

client

DeviceRegistryManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>