Metadata Roles - List

Service:

Purview

API Version:

2021-07-01-preview

Lists roles for Purview Account

GET {Endpoint}/policyStore/metadataRoles?api-version=2021-07-01-preview

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	The endpoint of your Purview account. Example: https://{accountName}.purview.azure.com.
api-version	query	True	string	The api version to use.

Responses

Name	Type	Description
200 OK	MetadataRoleList	Success
Other Status Codes	ErrorResponseModel	An error response received from the Metadata Policy Service Headers x-ms-error-code: string

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

MetadataRoles_List

Sample request

HTTP

GET {Endpoint}/policyStore/metadataRoles?api-version=2021-07-01-preview

Sample response

Status code:

200

x-ms-request-id: 8e58266a-de42-40d5-b3c4-c6a7e159cfba

{
  "values": [
    {
      "id": "purviewmetadatarole_builtin_data-source-administrator",
      "name": "data-source-administrator",
      "type": "Microsoft.Purview/role",
      "properties": {
        "provisioningState": "Provisioned",
        "roleType": "BuiltIn",
        "friendlyName": "Data Source Administrator",
        "cnfCondition": [
          [
            {
              "attributeName": "request.azure.dataAction",
              "attributeValueIncludedIn": [
                "Microsoft.Purview/accounts/scan/read",
                "Microsoft.Purview/accounts/scan/write",
                "Microsoft.Purview/accounts/collection/read"
              ]
            }
          ]
        ],
        "version": 1
      }
    },
    {
      "id": "purviewmetadatarole_builtin_collection-administrator",
      "name": "collection-administrator",
      "type": "Microsoft.Purview/role",
      "properties": {
        "provisioningState": "Provisioned",
        "roleType": "BuiltIn",
        "friendlyName": "Collection Administrator",
        "cnfCondition": [
          [
            {
              "attributeName": "request.azure.dataAction",
              "attributeValueIncludedIn": [
                "Microsoft.Purview/accounts/collection/read",
                "Microsoft.Purview/accounts/collection/write"
              ]
            }
          ]
        ],
        "version": 1
      }
    },
    {
      "id": "purviewmetadatarole_builtin_purview-reader",
      "name": "purview-reader",
      "type": "Microsoft.Purview/role",
      "properties": {
        "provisioningState": "Provisioned",
        "roleType": "BuiltIn",
        "friendlyName": "Purview Reader",
        "cnfCondition": [
          [
            {
              "attributeName": "request.azure.dataAction",
              "attributeValueIncludedIn": [
                "Microsoft.Purview/accounts/data/read",
                "Microsoft.Purview/accounts/collection/read"
              ]
            }
          ]
        ],
        "version": 1
      }
    },
    {
      "id": "purviewmetadatarole_builtin_data-curator",
      "name": "data-curator",
      "type": "Microsoft.Purview/role",
      "properties": {
        "provisioningState": "Provisioned",
        "roleType": "BuiltIn",
        "friendlyName": "Data Curator",
        "cnfCondition": [
          [
            {
              "attributeName": "request.azure.dataAction",
              "attributeValueIncludedIn": [
                "Microsoft.Purview/accounts/data/read",
                "Microsoft.Purview/accounts/data/write",
                "Microsoft.Purview/accounts/collection/read"
              ]
            }
          ]
        ],
        "version": 1
      }
    }
  ]
}

Definitions

Name	Description
AttributeMatcher	Attribute matcher for a rule
ErrorModel	The error model for metadata policy
ErrorResponseModel	The error response model for metadata policy
MetadataRole
MetadataRoleList	List of Metadata roles
MetadataRoleProperties

AttributeMatcher

Object

Attribute matcher for a rule

Name	Type	Description
attributeName	string	AttributeName
attributeValueExcludedIn	string[]	List of values excluded for attribute
attributeValueExcludes	string	Value excluded for attribute
attributeValueIncludedIn	string[]	List of values for attribute
attributeValueIncludes	string	Value for attribute

ErrorModel

Object

The error model for metadata policy

Name	Type	Description
code	string	The error code
details	ErrorModel[]	The error details
message	string	The error message
target	string	The error target

ErrorResponseModel

Object

The error response model for metadata policy

Name	Type	Description
error	ErrorModel	The error model for metadata policy

MetadataRole

Object

Name	Type	Description
id	string	The Id of role
name	string	The name of role
properties	MetadataRoleProperties
type	string	The type of role

MetadataRoleList

Object

List of Metadata roles

Name	Type	Description
nextLink	string
values	MetadataRole[]

MetadataRoleProperties

Object

Name	Type	Description
cnfCondition	AttributeMatcher[]	The cnf Condition for a rule
description	string	The description of role
dnfCondition	AttributeMatcher[]	The dnf Condition for a rule
friendlyName	string	The friendly name of role
provisioningState	string	The provisioningState of role
roleType	string	The type of role
version	integer (int64)	The version of role