Share via

AttachedDatabaseConfiguration interface

  • Reference
Package:
@azure/arm-kusto

Class representing an attached database configuration.

Extends
ProxyResource

Properties

attachedDatabaseNames

The list of databases from the clusterResourceId which are currently attached to the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
clusterResourceId

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

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

Overrides the original database name. Relevant only when attaching to a specific database.
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.
defaultPrincipalsModificationKind

The default principals modification kind
location

Resource location.
provisioningState

The provisioned state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
tableLevelSharingProperties

Table level sharing specifications

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

attachedDatabaseNames

The list of databases from the clusterResourceId which are currently attached to the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

attachedDatabaseNames?: string[]

Property Value

string[]

clusterResourceId

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

clusterResourceId?: string

Property Value

string

databaseName

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

databaseName?: string

Property Value

string

databaseNameOverride

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

databaseNameOverride?: string

Property Value

string

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.

databaseNamePrefix?: string

Property Value

string

defaultPrincipalsModificationKind

The default principals modification kind

defaultPrincipalsModificationKind?: string

Property Value

string

location

Resource location.

location?: string

Property Value

string

provisioningState

The provisioned state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

tableLevelSharingProperties

Table level sharing specifications

tableLevelSharingProperties?: TableLevelSharingProperties

Property Value

TableLevelSharingProperties

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type