AttachedDatabaseConfiguration interface
Class representing an attached database configuration.
- Extends
Properties
| attached |
The list of databases from the clusterResourceId which are currently attached to the cluster. |
| cluster |
The resource id of the cluster where the databases you would like to attach reside. |
| database |
The name of the database which you would like to attach, use * if you want to follow all current and future databases. |
| database |
Overrides the original database name. Relevant only when attaching to a specific database. |
| database |
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. |
| default |
The default principals modification kind |
| location | Resource location. |
| provisioning |
The provisioned state of the resource. |
| table |
Table level sharing specifications |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name | The name of the resource |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Property Details
attachedDatabaseNames
The list of databases from the clusterResourceId which are currently attached to the cluster.
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.
provisioningState?: string
Property Value
string
tableLevelSharingProperties
Table level sharing specifications
tableLevelSharingProperties?: TableLevelSharingProperties
Property Value
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: string
Property Value
string
Inherited From ProxyResource.id
name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemData?: SystemData
Property Value
Inherited From ProxyResource.systemData
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
type?: string
Property Value
string
Inherited From ProxyResource.type