Invoke-AzKustoDataConnectionValidation
Checks that the data connection parameters are valid.
Syntax
DataExpandedEventHub (Default)
Invoke-AzKustoDataConnectionValidation
-ClusterName <String>
-DatabaseName <String>
-ResourceGroupName <String>
-Kind <Kind>
-DataConnectionName <String>
-ConsumerGroup <String>
-Location <String>
-EventHubResourceId <String>
[-SubscriptionId <String>]
[-DataFormat <String>]
[-EventSystemProperty <String[]>]
[-MappingRuleName <String>]
[-TableName <String>]
[-Compression <Compression>]
[-ManagedIdentityResourceId <String>]
[-DatabaseRouting <DatabaseRouting>]
[-RetrievalStartDate <DateTime>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DataExpandedEventGrid
Invoke-AzKustoDataConnectionValidation
-ClusterName <String>
-DatabaseName <String>
-ResourceGroupName <String>
-Kind <Kind>
-DataConnectionName <String>
-ConsumerGroup <String>
-Location <String>
-EventHubResourceId <String>
-StorageAccountResourceId <String>
[-SubscriptionId <String>]
[-DataFormat <String>]
[-MappingRuleName <String>]
[-TableName <String>]
[-ManagedIdentityResourceId <String>]
[-DatabaseRouting <DatabaseRouting>]
[-EventGridResourceId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DataExpandedIotHub
Invoke-AzKustoDataConnectionValidation
-ClusterName <String>
-DatabaseName <String>
-ResourceGroupName <String>
-Kind <Kind>
-DataConnectionName <String>
-ConsumerGroup <String>
-Location <String>
-IotHubResourceId <String>
-SharedAccessPolicyName <String>
[-SubscriptionId <String>]
[-DataFormat <String>]
[-EventSystemProperty <String[]>]
[-MappingRuleName <String>]
[-TableName <String>]
[-DatabaseRouting <DatabaseRouting>]
[-RetrievalStartDate <DateTime>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DataViaIdentityExpandedEventHub
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>]
DataViaIdentityExpandedEventGrid
Invoke-AzKustoDataConnectionValidation
-InputObject <IKustoIdentity>
-Kind <Kind>
-DataConnectionName <String>
-ConsumerGroup <String>
-Location <String>
-EventHubResourceId <String>
-StorageAccountResourceId <String>
[-DataFormat <String>]
[-MappingRuleName <String>]
[-TableName <String>]
[-ManagedIdentityResourceId <String>]
[-DatabaseRouting <DatabaseRouting>]
[-EventGridResourceId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DataViaIdentityExpandedIotHub
Invoke-AzKustoDataConnectionValidation
-InputObject <IKustoIdentity>
-Kind <Kind>
-DataConnectionName <String>
-ConsumerGroup <String>
-Location <String>
-IotHubResourceId <String>
-SharedAccessPolicyName <String>
[-DataFormat <String>]
[-EventSystemProperty <String[]>]
[-MappingRuleName <String>]
[-TableName <String>]
[-DatabaseRouting <DatabaseRouting>]
[-RetrievalStartDate <DateTime>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateExpandedEventGrid
Invoke-AzKustoDataConnectionValidation
-Kind <Kind>
-DataConnectionName <String>
-ConsumerGroup <String>
-Location <String>
[-DataFormat <String>]
[-MappingRuleName <String>]
[-TableName <String>]
[-BlobStorageEventType <BlobStorageEventType>]
[-IgnoreFirstRecord]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpandedEventGrid
Invoke-AzKustoDataConnectionValidation
-Kind <Kind>
-DataConnectionName <String>
-ConsumerGroup <String>
-Location <String>
[-DataFormat <String>]
[-MappingRuleName <String>]
[-TableName <String>]
[-BlobStorageEventType <BlobStorageEventType>]
[-IgnoreFirstRecord]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Checks that the data connection parameters are valid.
Examples
Example 1: Validate EventHub data connection parameters
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
The above command validates EventHub data connection named "myeventhubdc" for the database "mykustodatabase" in the cluster "testnewkustocluster".
Example 2: Validate EventGrid data connection parameters
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
The above command validates EventGrid data connection named "myeventgriddc" for the database "mykustodatabase" in the cluster "testnewkustocluster".
Example 3: Validate IotHub data connection parameters
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
The above command validates IotHub data connection named "myiothubdc" for the database "mykustodatabase" in the cluster "testnewkustocluster".
Example 4: Validate EventHub data connection parameters via identity
$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
The above command validates EventHub data connection named "myeventhubdc" for the database "mykustodatabase" in the cluster "testnewkustocluster".
Example 5: Validate EventGrid data connection parameters via identity
$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
The above command validates EventGrid data connection named "myeventgriddc" for the database "mykustodatabase" in the cluster "testnewkustocluster".
Example 6: Validate IotHub data connection parameters via identity
$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
The above command validates IotHub data connection named "myiothubdc" for the database "mykustodatabase" in the cluster "testnewkustocluster".
Parameters
-BlobStorageEventType
The name of blob storage event type to process.
Parameter properties
Parameter sets
UpdateExpandedEventGrid
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpandedEventGrid
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ClusterName
The name of the Kusto cluster.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DataExpandedEventHub
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataExpandedEventGrid
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataExpandedIotHub
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Compression
The event hub messages compression type.
Parameter properties
Type: Compression
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DataExpandedEventHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedEventHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ConsumerGroup
The event/iot hub consumer group.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DatabaseName
The name of the database in the Kusto cluster.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DataExpandedEventHub
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataExpandedEventGrid
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataExpandedIotHub
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DatabaseRouting
Indication for database routing information from the data connection, by default only database routing information is allowed.
Parameter properties
Type: DatabaseRouting
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DataExpandedEventHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataExpandedEventGrid
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataExpandedIotHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedEventHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedEventGrid
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedIotHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DataConnectionName
The name of the data connection.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
The data format of the message.
Optionally the data format can be added to each message.
Type: String
Default value: None Supports wildcards: False DontShow: False
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EventGridResourceId
The resource ID of the event grid that is subscribed to the storage account events.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DataExpandedEventGrid
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedEventGrid
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EventHubResourceId
The resource ID of the event hub to be used to create a data connection / event grid is configured to send events.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DataExpandedEventHub
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataExpandedEventGrid
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedEventHub
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedEventGrid
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EventSystemProperty
System properties of the event/iot hub.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DataExpandedEventHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataExpandedIotHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedEventHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedIotHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IgnoreFirstRecord
If set to true, indicates that ingestion should ignore the first record of every file.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpandedEventGrid
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpandedEventGrid
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: IKustoIdentity
Default value: None Supports wildcards: False DontShow: False
DataViaIdentityExpandedEventHub
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedEventGrid
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedIotHub
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-IotHubResourceId
The resource ID of the Iot hub to be used to create a data connection.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DataExpandedIotHub
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedIotHub
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Kind
Kind of the endpoint for the data connection
Parameter properties
Type: Kind
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
Resource location.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedIdentityResourceId
The resource ID of a managed identity (system or user assigned) to be used to authenticate with external resources.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DataExpandedEventHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataExpandedEventGrid
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedEventHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedEventGrid
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MappingRuleName
The mapping rule to be used to ingest the data.
Optionally the mapping information can be added to each message.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group containing the Kusto cluster.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DataExpandedEventHub
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataExpandedEventGrid
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataExpandedIotHub
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RetrievalStartDate
When defined, the data connection retrieves existing Event hub events created since the Retrieval start date.
It can only retrieve events retained by the Event hub, based on its retention period.
Parameter properties
Type: DateTime
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DataExpandedEventHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataExpandedIotHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedEventHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedIotHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SharedAccessPolicyName
The name of the share access policy.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DataExpandedIotHub
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedIotHub
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-StorageAccountResourceId
The resource ID of the storage account where the data resides.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DataExpandedEventGrid
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataViaIdentityExpandedEventGrid
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
Gets subscription credentials which uniquely identify Microsoft Azure subscription.
The subscription ID forms part of the URI for every service call.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
DataExpandedEventHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataExpandedEventGrid
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
DataExpandedIotHub
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TableName
The table where the data should be ingested.
Optionally the table information can be added to each message.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
