@azure/arm-servicebus package

Classes

ServiceBusManagementClient

Interfaces

@azure/arm-servicebus.FailOverProperties

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
ArmDisasterRecoveryProperties	Properties required to the Create Or Update Alias(Disaster Recovery configurations)
CheckNameAvailability	Description of a Check Name availability request properties.
CheckNameAvailabilityResult	Description of a Check Name availability request properties.
ConfidentialCompute	model interface ConfidentialCompute
ConnectionState	ConnectionState information.
CorrelationFilter	Represents the correlation filter expression.
DisasterRecoveryConfigsBreakPairingOptionalParams	Optional parameters.
DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams	Optional parameters.
DisasterRecoveryConfigsCreateOrUpdateOptionalParams	Optional parameters.
DisasterRecoveryConfigsDeleteOptionalParams	Optional parameters.
DisasterRecoveryConfigsFailOverOptionalParams	Optional parameters.
DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams	Optional parameters.
DisasterRecoveryConfigsGetOptionalParams	Optional parameters.
DisasterRecoveryConfigsListAuthorizationRulesOptionalParams	Optional parameters.
DisasterRecoveryConfigsListKeysOptionalParams	Optional parameters.
DisasterRecoveryConfigsListOptionalParams	Optional parameters.
DisasterRecoveryConfigsOperations	Interface representing a DisasterRecoveryConfigs operations.
Encryption	Properties to configure Encryption
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	The resource management error response.
ErrorResponseError	The error object.
FailOver	model interface FailOver
FailoverProperties	Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary.
FailoverPropertiesProperties	Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary.
GeoDataReplicationProperties	GeoDR Replication properties
Identity	Properties to configure User Assigned Identities for Bring your Own Keys
KeyVaultProperties	Properties to configure keyVault Properties
MessageCountDetails	Message Count Details.
MigrationConfigProperties	Single item in List or Get Migration Config operation
MigrationConfigPropertiesProperties	Properties required to the Create Migration Configuration
MigrationConfigsCompleteMigrationOptionalParams	Optional parameters.
MigrationConfigsCreateAndStartMigrationOptionalParams	Optional parameters.
MigrationConfigsDeleteOptionalParams	Optional parameters.
MigrationConfigsGetOptionalParams	Optional parameters.
MigrationConfigsListOptionalParams	Optional parameters.
MigrationConfigsOperations	Interface representing a MigrationConfigs operations.
MigrationConfigsRevertOptionalParams	Optional parameters.
NWRuleSetIpRules	Description of NetWorkRuleSet - IpRules resource.
NWRuleSetVirtualNetworkRules	Description of VirtualNetworkRules - NetworkRules resource.
NamespaceReplicaLocation	Namespace replication properties
NamespacesCheckNameAvailabilityOptionalParams	Optional parameters.
NamespacesCreateOrUpdateAuthorizationRuleOptionalParams	Optional parameters.
NamespacesCreateOrUpdateNetworkRuleSetOptionalParams	Optional parameters.
NamespacesCreateOrUpdateOptionalParams	Optional parameters.
NamespacesDeleteAuthorizationRuleOptionalParams	Optional parameters.
NamespacesDeleteOptionalParams	Optional parameters.
NamespacesFailoverOptionalParams	Optional parameters.
NamespacesGetAuthorizationRuleOptionalParams	Optional parameters.
NamespacesGetNetworkRuleSetOptionalParams	Optional parameters.
NamespacesGetOptionalParams	Optional parameters.
NamespacesListAuthorizationRulesOptionalParams	Optional parameters.
NamespacesListByResourceGroupOptionalParams	Optional parameters.
NamespacesListKeysOptionalParams	Optional parameters.
NamespacesListNetworkRuleSetsOptionalParams	Optional parameters.
NamespacesListOptionalParams	Optional parameters.
NamespacesOperations	Interface representing a Namespaces operations.
NamespacesRegenerateKeysOptionalParams	Optional parameters.
NamespacesUpdateOptionalParams	Optional parameters.
NetworkRuleSet	Description of NetworkRuleSet resource.
NetworkRuleSetProperties	NetworkRuleSet properties
NetworkSecurityPerimeter	NetworkSecurityPerimeter related information
NetworkSecurityPerimeterConfiguration	Network Security Perimeter related configurations of a given namespace
NetworkSecurityPerimeterConfigurationListOptionalParams	Optional parameters.
NetworkSecurityPerimeterConfigurationOperations	Interface representing a NetworkSecurityPerimeterConfiguration operations.
NetworkSecurityPerimeterConfigurationProperties	Properties of NetworkSecurityPerimeterConfiguration
NetworkSecurityPerimeterConfigurationPropertiesProfile	Information about current network profile
NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation	Information about resource association
NetworkSecurityPerimeterConfigurationsGetResourceAssociationNameOptionalParams	Optional parameters.
NetworkSecurityPerimeterConfigurationsOperations	Interface representing a NetworkSecurityPerimeterConfigurations operations.
NetworkSecurityPerimeterConfigurationsReconcileOptionalParams	Optional parameters.
NspAccessRule	Information of Access Rule in Network Profile
NspAccessRuleProperties	Properties of Access Rule
NspAccessRulePropertiesSubscriptionsItem	Subscription for inbound rule
Operation	A Service Bus REST API operation
OperationDisplay	Operation display payload
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.
PlatformCapabilities	model interface PlatformCapabilities
PrivateEndpoint	PrivateEndpoint information.
PrivateEndpointConnection	Properties of the PrivateEndpointConnection.
PrivateEndpointConnectionProperties	Properties of the private endpoint connection resource.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateLinkResource	Information of the private link resource.
PrivateLinkResourceProperties	Properties of PrivateLinkResource
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListResult	The response of a PrivateLinkResource list operation.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
ProvisioningIssue	Describes Provisioning issue for given NetworkSecurityPerimeterConfiguration
ProvisioningIssueProperties	Properties of Provisioning Issue
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
QueuesCreateOrUpdateAuthorizationRuleOptionalParams	Optional parameters.
QueuesCreateOrUpdateOptionalParams	Optional parameters.
QueuesDeleteAuthorizationRuleOptionalParams	Optional parameters.
QueuesDeleteOptionalParams	Optional parameters.
QueuesGetAuthorizationRuleOptionalParams	Optional parameters.
QueuesGetOptionalParams	Optional parameters.
QueuesListAuthorizationRulesOptionalParams	Optional parameters.
QueuesListByNamespaceOptionalParams	Optional parameters.
QueuesListKeysOptionalParams	Optional parameters.
QueuesOperations	Interface representing a Queues operations.
QueuesRegenerateKeysOptionalParams	Optional parameters.
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
ResourceNamespacePatch	The Resource definition.
RestorePollerOptions
Rule	Description of Rule Resource.
Ruleproperties	Description of Rule Resource.
RulesCreateOrUpdateOptionalParams	Optional parameters.
RulesDeleteOptionalParams	Optional parameters.
RulesGetOptionalParams	Optional parameters.
RulesListBySubscriptionsOptionalParams	Optional parameters.
RulesOperations	Interface representing a Rules operations.
SBAuthorizationRule	Description of a namespace authorization rule.
SBAuthorizationRuleProperties	AuthorizationRule properties.
SBClientAffineProperties	Properties specific to client affine subscriptions.
SBNamespace	Description of a namespace resource.
SBNamespaceProperties	Properties of the namespace.
SBNamespaceUpdateParameters	Description of a namespace resource.
SBNamespaceUpdateProperties	Properties of the namespace.
SBQueue	Description of queue Resource.
SBQueueProperties	The Queue Properties definition.
SBSku	SKU of the namespace.
SBSubscription	Description of subscription resource.
SBSubscriptionProperties	Description of Subscription Resource.
SBTopic	Description of topic resource.
SBTopicProperties	The Topic Properties definition.
ServiceBusManagementClientOptionalParams	Optional parameters for the client.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SqlFilter	Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.
Subnet	Properties supplied for Subnet
SubscriptionsCreateOrUpdateOptionalParams	Optional parameters.
SubscriptionsDeleteOptionalParams	Optional parameters.
SubscriptionsGetOptionalParams	Optional parameters.
SubscriptionsListByTopicOptionalParams	Optional parameters.
SubscriptionsOperations	Interface representing a Subscriptions operations.
SystemData	Metadata pertaining to creation and last modification of the resource.
TopicsCreateOrUpdateAuthorizationRuleOptionalParams	Optional parameters.
TopicsCreateOrUpdateOptionalParams	Optional parameters.
TopicsDeleteAuthorizationRuleOptionalParams	Optional parameters.
TopicsDeleteOptionalParams	Optional parameters.
TopicsGetAuthorizationRuleOptionalParams	Optional parameters.
TopicsGetOptionalParams	Optional parameters.
TopicsListAuthorizationRulesOptionalParams	Optional parameters.
TopicsListByNamespaceOptionalParams	Optional parameters.
TopicsListKeysOptionalParams	Optional parameters.
TopicsOperations	Interface representing a Topics operations.
TopicsRegenerateKeysOptionalParams	Optional parameters.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity	Recognized Dictionary value.
UserAssignedIdentityProperties	model interface UserAssignedIdentityProperties

Type Aliases

AccessRights	Type of AccessRights
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. 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.
DefaultAction	Default Action for Network Rule Set 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
EndPointProvisioningState	Provisioning state of the Private Endpoint Connection. 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	Entity status.
FilterType	Rule filter types
GeoDRRoleType	GeoDR Role Types KnownGeoDRRoleType can be used interchangeably with GeoDRRoleType, this enum contains the known values that the service supports. Known values supported by the service Primary Secondary
KeyType	The access key to regenerate.
ManagedServiceIdentityType	Type of managed service identity.
MigrationConfigurationName	Type of MigrationConfigurationName
Mode	Setting to Enable or Disable Confidential Compute KnownMode can be used interchangeably with Mode, this enum contains the known values that the service supports. Known values supported by the service Disabled Enabled
NetworkRuleIPAction	The IP Filter Action KnownNetworkRuleIPAction can be used interchangeably with NetworkRuleIPAction, this enum contains the known values that the service supports. Known values supported by the service Allow
NetworkSecurityPerimeterConfigurationProvisioningState	Provisioning state of NetworkSecurityPerimeter configuration propagation 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	Direction of Access Rule 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
PrivateLinkConnectionStatus	Status of the connection. 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
ProvisioningStateDR	Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'
PublicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled. 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	This determines if traffic is allowed over public network. By default it is enabled. 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
ResourceAssociationAccessMode	Access Mode of the resource association 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	role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'
SkuName	Name of this SKU.
SkuTier	The billing tier of this particular SKU.
TlsVersion	The minimum TLS version for the cluster to support, e.g. '1.3' 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 1.3
UnavailableReason	Specifies the reason for the unavailability of the service.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownCreatedByType	The kind of entity that created the resource.
KnownDefaultAction	Default Action for Network Rule Set
KnownEndPointProvisioningState	Provisioning state of the Private Endpoint Connection.
KnownGeoDRRoleType	GeoDR Role Types
KnownMigrationConfigurationName	Known values of MigrationConfigurationName that the service accepts.
KnownMode	Setting to Enable or Disable Confidential Compute
KnownNetworkRuleIPAction	The IP Filter Action
KnownNetworkSecurityPerimeterConfigurationProvisioningState	Provisioning state of NetworkSecurityPerimeter configuration propagation
KnownNspAccessRuleDirection	Direction of Access Rule
KnownPrivateLinkConnectionStatus	Status of the connection.
KnownPublicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled.
KnownPublicNetworkAccessFlag	This determines if traffic is allowed over public network. By default it is enabled.
KnownResourceAssociationAccessMode	Access Mode of the resource association
KnownTlsVersion	The minimum TLS version for the cluster to support, e.g. '1.3'
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(ServiceBusManagementClient, 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.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(ServiceBusManagementClient, 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: ServiceBusManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

ServiceBusManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor