Edit

Update-AzSynapseKustoPoolDataConnection

  • Reference
Module:
Az.Synapse

Updates a data connection.

Syntax

Update-AzSynapseKustoPoolDataConnection
      -DatabaseName <String>
      -DataConnectionName <String>
      -KustoPoolName <String>
      -ResourceGroupName <String>
      -WorkspaceName <String>
      -ConsumerGroup <String>
      -EventHubResourceId <String>
      -Kind <DataConnectionKind>
      -Location <String>
      [-SubscriptionId <String>]
      [-Compression <Compression>]
      [-DataFormat <EventGridDataFormat>]
      [-EventSystemProperty <String[]>]
      [-MappingRuleName <String>]
      [-TableName <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Update-AzSynapseKustoPoolDataConnection
      -DatabaseName <String>
      -DataConnectionName <String>
      -KustoPoolName <String>
      -ResourceGroupName <String>
      -WorkspaceName <String>
      -ConsumerGroup <String>
      -EventHubResourceId <String>
      -Kind <DataConnectionKind>
      -Location <String>
      -StorageAccountResourceId <String>
      [-SubscriptionId <String>]
      [-BlobStorageEventType <BlobStorageEventType>]
      [-DataFormat <EventGridDataFormat>]
      [-IgnoreFirstRecord]
      [-MappingRuleName <String>]
      [-TableName <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Update-AzSynapseKustoPoolDataConnection
      -DatabaseName <String>
      -DataConnectionName <String>
      -KustoPoolName <String>
      -ResourceGroupName <String>
      -WorkspaceName <String>
      -ConsumerGroup <String>
      -IotHubResourceId <String>
      -Kind <DataConnectionKind>
      -Location <String>
      -SharedAccessPolicyName <String>
      [-SubscriptionId <String>]
      [-DataFormat <EventGridDataFormat>]
      [-EventSystemProperty <String[]>]
      [-MappingRuleName <String>]
      [-TableName <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Update-AzSynapseKustoPoolDataConnection
      -InputObject <ISynapseIdentity>
      -ConsumerGroup <String>
      -EventHubResourceId <String>
      -Kind <DataConnectionKind>
      -Location <String>
      -StorageAccountResourceId <String>
      [-BlobStorageEventType <BlobStorageEventType>]
      [-DataFormat <EventGridDataFormat>]
      [-IgnoreFirstRecord]
      [-MappingRuleName <String>]
      [-TableName <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Update-AzSynapseKustoPoolDataConnection
      -InputObject <ISynapseIdentity>
      -ConsumerGroup <String>
      -EventHubResourceId <String>
      -Kind <DataConnectionKind>
      -Location <String>
      [-Compression <Compression>]
      [-DataFormat <EventGridDataFormat>]
      [-EventSystemProperty <String[]>]
      [-MappingRuleName <String>]
      [-TableName <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Update-AzSynapseKustoPoolDataConnection
      -InputObject <ISynapseIdentity>
      -ConsumerGroup <String>
      -IotHubResourceId <String>
      -Kind <DataConnectionKind>
      -Location <String>
      -SharedAccessPolicyName <String>
      [-DataFormat <EventGridDataFormat>]
      [-EventSystemProperty <String[]>]
      [-MappingRuleName <String>]
      [-TableName <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Updates a data connection.

Examples

Example 1: Update an existing EventHub data connection

Update-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventhubdc -Location eastus2 -Kind EventHub -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -DataFormat "JSON" -ConsumerGroup '$Default' -Compression "None" -TableName "Events" -MappingRuleName "EventsMapping"

Kind     Location  Name                                            
----     --------  ----                                            
EventHub East US 2 testws/testkustopool/testdatabase/eventhubdc

The above command updates the existing EventHub data connection named "eventhubdc" for the database "testdatabase" in the kusto pool "testkustopool".

Example 2: Update an existing EventGrid data connection

Update-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventgriddc -Location eastus2 -Kind EventGrid -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/teststorage" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping"

Kind      Location  Name
----      --------  ----                                              
EventGrid East US 2 testws/testkustopool/testdatabase/eventgriddc

The above command updates the existing EventGrid data connection named "eventgriddc" for the database "testdatabase" in the kusto pool "testkustopool".

Example 3: Update an existing IotHub data connection

Update-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name iothubdc -Location eastus2 -Kind IotHub -IotHubResourceId "/subscriptions/051ddeca-1ed6-4d8b-ba6f-1ff561e5f3b3/resourceGroups/ywtest/providers/Microsoft.Devices/IotHubs/ywtestiothub" -SharedAccessPolicyName registryRead -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping"

Kind   Location  Name 
----   --------  ----                                           
IotHub East US 2 testws/testkustopool/testdatabase/iothubdc

The above command updates the existing IotHub data connection named "iothubdc" for the database "testdatabase" in the kusto pool "testkustopool".

Example 4: Update an existing EventHub data connection via identity

$dataConnection = Get-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventhubdc
Update-AzSynapseKustoPoolDataConnection -InputObject $dataConnection -Location eastus2 -Kind EventHub -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -DataFormat "JSON" -ConsumerGroup '$Default' -Compression "None" -TableName "Events" -MappingRuleName "EventsMapping"

Kind     Location  Name                                            
----     --------  ----                                            
EventHub East US 2 testws/testkustopool/testdatabase/eventhubdc

The above command updates the existing EventHub data connection named "eventhubdc" for the database "testdatabase" in the kusto pool "testkustopool".

Example 5: Update an existing EventGrid data connection via identity

$dataConnection = Get-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventgriddc
Update-AzSynapseKustoPoolDataConnection -InputObject $dataConnection -Location eastus2 -Kind EventGrid -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/teststorage" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping"

Kind      Location  Name
----      --------  ----                                              
EventGrid East US 2 testws/testkustopool/testdatabase/eventgriddc

The above command updates the existing EventGrid data connection named "eventgriddc" for the database "testdatabase" in the kusto pool "testkustopool".

Example 6: Update an existing IotHub data connection via identity

$dataConnection = Get-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name iothubdc
Update-AzSynapseKustoPoolDataConnection -InputObject $dataConnection -Location eastus2 -Kind IotHub -IotHubResourceId "/subscriptions/051ddeca-1ed6-4d8b-ba6f-1ff561e5f3b3/resourceGroups/ywtest/providers/Microsoft.Devices/IotHubs/ywtestiothub" -SharedAccessPolicyName registryRead -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping"

Kind   Location  Name 
----   --------  ----                                           
IotHub East US 2 testws/testkustopool/testdatabase/iothubdc

The above command updates the existing IotHub data connection named "iothubdc" for the database "testdatabase" in the kusto pool "testkustopool".

Parameters

-AsJob

Run the command as a job

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

-BlobStorageEventType

The name of blob storage event type to process.

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

-Compression

The event hub messages compression type.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-ConsumerGroup

The event/iot hub consumer group.

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

-DatabaseName

The name of the database in the Kusto pool.

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

-DataConnectionName

The name of the data connection.

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

-DataFormat

The data format of the message. Optionally the data format can be added to each message.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

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

-EventHubResourceId

The resource ID of the event hub to be used to create a data connection / event grid is configured to send events.

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

-EventSystemProperty

System properties of the event/iot hub.

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

-IgnoreFirstRecord

If set to true, indicates that ingestion should ignore the first record of every file.

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-IotHubResourceId

The resource ID of the Iot hub to be used to create a data connection.

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

-Kind

Kind of the endpoint for the data connection

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

-KustoPoolName

The name of the Kusto pool.

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

-Location

Resource location.

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

-MappingRuleName

The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.

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

-NoWait

Run the command asynchronously

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-SharedAccessPolicyName

The name of the share access policy.

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

-StorageAccountResourceId

The resource ID of the storage account where the data resides.

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

-SubscriptionId

The ID of the target subscription.

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

-TableName

The table where the data should be ingested. Optionally the table information can be added to each message.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

-WorkspaceName

The name of the workspace

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

Inputs

ISynapseIdentity

Outputs

IDataConnection

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <ISynapseIdentity>: Identity Parameter

  • [AttachedDatabaseConfigurationName <String>]: The name of the attached database configuration.
  • [DataConnectionName <String>]: The name of the data connection.
  • [DatabaseName <String>]: The name of the database in the Kusto pool.
  • [Id <String>]: Resource identity path
  • [KustoPoolName <String>]: The name of the Kusto pool.
  • [Location <String>]: The name of Azure region.
  • [PrincipalAssignmentName <String>]: The name of the Kusto principalAssignment.
  • [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
  • [SubscriptionId <String>]: The ID of the target subscription.
  • [WorkspaceName <String>]: The name of the workspace