你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Cluster Principal Assignments - List

Lists all Kusto cluster principalAssignments.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments?api-version=2023-08-15

URI Parameters

Name In Required Type Description
clusterName
path True

string

The name of the Kusto cluster.

Regex pattern: ^.*$

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
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

ClusterPrincipalAssignmentListResult

OK.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Examples

KustoPrincipalAssignmentsList

Sample request

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster/principalAssignments?api-version=2023-08-15

Sample response

{
  "value": [
    {
      "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1",
      "name": "kustoCluster/Kustodatabase8/kustoprincipal1",
      "type": "Microsoft.Kusto/Clusters/Databases/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"
      }
    },
    {
      "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoCluster/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1",
      "name": "kustoCluster/Kustodatabase8/kustoprincipal2",
      "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments",
      "properties": {
        "role": "AllDatabasesViewer",
        "principalId": "11112222-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
ClusterPrincipalAssignment

Class representing a cluster principal assignment.

ClusterPrincipalAssignmentListResult

The list Kusto cluster principal assignments operation response.

ClusterPrincipalRole

Cluster principal role.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

PrincipalType

Principal type.

ProvisioningState

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

PrincipalType

Principal type.

properties.provisioningState

ProvisioningState

The provisioned state of the resource.

properties.role

ClusterPrincipalRole

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"

ClusterPrincipalAssignmentListResult

The list Kusto cluster principal assignments operation response.

Name Type Description
value

ClusterPrincipalAssignment[]

The list of Kusto cluster principal assignments.

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

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

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