@azure/arm-eventhub package

類別

EventHubManagementClient

介面

AccessKeys	Namespace/EventHub 連接字串
ApplicationGroup	應用程式群組物件
ApplicationGroupOperationsCreateOrUpdateApplicationGroupOptionalParams	選擇性參數。
ApplicationGroupOperationsDeleteOptionalParams	選擇性參數。
ApplicationGroupOperationsGetOptionalParams	選擇性參數。
ApplicationGroupOperationsListByNamespaceOptionalParams	選擇性參數。
ApplicationGroupOperationsOperations	介面代表 ApplicationGroupOperations 操作。
ApplicationGroupPolicy	應用程式組策略的屬性
ApplicationGroupProperties	model interface ApplicationGroupProperties
ArmDisasterRecovery	清單或取得別名中的單一專案（災害復原組態） 作業
ArmDisasterRecoveryProperties	建立或更新別名所需的屬性（災害復原組態）
AuthorizationRule	List 或 Get AuthorizationRule 作業中的單一專案
AuthorizationRuleProperties	提供用來建立或更新 AuthorizationRule 的屬性
AvailableCluster	每個區域預先布建且隨時可用的事件中樞叢集計數。
AvailableClustersList	列出可用叢集作業的回應。
CaptureDescription	設定 eventhub 擷取描述的屬性
CaptureIdentity	值，指出是否啟用擷取描述。
CheckNameAvailabilityParameter	提供的參數以檢查命名空間名稱可用性作業
CheckNameAvailabilityResult	CheckNameAvailability 作業的結果
Cluster	清單或取得作業中的單一事件中樞叢集資源。
ClusterProperties	清單或取得作業中回應中提供的事件中樞叢集屬性。
ClusterQuotaConfigurationProperties	包含叢集的所有設定。
ClusterSku	叢集實例特有的SKU參數。
ClustersCreateOrUpdateOptionalParams	選擇性參數。
ClustersDeleteOptionalParams	選擇性參數。
ClustersGetOptionalParams	選擇性參數。
ClustersListAvailableClusterRegionOptionalParams	選擇性參數。
ClustersListByResourceGroupOptionalParams	選擇性參數。
ClustersListBySubscriptionOptionalParams	選擇性參數。
ClustersListNamespacesOptionalParams	選擇性參數。
ClustersOperations	表示 Clusters 作的介面。
ClustersUpdateOptionalParams	選擇性參數。
ConfidentialCompute	模型介面 ConfidentialCompute
ConfigurationGetOptionalParams	選擇性參數。
ConfigurationOperations	介面代表組態操作。
ConfigurationPatchOptionalParams	選擇性參數。
ConnectionState	ConnectionState 資訊。
ConsumerGroup	清單或取得取用者群組作業中的單一專案
ConsumerGroupProperties	清單或取得取用者群組作業中的單一專案
ConsumerGroupsCreateOrUpdateOptionalParams	選擇性參數。
ConsumerGroupsDeleteOptionalParams	選擇性參數。
ConsumerGroupsGetOptionalParams	選擇性參數。
ConsumerGroupsListByEventHubOptionalParams	選擇性參數。
ConsumerGroupsOperations	介面代表 ConsumerGroups 作業。
Destination	擷取描述的擷取記憶體詳細
DestinationProperties	描述擷取目的地之記憶體帳戶、Blob 容器和封存名稱格式的屬性
DisasterRecoveryConfigsBreakPairingOptionalParams	選擇性參數。
DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams	選擇性參數。
DisasterRecoveryConfigsCreateOrUpdateOptionalParams	選擇性參數。
DisasterRecoveryConfigsDeleteOptionalParams	選擇性參數。
DisasterRecoveryConfigsFailOverOptionalParams	選擇性參數。
DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams	選擇性參數。
DisasterRecoveryConfigsGetOptionalParams	選擇性參數。
DisasterRecoveryConfigsListAuthorizationRulesOptionalParams	選擇性參數。
DisasterRecoveryConfigsListKeysOptionalParams	選擇性參數。
DisasterRecoveryConfigsListOptionalParams	選擇性參數。
DisasterRecoveryConfigsOperations	介面代表災難復原配置（DisasterRecoveryConfigs）操作。
EHNamespace	清單或取得作業中的單一命名空間專案
EHNamespaceIdContainer	事件中樞命名空間的完整ARM標識碼
EHNamespaceIdListResult	清單命名空間標識子作業的回應
EHNamespaceProperties	Namespace為建立命名空間作業提供的屬性。
Encryption	設定加密的屬性
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應指出事件中樞服務無法處理傳入要求。 錯誤訊息中會提供原因。
EventHubManagementClientOptionalParams	用戶端的選擇性參數。
EventHubsCreateOrUpdateAuthorizationRuleOptionalParams	選擇性參數。
EventHubsCreateOrUpdateOptionalParams	選擇性參數。
EventHubsDeleteAuthorizationRuleOptionalParams	選擇性參數。
EventHubsDeleteOptionalParams	選擇性參數。
EventHubsGetAuthorizationRuleOptionalParams	選擇性參數。
EventHubsGetOptionalParams	選擇性參數。
EventHubsListAuthorizationRulesOptionalParams	選擇性參數。
EventHubsListByNamespaceOptionalParams	選擇性參數。
EventHubsListKeysOptionalParams	選擇性參數。
EventHubsOperations	介面代表 EventHubs 操作。
EventHubsRegenerateKeysOptionalParams	選擇性參數。
Eventhub	清單或取得事件中樞作業中的單一專案
EventhubProperties	提供給建立或更新事件中樞作業的屬性。
FailOver	模型介面故障轉移
FailOverProperties	model interface FailOverProperties
GeoDataReplicationProperties	GeoDR 複寫屬性
Identity	設定攜帶您自己的金鑰身分識別的屬性
KeyVaultProperties	設定keyVault屬性的屬性
MessageTimestampDescription	MessageTimestamp 描述的屬性
NWRuleSetIpRules	List 命名空間作業的回應。
NWRuleSetVirtualNetworkRules	List 命名空間作業的回應。
NamespaceReplicaLocation	命名空間複寫屬性
NamespacesCheckNameAvailabilityOptionalParams	選擇性參數。
NamespacesCreateOrUpdateAuthorizationRuleOptionalParams	選擇性參數。
NamespacesCreateOrUpdateNetworkRuleSetOptionalParams	選擇性參數。
NamespacesCreateOrUpdateOptionalParams	選擇性參數。
NamespacesDeleteAuthorizationRuleOptionalParams	選擇性參數。
NamespacesDeleteOptionalParams	選擇性參數。
NamespacesFailoverOptionalParams	選擇性參數。
NamespacesGetAuthorizationRuleOptionalParams	選擇性參數。
NamespacesGetNetworkRuleSetOptionalParams	選擇性參數。
NamespacesGetOptionalParams	選擇性參數。
NamespacesListAuthorizationRulesOptionalParams	選擇性參數。
NamespacesListByResourceGroupOptionalParams	選擇性參數。
NamespacesListKeysOptionalParams	選擇性參數。
NamespacesListNetworkRuleSetOptionalParams	選擇性參數。
NamespacesListOptionalParams	選擇性參數。
NamespacesOperations	代表命名空間作業的介面。
NamespacesRegenerateKeysOptionalParams	選擇性參數。
NamespacesUpdateOptionalParams	選擇性參數。
NetworkRuleSet	主題資源的描述。
NetworkRuleSetListResult	NetworkRuleSet 專案的分頁集合
NetworkRuleSetProperties	NetworkRuleSet 屬性
NetworkSecurityPerimeter	NetworkSecurityPerimeter 相關信息
NetworkSecurityPerimeterConfiguration	指定命名空間的網路安全性周邊相關組態
NetworkSecurityPerimeterConfigurationList	List NetworkSecurityPerimeterConfiguration 作業的結果。
NetworkSecurityPerimeterConfigurationOperationsListOptionalParams	選擇性參數。
NetworkSecurityPerimeterConfigurationOperationsOperations	介面代表網路安全周邊配置操作。
NetworkSecurityPerimeterConfigurationProperties	NetworkSecurityPerimeterConfiguration 的特性
NetworkSecurityPerimeterConfigurationPropertiesProfile	目前網路配置文件的相關信息
NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation	資源關聯的相關信息
NetworkSecurityPerimeterConfigurationsCreateOrUpdateOptionalParams	選擇性參數。
NetworkSecurityPerimeterConfigurationsGetResourceAssociationNameOptionalParams	選擇性參數。
NetworkSecurityPerimeterConfigurationsOperations	介面代表 NetworkSecurityPerimeterConfigurations 操作。
NspAccessRule	網路配置檔中的存取規則資訊
NspAccessRuleProperties	存取規則的屬性
NspAccessRulePropertiesSubscriptionsItem	輸入規則的訂用帳戶
Operation	事件中樞 REST API 作業
OperationDisplay	作業顯示承載
OperationsListOptionalParams	選擇性參數。
OperationsOperations	表示作業作業的介面。
PageSettings	byPage 方法的選項
PagedAsyncIterableIterator	介面，可讓異步反覆運算同時完成和逐頁執行。
PlatformCapabilities	模型介面平台功能
PrivateEndpoint	PrivateEndpoint 資訊。
PrivateEndpointConnection	PrivateEndpointConnection 的屬性。
PrivateEndpointConnectionProperties	私有端點連線資源的屬性。
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	選擇性參數。
PrivateEndpointConnectionsDeleteOptionalParams	選擇性參數。
PrivateEndpointConnectionsGetOptionalParams	選擇性參數。
PrivateEndpointConnectionsListOptionalParams	選擇性參數。
PrivateEndpointConnectionsOperations	代表 PrivateEndpointConnections 作業的介面。
PrivateLinkResource	私人鏈接資源的資訊。
PrivateLinkResourceProperties	PrivateLinkResource 的屬性
PrivateLinkResourcesGetOptionalParams	選擇性參數。
PrivateLinkResourcesListResult	PrivateLinkResource 專案的分頁集合
PrivateLinkResourcesOperations	代表 PrivateLinkResources 作業的介面。
ProvisioningIssue	說明給定 NetworkSecurityPerimeterConfiguration 的布建問題
ProvisioningIssueProperties	布建問題的屬性
ProxyResource	Azure Resource Manager Proxy 資源的資源模型定義。 它不會有標記和位置
RegenerateAccessKeyParameters	提供給重新產生授權規則作業的參數，指定需要重設哪些密鑰。
Resource	回應中針對所有 Azure Resource Manager 資源傳回的常見欄位
RestorePollerOptions
RetentionDescription	設定 eventhub 保留設定的屬性
SchemaGroup	清單或取得架構群組作業中的單一專案
SchemaGroupProperties	模型介面 SchemaGroupProperties
SchemaRegistryCreateOrUpdateOptionalParams	選擇性參數。
SchemaRegistryDeleteOptionalParams	選擇性參數。
SchemaRegistryGetOptionalParams	選擇性參數。
SchemaRegistryListByNamespaceOptionalParams	選擇性參數。
SchemaRegistryOperations	介面代表 SchemaRegistry 操作。
SimplePollerLike	簡單的輪詢器，可用來輪詢長時間執行的作業。
Sku	提供給建立命名空間作業的 SKU 參數
Subnet	針對子網提供的屬性
SystemData	與建立和上次修改資源相關的元數據。
ThrottlingPolicy	節流原則的屬性
UserAssignedIdentity	辨識的字典值。
UserAssignedIdentityProperties	model interface UserAssignedIdentityProperties

類型別名

AccessRights	存取權限類型
ApplicationGroupPolicyType	應用程式群組政策類型 KnownApplicationGroupPolicyType 可以與 ApplicationGroupPolicyType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 ThrottlingPolicy
ApplicationGroupPolicyUnion	ApplicationGroupPolicyUnion 的別名
AzureSupportedClouds	雲端設定為字串常值類型的支援值
CaptureIdentityType	Azure Active Directory 受控識別的類型。
CleanupPolicyRetentionDescription	列舉清理政策可能的數值 KnownCleanupPolicyRetentionDescription 可以與 CleanupPolicyRetentionDescription 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 刪除 Compact DeleteOrCompact
ClusterSkuName	此 SKU 的名稱。 KnownClusterSkuName 可以與 ClusterSkuName 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 專用
ContinuablePage	描述結果頁面的介面。
CreatedByType	建立資源的實體種類。 KnownCreatedByType 可以與 CreatedByType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 使用者：實體是由使用者建立的。 應用程式：實體是由應用程式所建立。 ManagedIdentity：實體是由受控識別所建立。 金鑰：實體是由金鑰所建立。
DefaultAction	網路規則集的預設動作 KnownDefaultAction 可以與 DefaultAction 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 允許 拒絕
EncodingCaptureDescription	列舉擷取描述編碼格式的可能值。 注意：新 API 版本中將會淘汰 'AvroDeflate'
EndPointProvisioningState	私人端點聯機的布建狀態。 KnownEndPointProvisioningState 可以與 EndPointProvisioningState 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 建立 更新 刪除 成功 已取消 失敗
EntityStatus	列舉事件中樞狀態的可能值。
GeoDRRoleType	GeoDR 角色類型 KnownGeoDRRoleType 可與 GeoDRRoleType 互換使用，此枚舉包含服務所支援的已知值。 服務支援的已知值 Primary 次級
KeyType	要重新產生的存取金鑰。 KnownKeyType 可以與 KeyType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 PrimaryKey SecondaryKey
ManagedServiceIdentityType	受控服務識別的類型。
MetricId	節流限制應該設定的 Metric Id，可以在 Azure 入口網站 事件中心命名空間的 Metrics 區塊中將滑鼠移到「Metric」上方來發現 KnownMetricId 可以與 MetricId 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 incomingBytes OutgoingBytes IncomingMessages OutgoingMessages
Mode	啟用或停用機密運算的設定 KnownMode 可以與 Mode 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 停用 已啟用
NetworkRuleIPAction	IP 過濾動作 KnownNetworkRuleIPAction 可以與 NetworkRuleIPAction 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 允許
NetworkSecurityPerimeterConfigurationProvisioningState	NetworkSecurityPerimeter 配置傳播的配置狀態 KnownNetworkSecurityPerimeterConfigurationProvisioningState 可以與 NetworkSecurityPerimeterConfigurationProvisioningState 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 未知 建立 更新 已接受 InvalidResponse 成功 SucceededWithIssues 失敗 刪除 已刪除 已取消
NspAccessRuleDirection	存取方向規則 KnownNspAccessRuleDirection 可以與 NspAccessRuleDirection 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 輸入 輸出
PrivateLinkConnectionStatus	線上的狀態。 KnownPrivateLinkConnectionStatus 可以與 PrivateLinkConnectionStatus 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 暫止 已核准 拒絕 已中斷連線
ProvisioningState	叢集的布建狀態。 KnownProvisioningState 可以與 ProvisioningState 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 未知 建立 刪除 調整 Active 失敗 成功 已取消
ProvisioningStateDR	別名的布建狀態（災害復原設定） - 可能的值 'Accepted' 或 'Succeeded' 或 'Failed'
PublicNetworkAccess	這會判斷是否允許透過公用網路傳輸流量。 默認會啟用。 KnownPublicNetworkAccess 可以與 PublicNetworkAccess 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 已啟用 停用 SecuredByPerimeter
PublicNetworkAccessFlag	這會判斷是否允許透過公用網路傳輸流量。 默認會啟用。 如果值為 SecuredByPerimeter，則輸入和輸出通訊是由網路安全性周邊和配置檔的存取規則所控制。 KnownPublicNetworkAccessFlag 可以與 PublicNetworkAccessFlag 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 已啟用 停用 SecuredByPerimeter
ResourceAssociationAccessMode	資源關聯的存取模式 KnownResourceAssociationAccessMode 可以與 ResourceAssociationAccessMode 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 NoAssociationMode EnforcedMode LearningMode AuditMode UnspecifiedMode
RoleDisasterRecovery	GEO DR 中命名空間的角色 - 可能的值 'Primary' 或 'PrimaryNotReplicating' 或 'Secondary'
SchemaCompatibility	結構相容性類型
SchemaType	模式類型
SkuName	此 SKU 的名稱。 KnownSkuName 可以與 SkuName 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 基本 Standard Premium
SkuTier	這個特定 SKU 的計費層。 KnownSkuTier 可以與 SkuTier 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 基本 Standard Premium
TimestampType	表示訊息將保留的時間戳類型。兩種類型的時間戳類型 - “AppendTime” 和 “CreateTime”。 AppendTime 是指訊息在訊息代理程式記錄檔內附加的時間。 CreateTime 是指在來源端產生訊息的時間，而產生者可以在傳送訊息時設定此時間戳。 預設值為 AppendTime。 如果您使用AMQP通訊協定，CreateTime等於AppendTime，其行為會維持不變。 KnownTimestampType 可以與 TimestampType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 LogAppend 創造
TlsVersion	叢集支援的最低 TLS 版本，例如 '1.2' KnownTlsVersion 可以與 TlsVersion 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 1.0 1.1 1.2 1.3
UnavailableReason	指定服務無法使用的原因。

列舉

AzureClouds	一個用來描述 Azure Cloud 環境的 enum。
KnownAccessRights	AccessRights 服務的已知值。
KnownApplicationGroupPolicyType	應用程式組策略類型
KnownCleanupPolicyRetentionDescription	列舉清除原則的可能值
KnownClusterSkuName	此 SKU 的名稱。
KnownCreatedByType	建立資源的實體種類。
KnownDefaultAction	網路規則集的預設動作
KnownEndPointProvisioningState	私人端點聯機的布建狀態。
KnownGeoDRRoleType	GeoDR 角色類型
KnownKeyType	要重新產生的存取金鑰。
KnownMetricId	節流限制應該設定的 Metric Id，可以在 Azure 入口網站 事件中心命名空間的 Metrics 區塊中將滑鼠移到「Metric」上方來發現
KnownMode	啟用或禁用機密計算的設置
KnownNetworkRuleIPAction	IP 篩選動作
KnownNetworkSecurityPerimeterConfigurationProvisioningState	布建 NetworkSecurityPerimeter 組態傳播的狀態
KnownNspAccessRuleDirection	存取規則的方向
KnownPrivateLinkConnectionStatus	線上的狀態。
KnownProvisioningState	叢集的布建狀態。
KnownPublicNetworkAccess	這會判斷是否允許透過公用網路傳輸流量。 默認會啟用。
KnownPublicNetworkAccessFlag	這會判斷是否允許透過公用網路傳輸流量。 默認會啟用。 如果值為 SecuredByPerimeter，則輸入和輸出通訊是由網路安全性周邊和配置檔的存取規則所控制。
KnownResourceAssociationAccessMode	資源關聯的存取模式
KnownSchemaCompatibility	服務接受的已知 SchemaCompatibility 值。
KnownSchemaType	服務接受的 SchemaType 已知值。
KnownSkuName	此 SKU 的名稱。
KnownSkuTier	這個特定 SKU 的計費層。
KnownTimestampType	表示訊息將保留的時間戳類型。兩種類型的時間戳類型 - “AppendTime” 和 “CreateTime”。 AppendTime 是指訊息在訊息代理程式記錄檔內附加的時間。 CreateTime 是指在來源端產生訊息的時間，而產生者可以在傳送訊息時設定此時間戳。 預設值為 AppendTime。 如果您使用AMQP通訊協定，CreateTime等於AppendTime，其行為會維持不變。
KnownTlsVersion	叢集支援的最低 TLS 版本，例如 '1.2'
KnownVersions	可用的 API 版本。

函式

isRestError(unknown)	RestError 的 Typeguard
restorePoller<TResponse, TResult>(EventHubManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	從另一個輪詢程式的串行化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器，或在原始輪詢器不在範圍內之後建構投票器時，這非常有用。

變數

RestError

失敗管線要求的自定義錯誤類型。

函式詳細資料

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e is RestError

參數

e

unknown

catch 子句攔截到的東西。

傳回

e is RestError

restorePoller<TResponse, TResult>(EventHubManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

從另一個輪詢程式的串行化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器，或在原始輪詢器不在範圍內之後建構投票器時，這非常有用。

function restorePoller<TResponse, TResult>(client: EventHubManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

參數

client

EventHubManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

傳回

PollerLike<OperationState<TResult>, TResult>

變數詳細資料

RestError

失敗管線要求的自定義錯誤類型。

RestError: RestErrorConstructor

類型

RestErrorConstructor