Azure Synapse Analytics Role Assignment

A role assignment that grants access to Synapse workspace resources through role-based access control.

AnalyticsApache SparkBig DataData IntegrationData WarehouseETLSQL

Properties

Name Type Description
id string Role Assignment ID.
roleDefinitionId string Role Definition ID.
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

azure-synapse-analytics-role-assignment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-search/azure-synapse-analytics/json-schema/azure-synapse-analytics-role-assignment-schema.json",
  "title": "Azure Synapse Analytics Role Assignment",
  "description": "A role assignment that grants access to Synapse workspace resources through role-based access control.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Role Assignment ID."
    },
    "roleDefinitionId": {
      "type": "string",
      "format": "uuid",
      "description": "Role Definition ID."
    },
    "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"]
    }
  },
  "required": ["roleDefinitionId", "principalId", "scope"]
}