@azure/arm-eventhub package

Classes

EventHubManagementClient

Interfaces

AccessKeys

Namespace/EventHub Connection String

ApplicationGroup

The Application Group object

ApplicationGroupCreateOrUpdateApplicationGroupOptionalParams

Optional parameters.

ApplicationGroupDeleteOptionalParams

Optional parameters.

ApplicationGroupGetOptionalParams

Optional parameters.

ApplicationGroupListByNamespaceNextOptionalParams

Optional parameters.

ApplicationGroupListByNamespaceOptionalParams

Optional parameters.

ApplicationGroupListResult

The response from the List Application Groups operation.

ApplicationGroupOperations

Interface representing a ApplicationGroupOperations.

ApplicationGroupPolicy

Properties of the Application Group policy

ArmDisasterRecovery

Single item in List or Get Alias(Disaster Recovery configuration) operation

ArmDisasterRecoveryListResult

The result of the List Alias(Disaster Recovery configuration) operation.

AuthorizationRule

Single item in a List or Get AuthorizationRule operation

AuthorizationRuleListResult

The response from the List namespace operation.

AvailableCluster

Pre-provisioned and readily available Event Hubs Cluster count per region.

AvailableClustersList

The response of the List Available Clusters operation.

CaptureDescription

Properties to configure capture description for eventhub

CaptureIdentity

A value that indicates whether capture description is enabled.

CheckNameAvailabilityParameter

Parameter supplied to check Namespace name availability operation

CheckNameAvailabilityResult

The Result of the CheckNameAvailability operation

Cluster

Single Event Hubs Cluster resource in List or Get operations.

ClusterListResult

The response of the List Event Hubs Clusters operation.

ClusterQuotaConfigurationProperties

Contains all settings for the cluster.

ClusterSku

SKU parameters particular to a cluster instance.

Clusters

Interface representing a Clusters.

ClustersCreateOrUpdateOptionalParams

Optional parameters.

ClustersDeleteOptionalParams

Optional parameters.

ClustersGetOptionalParams

Optional parameters.

ClustersListAvailableClusterRegionOptionalParams

Optional parameters.

ClustersListByResourceGroupNextOptionalParams

Optional parameters.

ClustersListByResourceGroupOptionalParams

Optional parameters.

ClustersListBySubscriptionNextOptionalParams

Optional parameters.

ClustersListBySubscriptionOptionalParams

Optional parameters.

ClustersListNamespacesOptionalParams

Optional parameters.

ClustersUpdateOptionalParams

Optional parameters.

Configuration

Interface representing a Configuration.

ConfigurationGetOptionalParams

Optional parameters.

ConfigurationPatchOptionalParams

Optional parameters.

ConnectionState

ConnectionState information.

ConsumerGroup

Single item in List or Get Consumer group operation

ConsumerGroupListResult

The result to the List Consumer Group operation.

ConsumerGroups

Interface representing a ConsumerGroups.

ConsumerGroupsCreateOrUpdateOptionalParams

Optional parameters.

ConsumerGroupsDeleteOptionalParams

Optional parameters.

ConsumerGroupsGetOptionalParams

Optional parameters.

ConsumerGroupsListByEventHubNextOptionalParams

Optional parameters.

ConsumerGroupsListByEventHubOptionalParams

Optional parameters.

Destination

Capture storage details for capture description

DisasterRecoveryConfigs

Interface representing a DisasterRecoveryConfigs.

DisasterRecoveryConfigsBreakPairingOptionalParams

Optional parameters.

DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams

Optional parameters.

DisasterRecoveryConfigsCreateOrUpdateOptionalParams

Optional parameters.

DisasterRecoveryConfigsDeleteOptionalParams

Optional parameters.

DisasterRecoveryConfigsFailOverOptionalParams

Optional parameters.

DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams

Optional parameters.

DisasterRecoveryConfigsGetOptionalParams

Optional parameters.

DisasterRecoveryConfigsListAuthorizationRulesNextOptionalParams

Optional parameters.

DisasterRecoveryConfigsListAuthorizationRulesOptionalParams

Optional parameters.

DisasterRecoveryConfigsListKeysOptionalParams

Optional parameters.

DisasterRecoveryConfigsListNextOptionalParams

Optional parameters.

DisasterRecoveryConfigsListOptionalParams

Optional parameters.

EHNamespace

Single Namespace item in List or Get Operation

EHNamespaceIdContainer

The full ARM ID of an Event Hubs Namespace

EHNamespaceIdListResult

The response of the List Namespace IDs operation

EHNamespaceListResult

The response of the List Namespace operation

Encryption

Properties to configure Encryption

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.

EventHubListResult

The result of the List EventHubs operation.

EventHubManagementClientOptionalParams

Optional parameters.

EventHubs

Interface representing a EventHubs.

EventHubsCreateOrUpdateAuthorizationRuleOptionalParams

Optional parameters.

EventHubsCreateOrUpdateOptionalParams

Optional parameters.

EventHubsDeleteAuthorizationRuleOptionalParams

Optional parameters.

EventHubsDeleteOptionalParams

Optional parameters.

EventHubsGetAuthorizationRuleOptionalParams

Optional parameters.

EventHubsGetOptionalParams

Optional parameters.

EventHubsListAuthorizationRulesNextOptionalParams

Optional parameters.

EventHubsListAuthorizationRulesOptionalParams

Optional parameters.

EventHubsListByNamespaceNextOptionalParams

Optional parameters.

EventHubsListByNamespaceOptionalParams

Optional parameters.

EventHubsListKeysOptionalParams

Optional parameters.

EventHubsRegenerateKeysOptionalParams

Optional parameters.

Eventhub

Single item in List or Get Event Hub operation

Identity

Properties to configure Identity for Bring your Own Keys

KeyVaultProperties

Properties to configure keyVault Properties

NWRuleSetIpRules

The response from the List namespace operation.

NWRuleSetVirtualNetworkRules

The response from the List namespace operation.

Namespaces

Interface representing a Namespaces.

NamespacesCheckNameAvailabilityOptionalParams

Optional parameters.

NamespacesCreateOrUpdateAuthorizationRuleOptionalParams

Optional parameters.

NamespacesCreateOrUpdateNetworkRuleSetOptionalParams

Optional parameters.

NamespacesCreateOrUpdateOptionalParams

Optional parameters.

NamespacesDeleteAuthorizationRuleOptionalParams

Optional parameters.

NamespacesDeleteOptionalParams

Optional parameters.

NamespacesGetAuthorizationRuleOptionalParams

Optional parameters.

NamespacesGetNetworkRuleSetOptionalParams

Optional parameters.

NamespacesGetOptionalParams

Optional parameters.

NamespacesListAuthorizationRulesNextOptionalParams

Optional parameters.

NamespacesListAuthorizationRulesOptionalParams

Optional parameters.

NamespacesListByResourceGroupNextOptionalParams

Optional parameters.

NamespacesListByResourceGroupOptionalParams

Optional parameters.

NamespacesListKeysOptionalParams

Optional parameters.

NamespacesListNetworkRuleSetOptionalParams

Optional parameters.

NamespacesListNextOptionalParams

Optional parameters.

NamespacesListOptionalParams

Optional parameters.

NamespacesRegenerateKeysOptionalParams

Optional parameters.

NamespacesUpdateOptionalParams

Optional parameters.

NetworkRuleSet

Description of topic resource.

NetworkRuleSetListResult

The response of the List NetworkRuleSet operation

NetworkSecurityPerimeter

NetworkSecurityPerimeter related information

NetworkSecurityPerimeterConfiguration

Network Security Perimeter related configurations of a given namespace

NetworkSecurityPerimeterConfigurationList

Result of the List NetworkSecurityPerimeterConfiguration operation.

NetworkSecurityPerimeterConfigurationListOptionalParams

Optional parameters.

NetworkSecurityPerimeterConfigurationOperations

Interface representing a NetworkSecurityPerimeterConfigurationOperations.

NetworkSecurityPerimeterConfigurationPropertiesProfile

Information about current network profile

NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation

Information about resource association

NetworkSecurityPerimeterConfigurations

Interface representing a NetworkSecurityPerimeterConfigurations.

NetworkSecurityPerimeterConfigurationsCreateOrUpdateOptionalParams

Optional parameters.

NspAccessRule

Information of Access Rule in Network Profile

NspAccessRuleProperties

Properties of Access Rule

NspAccessRulePropertiesSubscriptionsItem

Subscription for inbound rule

Operation

A Event Hub REST API operation

OperationDisplay

Operation display payload

OperationListResult

Result of the request to list Event Hub 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

PrivateEndpoint information.

PrivateEndpointConnection

Properties of the PrivateEndpointConnection.

PrivateEndpointConnectionListResult

Result of the list of all private endpoint connections operation.

PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListNextOptionalParams

Optional parameters.

PrivateEndpointConnectionsListOptionalParams

Optional parameters.

PrivateLinkResource

Information of the private link resource.

PrivateLinkResources

Interface representing a PrivateLinkResources.

PrivateLinkResourcesGetOptionalParams

Optional parameters.

PrivateLinkResourcesListResult

Result of the List private link resources operation.

ProvisioningIssue

Describes Provisioning issue for given NetworkSecurityPerimeterConfiguration

ProvisioningIssueProperties

Properties of Provisioning Issue

ProxyResource

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

RegenerateAccessKeyParameters

Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset.

Resource

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

RetentionDescription

Properties to configure retention settings for the eventhub

SchemaGroup

Single item in List or Get Schema Group operation

SchemaGroupListResult

The result of the List SchemaGroup operation.

SchemaRegistry

Interface representing a SchemaRegistry.

SchemaRegistryCreateOrUpdateOptionalParams

Optional parameters.

SchemaRegistryDeleteOptionalParams

Optional parameters.

SchemaRegistryGetOptionalParams

Optional parameters.

SchemaRegistryListByNamespaceNextOptionalParams

Optional parameters.

SchemaRegistryListByNamespaceOptionalParams

Optional parameters.

Sku

SKU parameters supplied to the create namespace operation

Subnet

Properties supplied for Subnet

SystemData

Metadata pertaining to creation and last modification of the resource.

ThrottlingPolicy

Properties of the throttling policy

TrackedResource

Definition of resource.

UserAssignedIdentity

Recognized Dictionary value.

UserAssignedIdentityProperties

Type Aliases

AccessRights

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

Known values supported by the service

Manage
Send
Listen

ApplicationGroupCreateOrUpdateApplicationGroupResponse

Contains response data for the createOrUpdateApplicationGroup operation.

ApplicationGroupGetResponse

Contains response data for the get operation.

ApplicationGroupListByNamespaceNextResponse

Contains response data for the listByNamespaceNext operation.

ApplicationGroupListByNamespaceResponse

Contains response data for the listByNamespace operation.

ApplicationGroupPolicyType

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

Known values supported by the service

ThrottlingPolicy

ApplicationGroupPolicyUnion
CaptureIdentityType

Defines values for CaptureIdentityType.

CleanupPolicyRetentionDescription

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

Known values supported by the service

Delete
Compact

ClusterSkuName

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

Known values supported by the service

Dedicated

ClustersCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ClustersGetResponse

Contains response data for the get operation.

ClustersListAvailableClusterRegionResponse

Contains response data for the listAvailableClusterRegion operation.

ClustersListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

ClustersListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ClustersListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

ClustersListBySubscriptionResponse

Contains response data for the listBySubscription operation.

ClustersListNamespacesResponse

Contains response data for the listNamespaces operation.

ClustersUpdateResponse

Contains response data for the update operation.

ConfigurationGetResponse

Contains response data for the get operation.

ConfigurationPatchResponse

Contains response data for the patch operation.

ConsumerGroupsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ConsumerGroupsGetResponse

Contains response data for the get operation.

ConsumerGroupsListByEventHubNextResponse

Contains response data for the listByEventHubNext operation.

ConsumerGroupsListByEventHubResponse

Contains response data for the listByEventHub 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

DefaultAction

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

Known values supported by the service

Allow
Deny

DisasterRecoveryConfigsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

DisasterRecoveryConfigsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

DisasterRecoveryConfigsGetAuthorizationRuleResponse

Contains response data for the getAuthorizationRule operation.

DisasterRecoveryConfigsGetResponse

Contains response data for the get operation.

DisasterRecoveryConfigsListAuthorizationRulesNextResponse

Contains response data for the listAuthorizationRulesNext operation.

DisasterRecoveryConfigsListAuthorizationRulesResponse

Contains response data for the listAuthorizationRules operation.

DisasterRecoveryConfigsListKeysResponse

Contains response data for the listKeys operation.

DisasterRecoveryConfigsListNextResponse

Contains response data for the listNext operation.

DisasterRecoveryConfigsListResponse

Contains response data for the list operation.

EncodingCaptureDescription

Defines values for EncodingCaptureDescription.

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

Creating
Updating
Deleting
Succeeded
Canceled
Failed

EntityStatus

Defines values for EntityStatus.

EventHubsCreateOrUpdateAuthorizationRuleResponse

Contains response data for the createOrUpdateAuthorizationRule operation.

EventHubsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

EventHubsGetAuthorizationRuleResponse

Contains response data for the getAuthorizationRule operation.

EventHubsGetResponse

Contains response data for the get operation.

EventHubsListAuthorizationRulesNextResponse

Contains response data for the listAuthorizationRulesNext operation.

EventHubsListAuthorizationRulesResponse

Contains response data for the listAuthorizationRules operation.

EventHubsListByNamespaceNextResponse

Contains response data for the listByNamespaceNext operation.

EventHubsListByNamespaceResponse

Contains response data for the listByNamespace operation.

EventHubsListKeysResponse

Contains response data for the listKeys operation.

EventHubsRegenerateKeysResponse

Contains response data for the regenerateKeys operation.

KeyType

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

Known values supported by the service

PrimaryKey
SecondaryKey

ManagedServiceIdentityType

Defines values for ManagedServiceIdentityType.

MetricId

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

Known values supported by the service

IncomingBytes
OutgoingBytes
IncomingMessages
OutgoingMessages

NamespacesCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

NamespacesCreateOrUpdateAuthorizationRuleResponse

Contains response data for the createOrUpdateAuthorizationRule operation.

NamespacesCreateOrUpdateNetworkRuleSetResponse

Contains response data for the createOrUpdateNetworkRuleSet operation.

NamespacesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

NamespacesGetAuthorizationRuleResponse

Contains response data for the getAuthorizationRule operation.

NamespacesGetNetworkRuleSetResponse

Contains response data for the getNetworkRuleSet operation.

NamespacesGetResponse

Contains response data for the get operation.

NamespacesListAuthorizationRulesNextResponse

Contains response data for the listAuthorizationRulesNext operation.

NamespacesListAuthorizationRulesResponse

Contains response data for the listAuthorizationRules operation.

NamespacesListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

NamespacesListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

NamespacesListKeysResponse

Contains response data for the listKeys operation.

NamespacesListNetworkRuleSetResponse

Contains response data for the listNetworkRuleSet operation.

NamespacesListNextResponse

Contains response data for the listNext operation.

NamespacesListResponse

Contains response data for the list operation.

NamespacesRegenerateKeysResponse

Contains response data for the regenerateKeys operation.

NamespacesUpdateResponse

Contains response data for the update operation.

NetworkRuleIPAction

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

Known values supported by the service

Allow

NetworkSecurityPerimeterConfigurationListResponse

Contains response data for the list operation.

NetworkSecurityPerimeterConfigurationProvisioningState

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

Known values supported by the service

Unknown
Creating
Updating
Accepted
InvalidResponse
Succeeded
SucceededWithIssues
Failed
Deleting
Deleted
Canceled

NspAccessRuleDirection

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

Known values supported by the service

Inbound
Outbound

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.

PrivateEndpointConnectionsListNextResponse

Contains response data for the listNext operation.

PrivateEndpointConnectionsListResponse

Contains response data for the list operation.

PrivateLinkConnectionStatus

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

Known values supported by the service

Pending
Approved
Rejected
Disconnected

PrivateLinkResourcesGetResponse

Contains response data for the get operation.

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

Unknown
Creating
Deleting
Scaling
Active
Failed
Succeeded
Canceled

ProvisioningStateDR

Defines values for ProvisioningStateDR.

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
SecuredByPerimeter

PublicNetworkAccessFlag

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

Known values supported by the service

Enabled
Disabled
SecuredByPerimeter

ResourceAssociationAccessMode

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

Known values supported by the service

NoAssociationMode
EnforcedMode
LearningMode
AuditMode
UnspecifiedMode

RoleDisasterRecovery

Defines values for RoleDisasterRecovery.

SchemaCompatibility

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

Known values supported by the service

None
Backward
Forward

SchemaRegistryCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

SchemaRegistryGetResponse

Contains response data for the get operation.

SchemaRegistryListByNamespaceNextResponse

Contains response data for the listByNamespaceNext operation.

SchemaRegistryListByNamespaceResponse

Contains response data for the listByNamespace operation.

SchemaType

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

Known values supported by the service

Unknown
Avro

SkuName

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

Known values supported by the service

Basic
Standard
Premium

SkuTier

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

Known values supported by the service

Basic
Standard
Premium

TlsVersion

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

Known values supported by the service

1.0
1.1
1.2

UnavailableReason

Defines values for UnavailableReason.

Enums

KnownAccessRights

Known values of AccessRights that the service accepts.

KnownApplicationGroupPolicyType

Known values of ApplicationGroupPolicyType that the service accepts.

KnownCleanupPolicyRetentionDescription

Known values of CleanupPolicyRetentionDescription that the service accepts.

KnownClusterSkuName

Known values of ClusterSkuName that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownDefaultAction

Known values of DefaultAction that the service accepts.

KnownEndPointProvisioningState

Known values of EndPointProvisioningState that the service accepts.

KnownKeyType

Known values of KeyType that the service accepts.

KnownMetricId

Known values of MetricId that the service accepts.

KnownNetworkRuleIPAction

Known values of NetworkRuleIPAction that the service accepts.

KnownNetworkSecurityPerimeterConfigurationProvisioningState

Known values of NetworkSecurityPerimeterConfigurationProvisioningState that the service accepts.

KnownNspAccessRuleDirection

Known values of NspAccessRuleDirection that the service accepts.

KnownPrivateLinkConnectionStatus

Known values of PrivateLinkConnectionStatus that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownPublicNetworkAccess

Known values of PublicNetworkAccess that the service accepts.

KnownPublicNetworkAccessFlag

Known values of PublicNetworkAccessFlag that the service accepts.

KnownResourceAssociationAccessMode

Known values of ResourceAssociationAccessMode that the service accepts.

KnownSchemaCompatibility

Known values of SchemaCompatibility that the service accepts.

KnownSchemaType

Known values of SchemaType that the service accepts.

KnownSkuName

Known values of SkuName that the service accepts.

KnownSkuTier

Known values of SkuTier that the service accepts.

KnownTlsVersion

Known values of TlsVersion 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.