Invoke-AzKustoInviteDatabaseFollower

Reference

Module:: Az.Kusto

Generates an invitation token that allows attaching a follower database to this database.

Syntax

Invoke-AzKustoInviteDatabaseFollower
      -ClusterName <String>
      -DatabaseName <String>
      -ResourceGroupName <String>
      -InviteeEmail <String>
      [-SubscriptionId <String>]
      [-TableLevelSharingPropertyExternalTablesToExclude <String[]>]
      [-TableLevelSharingPropertyExternalTablesToInclude <String[]>]
      [-TableLevelSharingPropertyFunctionsToExclude <String[]>]
      [-TableLevelSharingPropertyFunctionsToInclude <String[]>]
      [-TableLevelSharingPropertyMaterializedViewsToExclude <String[]>]
      [-TableLevelSharingPropertyMaterializedViewsToInclude <String[]>]
      [-TableLevelSharingPropertyTablesToExclude <String[]>]
      [-TableLevelSharingPropertyTablesToInclude <String[]>]
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Invoke-AzKustoInviteDatabaseFollower
      -ClusterName <String>
      -DatabaseName <String>
      -ResourceGroupName <String>
      -Parameter <IDatabaseInviteFollowerRequest>
      [-SubscriptionId <String>]
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Invoke-AzKustoInviteDatabaseFollower
      -InputObject <IKustoIdentity>
      -Parameter <IDatabaseInviteFollowerRequest>
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Invoke-AzKustoInviteDatabaseFollower
      -InputObject <IKustoIdentity>
      -InviteeEmail <String>
      [-TableLevelSharingPropertyExternalTablesToExclude <String[]>]
      [-TableLevelSharingPropertyExternalTablesToInclude <String[]>]
      [-TableLevelSharingPropertyFunctionsToExclude <String[]>]
      [-TableLevelSharingPropertyFunctionsToInclude <String[]>]
      [-TableLevelSharingPropertyMaterializedViewsToExclude <String[]>]
      [-TableLevelSharingPropertyMaterializedViewsToInclude <String[]>]
      [-TableLevelSharingPropertyTablesToExclude <String[]>]
      [-TableLevelSharingPropertyTablesToInclude <String[]>]
      [-DefaultProfile <PSObject>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Generates an invitation token that allows attaching a follower database to this database.

Examples

Example 1: Invite a Follower to a Cluster database

Invoke-AzKustoInviteDatabaseFollower -ClusterName "myCluster" -DatabaseName "myDatabase" -ResourceGroupName "myResourceGroup" -InviteeEmail "user@contoso.com"

Invite a user to follow database "myDatabase" in cluster "myCluster" in resource group "myResourceGroup"

Parameters

-ClusterName

The name of the Kusto cluster.

Type:	String
Position:	Named
Default value:	None
Required:	True
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

-DatabaseName

The name of the database in the Kusto cluster.

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

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
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:	IKustoIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InviteeEmail

The email of the invited user for which the follower invitation is generated.

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

-Parameter

The request to invite a follower to a database. To construct, see NOTES section for PARAMETER properties and create a hash table.

Type:	IDatabaseInviteFollowerRequest
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

-SubscriptionId

The ID of the target subscription.

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

-TableLevelSharingPropertyExternalTablesToExclude

List of external tables to exclude from the follower database

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

-TableLevelSharingPropertyExternalTablesToInclude

List of external tables to include in the follower database

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

-TableLevelSharingPropertyFunctionsToExclude

List of functions to exclude from the follower database

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

-TableLevelSharingPropertyFunctionsToInclude

List of functions to include in the follower database

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

-TableLevelSharingPropertyMaterializedViewsToExclude

List of materialized views to exclude from the follower database

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

-TableLevelSharingPropertyMaterializedViewsToInclude

List of materialized views to include in the follower database

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

-TableLevelSharingPropertyTablesToExclude

List of tables to exclude from the follower database

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

-TableLevelSharingPropertyTablesToInclude

List of tables to include in the follower database

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

Inputs

IDatabaseInviteFollowerRequest

IKustoIdentity

Outputs

String