Invoke-AzKustoInviteDatabaseFollower
Generates an invitation token that allows attaching a follower database to this database.
Syntax
InviteExpanded (Default)
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>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invite
Invoke-AzKustoInviteDatabaseFollower
-ClusterName <String>
-DatabaseName <String>
-ResourceGroupName <String>
-Parameter <IDatabaseInviteFollowerRequest>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InviteViaIdentityExpanded
Invoke-AzKustoInviteDatabaseFollower
-InputObject <IKustoIdentity>
-InviteeEmail <String>
[-TableLevelSharingPropertyExternalTablesToExclude <String[]>]
[-TableLevelSharingPropertyExternalTablesToInclude <String[]>]
[-TableLevelSharingPropertyFunctionsToExclude <String[]>]
[-TableLevelSharingPropertyFunctionsToInclude <String[]>]
[-TableLevelSharingPropertyMaterializedViewsToExclude <String[]>]
[-TableLevelSharingPropertyMaterializedViewsToInclude <String[]>]
[-TableLevelSharingPropertyTablesToExclude <String[]>]
[-TableLevelSharingPropertyTablesToInclude <String[]>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InviteViaIdentity
Invoke-AzKustoInviteDatabaseFollower
-InputObject <IKustoIdentity>
-Parameter <IDatabaseInviteFollowerRequest>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Invite
Position: Named Mandatory: True 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
-DatabaseName
The name of the database in the Kusto cluster.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Invite
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
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
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
InviteViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-InviteeEmail
The email of the invited user for which the follower invitation is generated.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Parameter
The request to invite a follower to a database.
To construct, see NOTES section for PARAMETER properties and create a hash table.
Parameter properties
Parameter sets
Invite
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Invite
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Invite
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TableLevelSharingPropertyExternalTablesToExclude
List of external tables to exclude from the follower database
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TableLevelSharingPropertyExternalTablesToInclude
List of external tables to include in the follower database
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TableLevelSharingPropertyFunctionsToExclude
List of functions to exclude from the follower database
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TableLevelSharingPropertyFunctionsToInclude
List of functions to include in the follower database
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TableLevelSharingPropertyMaterializedViewsToExclude
List of materialized views to exclude from the follower database
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TableLevelSharingPropertyMaterializedViewsToInclude
List of materialized views to include in the follower database
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TableLevelSharingPropertyTablesToExclude
List of tables to exclude from the follower database
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TableLevelSharingPropertyTablesToInclude
List of tables to include in the follower database
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentityExpanded
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
