@azure/arm-eventhub-profile-2020-09-01-hybrid package

Classes

EventHubManagementClient

Interfaces

AccessKeys

Namespace/EventHub Connection String

AuthorizationRule

Single item in a List or Get AuthorizationRule operation

AuthorizationRuleListResult

The response from the List namespace operation.

AvailableCluster

Pre-provisioned and readily available Event Hubs Cluster count per region.

AvailableClustersList

The response of the List Available Clusters operation.

CaptureDescription

Properties to configure capture description for eventhub

CheckNameAvailabilityParameter

Parameter supplied to check Namespace name availability operation

CheckNameAvailabilityResult

The Result of the CheckNameAvailability operation

Cluster

Single Event Hubs Cluster resource in List or Get operations.

ClusterListResult

The response of the List Event Hubs Clusters operation.

ClusterSku

SKU parameters particular to a cluster instance.

Clusters

Interface representing a Clusters.

ClustersCreateOrUpdateOptionalParams

Optional parameters.

ClustersDeleteOptionalParams

Optional parameters.

ClustersGetOptionalParams

Optional parameters.

ClustersListAvailableClusterRegionOptionalParams

Optional parameters.

ClustersListByResourceGroupNextOptionalParams

Optional parameters.

ClustersListByResourceGroupOptionalParams

Optional parameters.

ClustersListNamespacesOptionalParams

Optional parameters.

ClustersUpdateOptionalParams

Optional parameters.

ConnectionState

ConnectionState information.

ConsumerGroup

Single item in List or Get Consumer group operation

ConsumerGroupListResult

The result to the List Consumer Group operation.

ConsumerGroups

Interface representing a ConsumerGroups.

ConsumerGroupsCreateOrUpdateOptionalParams

Optional parameters.

ConsumerGroupsDeleteOptionalParams

Optional parameters.

ConsumerGroupsGetOptionalParams

Optional parameters.

ConsumerGroupsListByEventHubNextOptionalParams

Optional parameters.

ConsumerGroupsListByEventHubOptionalParams

Optional parameters.

Destination

Capture storage details for capture description

DisasterRecoveryConfigs

Interface representing a DisasterRecoveryConfigs.

DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams

Optional parameters.

DisasterRecoveryConfigsListAuthorizationRulesNextOptionalParams

Optional parameters.

DisasterRecoveryConfigsListAuthorizationRulesOptionalParams

Optional parameters.

DisasterRecoveryConfigsListKeysOptionalParams

Optional parameters.

EHNamespace

Single Namespace item in List or Get Operation

EHNamespaceIdContainer

The full ARM ID of an Event Hubs Namespace

EHNamespaceIdListResult

The response of the List Namespace IDs operation

EHNamespaceListResult

The response of the List Namespace operation

Encryption

Properties to configure Encryption

ErrorResponse

Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.

EventHubListResult

The result of the List EventHubs operation.

EventHubManagementClientOptionalParams

Optional parameters.

EventHubs

Interface representing a EventHubs.

EventHubsCreateOrUpdateAuthorizationRuleOptionalParams

Optional parameters.

EventHubsCreateOrUpdateOptionalParams

Optional parameters.

EventHubsDeleteAuthorizationRuleOptionalParams

Optional parameters.

EventHubsDeleteOptionalParams

Optional parameters.

EventHubsGetAuthorizationRuleOptionalParams

Optional parameters.

EventHubsGetOptionalParams

Optional parameters.

EventHubsListAuthorizationRulesNextOptionalParams

Optional parameters.

EventHubsListAuthorizationRulesOptionalParams

Optional parameters.

EventHubsListByNamespaceNextOptionalParams

Optional parameters.

EventHubsListByNamespaceOptionalParams

Optional parameters.

EventHubsListKeysOptionalParams

Optional parameters.

EventHubsRegenerateKeysOptionalParams

Optional parameters.

Eventhub

Single item in List or Get Event Hub operation

Identity

Properties to configure Identity for Bring your Own Keys

KeyVaultProperties

Properties to configure keyVault Properties

MessagingRegions

Messaging Region

MessagingRegionsListResult

The response of the List MessagingRegions operation.

MessagingRegionsProperties

Properties of Messaging Region

Namespaces

Interface representing a Namespaces.

NamespacesCheckNameAvailabilityOptionalParams

Optional parameters.

NamespacesCreateOrUpdateAuthorizationRuleOptionalParams

Optional parameters.

NamespacesCreateOrUpdateOptionalParams

Optional parameters.

NamespacesDeleteAuthorizationRuleOptionalParams

Optional parameters.

NamespacesDeleteOptionalParams

Optional parameters.

NamespacesGetAuthorizationRuleOptionalParams

Optional parameters.

NamespacesGetOptionalParams

Optional parameters.

NamespacesListAuthorizationRulesNextOptionalParams

Optional parameters.

NamespacesListAuthorizationRulesOptionalParams

Optional parameters.

NamespacesListByResourceGroupNextOptionalParams

Optional parameters.

NamespacesListByResourceGroupOptionalParams

Optional parameters.

NamespacesListKeysOptionalParams

Optional parameters.

NamespacesListNextOptionalParams

Optional parameters.

NamespacesListOptionalParams

Optional parameters.

NamespacesRegenerateKeysOptionalParams

Optional parameters.

NamespacesUpdateOptionalParams

Optional parameters.

Operation

A Event Hub REST API operation

OperationDisplay

The object that represents the operation.

OperationListResult

Result of the request to list Event Hub operations. It contains a list of operations and a URL link to get the next set of results.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

PrivateEndpoint

PrivateEndpoint information.

PrivateEndpointConnection

Properties of the PrivateEndpointConnection.

PrivateEndpointConnectionListResult

Result of the list of all private endpoint connections operation.

PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListNextOptionalParams

Optional parameters.

PrivateEndpointConnectionsListOptionalParams

Optional parameters.

PrivateLinkResource

Information of the private link resource.

PrivateLinkResources

Interface representing a PrivateLinkResources.

PrivateLinkResourcesGetOptionalParams

Optional parameters.

PrivateLinkResourcesListResult

Result of the List private link resources operation.

RegenerateAccessKeyParameters

Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset.

Regions

Interface representing a Regions.

RegionsListBySkuNextOptionalParams

Optional parameters.

RegionsListBySkuOptionalParams

Optional parameters.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

Sku

SKU parameters supplied to the create namespace operation

TrackedResource

Definition of resource.

Type Aliases

AccessRights

Defines values for AccessRights.
KnownAccessRights can be used interchangeably with AccessRights, this enum contains the known values that the service supports.

Known values supported by the service

Manage
Send
Listen

ClusterSkuName

Defines values for ClusterSkuName.
KnownClusterSkuName can be used interchangeably with ClusterSkuName, this enum contains the known values that the service supports.

Known values supported by the service

Dedicated

ClustersCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ClustersGetResponse

Contains response data for the get operation.

ClustersListAvailableClusterRegionResponse

Contains response data for the listAvailableClusterRegion operation.

ClustersListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

ClustersListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ClustersListNamespacesResponse

Contains response data for the listNamespaces operation.

ClustersUpdateResponse

Contains response data for the update operation.

ConsumerGroupsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ConsumerGroupsGetResponse

Contains response data for the get operation.

ConsumerGroupsListByEventHubNextResponse

Contains response data for the listByEventHubNext operation.

ConsumerGroupsListByEventHubResponse

Contains response data for the listByEventHub operation.

DisasterRecoveryConfigsGetAuthorizationRuleResponse

Contains response data for the getAuthorizationRule operation.

DisasterRecoveryConfigsListAuthorizationRulesNextResponse

Contains response data for the listAuthorizationRulesNext operation.

DisasterRecoveryConfigsListAuthorizationRulesResponse

Contains response data for the listAuthorizationRules operation.

DisasterRecoveryConfigsListKeysResponse

Contains response data for the listKeys operation.

EncodingCaptureDescription

Defines values for EncodingCaptureDescription.

EndPointProvisioningState

Defines values for EndPointProvisioningState.
KnownEndPointProvisioningState can be used interchangeably with EndPointProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating
Updating
Deleting
Succeeded
Canceled
Failed

EntityStatus

Defines values for EntityStatus.

EventHubsCreateOrUpdateAuthorizationRuleResponse

Contains response data for the createOrUpdateAuthorizationRule operation.

EventHubsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

EventHubsGetAuthorizationRuleResponse

Contains response data for the getAuthorizationRule operation.

EventHubsGetResponse

Contains response data for the get operation.

EventHubsListAuthorizationRulesNextResponse

Contains response data for the listAuthorizationRulesNext operation.

EventHubsListAuthorizationRulesResponse

Contains response data for the listAuthorizationRules operation.

EventHubsListByNamespaceNextResponse

Contains response data for the listByNamespaceNext operation.

EventHubsListByNamespaceResponse

Contains response data for the listByNamespace operation.

EventHubsListKeysResponse

Contains response data for the listKeys operation.

EventHubsRegenerateKeysResponse

Contains response data for the regenerateKeys operation.

KeyType

Defines values for KeyType.

NamespacesCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

NamespacesCreateOrUpdateAuthorizationRuleResponse

Contains response data for the createOrUpdateAuthorizationRule operation.

NamespacesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

NamespacesGetAuthorizationRuleResponse

Contains response data for the getAuthorizationRule operation.

NamespacesGetResponse

Contains response data for the get operation.

NamespacesListAuthorizationRulesNextResponse

Contains response data for the listAuthorizationRulesNext operation.

NamespacesListAuthorizationRulesResponse

Contains response data for the listAuthorizationRules operation.

NamespacesListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

NamespacesListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

NamespacesListKeysResponse

Contains response data for the listKeys operation.

NamespacesListNextResponse

Contains response data for the listNext operation.

NamespacesListResponse

Contains response data for the list operation.

NamespacesRegenerateKeysResponse

Contains response data for the regenerateKeys operation.

NamespacesUpdateResponse

Contains response data for the update operation.

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

PrivateEndpointConnectionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PrivateEndpointConnectionsGetResponse

Contains response data for the get operation.

PrivateEndpointConnectionsListNextResponse

Contains response data for the listNext operation.

PrivateEndpointConnectionsListResponse

Contains response data for the list operation.

PrivateLinkConnectionStatus

Defines values for PrivateLinkConnectionStatus.
KnownPrivateLinkConnectionStatus can be used interchangeably with PrivateLinkConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected
Disconnected

PrivateLinkResourcesGetResponse

Contains response data for the get operation.

RegionsListBySkuNextResponse

Contains response data for the listBySkuNext operation.

RegionsListBySkuResponse

Contains response data for the listBySku operation.

SkuName

Defines values for SkuName.
KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports.

Known values supported by the service

Basic
Standard

SkuTier

Defines values for SkuTier.
KnownSkuTier can be used interchangeably with SkuTier, this enum contains the known values that the service supports.

Known values supported by the service

Basic
Standard

UnavailableReason

Defines values for UnavailableReason.

Enums

KnownAccessRights

Known values of AccessRights that the service accepts.

KnownClusterSkuName

Known values of ClusterSkuName that the service accepts.

KnownEndPointProvisioningState

Known values of EndPointProvisioningState that the service accepts.

KnownPrivateLinkConnectionStatus

Known values of PrivateLinkConnectionStatus that the service accepts.

KnownSkuName

Known values of SkuName that the service accepts.

KnownSkuTier

Known values of SkuTier that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.