Microsoft.Purview (preview:2023-06-01)

2025/08/29 • 2 new, 2 deleted methods

PurviewPolicies_List (new)
Description :  The API lists the Azure purview RBAC policies affecting the scope. The scope can be any valid ARM resource id
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Purview/policies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the operation is performed. ,
Required: True ,
}
string ,
skipToken:
{
Description: Paging key to paginate to next page. ,
Required: False ,
}
string ,
$filter:
{
Description: Supported filters : $filter=policyType eq SelfService, $filter=policyType eq SqlDevops. Returns only the policies of the specified type. If not specified, all policies are returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Policy items on this page ,
Required: True ,
}
[
{
kind:
{
Description: The policy kind ,
Required: False ,
}
string ,
source:
{
Description: The policy source ,
Required: True ,
}
string ,
etag:
{
Description: The etag version of a policy ,
Required: True ,
}
string ,
scopes:
{
Description: Array of scopes where the policy is published ,
Required: True ,
}
[
string ,
]
,
members:
{
Description: Members of the policy ,
Required: True ,
}
{
fabricItemMembers:
{
Description: Array of azure active directory members ,
Required: False ,
}
[
{
sourcePath:
{
Description: Source path of the member ,
Required: False ,
}
string ,
itemAccess:
{
Description: Array of access items for the member ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aadMembers:
{
Description: Array of azure active directory members ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenantId of the member ,
Required: False ,
}
string ,
objectId:
{
Description: The objectId of the member ,
Required: False ,
}
string ,
objectType:
{
Description: The objectType of the member. ,
Enum:
{
User: AAD User object type. ,
Group: AAD Group object type. ,
ServicePrincipal: Service Principal object type. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
decisionRules:
{
Description: Array of decision rules for the policy ,
Required: True ,
}
[
{
effect:
{
Description: The effect for rule ,
Enum:
{
Permit: Access permitted ,
Deny: Access denied ,
}
,
Required: True ,
}
enum ,
permission:
{
Description: Array of attribute predicates ,
Required: False ,
}
[
{
attributeName:
{
Description: AttributeName of a policy permission ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: values for a policy permission ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
expiryTime:
{
Description: The timestamp of the expiry time of the policy (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
requestor:
{
Description: The AAD member who requested the policy ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Purview/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PurviewPolicies_List (removed)
Description :  The API lists the Azure purview RBAC policies affecting the scope. The scope can be any valid ARM resource id
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Purview/policies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the operation is performed. ,
Required: True ,
}
string ,
skipToken:
{
Description: Paging key to paginate to next page. ,
Required: False ,
}
string ,
$filter:
{
Description: Supported filters : $filter=policyType eq SelfService, $filter=policyType eq SqlDevops. Returns only the policies of the specified type. If not specified, all policies are returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Policy items on this page ,
Required: True ,
}
[
{
kind:
{
Description: The policy kind ,
Required: False ,
}
string ,
source:
{
Description: The policy source ,
Required: True ,
}
string ,
etag:
{
Description: The etag version of a policy ,
Required: True ,
}
string ,
scopes:
{
Description: Array of scopes where the policy is published ,
Required: True ,
}
[
string ,
]
,
members:
{
Description: Members of the policy ,
Required: True ,
}
{
fabricItemMembers:
{
Description: Array of azure active directory members ,
Required: False ,
}
[
{
sourcePath:
{
Description: Source path of the member ,
Required: False ,
}
string ,
itemAccess:
{
Description: Array of access items for the member ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aadMembers:
{
Description: Array of azure active directory members ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenantId of the member ,
Required: False ,
}
string ,
objectId:
{
Description: The objectId of the member ,
Required: False ,
}
string ,
objectType:
{
Description: The objectType of the member. ,
Enum:
{
User: AAD User object type. ,
Group: AAD Group object type. ,
ServicePrincipal: Service Principal object type. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
decisionRules:
{
Description: Array of decision rules for the policy ,
Required: True ,
}
[
{
effect:
{
Description: The effect for rule ,
Enum:
{
Permit: Access permitted ,
Deny: Access denied ,
}
,
Required: True ,
}
enum ,
permission:
{
Description: Array of attribute predicates ,
Required: False ,
}
[
{
attributeName:
{
Description: AttributeName of a policy permission ,
Required: False ,
}
string ,
attributeValueIncludedIn:
{
Description: values for a policy permission ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
expiryTime:
{
Description: The timestamp of the expiry time of the policy (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
requestor:
{
Description: The AAD member who requested the policy ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Purview/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}