Invoke-AzKustoDataConnectionValidation

モジュール:

Az.Kusto

データ接続パラメーターが有効であることを確認します。

構文

Invoke-AzKustoDataConnectionValidation
      -ClusterName <String>
      -DatabaseName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -Kind <Kind>
      -DataConnectionName <String>
      -ConsumerGroup <String>
      -Location <String>
      -EventHubResourceId <String>
      [-DataFormat <String>]
      [-EventSystemProperty <String[]>]
      [-MappingRuleName <String>]
      [-TableName <String>]
      [-Compression <Compression>]
      [-ManagedIdentityResourceId <String>]
      [-DatabaseRouting <DatabaseRouting>]
      [-RetrievalStartDate <DateTime>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzKustoDataConnectionValidation
      -ClusterName <String>
      -DatabaseName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -Kind <Kind>
      -DataConnectionName <String>
      -ConsumerGroup <String>
      -Location <String>
      -EventHubResourceId <String>
      [-DataFormat <String>]
      [-MappingRuleName <String>]
      [-TableName <String>]
      [-ManagedIdentityResourceId <String>]
      [-DatabaseRouting <DatabaseRouting>]
      -StorageAccountResourceId <String>
      [-EventGridResourceId <String>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzKustoDataConnectionValidation
      -ClusterName <String>
      -DatabaseName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -Kind <Kind>
      -DataConnectionName <String>
      -ConsumerGroup <String>
      -Location <String>
      [-DataFormat <String>]
      [-EventSystemProperty <String[]>]
      [-MappingRuleName <String>]
      [-TableName <String>]
      [-DatabaseRouting <DatabaseRouting>]
      [-RetrievalStartDate <DateTime>]
      -IotHubResourceId <String>
      -SharedAccessPolicyName <String>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzKustoDataConnectionValidation
      -InputObject <IKustoIdentity>
      -Kind <Kind>
      -DataConnectionName <String>
      -ConsumerGroup <String>
      -Location <String>
      -EventHubResourceId <String>
      [-DataFormat <String>]
      [-EventSystemProperty <String[]>]
      [-MappingRuleName <String>]
      [-TableName <String>]
      [-Compression <Compression>]
      [-ManagedIdentityResourceId <String>]
      [-DatabaseRouting <DatabaseRouting>]
      [-RetrievalStartDate <DateTime>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzKustoDataConnectionValidation
      -InputObject <IKustoIdentity>
      -Kind <Kind>
      -DataConnectionName <String>
      -ConsumerGroup <String>
      -Location <String>
      -EventHubResourceId <String>
      [-DataFormat <String>]
      [-MappingRuleName <String>]
      [-TableName <String>]
      [-ManagedIdentityResourceId <String>]
      [-DatabaseRouting <DatabaseRouting>]
      -StorageAccountResourceId <String>
      [-EventGridResourceId <String>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzKustoDataConnectionValidation
      -InputObject <IKustoIdentity>
      -Kind <Kind>
      -DataConnectionName <String>
      -ConsumerGroup <String>
      -Location <String>
      [-DataFormat <String>]
      [-EventSystemProperty <String[]>]
      [-MappingRuleName <String>]
      [-TableName <String>]
      [-DatabaseRouting <DatabaseRouting>]
      [-RetrievalStartDate <DateTime>]
      -IotHubResourceId <String>
      -SharedAccessPolicyName <String>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzKustoDataConnectionValidation
      -Kind <Kind>
      -DataConnectionName <String>
      -ConsumerGroup <String>
      -Location <String>
      [-DataFormat <String>]
      [-MappingRuleName <String>]
      [-TableName <String>]
      [-BlobStorageEventType <BlobStorageEventType>]
      [-IgnoreFirstRecord]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzKustoDataConnectionValidation
      -Kind <Kind>
      -DataConnectionName <String>
      -ConsumerGroup <String>
      -Location <String>
      [-DataFormat <String>]
      [-MappingRuleName <String>]
      [-TableName <String>]
      [-BlobStorageEventType <BlobStorageEventType>]
      [-IgnoreFirstRecord]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

データ接続パラメーターが有効であることを確認します。

例

例 1: EventHub データ接続パラメーターを検証する

Invoke-AzKustoDataConnectionValidation -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventhubdc" -Location "East US" -Kind "EventHub" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -DataFormat "MULTIJSON" -ConsumerGroup 'Default' -Compression "None" -TableName "Events" -MappingRuleName "NewEventsMapping"

ErrorMessage
------------
event hub resource id and consumer group tuple provided are already used

上記のコマンドは、クラスター "testnewkustocluster" 内のデータベース "mykustodatabase" の "myeventhubdc" という名前の EventHub データ接続を検証します。

例 2: EventGrid データ接続パラメーターを検証する

Invoke-AzKustoDataConnectionValidation -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventgriddc" -Location "East US" -Kind "EventGrid" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -StorageAccountResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Storage/storageAccounts/mystorage" -DataFormat "MULTIJSON" -ConsumerGroup 'Default' -TableName "Events" -MappingRuleName "NewEventsMapping"

ErrorMessage
------------
event hub resource id and consumer group tuple provided are already used

上記のコマンドは、クラスター "testnewkustocluster" 内のデータベース "mykustodatabase" の "myeventgriddc" という名前の EventGrid データ接続を検証します。

例 3: IotHub データ接続パラメーターを検証する

Invoke-AzKustoDataConnectionValidation -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myiothubdc" -Location "East US" -Kind "IotHub" -IotHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Devices/IotHubs/myiothub" -SharedAccessPolicyName "myiothubpolicy" -DataFormat "MULTIJSON" -ConsumerGroup 'Default' -TableName "Events" -MappingRuleName "NewEventsMapping"

ErrorMessage
------------
event hub resource id and consumer group tuple provided are already used

上記のコマンドは、クラスター "testnewkustocluster" 内のデータベース "mykustodatabase" の "myiothubdc" という名前の IotHub データ接続を検証します。

例 4: ID を使用して EventHub データ接続パラメーターを検証する

$database = Get-AzKustoDatabase -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" 
Invoke-AzKustoDataConnectionValidation -InputObject $database -DataConnectionName "myeventhubdc" -Location "East US" -Kind "EventHub" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -DataFormat "MULTIJSON" -ConsumerGroup 'Default' -Compression "None" -TableName "Events" -MappingRuleName "NewEventsMapping"

ErrorMessage
------------
event hub resource id and consumer group tuple provided are already used

上記のコマンドは、クラスター "testnewkustocluster" 内のデータベース "mykustodatabase" の "myeventhubdc" という名前の EventHub データ接続を検証します。

例 5: ID を使用して EventGrid データ接続パラメーターを検証する

$database = Get-AzKustoDatabase -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase"
Invoke-AzKustoDataConnectionValidation -InputObject $database -DataConnectionName "myeventgriddc" -Location "East US" -Kind "EventGrid" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -StorageAccountResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Storage/storageAccounts/mystorage" -DataFormat "MULTIJSON" -ConsumerGroup 'Default' -TableName "Events" -MappingRuleName "NewEventsMapping"

ErrorMessage
------------
event hub resource id and consumer group tuple provided are already used

上記のコマンドは、クラスター "testnewkustocluster" 内のデータベース "mykustodatabase" の "myeventgriddc" という名前の EventGrid データ接続を検証します。

例 6: ID を使用して IotHub データ接続パラメーターを検証する

$database = Get-AzKustoDatabase -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" 
Invoke-AzKustoDataConnectionValidation -InputObject $database -DataConnectionName "myiothubdc" -Location "East US" -Kind "IotHub" -IotHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Devices/IotHubs/myiothub" -SharedAccessPolicyName "myiothubpolicy" -DataFormat "MULTIJSON" -ConsumerGroup 'Default' -TableName "Events" -MappingRuleName "NewEventsMapping"

ErrorMessage
------------
event hub resource id and consumer group tuple provided are already used

上記のコマンドは、クラスター "testnewkustocluster" 内のデータベース "mykustodatabase" の "myiothubdc" という名前の IotHub データ接続を検証します。

パラメーター

-BlobStorageEventType

処理する BLOB ストレージ イベントの種類の名前。

型:	BlobStorageEventType
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ClusterName

Kusto クラスターの名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Compression

イベント ハブ メッセージの圧縮の種類。

型:	Compression
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ConsumerGroup

イベント/IoT ハブ コンシューマー グループ。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DatabaseName

Kusto クラスター内のデータベースの名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DatabaseRouting

データ接続からのデータベース ルーティング情報を示します。既定では、データベース ルーティング情報のみが許可されます。

型:	DatabaseRouting
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DataConnectionName

データ接続の名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DataFormat

メッセージのデータ形式。 必要に応じて、各メッセージにデータ形式を追加できます。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

型:	PSObject
Aliases:	AzureRMContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-EventGridResourceId

ストレージ アカウント イベントにサブスクライブされているイベント グリッドのリソース ID。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-EventHubResourceId

データ接続/イベント グリッドの作成に使用するイベント ハブのリソース ID は、イベントを送信するように構成されます。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-EventSystemProperty

イベント/IoT ハブのシステム プロパティ。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-IgnoreFirstRecord

true に設定すると、インジェストはすべてのファイルの最初のレコードを無視する必要があることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

ID パラメーターを構築するには、INPUTOBJECT プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。

型:	IKustoIdentity
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-IotHubResourceId

データ接続の作成に使用する IoT ハブのリソース ID。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Kind

データ接続のエンドポイントの種類

型:	Kind
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Location

リソースの場所。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ManagedIdentityResourceId

外部リソースでの認証に使用するマネージド ID (システムまたはユーザー割り当て) のリソース ID。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-MappingRuleName

データの取り込みに使用するマッピング ルール。 必要に応じて、マッピング情報を各メッセージに追加できます。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

Kusto クラスターを含むリソース グループの名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RetrievalStartDate

定義すると、データ接続は取得開始日以降に作成された既存のイベント ハブ イベントを取得します。 保持期間に基づいて、イベント ハブによって保持されるイベントのみを取得できます。

型:	DateTime
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SharedAccessPolicyName

共有アクセス ポリシーの名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-StorageAccountResourceId

データが存在するストレージ アカウントのリソース ID。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SubscriptionId

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報を取得します。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。

型:	String
配置:	Named
規定値:	(Get-AzContext).Subscription.Id
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TableName

データを取り込むテーブル。 必要に応じて、各メッセージにテーブル情報を追加できます。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

IKustoIdentity

出力

IDataConnectionValidationResult