EventHubs interface

Package:

@azure/arm-eventhub

Interface representing a EventHubs.

Methods

createOrUpdate(string, string, string, Eventhub, EventHubsCreateOrUpdateOptionalParams)	Creates or updates a new Event Hub as a nested resource within a Namespace.
createOrUpdateAuthorizationRule(string, string, string, string, AuthorizationRule, EventHubsCreateOrUpdateAuthorizationRuleOptionalParams)	Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.
delete(string, string, string, EventHubsDeleteOptionalParams)	Deletes an Event Hub from the specified Namespace and resource group.
deleteAuthorizationRule(string, string, string, string, EventHubsDeleteAuthorizationRuleOptionalParams)	Deletes an Event Hub AuthorizationRule.
get(string, string, string, EventHubsGetOptionalParams)	Gets an Event Hubs description for the specified Event Hub.
getAuthorizationRule(string, string, string, string, EventHubsGetAuthorizationRuleOptionalParams)	Gets an AuthorizationRule for an Event Hub by rule name.
listAuthorizationRules(string, string, string, EventHubsListAuthorizationRulesOptionalParams)	Gets the authorization rules for an Event Hub.
listByNamespace(string, string, EventHubsListByNamespaceOptionalParams)	Gets all the Event Hubs in a Namespace.
listKeys(string, string, string, string, EventHubsListKeysOptionalParams)	Gets the ACS and SAS connection strings for the Event Hub.
regenerateKeys(string, string, string, string, RegenerateAccessKeyParameters, EventHubsRegenerateKeysOptionalParams)	Regenerates the ACS and SAS connection strings for the Event Hub.

Method Details

createOrUpdate(string, string, string, Eventhub, EventHubsCreateOrUpdateOptionalParams)

Creates or updates a new Event Hub as a nested resource within a Namespace.

function createOrUpdate(resourceGroupName: string, namespaceName: string, eventHubName: string, parameters: Eventhub, options?: EventHubsCreateOrUpdateOptionalParams): Promise<Eventhub>

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

eventHubName

string

The Event Hub name

parameters

Eventhub

Parameters supplied to create an Event Hub resource.

options

EventHubsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Eventhub>

createOrUpdateAuthorizationRule(string, string, string, string, AuthorizationRule, EventHubsCreateOrUpdateAuthorizationRuleOptionalParams)

Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.

function createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, eventHubName: string, authorizationRuleName: string, parameters: AuthorizationRule, options?: EventHubsCreateOrUpdateAuthorizationRuleOptionalParams): Promise<AuthorizationRule>

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

eventHubName

string

The Event Hub name

authorizationRuleName

string

The authorization rule name.

parameters

AuthorizationRule

The shared access AuthorizationRule.

options

EventHubsCreateOrUpdateAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<AuthorizationRule>

delete(string, string, string, EventHubsDeleteOptionalParams)

Deletes an Event Hub from the specified Namespace and resource group.

function delete(resourceGroupName: string, namespaceName: string, eventHubName: string, options?: EventHubsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

eventHubName

string

The Event Hub name

options

EventHubsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

deleteAuthorizationRule(string, string, string, string, EventHubsDeleteAuthorizationRuleOptionalParams)

Deletes an Event Hub AuthorizationRule.

function deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, eventHubName: string, authorizationRuleName: string, options?: EventHubsDeleteAuthorizationRuleOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

eventHubName

string

The Event Hub name

authorizationRuleName

string

The authorization rule name.

options

EventHubsDeleteAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, EventHubsGetOptionalParams)

Gets an Event Hubs description for the specified Event Hub.

function get(resourceGroupName: string, namespaceName: string, eventHubName: string, options?: EventHubsGetOptionalParams): Promise<Eventhub>

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

eventHubName

string

The Event Hub name

options

EventHubsGetOptionalParams

The options parameters.

Returns

Promise<Eventhub>

getAuthorizationRule(string, string, string, string, EventHubsGetAuthorizationRuleOptionalParams)

Gets an AuthorizationRule for an Event Hub by rule name.

function getAuthorizationRule(resourceGroupName: string, namespaceName: string, eventHubName: string, authorizationRuleName: string, options?: EventHubsGetAuthorizationRuleOptionalParams): Promise<AuthorizationRule>

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

eventHubName

string

The Event Hub name

authorizationRuleName

string

The authorization rule name.

options

EventHubsGetAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<AuthorizationRule>

listAuthorizationRules(string, string, string, EventHubsListAuthorizationRulesOptionalParams)

Gets the authorization rules for an Event Hub.

function listAuthorizationRules(resourceGroupName: string, namespaceName: string, eventHubName: string, options?: EventHubsListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<AuthorizationRule, AuthorizationRule[], PageSettings>

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

eventHubName

string

The Event Hub name

options

EventHubsListAuthorizationRulesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AuthorizationRule, AuthorizationRule[], PageSettings>

listByNamespace(string, string, EventHubsListByNamespaceOptionalParams)

Gets all the Event Hubs in a Namespace.

function listByNamespace(resourceGroupName: string, namespaceName: string, options?: EventHubsListByNamespaceOptionalParams): PagedAsyncIterableIterator<Eventhub, Eventhub[], PageSettings>

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

options

EventHubsListByNamespaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Eventhub, Eventhub[], PageSettings>

listKeys(string, string, string, string, EventHubsListKeysOptionalParams)

Gets the ACS and SAS connection strings for the Event Hub.

function listKeys(resourceGroupName: string, namespaceName: string, eventHubName: string, authorizationRuleName: string, options?: EventHubsListKeysOptionalParams): Promise<AccessKeys>

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

eventHubName

string

The Event Hub name

authorizationRuleName

string

The authorization rule name.

options

EventHubsListKeysOptionalParams

The options parameters.

Returns

Promise<AccessKeys>

regenerateKeys(string, string, string, string, RegenerateAccessKeyParameters, EventHubsRegenerateKeysOptionalParams)

Regenerates the ACS and SAS connection strings for the Event Hub.

function regenerateKeys(resourceGroupName: string, namespaceName: string, eventHubName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options?: EventHubsRegenerateKeysOptionalParams): Promise<AccessKeys>

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

eventHubName

string

The Event Hub name

authorizationRuleName

string

The authorization rule name.

parameters

RegenerateAccessKeyParameters

Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey).

options

EventHubsRegenerateKeysOptionalParams

The options parameters.

Returns

Promise<AccessKeys>