@azure/arm-servicebus package

Classes

ServiceBusManagementClient

Interfaces

AccessKeys	Namespace/ServiceBus Connection String
Action	Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
ArmDisasterRecovery	Single item in List or Get Alias(Disaster Recovery configuration) operation
ArmDisasterRecoveryListResult	The result of the List Alias(Disaster Recovery configuration) operation.
CheckNameAvailability	Description of a Check Name availability request properties.
CheckNameAvailabilityResult	Description of a Check Name availability request properties.
ConnectionState	ConnectionState information.
CorrelationFilter	Represents the correlation filter expression.
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.
Encryption	Properties to configure Encryption
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	The resource management error response.
ErrorResponseError	The error object.
FailoverProperties	Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary.
Identity	Properties to configure User Assigned Identities for Bring your Own Keys
KeyVaultProperties	Properties to configure keyVault Properties
MessageCountDetails	Message Count Details.
MigrationConfigListResult	The result of the List migrationConfigurations operation.
MigrationConfigProperties	Single item in List or Get Migration Config operation
MigrationConfigs	Interface representing a MigrationConfigs.
MigrationConfigsCompleteMigrationOptionalParams	Optional parameters.
MigrationConfigsCreateAndStartMigrationOptionalParams	Optional parameters.
MigrationConfigsDeleteOptionalParams	Optional parameters.
MigrationConfigsGetOptionalParams	Optional parameters.
MigrationConfigsListNextOptionalParams	Optional parameters.
MigrationConfigsListOptionalParams	Optional parameters.
MigrationConfigsRevertOptionalParams	Optional parameters.
NWRuleSetIpRules	Description of NetWorkRuleSet - IpRules resource.
NWRuleSetVirtualNetworkRules	Description of VirtualNetworkRules - NetworkRules resource.
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.
NamespacesListNetworkRuleSetsNextOptionalParams	Optional parameters.
NamespacesListNetworkRuleSetsOptionalParams	Optional parameters.
NamespacesListNextOptionalParams	Optional parameters.
NamespacesListOptionalParams	Optional parameters.
NamespacesRegenerateKeysOptionalParams	Optional parameters.
NamespacesUpdateOptionalParams	Optional parameters.
NetworkRuleSet	Description of NetworkRuleSet resource.
NetworkRuleSetListResult	The response of the List NetworkRuleSet operation.
Operation	A Service Bus REST API operation
OperationDisplay	Operation display payload
OperationListResult	Result of the request to list ServiceBus 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.
ProxyResource	Common fields that are returned in the response for all Azure Resource Manager resources
Queues	Interface representing a Queues.
QueuesCreateOrUpdateAuthorizationRuleOptionalParams	Optional parameters.
QueuesCreateOrUpdateOptionalParams	Optional parameters.
QueuesDeleteAuthorizationRuleOptionalParams	Optional parameters.
QueuesDeleteOptionalParams	Optional parameters.
QueuesGetAuthorizationRuleOptionalParams	Optional parameters.
QueuesGetOptionalParams	Optional parameters.
QueuesListAuthorizationRulesNextOptionalParams	Optional parameters.
QueuesListAuthorizationRulesOptionalParams	Optional parameters.
QueuesListByNamespaceNextOptionalParams	Optional parameters.
QueuesListByNamespaceOptionalParams	Optional parameters.
QueuesListKeysOptionalParams	Optional parameters.
QueuesRegenerateKeysOptionalParams	Optional parameters.
RegenerateAccessKeyParameters	Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset.
Resource	The Resource definition for other than namespace.
ResourceNamespacePatch	The Resource definition.
Rule	Description of Rule Resource.
RuleListResult	The response of the List rule operation.
Rules	Interface representing a Rules.
RulesCreateOrUpdateOptionalParams	Optional parameters.
RulesDeleteOptionalParams	Optional parameters.
RulesGetOptionalParams	Optional parameters.
RulesListBySubscriptionsNextOptionalParams	Optional parameters.
RulesListBySubscriptionsOptionalParams	Optional parameters.
SBAuthorizationRule	Description of a namespace authorization rule.
SBAuthorizationRuleListResult	The response to the List Namespace operation.
SBClientAffineProperties	Properties specific to client affine subscriptions.
SBNamespace	Description of a namespace resource.
SBNamespaceListResult	The response of the List Namespace operation.
SBNamespaceUpdateParameters	Description of a namespace resource.
SBQueue	Description of queue Resource.
SBQueueListResult	The response to the List Queues operation.
SBSku	SKU of the namespace.
SBSubscription	Description of subscription resource.
SBSubscriptionListResult	The response to the List Subscriptions operation.
SBTopic	Description of topic resource.
SBTopicListResult	The response to the List Topics operation.
ServiceBusManagementClientOptionalParams	Optional parameters.
SqlFilter	Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.
SqlRuleAction	Represents set of actions written in SQL language-based syntax that is performed against a ServiceBus.Messaging.BrokeredMessage
Subnet	Properties supplied for Subnet
Subscriptions	Interface representing a Subscriptions.
SubscriptionsCreateOrUpdateOptionalParams	Optional parameters.
SubscriptionsDeleteOptionalParams	Optional parameters.
SubscriptionsGetOptionalParams	Optional parameters.
SubscriptionsListByTopicNextOptionalParams	Optional parameters.
SubscriptionsListByTopicOptionalParams	Optional parameters.
SystemData	Metadata pertaining to creation and last modification of the resource.
Topics	Interface representing a Topics.
TopicsCreateOrUpdateAuthorizationRuleOptionalParams	Optional parameters.
TopicsCreateOrUpdateOptionalParams	Optional parameters.
TopicsDeleteAuthorizationRuleOptionalParams	Optional parameters.
TopicsDeleteOptionalParams	Optional parameters.
TopicsGetAuthorizationRuleOptionalParams	Optional parameters.
TopicsGetOptionalParams	Optional parameters.
TopicsListAuthorizationRulesNextOptionalParams	Optional parameters.
TopicsListAuthorizationRulesOptionalParams	Optional parameters.
TopicsListByNamespaceNextOptionalParams	Optional parameters.
TopicsListByNamespaceOptionalParams	Optional parameters.
TopicsListKeysOptionalParams	Optional parameters.
TopicsRegenerateKeysOptionalParams	Optional parameters.
TrackedResource	The Resource definition.
UserAssignedIdentity	Recognized Dictionary value.
UserAssignedIdentityProperties

Type Aliases

AccessRights	Defines values for AccessRights.
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.
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.
FilterType	Defines values for FilterType.
KeyType	Defines values for KeyType.
ManagedServiceIdentityType	Defines values for ManagedServiceIdentityType.
MigrationConfigsCreateAndStartMigrationResponse	Contains response data for the createAndStartMigration operation.
MigrationConfigsGetResponse	Contains response data for the get operation.
MigrationConfigsListNextResponse	Contains response data for the listNext operation.
MigrationConfigsListResponse	Contains response data for the list operation.
MigrationConfigurationName	Defines values for MigrationConfigurationName. KnownMigrationConfigurationName can be used interchangeably with MigrationConfigurationName, this enum contains the known values that the service supports. Known values supported by the service $default
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.
NamespacesListNetworkRuleSetsNextResponse	Contains response data for the listNetworkRuleSetsNext operation.
NamespacesListNetworkRuleSetsResponse	Contains response data for the listNetworkRuleSets 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
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.
ProvisioningStateDR	Defines values for ProvisioningStateDR.
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
QueuesCreateOrUpdateAuthorizationRuleResponse	Contains response data for the createOrUpdateAuthorizationRule operation.
QueuesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
QueuesGetAuthorizationRuleResponse	Contains response data for the getAuthorizationRule operation.
QueuesGetResponse	Contains response data for the get operation.
QueuesListAuthorizationRulesNextResponse	Contains response data for the listAuthorizationRulesNext operation.
QueuesListAuthorizationRulesResponse	Contains response data for the listAuthorizationRules operation.
QueuesListByNamespaceNextResponse	Contains response data for the listByNamespaceNext operation.
QueuesListByNamespaceResponse	Contains response data for the listByNamespace operation.
QueuesListKeysResponse	Contains response data for the listKeys operation.
QueuesRegenerateKeysResponse	Contains response data for the regenerateKeys operation.
RoleDisasterRecovery	Defines values for RoleDisasterRecovery.
RulesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
RulesGetResponse	Contains response data for the get operation.
RulesListBySubscriptionsNextResponse	Contains response data for the listBySubscriptionsNext operation.
RulesListBySubscriptionsResponse	Contains response data for the listBySubscriptions operation.
SkuName	Defines values for SkuName.
SkuTier	Defines values for SkuTier.
SubscriptionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
SubscriptionsGetResponse	Contains response data for the get operation.
SubscriptionsListByTopicNextResponse	Contains response data for the listByTopicNext operation.
SubscriptionsListByTopicResponse	Contains response data for the listByTopic operation.
TopicsCreateOrUpdateAuthorizationRuleResponse	Contains response data for the createOrUpdateAuthorizationRule operation.
TopicsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
TopicsGetAuthorizationRuleResponse	Contains response data for the getAuthorizationRule operation.
TopicsGetResponse	Contains response data for the get operation.
TopicsListAuthorizationRulesNextResponse	Contains response data for the listAuthorizationRulesNext operation.
TopicsListAuthorizationRulesResponse	Contains response data for the listAuthorizationRules operation.
TopicsListByNamespaceNextResponse	Contains response data for the listByNamespaceNext operation.
TopicsListByNamespaceResponse	Contains response data for the listByNamespace operation.
TopicsListKeysResponse	Contains response data for the listKeys operation.
TopicsRegenerateKeysResponse	Contains response data for the regenerateKeys operation.
UnavailableReason	Defines values for UnavailableReason.

Enums

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.
KnownMigrationConfigurationName	Known values of MigrationConfigurationName that the service accepts.
KnownNetworkRuleIPAction	Known values of NetworkRuleIPAction that the service accepts.
KnownPrivateLinkConnectionStatus	Known values of PrivateLinkConnectionStatus that the service accepts.
KnownPublicNetworkAccessFlag	Known values of PublicNetworkAccessFlag 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.