New-AzKustoAttachedDatabaseConfiguration

Reference

Module:: Az.Kusto

Creates or updates an attached database configuration.

Syntax

New-AzKustoAttachedDatabaseConfiguration
   -ClusterName <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-ClusterResourceId <String>]
   [-DatabaseName <String>]
   [-DatabaseNameOverride <String>]
   [-DatabaseNamePrefix <String>]
   [-DefaultPrincipalsModificationKind <DefaultPrincipalsModificationKind>]
   [-Location <String>]
   [-TableLevelSharingPropertyExternalTablesToExclude <String[]>]
   [-TableLevelSharingPropertyExternalTablesToInclude <String[]>]
   [-TableLevelSharingPropertyFunctionsToExclude <String[]>]
   [-TableLevelSharingPropertyFunctionsToInclude <String[]>]
   [-TableLevelSharingPropertyMaterializedViewsToExclude <String[]>]
   [-TableLevelSharingPropertyMaterializedViewsToInclude <String[]>]
   [-TableLevelSharingPropertyTablesToExclude <String[]>]
   [-TableLevelSharingPropertyTablesToInclude <String[]>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

Creates or updates an attached database configuration.

Examples

Example 1: Create a new AttachedDatabaseConfiguration

New-AzKustoAttachedDatabaseConfiguration -ResourceGroupName "testrg" -ClusterName "testnewkustoclusterf" -Name "myfollowerconfiguration" -Location "East US" -ClusterResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Kusto/Clusters/testnewkustocluster" -DatabaseName "mykustodatabase" -DefaultPrincipalsModificationKind "Union"

Name                                 Type                                                    Location
----                                 ----                                                    --------
testnewkustoclusterf/myfollowerconfiguration Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations East US

The above command creates a ReadOnly database "mykustodatabase" in cluster "testnewkustoclusterf". It follows the database "mykustodatabase" from cluster "testnewkustocluster"

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

-ClusterName

The name of the Kusto cluster.

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

-ClusterResourceId

The resource id of the cluster where the databases you would like to attach reside.

Type:	String
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

-DatabaseName

The name of the database which you would like to attach, use * if you want to follow all current and future databases.

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

-DatabaseNameOverride

Overrides the original database name. Relevant only when attaching to a specific database.

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

-DatabaseNamePrefix

Adds a prefix to the attached databases name. When following an entire cluster, that prefix would be added to all of the databases original names from leader cluster.

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

-DefaultPrincipalsModificationKind

The default principals modification kind

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

-Location

Resource location.

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

-Name

The name of the attached database configuration.

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

-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

Outputs

IAttachedDatabaseConfiguration