@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.
DataPoint	Defines the data point properties.
DataPointBase	Defines the data point properties.
Dataset	Defines the dataset properties.
DeviceRegistryManagementClientOptionalParams	Optional parameters for the client.
DiscoveredAsset	Discovered Asset definition.
DiscoveredAssetEndpointProfile	Discovered Asset Endpoint Profile definition.
DiscoveredAssetEndpointProfileProperties	Defines the Discovered Asset Endpoint Profile properties.
DiscoveredAssetEndpointProfileUpdate	The type used for update operations of the DiscoveredAssetEndpointProfile.
DiscoveredAssetEndpointProfileUpdateProperties	The updatable properties of the DiscoveredAssetEndpointProfile.
DiscoveredAssetEndpointProfilesCreateOrReplaceOptionalParams	Optional parameters.
DiscoveredAssetEndpointProfilesDeleteOptionalParams	Optional parameters.
DiscoveredAssetEndpointProfilesGetOptionalParams	Optional parameters.
DiscoveredAssetEndpointProfilesListByResourceGroupOptionalParams	Optional parameters.
DiscoveredAssetEndpointProfilesListBySubscriptionOptionalParams	Optional parameters.
DiscoveredAssetEndpointProfilesOperations	Interface representing a DiscoveredAssetEndpointProfiles operations.
DiscoveredAssetEndpointProfilesUpdateOptionalParams	Optional parameters.
DiscoveredAssetProperties	Defines the discovered asset properties.
DiscoveredAssetUpdate	The type used for update operations of the DiscoveredAsset.
DiscoveredAssetUpdateProperties	The updatable properties of the DiscoveredAsset.
DiscoveredAssetsCreateOrReplaceOptionalParams	Optional parameters.
DiscoveredAssetsDeleteOptionalParams	Optional parameters.
DiscoveredAssetsGetOptionalParams	Optional parameters.
DiscoveredAssetsListByResourceGroupOptionalParams	Optional parameters.
DiscoveredAssetsListBySubscriptionOptionalParams	Optional parameters.
DiscoveredAssetsOperations	Interface representing a DiscoveredAssets operations.
DiscoveredAssetsUpdateOptionalParams	Optional parameters.
DiscoveredDataPoint	Defines the data point properties.
DiscoveredDataset	Defines the dataset properties.
DiscoveredEvent	Defines the event properties.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
Event	Defines the event properties.
EventBase	Defines the event properties.
ExtendedLocation	The extended location.
MessageSchemaReference	Defines the message schema reference properties.
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.
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.
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'
UsernamePasswordCredentials	The credentials for authentication mode UsernamePassword.
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.
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. <xref: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.
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
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
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

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.
KnownEventObservabilityMode	Defines the event observability mode.
KnownFormat	Defines the schema format.
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.
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>