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 "JSON" -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 "JSON" -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 "JSON" -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 "JSON" -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 "JSON" -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 "JSON" -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 ストレージ イベントの種類の名前。

Type:	BlobStorageEventType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClusterName

Kusto クラスターの名前。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Compression

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

Type:	Compression
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ConsumerGroup

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DatabaseName

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DatabaseRouting

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

Type:	DatabaseRouting
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DataConnectionName

データ接続の名前。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DataFormat

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EventGridResourceId

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EventHubResourceId

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-EventSystemProperty

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IgnoreFirstRecord

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

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

Type:	IKustoIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-IotHubResourceId

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Kind

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

Type:	Kind
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Location

リソースの場所。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagedIdentityResourceId

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MappingRuleName

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-RetrievalStartDate

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

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SharedAccessPolicyName

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-StorageAccountResourceId

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報を取得します。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TableName

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

IKustoIdentity

出力

IDataConnectionValidationResult