Microsoft Purview

https://learn.microsoft.com/en-us/purview/
Admin
Microsoft Purview is a comprehensive portfolio of products spanning data governance, data security,...
Tokens:2,265,284
Snippets:15,538
Trust Score:10
Update:5 hours ago
Show doc for...
Tokens:
Raw
### Get Lineage by GUID JSON response payload

Source: https://learn.microsoft.com/en-us/purview/data-gov-api-create-lineage-relationships

Example JSON response from the Get Lineage by GUID API showing lineage relationships for table2, including entity map, relations, and width counts.

```json
{
    "baseEntityGuid": "2a12b3ff-5816-4222-833a-035bf82e06e0",
    "lineageDirection": "BOTH",
    "lineageDepth": 3,
    "lineageWidth": -1,
    "childrenCount": -1,
    "guidEntityMap": {
        "16b93b78-8683-4f88-9651-24c4a9d797b0": {
            "typeName": "hive_table",
            "attributes": {
                "temporary": false,
                "lastAccessTime": 0,
                "createTime": 0,
                "qualifiedName": "test_lineage.table3",
                "name": "table3",
                "retention": 0
            },
            "lastModifiedTS": "1",
            "guid": "16b93b78-8683-4f88-9651-24c4a9d797b0",
            "status": "ACTIVE",
            "displayText": "table3",
            "classificationNames": [],
            "meaningNames": [],
            "meanings": [],
            "isIncomplete": false,
            "labels": [],
            "isIndexed": true
        },
        "cb22ba23-47a2-4149-ade6-e3d9642fe592": {
            "typeName": "hive_table",
            "attributes": {
                "temporary": false,
                "lastAccessTime": 0,
                "createTime": 0,
                "qualifiedName": "test_lineage.table1",
                "name": "table1",
                "retention": 0
            },
            "lastModifiedTS": "1",
            "guid": "cb22ba23-47a2-4149-ade6-e3d9642fe592",
            "status": "ACTIVE",
            "displayText": "table1",
            "classificationNames": [],
            "meaningNames": [],
            "meanings": [],
            "isIncomplete": false,
            "labels": [],
            "isIndexed": true
        },
        "bbeacce6-5bde-46f7-8fe4-689cbb36ba51": {
            "typeName": "hive_view_query",
            "attributes": {
                "qualifiedName": "test_lineage.HiveQuery1",
                "name": "HiveQuery1",
                "columnMapping": "[{\"DatasetMapping\":{\"Source\":\"test_lineage.table1\",\"Sink\":\"test_lineage.table2\"},\"ColumnMapping\":[{\"Source\":\"column1\",\"Sink\":\"column1\"},{\"Source\":\"column2\",\"Sink\":\"column2\"}]}]"
            },
            "lastModifiedTS": "1",
            "guid": "bbeacce6-5bde-46f7-8fe4-689cbb36ba51",
            "status": "ACTIVE",
            "displayText": "HiveQuery1",
            "classificationNames": [],
            "meaningNames": [],
            "meanings": [],
            "isIncomplete": false,
            "labels": [],
            "isIndexed": true
        },
        "2a12b3ff-5816-4222-833a-035bf82e06e0": {
            "typeName": "hive_table",
            "attributes": {
                "temporary": false,
                "lastAccessTime": 0,
                "createTime": 0,
                "qualifiedName": "test_lineage.table2",
                "name": "table2",
                "retention": 0
            },
            "lastModifiedTS": "1",
            "guid": "2a12b3ff-5816-4222-833a-035bf82e06e0",
            "status": "ACTIVE",
            "displayText": "table2",
            "classificationNames": [],
            "meaningNames": [],
            "meanings": [],
            "isIncomplete": false,
            "labels": [],
            "isIndexed": true
        }
    },
    "includeParent": false,
    "relations": [
        {
            "fromEntityId": "2a12b3ff-5816-4222-833a-035bf82e06e0",
            "toEntityId": "16b93b78-8683-4f88-9651-24c4a9d797b0",
            "relationshipId": "23df8e3e-b066-40b2-be29-9fd90693c51b",
            "columnMapping": "[{\"Source\":\"column1\",\"Sink\":\"column1\"},{\"Source\":\"column2\",\"Sink\":\"column2\"}]"
        },
        {
            "fromEntityId": "bbeacce6-5bde-46f7-8fe4-689cbb36ba51",
            "toEntityId": "2a12b3ff-5816-4222-833a-035bf82e06e0",
            "relationshipId": "5fe8d378-39cd-4c6b-8ced-91b0152d3014"
        },
        {
            "fromEntityId": "cb22ba23-47a2-4149-ade6-e3d9642fe592",
            "toEntityId": "bbeacce6-5bde-46f7-8fe4-689cbb36ba51",
            "relationshipId": "73e084bf-98a3-45fb-a1e4-c56cc40661b8"
        }
    ],
    "parentRelations": [],
    "widthCounts": {
        "INPUT": {
            "cb22ba23-47a2-4149-ade6-e3d9642fe592": 0,
            "bbeacce6-5bde-46f7-8fe4-689cbb36ba51": 1,
            "2a12b3ff-5816-4222-833a-035bf82e06e0": 1
        },
        "OUTPUT": {
            "16b93b78-8683-4f88-9651-24c4a9d797b0": 0,
            "2a12b3ff-5816-4222-833a-035bf82e06e0": 1
        }
    }
}
```

--------------------------------

### Verify Ksetup configuration

Source: https://learn.microsoft.com/en-us/purview/register-scan-hdfs

Run the Ksetup command to verify the configuration. The output should be similar to the example shown.

```bash
C:> Ksetup
default realm = REALM.COM (external)
REALM.com:
    kdc = <your_kdc_server_address>
```

--------------------------------

### IRCTL Create Command Output

Source: https://learn.microsoft.com/en-us/purview/data-map-integration-runtime-kubernetes

Expected printout after running the create command. It shows environment validation, registration, and provisioning steps; provisioning may take about 5-30 minutes. If interrupted by Ctrl-C, use `./irctl install status` to monitor progress.

```text
[Info] Start to create SHIR with Kubernetes context [your-context]......
[Info] Environment validation passed!
[Info] Registering SHIR[example-k8s-shir] for Microsoft Purview Account [yourpurviewaccount]......
[Info] SHIR Registration done!
[Info] Provisioning SHIR, it may take about 5-30 minutes......done!
[Info] SHIR creation succeeded!  
```

--------------------------------

### Example API URL with policy ID

Source: https://learn.microsoft.com/en-us/purview/legacy/tutorial-metadata-policy-collections-apis

Example of the API URL after replacing {policyId} with the policy GUID 'aaaabbbb-0000-cccc-1111-dddd2222eeee' from the 'Get All Metadata Policies' output.

```http
https://{your_purview_account_name}.purview.azure.com/policystore/metadataPolicies/aaaabbbb-0000-cccc-1111-dddd2222eeee?api-version=2021-07-01
```

--------------------------------

### View Onboarding Request Output with $request

Source: https://learn.microsoft.com/en-us/purview/customer-key-set-up

After signing in, run the variable to display output including ID, CreatedDate, ValidationResult, and EnablementResult. Success in both fields indicates the tenant is ready for Customer Key.

```powershell
$request
```

--------------------------------

### Mailbox Diagnostics Log Example Output

Source: https://learn.microsoft.com/en-us/purview/edisc-hold-types-mailboxes

Example output from Export-MailboxDiagnosticLogs for HoldTracking or SubstrateHoldTracking. Fields: ed (end date), hid (policy GUID), ht (hold type), lsd (last start date), osd (original start date).

```text
ed : 0001-01-01T00:00:00.0000000 hid : mbx7cfb30345d454ac0a989ab3041051209:1 ht : 4 lsd : 2020-03-23T18:24:37.1884606Z osd : 2020-03-23T18:24:37.1884606Z
```

--------------------------------

### List onboarding requests with Get-CustomerKeyOnboardingRequest

Source: https://learn.microsoft.com/en-us/purview/customer-key-set-up

Lists all onboarding requests for your tenant to find the RequestID of the one you want to investigate. Replace <OrganizationID> with your organization's ID.

```powershell
Get-CustomerKeyOnboardingRequest -OrganizationID <OrganizationID>
```

--------------------------------

### Get Lineage by GUID REST API request

Source: https://learn.microsoft.com/en-us/purview/data-gov-api-create-lineage-relationships

Use the Get Lineage by GUID API to retrieve lineage for a specific entity (table2) in both directions. Replace {{endpoint}} with your Purview endpoint and {{guid_of_table2}} with the GUID of table2.

```http
GET {{endpoint}}/api/atlas/v2/lineage/{{guid_of_table2}}?direction=BOTH
```

--------------------------------

### Deploy main.bicep with Azure CLI

Source: https://learn.microsoft.com/en-us/purview/legacy/quickstart-bicep-create-microsoft-purview

Creates a resource group named exampleRG in eastus and deploys the main.bicep template. Prompts for the Purview name during deployment.

```bash
az group create --name exampleRG --location eastus
az deployment group create --resource-group exampleRG --template-file main.bicep

```

--------------------------------

### Remove-InformationBarrierPolicy - Remove policy (example)

Source: https://learn.microsoft.com/en-us/purview/information-barriers-edit-segments-policies

Example that removes the policy with GUID 43c37853-ea10-4b90-a23d-ab8c93772471. You will be prompted to confirm the change.

```powershell
Remove-InformationBarrierPolicy -Identity 43c37853-ea10-4b90-a23d-ab8c93772471
```
Tokens:
Raw