@azure/arm-deviceregistry package

Classes

DeviceRegistryManagementClient

Interfaces

Asset

Asset definition.

AssetEndpointProfile

Asset Endpoint Profile definition.

AssetEndpointProfileListResult

The response of a AssetEndpointProfile list operation.

AssetEndpointProfileProperties

Defines the Asset Endpoint Profile properties.

AssetEndpointProfileUpdate

The type used for update operations of the AssetEndpointProfile.

AssetEndpointProfileUpdateProperties

The updatable properties of the AssetEndpointProfile.

AssetEndpointProfiles

Interface representing a AssetEndpointProfiles.

AssetEndpointProfilesCreateOrReplaceHeaders

Defines headers for AssetEndpointProfiles_createOrReplace operation.

AssetEndpointProfilesCreateOrReplaceOptionalParams

Optional parameters.

AssetEndpointProfilesDeleteHeaders

Defines headers for AssetEndpointProfiles_delete operation.

AssetEndpointProfilesDeleteOptionalParams

Optional parameters.

AssetEndpointProfilesGetOptionalParams

Optional parameters.

AssetEndpointProfilesListByResourceGroupNextOptionalParams

Optional parameters.

AssetEndpointProfilesListByResourceGroupOptionalParams

Optional parameters.

AssetEndpointProfilesListBySubscriptionNextOptionalParams

Optional parameters.

AssetEndpointProfilesListBySubscriptionOptionalParams

Optional parameters.

AssetEndpointProfilesUpdateHeaders

Defines headers for AssetEndpointProfiles_update operation.

AssetEndpointProfilesUpdateOptionalParams

Optional parameters.

AssetListResult

The response of a Asset list operation.

AssetProperties

Defines the asset properties.

AssetStatus

Defines the asset status properties.

AssetStatusError

Defines the asset status error properties.

AssetUpdate

The type used for update operations of the Asset.

AssetUpdateProperties

The updatable properties of the Asset.

Assets

Interface representing a Assets.

AssetsCreateOrReplaceHeaders

Defines headers for Assets_createOrReplace operation.

AssetsCreateOrReplaceOptionalParams

Optional parameters.

AssetsDeleteHeaders

Defines headers for Assets_delete operation.

AssetsDeleteOptionalParams

Optional parameters.

AssetsGetOptionalParams

Optional parameters.

AssetsListByResourceGroupNextOptionalParams

Optional parameters.

AssetsListByResourceGroupOptionalParams

Optional parameters.

AssetsListBySubscriptionNextOptionalParams

Optional parameters.

AssetsListBySubscriptionOptionalParams

Optional parameters.

AssetsUpdateHeaders

Defines headers for Assets_update operation.

AssetsUpdateOptionalParams

Optional parameters.

DataPoint

Defines the data point properties.

DeviceRegistryManagementClientOptionalParams

Optional parameters.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Event

Defines the event properties.

ExtendedLocation

The extended location.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for this particular operation.

OperationListResult

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

OperationStatus

Interface representing a OperationStatus.

OperationStatusGetOptionalParams

Optional parameters.

OperationStatusResult

The current status of an async operation.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

OwnCertificate

Certificate or private key that can be used by the southbound connector connecting to the shop floor/OT device. The accepted extensions are .der for certificates and .pfx/.pem for private keys.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

TransportAuthentication

Definition of the authentication mechanism for the southbound connector.

TransportAuthenticationUpdate

Definition of the authentication mechanism for the southbound connector.

UserAuthentication

Definition of the client authentication mechanism to the server.

UserAuthenticationUpdate

Definition of the client authentication mechanism to the server.

UsernamePasswordCredentials

The credentials for authentication mode UsernamePassword.

UsernamePasswordCredentialsUpdate

The credentials for authentication mode UsernamePassword.

X509Credentials

The x509 certificate for authentication mode Certificate.

X509CredentialsUpdate

The x509 certificate for authentication mode Certificate.

Type Aliases

ActionType

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal

AssetEndpointProfilesCreateOrReplaceResponse

Contains response data for the createOrReplace operation.

AssetEndpointProfilesDeleteResponse

Contains response data for the delete operation.

AssetEndpointProfilesGetResponse

Contains response data for the get operation.

AssetEndpointProfilesListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

AssetEndpointProfilesListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

AssetEndpointProfilesListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

AssetEndpointProfilesListBySubscriptionResponse

Contains response data for the listBySubscription operation.

AssetEndpointProfilesUpdateResponse

Contains response data for the update operation.

AssetsCreateOrReplaceResponse

Contains response data for the createOrReplace operation.

AssetsDeleteResponse

Contains response data for the delete operation.

AssetsGetResponse

Contains response data for the get operation.

AssetsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

AssetsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

AssetsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

AssetsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

AssetsUpdateResponse

Contains response data for the update operation.

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

DataPointsObservabilityMode

Defines values for DataPointsObservabilityMode.
KnownDataPointsObservabilityMode can be used interchangeably with DataPointsObservabilityMode, 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.

EventsObservabilityMode

Defines values for EventsObservabilityMode.
KnownEventsObservabilityMode can be used interchangeably with EventsObservabilityMode, 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.

OperationStatusGetResponse

Contains response data for the get operation.

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

Origin

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system

ProvisioningState

Defines values for ProvisioningState.
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.

UserAuthenticationMode

Defines values for UserAuthenticationMode.
KnownUserAuthenticationMode can be used interchangeably with UserAuthenticationMode, this enum contains the known values that the service supports.

Known values supported by the service

Anonymous: The user authentication mode is anonymous.
Certificate: The user authentication mode is an x509 certificate.
UsernamePassword: The user authentication mode is a username and password.

Enums

KnownActionType

Known values of ActionType that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownDataPointsObservabilityMode

Known values of DataPointsObservabilityMode that the service accepts.

KnownEventsObservabilityMode

Known values of EventsObservabilityMode that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownUserAuthenticationMode

Known values of UserAuthenticationMode that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.