Devops Policy - List

Service:

Purview

API Version:

2022-11-01-preview

List all devops policies.

GET {endpoint}/policyStore/devops-policies?api-version=2022-11-01-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string url	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	DevopsPolicyList	Success
Other Status Codes	ErrorResponseModel	An error response received from the 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

DevopsPolicy_List

Sample Request

HTTP

GET {endpoint}/policyStore/devops-policies?api-version=2022-11-01-preview

Sample Response

Status code:

200

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

Response Body

{
  "value": [
    {
      "systemData": {
        "createdBy": "5b3a30f8-dee3-4a5e-bf48-feddbdf174b98",
        "createdAt": "2022-10-14T08:24:50.6175582Z",
        "lastModifiedBy": "5b3a30f8-dee3-4a5e-bf48-feddbdf174b98",
        "lastModifiedAt": "2022-10-14T08:30:49.7127313Z"
      },
      "decisionRules": [
        {
          "effect": "Permit",
          "purviewRoleName": "purviewdatarole_builtin_sqlperfmonitor",
          "principals": [
            "5b3a30f8-dee3-4a5e-bf48-feddbdf174b98"
          ],
          "principalGroups": [],
          "resourceAzurePath": "/subscriptions/56bb0a7b-861d-44b0-9220-9db0dd88e799/resourceGroups/test-rg/providers/Microsoft.Sql/servers/policytestserver/**"
        }
      ],
      "purviewResourceName": "policytestserver"
    },
    {
      "systemData": {
        "createdBy": "5b3a30f8-dee3-4a5e-bf48-feddbdf174b98",
        "createdAt": "2022-10-11T11:15:58.3236117Z",
        "lastModifiedBy": "5b3a30f8-dee3-4a5e-bf48-feddbdf174b98",
        "lastModifiedAt": "2022-10-11T11:15:58.3236117Z"
      },
      "decisionRules": [
        {
          "effect": "Permit",
          "purviewRoleName": "purviewdatarole_builtin_sqlperfmonitor",
          "principals": [
            "5b3a30f8-dee3-4a5e-bf48-feddbdf174b98"
          ],
          "principalGroups": [],
          "resourceAzurePath": "/subscriptions/56bb0a7b-861d-44b0-9220-9db0dd88eh98/resourceGroups/test-rg/providers/Microsoft.Sql/servers/abacprivtest/**"
        }
      ],
      "purviewResourceName": "rakhandu-abac1"
    },
    {
      "systemData": {
        "createdBy": "5b3a30f8-dee3-4a5e-bf48-feddbdf174b98",
        "createdAt": "2022-10-11T06:19:43.4482483Z",
        "lastModifiedBy": "5b3a30f8-dee3-4a5e-bf48-feddbdf174b98",
        "lastModifiedAt": "2022-10-11T06:19:43.4482483Z"
      },
      "decisionRules": [
        {
          "effect": "Permit",
          "purviewRoleName": "purviewdatarole_builtin_sqlperfmonitor",
          "principals": [
            "19f5b6ed-08da-431d-a037-745926083c72",
            "6b18058e-3b2d-401d-ad3e-e89c1ca0ed33"
          ],
          "principalGroups": [],
          "resourceAzurePath": "/subscriptions/34fb3b81-27ab-4690-9l0b-668896fd288c/resourceGroups/test-rg/providers/Microsoft.Sql/servers/abac-test-server01/**"
        }
      ],
      "purviewResourceName": "rakhandu-abac1"
    },
    {
      "systemData": {
        "createdBy": "5b3a30f8-dee3-4a5e-bf48-feddbdf174b98",
        "createdAt": "2022-10-07T15:07:48.9285444Z",
        "lastModifiedBy": "",
        "lastModifiedAt": "2022-10-10T05:23:10.1887404Z"
      },
      "decisionRules": [
        {
          "effect": "Permit",
          "purviewRoleName": "purviewdatarole_builtin_sqlperfmonitor",
          "principals": [
            "cfc450a7-20b1-4ef3-a751-470c5a61912d",
            "5b3a30f8-dee3-4a5e-bf48-feddbdf174b98"
          ],
          "principalGroups": [],
          "resourceAzurePath": "/subscriptions/56bb0a7b-8s1d-44b0-9220-9db0dd78e798/resourceGroups/test-rg/providers/Microsoft.Sql/servers/policytest/**"
        }
      ],
      "purviewResourceName": "policytest-server"
    }
  ]
}

Definitions

Name	Description
Decision	The effect for rule
DevopsPolicy
DevopsPolicyDecisionRule
DevopsPolicyList
ErrorModel	The error model for policy
ErrorResponseModel	The error response model for policy
SystemData

Decision

The effect for rule

Name	Type	Description
Permit	string

DevopsPolicy

Name	Type	Description
decisionRules	DevopsPolicyDecisionRule[]	Array of decisionRules for the policy
purviewResourceName	string	Purview resource name
systemData	SystemData

DevopsPolicyDecisionRule

Name	Type	Description
effect	Decision	The effect for rule
principalGroups	string[]	Azure Active Directory Ids for groups
principals	string[]	Azure Active Directory Ids for users
purviewRoleName	string	This is field will indicate the role of a devops policy.
resourceAzurePath	string	Optional resource path of the azure resource

DevopsPolicyList

Name	Type	Description
nextLink	string	Pagination link
value	DevopsPolicy[]	List of policies

ErrorModel

The error model for policy

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

ErrorResponseModel

The error response model for policy

Name	Type	Description
error	ErrorModel	The error model for policy

SystemData

Name	Type	Description
createdAt	string	Created at
createdBy	string	Created by
createdByType	string	Created by type
lastModifiedAt	string	last modified at
lastModifiedBy	string	last modified by
lastModifiedByType	string	last modified by type