EventHubsOperations interface

Package:

@azure/arm-eventhub

Interface representing a EventHubs operations.

Properties

createOrUpdate	Creates or updates a new Event Hub as a nested resource within a Namespace.
createOrUpdateAuthorizationRule	Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.
delete	Deletes an Event Hub from the specified Namespace and resource group.
deleteAuthorizationRule	Deletes an Event Hub AuthorizationRule.
get	Gets an Event Hubs description for the specified Event Hub.
getAuthorizationRule	Gets an AuthorizationRule for an Event Hub by rule name.
listAuthorizationRules	Gets the authorization rules for an Event Hub.
listByNamespace	Gets all the Event Hubs in a Namespace.
listKeys	Gets the ACS and SAS connection strings for the Event Hub.
regenerateKeys	Regenerates the ACS and SAS connection strings for the Event Hub.

Property Details

createOrUpdate

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

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

Property Value

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

createOrUpdateAuthorizationRule

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

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

Property Value

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

delete

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

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

Property Value

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

deleteAuthorizationRule

Deletes an Event Hub AuthorizationRule.

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

Property Value

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

get

Gets an Event Hubs description for the specified Event Hub.

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

Property Value

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

getAuthorizationRule

Gets an AuthorizationRule for an Event Hub by rule name.

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

Property Value

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

listAuthorizationRules

Gets the authorization rules for an Event Hub.

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

Property Value

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

listByNamespace

Gets all the Event Hubs in a Namespace.

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

Property Value

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

listKeys

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

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

Property Value

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

regenerateKeys

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

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

Property Value

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