@datafire/azure_servicebus

Client library for ServiceBusManagementClient

Installation and Usage

npm install --save @datafire/azure_servicebus

let azure_servicebus = require('@datafire/azure_servicebus').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Azure Service Bus client

Actions

Operations_List

Lists all of the available ServiceBus REST API operations.

azure_servicebus.Operations_List({
  "api-version": ""
}, context)

Input

• input object
  • api-version required string: Client API version.

Output

• output OperationListResult

Namespaces_CheckNameAvailability

Check the give namespace name availability.

azure_servicebus.Namespaces_CheckNameAvailability({
  "api-version": "",
  "subscriptionId": "",
  "parameters": null
}, context)

Input

• input object
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • parameters required CheckNameAvailability

Output

• output CheckNameAvailabilityResult

Namespaces_List

Gets all the available namespaces within the subscription, irrespective of the resource groups.

azure_servicebus.Namespaces_List({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBNamespaceListResult

PremiumMessagingRegions_List

Gets the available premium messaging regions for servicebus

azure_servicebus.PremiumMessagingRegions_List({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output PremiumMessagingRegionsListResult

Regions_ListBySku

Gets the available Regions for a given sku

azure_servicebus.Regions_ListBySku({
  "api-version": "",
  "subscriptionId": "",
  "sku": ""
}, context)

Input

• input object
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • sku required string: The sku type.

Output

• output PremiumMessagingRegionsListResult

Namespaces_ListByResourceGroup

Gets the available namespaces within a resource group.

azure_servicebus.Namespaces_ListByResourceGroup({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBNamespaceListResult

Namespaces_Delete

Deletes an existing namespace. This operation also removes all associated resources under the namespace.

azure_servicebus.Namespaces_Delete({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Namespaces_Get

Gets a description for the specified namespace.

azure_servicebus.Namespaces_Get({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBNamespace

Namespaces_Update

Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

azure_servicebus.Namespaces_Update({
  "resourceGroupName": "",
  "namespaceName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • parameters required SBNamespaceUpdateParameters
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBNamespace

Namespaces_CreateOrUpdate

Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

azure_servicebus.Namespaces_CreateOrUpdate({
  "resourceGroupName": "",
  "namespaceName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name.
  • parameters required SBNamespace
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBNamespace

Namespaces_ListAuthorizationRules

Gets the authorization rules for a namespace.

azure_servicebus.Namespaces_ListAuthorizationRules({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBAuthorizationRuleListResult

Namespaces_DeleteAuthorizationRule

Deletes a namespace authorization rule.

azure_servicebus.Namespaces_DeleteAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • authorizationRuleName required string: The authorization rule name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Namespaces_GetAuthorizationRule

Gets an authorization rule for a namespace by rule name.

azure_servicebus.Namespaces_GetAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • authorizationRuleName required string: The authorization rule name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBAuthorizationRule

Namespaces_CreateOrUpdateAuthorizationRule

Creates or updates an authorization rule for a namespace.

azure_servicebus.Namespaces_CreateOrUpdateAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "authorizationRuleName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • authorizationRuleName required string: The authorization rule name.
  • parameters required SBAuthorizationRule
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBAuthorizationRule

Namespaces_ListKeys

Gets the primary and secondary connection strings for the namespace.

azure_servicebus.Namespaces_ListKeys({
  "resourceGroupName": "",
  "namespaceName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • authorizationRuleName required string: The authorization rule name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output AccessKeys

Namespaces_RegenerateKeys

Regenerates the primary or secondary connection strings for the namespace.

azure_servicebus.Namespaces_RegenerateKeys({
  "resourceGroupName": "",
  "namespaceName": "",
  "authorizationRuleName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • authorizationRuleName required string: The authorization rule name.
  • parameters required RegenerateAccessKeyParameters
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output AccessKeys

DisasterRecoveryConfigs_List

Gets all Alias(Disaster Recovery configurations)

azure_servicebus.DisasterRecoveryConfigs_List({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ArmDisasterRecoveryListResult

DisasterRecoveryConfigs_CheckNameAvailability

Check the give namespace name availability.

azure_servicebus.DisasterRecoveryConfigs_CheckNameAvailability({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": "",
  "parameters": null
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • parameters required CheckNameAvailability

Output

• output CheckNameAvailabilityResult

DisasterRecoveryConfigs_Delete

Deletes an Alias(Disaster Recovery configuration)

azure_servicebus.DisasterRecoveryConfigs_Delete({
  "resourceGroupName": "",
  "namespaceName": "",
  "alias": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • alias required string: The Disaster Recovery configuration name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

DisasterRecoveryConfigs_Get

Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace

azure_servicebus.DisasterRecoveryConfigs_Get({
  "resourceGroupName": "",
  "namespaceName": "",
  "alias": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • alias required string: The Disaster Recovery configuration name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ArmDisasterRecovery

DisasterRecoveryConfigs_CreateOrUpdate

Creates or updates a new Alias(Disaster Recovery configuration)

azure_servicebus.DisasterRecoveryConfigs_CreateOrUpdate({
  "resourceGroupName": "",
  "namespaceName": "",
  "alias": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • alias required string: The Disaster Recovery configuration name
  • parameters required ArmDisasterRecovery
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output ArmDisasterRecovery

DisasterRecoveryConfigs_ListAuthorizationRules

Gets the authorization rules for a namespace.

azure_servicebus.DisasterRecoveryConfigs_ListAuthorizationRules({
  "resourceGroupName": "",
  "namespaceName": "",
  "alias": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • alias required string: The Disaster Recovery configuration name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBAuthorizationRuleListResult

DisasterRecoveryConfigs_GetAuthorizationRule

Gets an authorization rule for a namespace by rule name.

azure_servicebus.DisasterRecoveryConfigs_GetAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "alias": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • alias required string: The Disaster Recovery configuration name
  • authorizationRuleName required string: The authorization rule name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBAuthorizationRule

DisasterRecoveryConfigs_ListKeys

Gets the primary and secondary connection strings for the namespace.

azure_servicebus.DisasterRecoveryConfigs_ListKeys({
  "resourceGroupName": "",
  "namespaceName": "",
  "alias": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • alias required string: The Disaster Recovery configuration name
  • authorizationRuleName required string: The authorization rule name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output AccessKeys

DisasterRecoveryConfigs_BreakPairing

This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces

azure_servicebus.DisasterRecoveryConfigs_BreakPairing({
  "resourceGroupName": "",
  "namespaceName": "",
  "alias": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • alias required string: The Disaster Recovery configuration name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

DisasterRecoveryConfigs_FailOver

Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace

azure_servicebus.DisasterRecoveryConfigs_FailOver({
  "resourceGroupName": "",
  "namespaceName": "",
  "alias": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • alias required string: The Disaster Recovery configuration name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

EventHubs_ListByNamespace

Gets all the Event Hubs in a service bus Namespace.

azure_servicebus.EventHubs_ListByNamespace({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output EventHubListResult

Namespaces_Migrate

This operation Migrate the given namespace to provided name type

azure_servicebus.Namespaces_Migrate({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": "",
  "parameters": {
    "targetNamespaceType": ""
  }
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • parameters required SBNamespaceMigrate

Output

Output schema unknown

MigrationConfigs_List

Gets all migrationConfigurations

azure_servicebus.MigrationConfigs_List({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output MigrationConfigListResult

MigrationConfigs_Delete

Deletes a MigrationConfiguration

azure_servicebus.MigrationConfigs_Delete({
  "resourceGroupName": "",
  "namespaceName": "",
  "configName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • configName required string (values: $default): The configuration name. Should always be "$default".
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

MigrationConfigs_Get

Retrieves Migration Config

azure_servicebus.MigrationConfigs_Get({
  "resourceGroupName": "",
  "namespaceName": "",
  "configName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • configName required string (values: $default): The configuration name. Should always be "$default".
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output MigrationConfigProperties

MigrationConfigs_CreateAndStartMigration

Creates Migration configuration and starts migration of entities from Standard to Premium namespace

azure_servicebus.MigrationConfigs_CreateAndStartMigration({
  "resourceGroupName": "",
  "namespaceName": "",
  "configName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • configName required string (values: $default): The configuration name. Should always be "$default".
  • parameters required MigrationConfigProperties
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output MigrationConfigProperties

MigrationConfigs_Revert

This operation reverts Migration

azure_servicebus.MigrationConfigs_Revert({
  "resourceGroupName": "",
  "namespaceName": "",
  "configName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • configName required string (values: $default): The configuration name. Should always be "$default".
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

MigrationConfigs_CompleteMigration

This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.

azure_servicebus.MigrationConfigs_CompleteMigration({
  "resourceGroupName": "",
  "namespaceName": "",
  "configName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • configName required string (values: $default): The configuration name. Should always be "$default".
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Namespaces_ListNetworkRuleSets

Gets list of NetworkRuleSet for a Namespace.

azure_servicebus.Namespaces_ListNetworkRuleSets({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output NetworkRuleSetListResult

Namespaces_GetNetworkRuleSet

Gets NetworkRuleSet for a Namespace.

azure_servicebus.Namespaces_GetNetworkRuleSet({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output NetworkRuleSet

Namespaces_CreateOrUpdateNetworkRuleSet

Create or update NetworkRuleSet for a Namespace.

azure_servicebus.Namespaces_CreateOrUpdateNetworkRuleSet({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": "",
  "parameters": null
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • parameters required NetworkRuleSet

Output

• output NetworkRuleSet

Queues_ListByNamespace

Gets the queues within a namespace.

azure_servicebus.Queues_ListByNamespace({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • $skip integer: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.
  • $top integer: May be used to limit the number of results to the most recent N usageDetails.

Output

• output SBQueueListResult

Queues_Delete

Deletes a queue from the specified namespace in a resource group.

azure_servicebus.Queues_Delete({
  "resourceGroupName": "",
  "namespaceName": "",
  "queueName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • queueName required string: The queue name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Queues_Get

Returns a description for the specified queue.

azure_servicebus.Queues_Get({
  "resourceGroupName": "",
  "namespaceName": "",
  "queueName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • queueName required string: The queue name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBQueue

Queues_CreateOrUpdate

Creates or updates a Service Bus queue. This operation is idempotent.

azure_servicebus.Queues_CreateOrUpdate({
  "resourceGroupName": "",
  "namespaceName": "",
  "queueName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • queueName required string: The queue name.
  • parameters required SBQueue
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBQueue

Queues_ListAuthorizationRules

Gets all authorization rules for a queue.

azure_servicebus.Queues_ListAuthorizationRules({
  "resourceGroupName": "",
  "namespaceName": "",
  "queueName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • queueName required string: The queue name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBAuthorizationRuleListResult

Queues_DeleteAuthorizationRule

Deletes a queue authorization rule.

azure_servicebus.Queues_DeleteAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "queueName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • queueName required string: The queue name.
  • authorizationRuleName required string: The authorization rule name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Queues_GetAuthorizationRule

Gets an authorization rule for a queue by rule name.

azure_servicebus.Queues_GetAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "queueName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • queueName required string: The queue name.
  • authorizationRuleName required string: The authorization rule name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBAuthorizationRule

Queues_CreateOrUpdateAuthorizationRule

Creates an authorization rule for a queue.

azure_servicebus.Queues_CreateOrUpdateAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "queueName": "",
  "authorizationRuleName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • queueName required string: The queue name.
  • authorizationRuleName required string: The authorization rule name.
  • parameters required SBAuthorizationRule
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBAuthorizationRule

Queues_ListKeys

Primary and secondary connection strings to the queue.

azure_servicebus.Queues_ListKeys({
  "resourceGroupName": "",
  "namespaceName": "",
  "queueName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • queueName required string: The queue name.
  • authorizationRuleName required string: The authorization rule name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output AccessKeys

Queues_RegenerateKeys

Regenerates the primary or secondary connection strings to the queue.

azure_servicebus.Queues_RegenerateKeys({
  "resourceGroupName": "",
  "namespaceName": "",
  "queueName": "",
  "authorizationRuleName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • queueName required string: The queue name.
  • authorizationRuleName required string: The authorization rule name.
  • parameters required RegenerateAccessKeyParameters
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output AccessKeys

Topics_ListByNamespace

Gets all the topics in a namespace.

azure_servicebus.Topics_ListByNamespace({
  "resourceGroupName": "",
  "namespaceName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • $skip integer: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.
  • $top integer: May be used to limit the number of results to the most recent N usageDetails.

Output

• output SBTopicListResult

Topics_Delete

Deletes a topic from the specified namespace and resource group.

azure_servicebus.Topics_Delete({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Topics_Get

Returns a description for the specified topic.

azure_servicebus.Topics_Get({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBTopic

Topics_CreateOrUpdate

Creates a topic in the specified namespace.

azure_servicebus.Topics_CreateOrUpdate({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • parameters required SBTopic
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBTopic

Topics_ListAuthorizationRules

Gets authorization rules for a topic.

azure_servicebus.Topics_ListAuthorizationRules({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBAuthorizationRuleListResult

Topics_DeleteAuthorizationRule

Deletes a topic authorization rule.

azure_servicebus.Topics_DeleteAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • authorizationRuleName required string: The authorization rule name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Topics_GetAuthorizationRule

Returns the specified authorization rule.

azure_servicebus.Topics_GetAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • authorizationRuleName required string: The authorization rule name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBAuthorizationRule

Topics_CreateOrUpdateAuthorizationRule

Creates an authorization rule for the specified topic.

azure_servicebus.Topics_CreateOrUpdateAuthorizationRule({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "authorizationRuleName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • authorizationRuleName required string: The authorization rule name.
  • parameters required SBAuthorizationRule
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBAuthorizationRule

Topics_ListKeys

Gets the primary and secondary connection strings for the topic.

azure_servicebus.Topics_ListKeys({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "authorizationRuleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • authorizationRuleName required string: The authorization rule name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output AccessKeys

Topics_RegenerateKeys

Regenerates primary or secondary connection strings for the topic.

azure_servicebus.Topics_RegenerateKeys({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "authorizationRuleName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • authorizationRuleName required string: The authorization rule name.
  • parameters required RegenerateAccessKeyParameters
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output AccessKeys

Subscriptions_ListByTopic

List all the subscriptions under a specified topic.

azure_servicebus.Subscriptions_ListByTopic({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • $skip integer: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.
  • $top integer: May be used to limit the number of results to the most recent N usageDetails.

Output

• output SBSubscriptionListResult

Subscriptions_Delete

Deletes a subscription from the specified topic.

azure_servicebus.Subscriptions_Delete({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "subscriptionName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • subscriptionName required string: The subscription name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Subscriptions_Get

Returns a subscription description for the specified topic.

azure_servicebus.Subscriptions_Get({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "subscriptionName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • subscriptionName required string: The subscription name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBSubscription

Subscriptions_CreateOrUpdate

Creates a topic subscription.

azure_servicebus.Subscriptions_CreateOrUpdate({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "subscriptionName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • subscriptionName required string: The subscription name.
  • parameters required SBSubscription
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SBSubscription

Rules_ListBySubscriptions

List all the rules within given topic-subscription

azure_servicebus.Rules_ListBySubscriptions({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "subscriptionName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • subscriptionName required string: The subscription name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • $skip integer: Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.
  • $top integer: May be used to limit the number of results to the most recent N usageDetails.

Output

• output RuleListResult

Rules_Delete

Deletes an existing rule.

azure_servicebus.Rules_Delete({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "subscriptionName": "",
  "ruleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • subscriptionName required string: The subscription name.
  • ruleName required string: The rule name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Rules_Get

Retrieves the description for the specified rule.

azure_servicebus.Rules_Get({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "subscriptionName": "",
  "ruleName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • subscriptionName required string: The subscription name.
  • ruleName required string: The rule name.
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output Rule

Rules_CreateOrUpdate

Creates a new rule and updates an existing rule

azure_servicebus.Rules_CreateOrUpdate({
  "resourceGroupName": "",
  "namespaceName": "",
  "topicName": "",
  "subscriptionName": "",
  "ruleName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: Name of the Resource group within the Azure subscription.
  • namespaceName required string: The namespace name
  • topicName required string: The topic name.
  • subscriptionName required string: The subscription name.
  • ruleName required string: The rule name.
  • parameters required Rule
  • api-version required string: Client API version.
  • subscriptionId required string: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output Rule

Definitions

AccessKeys

• AccessKeys object: Namespace/ServiceBus Connection String
  • aliasPrimaryConnectionString string: Primary connection string of the alias if GEO DR is enabled
  • aliasSecondaryConnectionString string: Secondary connection string of the alias if GEO DR is enabled
  • keyName string: A string that describes the authorization rule.
  • primaryConnectionString string: Primary connection string of the created namespace authorization rule.
  • primaryKey string: A base64-encoded 256-bit primary key for signing and validating the SAS token.
  • secondaryConnectionString string: Secondary connection string of the created namespace authorization rule.
  • secondaryKey string: A base64-encoded 256-bit primary key for signing and validating the SAS token.

Action

• Action object: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
  • compatibilityLevel integer: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
  • requiresPreprocessing boolean: Value that indicates whether the rule action requires preprocessing.
  • sqlExpression string: SQL expression. e.g. MyProperty='ABC'

ArmDisasterRecovery

• ArmDisasterRecovery object: Single item in List or Get Alias(Disaster Recovery configuration) operation
  • properties object: Properties required to the Create Or Update Alias(Disaster Recovery configurations)
    • alternateName string: Primary/Secondary eventhub namespace name, which is part of GEO DR pairing
    • partnerNamespace string: ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing
    • pendingReplicationOperationsCount integer: Number of entities pending to be replicated.
    • provisioningState string (values: Accepted, Succeeded, Failed): Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'
    • role string (values: Primary, PrimaryNotReplicating, Secondary): role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'
  • id string: Resource Id
  • name string: Resource name
  • type string: Resource type

ArmDisasterRecoveryListResult

• ArmDisasterRecoveryListResult object: The result of the List Alias(Disaster Recovery configuration) operation.
  • nextLink string: Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration)
  • value array: List of Alias(Disaster Recovery configurations)
    • items ArmDisasterRecovery

AuthorizationRuleProperties

• AuthorizationRuleProperties object: AuthorizationRule properties.
  • rights required array: The rights associated with the rule.
    • items string (values: Manage, Send, Listen)

CaptureDescription

• CaptureDescription object: Properties to configure capture description for eventhub
  • destination Destination
  • enabled boolean: A value that indicates whether capture description is enabled.
  • encoding string (values: Avro, AvroDeflate): Enumerates the possible values for the encoding format of capture description.
  • intervalInSeconds integer: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds
  • sizeLimitInBytes integer: The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 and 524288000 bytes

CheckNameAvailability

• CheckNameAvailability object: Description of a Check Name availability request properties.
  • name required string: The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number.

CheckNameAvailabilityResult

• CheckNameAvailabilityResult object: Description of a Check Name availability request properties.
  • message string: The detailed info regarding the reason associated with the namespace.
  • nameAvailable boolean: Value indicating namespace is availability, true if the namespace is available; otherwise, false.
  • reason UnavailableReason

CorrelationFilter

• CorrelationFilter object: Represents the correlation filter expression.
  • contentType string: Content type of the message.
  • correlationId string: Identifier of the correlation.
  • label string: Application specific label.
  • messageId string: Identifier of the message.
  • properties object: dictionary object for custom filters
  • replyTo string: Address of the queue to reply to.
  • replyToSessionId string: Session identifier to reply to.
  • requiresPreprocessing boolean: Value that indicates whether the rule action requires preprocessing.
  • sessionId string: Session identifier.
  • to string: Address to send to.

Destination

• Destination object: Capture storage details for capture description
  • name string: Name for capture destination
  • properties object: Properties describing the storage account, blob container and archive name format for capture destination
    • archiveNameFormat string: Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order
    • blobContainer string: Blob container Name
    • storageAccountResourceId string: Resource id of the storage account to be used to create the blobs

EntityStatus

• EntityStatus string (values: Active, Disabled, Restoring, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming, Unknown): Entity status.

ErrorResponse

• ErrorResponse object: Error response indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.
  • code string: Error code.
  • message string: Error message indicating why the operation failed.

EventHubListResult

• EventHubListResult object: The result of the List EventHubs operation.
  • nextLink string: Link to the next set of results. Not empty if Value contains incomplete list of EventHubs.
  • value array: Result of the List EventHubs operation.
    • items Eventhub

Eventhub

• Eventhub object: Single item in List or Get Event Hub operation
  • properties object: Properties supplied to the Create Or Update Event Hub operation.
    • captureDescription CaptureDescription
    • createdAt string: Exact time the Event Hub was created.
    • messageRetentionInDays integer: Number of days to retain the events for this Event Hub, value should be 1 to 7 days
    • partitionCount integer: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.
    • partitionIds array: Current number of shards on the Event Hub.
      • items string
    • status string (values: Active, Disabled, Restoring, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming, Unknown): Enumerates the possible values for the status of the Event Hub.
    • updatedAt string: The exact time the message was updated.
  • id string: Resource Id
  • name string: Resource name
  • type string: Resource type

FilterType

• FilterType string (values: SqlFilter, CorrelationFilter): Rule filter types

MessageCountDetails

• MessageCountDetails object: Message Count Details.
  • activeMessageCount integer: Number of active messages in the queue, topic, or subscription.
  • deadLetterMessageCount integer: Number of messages that are dead lettered.
  • scheduledMessageCount integer: Number of scheduled messages.
  • transferDeadLetterMessageCount integer: Number of messages transferred into dead letters.
  • transferMessageCount integer: Number of messages transferred to another queue, topic, or subscription.

MigrationConfigListResult

• MigrationConfigListResult object: The result of the List migrationConfigurations operation.
  • nextLink string: Link to the next set of results. Not empty if Value contains incomplete list of migrationConfigurations
  • value array: List of Migratio