RoleAssignmentRequest

AnalyticsApache SparkBig DataData IntegrationData WarehouseETLSQL

Properties

Name	Type	Description
roleId	string	Role ID of the Synapse Built-In Role.
principalId	string	Object ID of the AAD principal or security-group.
scope	string	Scope at which the role assignment is created.
principalType	string	Type of the principal.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RoleAssignmentRequest",
  "title": "RoleAssignmentRequest",
  "type": "object",
  "required": [
    "roleId",
    "principalId",
    "scope"
  ],
  "properties": {
    "roleId": {
      "type": "string",
      "format": "uuid",
      "description": "Role ID of the Synapse Built-In Role."
    },
    "principalId": {
      "type": "string",
      "format": "uuid",
      "description": "Object ID of the AAD principal or security-group."
    },
    "scope": {
      "type": "string",
      "description": "Scope at which the role assignment is created."
    },
    "principalType": {
      "type": "string",
      "description": "Type of the principal.",
      "enum": [
        "User",
        "Group",
        "ServicePrincipal"
      ]
    }
  }
}