Editar

Partilhar via

New-AzSynapseKustoPoolAttachedDatabaseConfiguration

  • Reference
Module:
Az.Synapse

Creates or updates an attached database configuration.

Syntax

New-AzSynapseKustoPoolAttachedDatabaseConfiguration
   -AttachedDatabaseConfigurationName <String>
   -KustoPoolName <String>
   -ResourceGroupName <String>
   -WorkspaceName <String>
   [-SubscriptionId <String>]
   [-DatabaseName <String>]
   [-DefaultPrincipalsModificationKind <DefaultPrincipalsModificationKind>]
   [-KustoPoolResourceId <String>]
   [-Location <String>]
   [-TableLevelSharingPropertyExternalTablesToExclude <String[]>]
   [-TableLevelSharingPropertyExternalTablesToInclude <String[]>]
   [-TableLevelSharingPropertyMaterializedViewsToExclude <String[]>]
   [-TableLevelSharingPropertyMaterializedViewsToInclude <String[]>]
   [-TableLevelSharingPropertyTablesToExclude <String[]>]
   [-TableLevelSharingPropertyTablesToInclude <String[]>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Creates or updates an attached database configuration.

Examples

Example 1: Create a new AttachedDatabaseConfiguration

New-AzSynapseKustoPoolAttachedDatabaseConfiguration -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testfollowerkustopool -Name followerconfiguration -KustoPoolResourceId /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Synapse/workspaces/testws/kustoPools/testkustopool -DatabaseName testdatabase -DefaultPrincipalsModificationKind Union -Location eastus2

Name                                               Type                                                                   Location
----                                               ----                                                                   --------
testws/testfollowerkustopool/followerconfiguration Microsoft.Synapse/workspaces/kustoPools/AttachedDatabaseConfigurations East US 2

The above command creates a ReadOnly database "testdatabase" in cluster "testfollowerkustopool". It follows the database "testdatabase" from cluster "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

-AttachedDatabaseConfigurationName

The name of the attached database configuration.

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

-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

-KustoPoolName

The name of the Kusto pool.

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

-KustoPoolResourceId

The resource id of the kusto pool 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

-Location

Resource location.

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

-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 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

-TableLevelSharingPropertyMaterializedViewsToExclude

List of materialized views 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

-WorkspaceName

The name of the workspace

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

Outputs

IAttachedDatabaseConfiguration