Purview Distribution Service REST API Document (preview:2022-11-01)

2025/12/05 • 3 new methods

DatasourcePreferences_Get (new)
Description :  Get Datasource Preferences for a given scope.
Reference :  Link ¶

⚼ Request

GET:  /datasource-preferences
{
scope:
{
Description: Scope. ,
Required: True ,
}
string ,
isProjectGondor:
{
Description: Is call from a Gondor client. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The api-version of the service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
consent:
{
Description: Consent information related to a resource. ,
Required: False ,
}
{
properties:
{
Description: Consent properties. ,
Required: False ,
}
{
scanner:
{
Description: Represents the collection of consent information for scanning service. ,
Required: False ,
}
{
metadata:
{
Description: Consent for metadata discovery. ,
Required: False ,
}
boolean ,
classification:
{
Description: Consent for classification discovery. ,
Required: False ,
}
boolean ,
}
,
dataUseGovernance:
{
Description: Consent for data use governance. ,
Required: False ,
}
boolean ,
}
,
excludedScopes:
{
Description: Child scopes that need to be excluded (optional). ,
Required: False ,
}
[
string ,
]
,
}
,
accountInfo:
{
Description: Represents a purview account. ,
Required: False ,
}
{
id:
{
Description: Id of the purview account. ,
Required: False ,
}
string ,
name:
{
Description: Name of the purview account. ,
Required: False ,
}
string ,
location:
{
Description: Region where purview account is created. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant id of the purview account. ,
Required: False ,
}
string ,
gatewayEndpoint:
{
Description: Purview account gateway endpoint. ,
Required: False ,
}
string ,
}
,
frequency:
{
Description: This represents the frequency at which the RPs will check for consent information. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error model. ,
Required: True ,
}
{
code:
{
Description: Service error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Detailed error message. ,
Required: False ,
}
string ,
details:
{
Description: Granular errors (if any). ,
Required: False ,
}
[
string ,
]
,
}
,
}
PolicyElements_List (new)
Description :  Get policies for given scope.
Reference :  Link ¶

⚼ Request

GET:  /policy-elements
{
scope:
{
Description: Scope. ,
Required: True ,
}
string ,
api-version:
{
Description: The API Version. ,
Required: True ,
}
string ,
filter:
{
Description: Optional value to filter policies based on hierarchy of resources. It is of type enum with possible values: AtScope, ChildrenScope, None, All ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
count:
{
Description: Count of elements in payload. ,
Format: int32 ,
Required: False ,
}
integer ,
syncToken:
{
Description: Sync token represents the checkpoint upto which this policy elements list is updated. Client need to pass this value while fetching records using policyEvents API. ,
Required: False ,
}
string ,
elements:
{
Description: List of policy elements. ,
Required: False ,
}
[
{
id:
{
Description: Id of the policy element. ,
Required: False ,
}
string ,
scopes:
{
Description: List of scopes included in this policy. ,
Required: False ,
}
[
string ,
]
,
kind:
{
Description: Kind of policy element. Possible values: policy/policySet/attributeRule. ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time at which this policy element is last updated. ,
Required: False ,
}
string ,
version:
{
Description: Current version of policy element. This is auto incremented with each change. Starts with 1. ,
Format: int64 ,
Required: False ,
}
integer ,
elementJson:
{
Description: Policy element serialized json payload. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link with skip token to fetch next set of records. This is used in case of pagination. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error model. ,
Required: True ,
}
{
code:
{
Description: Service error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Detailed error message. ,
Required: False ,
}
string ,
details:
{
Description: Granular errors (if any). ,
Required: False ,
}
[
string ,
]
,
}
,
}
PolicyEvents_List (new)
Description :  Get policy events for given scope.
Reference :  Link ¶

⚼ Request

GET:  /policy-events
{
scope:
{
Description: Scope. ,
Required: True ,
}
string ,
syncToken:
{
Description: The sync token. ,
Required: True ,
}
string ,
api-version:
{
Description: The api-version of the service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
count:
{
Description: Count of elements in payload. ,
Format: int32 ,
Required: False ,
}
integer ,
syncToken:
{
Description: Sync token represents the checkpoint upto which this policy elements list is updated. Client need to store this value and keep updating if PDS returns a new value. Call this API with the most recent value received. ,
Required: False ,
}
string ,
elements:
{
Description: List of created/updated policy elements. ,
Required: False ,
}
[
{
id:
{
Description: Id of the policy element. ,
Required: False ,
}
string ,
scopes:
{
Description: List of scopes included in this policy. ,
Required: False ,
}
[
string ,
]
,
kind:
{
Description: Kind of policy element. Possible values: policy/policySet/attributeRule. ,
Required: False ,
}
string ,
updatedAt:
{
Description: Time at which this policy element is last updated. ,
Required: False ,
}
string ,
version:
{
Description: Current version of policy element. This is auto incremented with each change. Starts with 1. ,
Format: int64 ,
Required: False ,
}
integer ,
elementJson:
{
Description: Policy element serialized json payload. ,
Required: False ,
}
string ,
eventType:
{
Description: Type of event. Format: //. For Example: Microsoft.Purview/PolicyElements/Delete. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (304)

{}

⚐ Response (default)

{
error:
{
Description: Represents the error model. ,
Required: True ,
}
{
code:
{
Description: Service error code. ,
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
target:
{
Description: Detailed error message. ,
Required: False ,
}
string ,
details:
{
Description: Granular errors (if any). ,
Required: False ,
}
[
string ,
]
,
}
,
}