@azure/arm-eventhub package
インターフェイス
型エイリアス
| AccessRights |
アクセス権の種類 |
| ApplicationGroupPolicyType |
アプリケーショングループポリシータイプ サービスでサポートされている既知の値ThrottlingPolicy |
| ApplicationGroupPolicyUnion |
ApplicationGroupPolicyUnion の別名 |
| AzureSupportedClouds |
文字列リテラル型としてのクラウド設定でサポートされている値 |
| CaptureIdentityType |
Azure Active Directoryマネージド ID の種類。 |
| CleanupPolicyRetentionDescription |
清掃政策の可能な値を列挙します サービスでサポートされている既知の値
削除 |
| ClusterSkuName |
この SKU の名前。 サービスでサポートされている既知の値専用 |
| ContinuablePage |
結果のページを記述するインターフェイス。 |
| CreatedByType |
リソースを作成したエンティティの種類。 サービスでサポートされている既知の値
ユーザー: エンティティはユーザーによって作成されました。 |
| DefaultAction |
ネットワークルールセットのデフォルトアクション サービスでサポートされている既知の値
許可 |
| EncodingCaptureDescription |
キャプチャの説明のエンコード形式に使用できる値を列挙します。 注: 'AvroDeflate' は新しい API バージョンで非推奨になります |
| EndPointProvisioningState |
プライベート エンドポイント接続のプロビジョニング状態。 サービスでサポートされている既知の値
の作成 |
| EntityStatus |
イベント ハブの状態に使用できる値を列挙します。 |
| GeoDRRoleType |
GeoDRの役割タイプ サービスでサポートされている既知の値
プライマリ |
| KeyType |
再生成するアクセス キー。 サービスでサポートされている既知の値
PrimaryKey |
| ManagedServiceIdentityType |
マネージド サービス ID の種類。 |
| MetricId |
スロットルリミットを設定するべきメトリックID。MetricIDはAzure portal内のEvent Hub NamespaceのMetricセクションでMetricにカーソルを合わせると見つけられます サービスでサポートされている既知の値
IncomingBytes |
| Mode |
機密計算を有効または無効にする設定 サービスでサポートされている既知の値
Disabled |
| NetworkRuleIPAction |
IPフィルターアクション サービスでサポートされている既知の値許可 |
| NetworkSecurityPerimeterConfigurationProvisioningState |
NetworkSecurityPerimeter構成伝播のプロビジョニング状態 サービスでサポートされている既知の値
不明な |
| NspAccessRuleDirection |
アクセスの方向規則 サービスでサポートされている既知の値受信 を する |
| PrivateLinkConnectionStatus |
接続の状態。 サービスでサポートされている既知の値保留中の の |
| ProvisioningState |
クラスターのプロビジョニング状態。 サービスでサポートされている既知の値
不明な |
| ProvisioningStateDR |
Alias (ディザスター リカバリー構成) のプロビジョニング状態 - 使用可能な値は "Accepted" または "Succeeded" または "Failed" です |
| PublicNetworkAccess |
これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 サービスでサポートされている既知の値
Enabled |
| PublicNetworkAccessFlag |
これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 値が SecuredByPerimeter の場合、受信と送信の通信は、ネットワーク セキュリティ境界とプロファイルのアクセス規則によって制御されます。 サービスでサポートされている既知の値
Enabled |
| ResourceAssociationAccessMode |
リソースアソシエーションのアクセスモード サービスでサポートされている既知の値
NoAssociationMode |
| RoleDisasterRecovery |
GEO DR の名前空間のロール - 使用可能な値 'Primary' または 'PrimaryNotReplicating' または 'Secondary' |
| SchemaCompatibility |
スキーマ互換性の種類 |
| SchemaType |
スキーマタイプのタイプ |
| SkuName |
この SKU の名前。 サービスでサポートされている既知の値
Basic |
| SkuTier |
この特定の SKU の課金レベル。 サービスでサポートされている既知の値
Basic |
| TimestampType |
メッセージが保持するタイムスタンプの種類を示します。タイムスタンプ型は、"AppendTime" と "CreateTime" の 2 種類です。 AppendTime は、メッセージがブローカー ログ内に追加された時刻を指します。 CreateTime は、メッセージがソース側で生成された時刻を指し、プロデューサーはメッセージの送信中にこのタイムスタンプを設定できます。 既定値は AppendTime です。 AMQP プロトコルを使用している場合、CreateTime は AppendTime と等しく、動作は変わりません。 サービスでサポートされている既知の値LogAppend を する |
| TlsVersion |
クラスタがサポートすべき最低TLSバージョン(例:'1.2') サービスでサポートされている既知の値
1.0 |
| UnavailableReason |
サービスが使用できない理由を指定します。 |
列挙型
| AzureClouds |
Azure Cloud 環境を説明するための列挙式です。 |
| KnownAccessRights | |
| KnownApplicationGroupPolicyType |
アプリケーション グループ ポリシーの種類 |
| KnownCleanupPolicyRetentionDescription |
クリーンアップ ポリシーで使用可能な値を列挙します。 |
| KnownClusterSkuName |
この SKU の名前。 |
| KnownCreatedByType |
リソースを作成したエンティティの種類。 |
| KnownDefaultAction |
ネットワーク ルール セットの既定のアクション |
| KnownEndPointProvisioningState |
プライベート エンドポイント接続のプロビジョニング状態。 |
| KnownGeoDRRoleType |
GeoDR ロールの種類 |
| KnownKeyType |
再生成するアクセス キー。 |
| KnownMetricId |
スロットル制限を設定する必要があるメトリック ID。MetricId は、Azure portal内の Event Hub 名前空間の [メトリック] セクションでメトリックにカーソルを合わせることで検出できます。 |
| KnownMode |
Confidential Computeを有効または無効にする設定 |
| KnownNetworkRuleIPAction |
IP フィルター アクション |
| KnownNetworkSecurityPerimeterConfigurationProvisioningState |
NetworkSecurityPerimeter 構成伝達のプロビジョニング状態 |
| KnownNspAccessRuleDirection |
アクセスルールの方向 |
| KnownPrivateLinkConnectionStatus |
接続の状態。 |
| KnownProvisioningState |
クラスターのプロビジョニング状態。 |
| KnownPublicNetworkAccess |
これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 |
| KnownPublicNetworkAccessFlag |
これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 値が SecuredByPerimeter の場合、受信と送信の通信は、ネットワーク セキュリティ境界とプロファイルのアクセス規則によって制御されます。 |
| KnownResourceAssociationAccessMode |
リソース関連付けのアクセス モード |
| KnownSchemaCompatibility | |
| KnownSchemaType | |
| KnownSkuName |
この SKU の名前。 |
| KnownSkuTier |
この特定の SKU の課金レベル。 |
| KnownTimestampType |
メッセージが保持するタイムスタンプの種類を示します。タイムスタンプ型は、"AppendTime" と "CreateTime" の 2 種類です。 AppendTime は、メッセージがブローカー ログ内に追加された時刻を指します。 CreateTime は、メッセージがソース側で生成された時刻を指し、プロデューサーはメッセージの送信中にこのタイムスタンプを設定できます。 既定値は AppendTime です。 AMQP プロトコルを使用している場合、CreateTime は AppendTime と等しく、動作は変わりません。 |
| KnownTlsVersion |
サポートするクラスターの最小 TLS バージョン (例: '1.2') |
| KnownVersions |
使用可能な API バージョン。 |
関数
| is |
RestError の Typeguard |
| restore |
別のポーラーのシリアル化された状態からポーリングャーを作成します。 これは、別のホストに投票者を作成する場合や、元のホストがスコープ内にない後にポーリングャーを構築する必要がある場合に便利です。 |
変数
| Rest |
失敗したパイプライン要求のカスタム エラーの種類。 |
関数の詳細
isRestError(unknown)
RestError の Typeguard
function isRestError(e: unknown): eパラメーター
- e
-
unknown
catch 句によってキャッチされる何か。
返品
e
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>