@azure/arm-digitaltwins package

Classes

AzureDigitalTwinsManagementClient

Interfaces

AzureDataExplorerConnectionProperties	Properties of a time series database connection to Azure Data Explorer with data being sent via an EventHub.
AzureDigitalTwinsManagementClientOptionalParams	Optional parameters.
CheckNameRequest	The result returned from a database check name availability request.
CheckNameResult	The result returned from a check name availability request.
ConnectionProperties	The properties of a private endpoint connection.
ConnectionPropertiesPrivateLinkServiceConnectionState	The connection state.
ConnectionState	The current state of a private endpoint connection.
DigitalTwins	Interface representing a DigitalTwins.
DigitalTwinsCheckNameAvailabilityOptionalParams	Optional parameters.
DigitalTwinsCreateOrUpdateOptionalParams	Optional parameters.
DigitalTwinsDeleteOptionalParams	Optional parameters.
DigitalTwinsDescription	The description of the DigitalTwins service.
DigitalTwinsDescriptionListResult	A list of DigitalTwins description objects with a next link.
DigitalTwinsEndpoint	Interface representing a DigitalTwinsEndpoint.
DigitalTwinsEndpointCreateOrUpdateOptionalParams	Optional parameters.
DigitalTwinsEndpointDeleteOptionalParams	Optional parameters.
DigitalTwinsEndpointGetOptionalParams	Optional parameters.
DigitalTwinsEndpointListNextOptionalParams	Optional parameters.
DigitalTwinsEndpointListOptionalParams	Optional parameters.
DigitalTwinsEndpointResource	DigitalTwinsInstance endpoint resource.
DigitalTwinsEndpointResourceListResult	A list of DigitalTwinsInstance Endpoints with a next link.
DigitalTwinsEndpointResourceProperties	Properties related to Digital Twins Endpoint
DigitalTwinsGetOptionalParams	Optional parameters.
DigitalTwinsIdentity	The managed identity for the DigitalTwinsInstance.
DigitalTwinsListByResourceGroupNextOptionalParams	Optional parameters.
DigitalTwinsListByResourceGroupOptionalParams	Optional parameters.
DigitalTwinsListNextOptionalParams	Optional parameters.
DigitalTwinsListOptionalParams	Optional parameters.
DigitalTwinsPatchDescription	The description of the DigitalTwins service.
DigitalTwinsPatchProperties	The properties of a DigitalTwinsInstance.
DigitalTwinsResource	The common properties of a DigitalTwinsInstance.
DigitalTwinsUpdateOptionalParams	Optional parameters.
ErrorDefinition	Error definition.
ErrorResponse	Error response.
EventGrid	Properties related to EventGrid.
EventHub	Properties related to EventHub.
ExternalResource	Definition of a resource.
GroupIdInformation	The group information for creating a private endpoint on Digital Twin.
GroupIdInformationProperties	The properties for a group information object.
GroupIdInformationResponse	The available private link resources for a Digital Twin.
ManagedIdentityReference	The properties of the Managed Identity.
Operation	DigitalTwins service REST API operation
OperationDisplay	The object that represents the operation.
OperationListResult	A list of DigitalTwins service operations. It contains a list of operations and a URL link to get the next set of results.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PrivateEndpoint	The private endpoint property of a private endpoint connection.
PrivateEndpointConnection	The private endpoint connection of a Digital Twin.
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListOptionalParams	Optional parameters.
PrivateEndpointConnectionsResponse	The available private link connections for a Digital Twin.
PrivateLinkResources	Interface representing a PrivateLinkResources.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListOptionalParams	Optional parameters.
ServiceBus	Properties related to ServiceBus.
SystemData	Metadata pertaining to creation and last modification of the resource.
TimeSeriesDatabaseConnection	Describes a time series database connection resource.
TimeSeriesDatabaseConnectionListResult	A pageable list of time series database connection resources.
TimeSeriesDatabaseConnectionProperties	Properties of a time series database connection resource.
TimeSeriesDatabaseConnections	Interface representing a TimeSeriesDatabaseConnections.
TimeSeriesDatabaseConnectionsCreateOrUpdateOptionalParams	Optional parameters.
TimeSeriesDatabaseConnectionsDeleteOptionalParams	Optional parameters.
TimeSeriesDatabaseConnectionsGetOptionalParams	Optional parameters.
TimeSeriesDatabaseConnectionsListNextOptionalParams	Optional parameters.
TimeSeriesDatabaseConnectionsListOptionalParams	Optional parameters.
UserAssignedIdentity	The information about the user assigned identity.

Type Aliases

AuthenticationType	Defines values for AuthenticationType. KnownAuthenticationType can be used interchangeably with AuthenticationType, this enum contains the known values that the service supports. Known values supported by the service KeyBased IdentityBased
CleanupConnectionArtifacts	Defines values for CleanupConnectionArtifacts. KnownCleanupConnectionArtifacts can be used interchangeably with CleanupConnectionArtifacts, this enum contains the known values that the service supports. Known values supported by the service true false
ConnectionPropertiesProvisioningState	Defines values for ConnectionPropertiesProvisioningState. KnownConnectionPropertiesProvisioningState can be used interchangeably with ConnectionPropertiesProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected Disconnected
ConnectionType	Defines values for ConnectionType. KnownConnectionType can be used interchangeably with ConnectionType, this enum contains the known values that the service supports. Known values supported by the service AzureDataExplorer
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
DigitalTwinsCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
DigitalTwinsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DigitalTwinsDeleteResponse	Contains response data for the delete operation.
DigitalTwinsEndpointCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DigitalTwinsEndpointDeleteResponse	Contains response data for the delete operation.
DigitalTwinsEndpointGetResponse	Contains response data for the get operation.
DigitalTwinsEndpointListNextResponse	Contains response data for the listNext operation.
DigitalTwinsEndpointListResponse	Contains response data for the list operation.
DigitalTwinsEndpointResourcePropertiesUnion
DigitalTwinsGetResponse	Contains response data for the get operation.
DigitalTwinsIdentityType	Defines values for DigitalTwinsIdentityType. KnownDigitalTwinsIdentityType can be used interchangeably with DigitalTwinsIdentityType, this enum contains the known values that the service supports. Known values supported by the service None SystemAssigned UserAssigned SystemAssigned,UserAssigned
DigitalTwinsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
DigitalTwinsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
DigitalTwinsListNextResponse	Contains response data for the listNext operation.
DigitalTwinsListResponse	Contains response data for the list operation.
DigitalTwinsUpdateResponse	Contains response data for the update operation.
EndpointProvisioningState	Defines values for EndpointProvisioningState. KnownEndpointProvisioningState can be used interchangeably with EndpointProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Provisioning Deleting Updating Succeeded Failed Canceled Deleted Warning Suspending Restoring Moving Disabled
EndpointType	Defines values for EndpointType. KnownEndpointType can be used interchangeably with EndpointType, this enum contains the known values that the service supports. Known values supported by the service EventHub EventGrid ServiceBus
IdentityType	Defines values for IdentityType. KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports. Known values supported by the service SystemAssigned UserAssigned
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
PrivateEndpointConnectionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
PrivateEndpointConnectionsListResponse	Contains response data for the list operation.
PrivateLinkResourcesGetResponse	Contains response data for the get operation.
PrivateLinkResourcesListResponse	Contains response data for the list operation.
PrivateLinkServiceConnectionStatus	Defines values for PrivateLinkServiceConnectionStatus. KnownPrivateLinkServiceConnectionStatus can be used interchangeably with PrivateLinkServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected Disconnected
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 Provisioning Deleting Updating Succeeded Failed Canceled Deleted Warning Suspending Restoring Moving
PublicNetworkAccess	Defines values for PublicNetworkAccess. KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
Reason	Defines values for Reason. KnownReason can be used interchangeably with Reason, this enum contains the known values that the service supports. Known values supported by the service Invalid AlreadyExists
RecordPropertyAndItemRemovals	Defines values for RecordPropertyAndItemRemovals. KnownRecordPropertyAndItemRemovals can be used interchangeably with RecordPropertyAndItemRemovals, this enum contains the known values that the service supports. Known values supported by the service true false
TimeSeriesDatabaseConnectionPropertiesUnion
TimeSeriesDatabaseConnectionState	Defines values for TimeSeriesDatabaseConnectionState. KnownTimeSeriesDatabaseConnectionState can be used interchangeably with TimeSeriesDatabaseConnectionState, this enum contains the known values that the service supports. Known values supported by the service Provisioning Deleting Updating Succeeded Failed Canceled Deleted Warning Suspending Restoring Moving Disabled
TimeSeriesDatabaseConnectionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
TimeSeriesDatabaseConnectionsDeleteResponse	Contains response data for the delete operation.
TimeSeriesDatabaseConnectionsGetResponse	Contains response data for the get operation.
TimeSeriesDatabaseConnectionsListNextResponse	Contains response data for the listNext operation.
TimeSeriesDatabaseConnectionsListResponse	Contains response data for the list operation.

Enums

KnownAuthenticationType	Known values of AuthenticationType that the service accepts.
KnownCleanupConnectionArtifacts	Known values of CleanupConnectionArtifacts that the service accepts.
KnownConnectionPropertiesProvisioningState	Known values of ConnectionPropertiesProvisioningState that the service accepts.
KnownConnectionType	Known values of ConnectionType that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownDigitalTwinsIdentityType	Known values of DigitalTwinsIdentityType that the service accepts.
KnownEndpointProvisioningState	Known values of EndpointProvisioningState that the service accepts.
KnownEndpointType	Known values of EndpointType that the service accepts.
KnownIdentityType	Known values of IdentityType that the service accepts.
KnownPrivateLinkServiceConnectionStatus	Known values of PrivateLinkServiceConnectionStatus that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownPublicNetworkAccess	Known values of PublicNetworkAccess that the service accepts.
KnownReason	Known values of Reason that the service accepts.
KnownRecordPropertyAndItemRemovals	Known values of RecordPropertyAndItemRemovals that the service accepts.
KnownTimeSeriesDatabaseConnectionState	Known values of TimeSeriesDatabaseConnectionState 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.