1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. getKustoPoolPrincipalAssignment
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.synapse.getKustoPoolPrincipalAssignment

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Gets a Kusto pool principalAssignment.

Uses Azure REST API version 2021-06-01-preview.

Other available API versions: 2021-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native synapse [ApiVersion]. See the version guide for details.

Using getKustoPoolPrincipalAssignment

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 getKustoPoolPrincipalAssignment(args: GetKustoPoolPrincipalAssignmentArgs, opts?: InvokeOptions): Promise<GetKustoPoolPrincipalAssignmentResult>
function getKustoPoolPrincipalAssignmentOutput(args: GetKustoPoolPrincipalAssignmentOutputArgs, opts?: InvokeOptions): Output<GetKustoPoolPrincipalAssignmentResult>
Copy
def get_kusto_pool_principal_assignment(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) -> GetKustoPoolPrincipalAssignmentResult
def get_kusto_pool_principal_assignment_output(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[GetKustoPoolPrincipalAssignmentResult]
Copy
func LookupKustoPoolPrincipalAssignment(ctx *Context, args *LookupKustoPoolPrincipalAssignmentArgs, opts ...InvokeOption) (*LookupKustoPoolPrincipalAssignmentResult, error)
func LookupKustoPoolPrincipalAssignmentOutput(ctx *Context, args *LookupKustoPoolPrincipalAssignmentOutputArgs, opts ...InvokeOption) LookupKustoPoolPrincipalAssignmentResultOutput
Copy

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

public static class GetKustoPoolPrincipalAssignment 
{
    public static Task<GetKustoPoolPrincipalAssignmentResult> InvokeAsync(GetKustoPoolPrincipalAssignmentArgs args, InvokeOptions? opts = null)
    public static Output<GetKustoPoolPrincipalAssignmentResult> Invoke(GetKustoPoolPrincipalAssignmentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetKustoPoolPrincipalAssignmentResult> getKustoPoolPrincipalAssignment(GetKustoPoolPrincipalAssignmentArgs args, InvokeOptions options)
public static Output<GetKustoPoolPrincipalAssignmentResult> getKustoPoolPrincipalAssignment(GetKustoPoolPrincipalAssignmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:synapse:getKustoPoolPrincipalAssignment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

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

getKustoPoolPrincipalAssignment Result

The following output properties are available:

AadObjectId string
The service principal object id in AAD (Azure active directory)
AzureApiVersion string
The Azure API version of the resource.
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 cluster 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
Cluster 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
AadObjectId string
The service principal object id in AAD (Azure active directory)
AzureApiVersion string
The Azure API version of the resource.
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 cluster 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
Cluster 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
aadObjectId String
The service principal object id in AAD (Azure active directory)
azureApiVersion String
The Azure API version of the resource.
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 cluster 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
Cluster 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
aadObjectId string
The service principal object id in AAD (Azure active directory)
azureApiVersion string
The Azure API version of the resource.
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 cluster 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
Cluster 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
aad_object_id str
The service principal object id in AAD (Azure active directory)
azure_api_version str
The Azure API version of the resource.
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 cluster 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
Cluster 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
aadObjectId String
The service principal object id in AAD (Azure active directory)
azureApiVersion String
The Azure API version of the resource.
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 cluster 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
Cluster 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 pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi