1. Packages
  2. Azure Native v2
  3. API Docs
  4. synapse
  5. getDatabasePrincipalAssignment
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.synapse.getDatabasePrincipalAssignment

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets a Kusto pool database principalAssignment. Azure REST API version: 2021-04-01-preview.

Using getDatabasePrincipalAssignment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDatabasePrincipalAssignment(args: GetDatabasePrincipalAssignmentArgs, opts?: InvokeOptions): Promise<GetDatabasePrincipalAssignmentResult>
function getDatabasePrincipalAssignmentOutput(args: GetDatabasePrincipalAssignmentOutputArgs, opts?: InvokeOptions): Output<GetDatabasePrincipalAssignmentResult>
Copy
def get_database_principal_assignment(database_name: Optional[str] = None,
                                      kusto_pool_name: Optional[str] = None,
                                      principal_assignment_name: Optional[str] = None,
                                      resource_group_name: Optional[str] = None,
                                      workspace_name: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetDatabasePrincipalAssignmentResult
def get_database_principal_assignment_output(database_name: Optional[pulumi.Input[str]] = None,
                                      kusto_pool_name: Optional[pulumi.Input[str]] = None,
                                      principal_assignment_name: Optional[pulumi.Input[str]] = None,
                                      resource_group_name: Optional[pulumi.Input[str]] = None,
                                      workspace_name: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetDatabasePrincipalAssignmentResult]
Copy
func LookupDatabasePrincipalAssignment(ctx *Context, args *LookupDatabasePrincipalAssignmentArgs, opts ...InvokeOption) (*LookupDatabasePrincipalAssignmentResult, error)
func LookupDatabasePrincipalAssignmentOutput(ctx *Context, args *LookupDatabasePrincipalAssignmentOutputArgs, opts ...InvokeOption) LookupDatabasePrincipalAssignmentResultOutput
Copy

> Note: This function is named LookupDatabasePrincipalAssignment in the Go SDK.

public static class GetDatabasePrincipalAssignment 
{
    public static Task<GetDatabasePrincipalAssignmentResult> InvokeAsync(GetDatabasePrincipalAssignmentArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabasePrincipalAssignmentResult> Invoke(GetDatabasePrincipalAssignmentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDatabasePrincipalAssignmentResult> getDatabasePrincipalAssignment(GetDatabasePrincipalAssignmentArgs args, InvokeOptions options)
public static Output<GetDatabasePrincipalAssignmentResult> getDatabasePrincipalAssignment(GetDatabasePrincipalAssignmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:synapse:getDatabasePrincipalAssignment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto pool.
KustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
PrincipalAssignmentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto principalAssignment.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto pool.
KustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
PrincipalAssignmentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto principalAssignment.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database in the Kusto pool.
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto pool.
principalAssignmentName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto principalAssignment.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database in the Kusto pool.
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto pool.
principalAssignmentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Kusto principalAssignment.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database in the Kusto pool.
kusto_pool_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kusto pool.
principal_assignment_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Kusto principalAssignment.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database in the Kusto pool.
kustoPoolName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto pool.
principalAssignmentName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Kusto principalAssignment.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace

getDatabasePrincipalAssignment Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
PrincipalId string
The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.
PrincipalName string
The principal name
PrincipalType string
Principal type.
ProvisioningState string
The provisioned state of the resource.
Role string
Database principal role.
SystemData Pulumi.AzureNative.Synapse.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TenantName string
The tenant name of the principal
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
TenantId string
The tenant id of the principal
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
PrincipalId string
The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.
PrincipalName string
The principal name
PrincipalType string
Principal type.
ProvisioningState string
The provisioned state of the resource.
Role string
Database principal role.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TenantName string
The tenant name of the principal
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
TenantId string
The tenant id of the principal
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
principalId String
The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.
principalName String
The principal name
principalType String
Principal type.
provisioningState String
The provisioned state of the resource.
role String
Database principal role.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantName String
The tenant name of the principal
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tenantId String
The tenant id of the principal
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
principalId string
The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.
principalName string
The principal name
principalType string
Principal type.
provisioningState string
The provisioned state of the resource.
role string
Database principal role.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantName string
The tenant name of the principal
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tenantId string
The tenant id of the principal
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
principal_id str
The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.
principal_name str
The principal name
principal_type str
Principal type.
provisioning_state str
The provisioned state of the resource.
role str
Database principal role.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenant_name str
The tenant name of the principal
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tenant_id str
The tenant id of the principal
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
principalId String
The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.
principalName String
The principal name
principalType String
Principal type.
provisioningState String
The provisioned state of the resource.
role String
Database principal role.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantName String
The tenant name of the principal
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tenantId String
The tenant id of the principal

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi