Cluster Principal Assignments - Get
Gets a Kusto cluster principalAssignment.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments/{principalAssignmentName}?api-version=2023-08-15
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
cluster
|
path | True |
string |
The name of the Kusto cluster. Regex pattern: |
principal
|
path | True |
string |
The name of the Kusto principalAssignment. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The Kusto cluster principal assignment object. |
|
Other Status Codes |
Error response describing why the operation failed. |
Examples
KustoClusterPrincipalAssignmentsGet
Sample Request
Sample Response
{
"id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/PrincipalAssignments/kustoprincipal1",
"name": "kustoCluster/kustoprincipal1",
"type": "Microsoft.Kusto/Clusters/PrincipalAssignments",
"properties": {
"role": "AllDatabasesAdmin",
"principalId": "87654321-1234-1234-1234-123456789123",
"principalType": "App",
"tenantId": "12345678-1234-1234-1234-123456789123",
"tenantName": "tenantName",
"principalName": "TestApp",
"provisioningState": "Succeeded",
"aadObjectId": "98765432-1234-1234-1234-123456789123"
}
}
Definitions
Name | Description |
---|---|
Cluster |
Class representing a cluster principal assignment. |
Cluster |
Cluster principal role. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Principal |
Principal type. |
Provisioning |
The provisioned state of the resource. |
ClusterPrincipalAssignment
Class representing a cluster principal assignment.
Name | Type | Description |
---|---|---|
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 |
properties.aadObjectId |
string |
The service principal object id in AAD (Azure active directory) |
properties.principalId |
string |
The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name. |
properties.principalName |
string |
The principal name |
properties.principalType |
Principal type. |
|
properties.provisioningState |
The provisioned state of the resource. |
|
properties.role |
Cluster principal role. |
|
properties.tenantId |
string |
The tenant id of the principal |
properties.tenantName |
string |
The tenant name of the principal |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
ClusterPrincipalRole
Cluster principal role.
Name | Type | Description |
---|---|---|
AllDatabasesAdmin |
string |
|
AllDatabasesViewer |
string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
PrincipalType
Principal type.
Name | Type | Description |
---|---|---|
App |
string |
|
Group |
string |
|
User |
string |
ProvisioningState
The provisioned state of the resource.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Moving |
string |
|
Running |
string |
|
Succeeded |
string |