你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Discovery - Navigation

参考

服务:: Purview

API 版本:: 2024-03-01-preview

按 itemPath 导航实体。

POST {endpoint}/datamap/api/navigate?api-version=2024-03-01-preview

具有可选参数:

POST {endpoint}/datamap/api/navigate?maxpagesize={maxpagesize}&continuationToken={continuationToken}&api-version=2024-03-01-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string
api-version	query	True	string minLength: 1	用于此作的 API 版本。
continuationToken	query		string	若要实现分页结果，请使用从导航结果接收的下一个 continuationToken 调用 API 以检索后续页面。
maxpagesize	query		integer (int32)	页面大小 - 默认情况下，值为 100。最大值为 10000。

请求正文

名称	必需	类型	说明
itemPath	True	ItemPath	导航请求的标识符。
includeNextLevelAssetCount		boolean	是否返回下一级资产计数。
navigationMode		NavigationMode	导航模式。
properties		object	项的其他属性。

响应

名称	类型	说明
200 OK	NavigationResult	还行。成功获取实体时。
Other Status Codes	AtlasErrorResponse	描述操作失败的原因的错误响应。标头 x-ms-error-code: string

名称

类型

说明

200 OK

NavigationResult

还行。成功获取实体时。

Other Status Codes

AtlasErrorResponse

描述操作失败的原因的错误响应。

标头

x-ms-error-code: string

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
https://purview.azure.net/.default

示例

Step 1 Discovery Navigate from root

Step 2 Discovery Navigate with specific source type

Step 3 Discovery Navigate from server

Step 4 Discovery Navigate from databases category

Step 5 Discovery Navigate from database

Step 6 Discovery Navigate from schemas category

Step 7 Discovery Navigate from schema

Step 8 Discovery Navigate from tables category

Step 1 Discovery Navigate from root

示例请求

HTTP

POST {endpoint}/datamap/api/navigate?maxpagesize=100&continuationToken=<token>&api-version=2024-03-01-preview

{
  "navigationMode": "assetType",
  "itemPath": {
    "path": "/",
    "extendedProperties": {}
  },
  "includeNextLevelAssetCount": true,
  "properties": {}
}

示例响应

状态代码:: 200

{
  "items": [
    {
      "name": "azure_blob_service",
      "type": "Azure Blob Storage",
      "isLeafNode": false,
      "isEntity": false,
      "itemPath": {
        "path": "azure_blob_service",
        "extendedProperties": {}
      },
      "properties": {
        "cloudType": "Azure"
      },
      "count": 54
    },
    {
      "name": "azure_datalake_gen2_service",
      "type": "Azure Data Lake Storage Gen2",
      "isLeafNode": false,
      "isEntity": false,
      "itemPath": {
        "path": "azure_datalake_gen2_service",
        "extendedProperties": {}
      },
      "properties": {
        "cloudType": "Azure"
      },
      "count": 47
    },
    {
      "name": "azure_sql_server",
      "type": "Azure SQL Server",
      "isLeafNode": false,
      "isEntity": false,
      "itemPath": {
        "path": "azure_sql_server",
        "extendedProperties": {}
      },
      "properties": {
        "cloudType": "Azure"
      },
      "count": 31
    },
    {
      "name": "azure_storage_account",
      "type": "Azure Storage Account",
      "isLeafNode": false,
      "isEntity": false,
      "itemPath": {
        "path": "azure_storage_account",
        "extendedProperties": {}
      },
      "properties": {
        "cloudType": "Azure"
      },
      "count": 101
    },
    {
      "name": "azure_sql_db",
      "type": "Azure SQL Database",
      "isLeafNode": false,
      "isEntity": false,
      "itemPath": {
        "path": "azure_sql_db",
        "extendedProperties": {}
      },
      "properties": {
        "cloudType": "Azure"
      },
      "count": 84
    }
  ]
}

Step 2 Discovery Navigate with specific source type

示例请求

HTTP

POST {endpoint}/datamap/api/navigate?maxpagesize=100&continuationToken=<token>&api-version=2024-03-01-preview

{
  "navigationMode": "assetType",
  "itemPath": {
    "path": "/azure_sql_server",
    "extendedProperties": {}
  },
  "properties": {}
}

示例响应

状态代码:: 200

{
  "items": [
    {
      "name": "testsqlserver01",
      "type": "azure_sql_server",
      "isLeafNode": false,
      "isEntity": true,
      "itemPath": {
        "path": "testsqlserver01",
        "extendedProperties": {
          "resourceGroup": "test-rg",
          "serverEndpoint": "testsqlserver01.database.windows.net",
          "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
        }
      },
      "properties": {
        "identifier": "mssql://testsqlserver01.database.windows.net",
        "resourceId": "/subscriptions/12345678-1234-5678-1234-86b7251e0353/resourceGroups/test-rg/providers/Microsoft.Sql/servers/testsqlserver01",
        "cloudType": "Azure"
      }
    },
    {
      "name": "testsqlserver02",
      "type": "azure_sql_server",
      "isLeafNode": false,
      "isEntity": true,
      "itemPath": {
        "path": "testsqlserver02",
        "extendedProperties": {
          "resourceGroup": "test-rg",
          "serverEndpoint": "testsqlserver02.database.windows.net",
          "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
        }
      },
      "properties": {
        "identifier": "mssql://testsqlserver02.database.windows.net",
        "resourceId": "/subscriptions/12345678-1234-5678-1234-86b7251e0353/resourceGroups/test-rg/providers/Microsoft.Sql/servers/testsqlserver02",
        "cloudType": "Azure"
      }
    }
  ]
}

Step 3 Discovery Navigate from server

示例请求

HTTP

POST {endpoint}/datamap/api/navigate?maxpagesize=100&continuationToken=<token>&api-version=2024-03-01-preview

{
  "navigationMode": "assetType",
  "itemPath": {
    "path": "/azure_sql_server/testsqlserver01",
    "extendedProperties": {
      "resourceGroup": "test-rg",
      "serverEndpoint": "testsqlserver01.database.windows.net",
      "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
    }
  },
  "properties": {}
}

示例响应

状态代码:: 200

{
  "items": [
    {
      "properties": {},
      "name": "databases",
      "type": "databases",
      "isLeafNode": false,
      "isEntity": false,
      "itemPath": {
        "path": "databases",
        "extendedProperties": {
          "resourceGroup": "test-rg",
          "serverEndpoint": "testsqlserver01.database.windows.net",
          "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
        }
      }
    },
    {
      "properties": {},
      "name": "datawarehouses",
      "type": "datawarehouses",
      "isLeafNode": false,
      "isEntity": false,
      "itemPath": {
        "path": "datawarehouses",
        "extendedProperties": {
          "resourceGroup": "test-rg",
          "serverEndpoint": "testsqlserver01.database.windows.net",
          "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
        }
      }
    }
  ]
}

Step 4 Discovery Navigate from databases category

示例请求

HTTP

POST {endpoint}/datamap/api/navigate?maxpagesize=100&continuationToken=<token>&api-version=2024-03-01-preview

{
  "navigationMode": "assetType",
  "itemPath": {
    "path": "/azure_sql_server/testsqlserver01/databases",
    "extendedProperties": {
      "resourceGroup": "test-rg",
      "serverEndpoint": "testsqlserver01.database.windows.net",
      "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
    }
  },
  "properties": {}
}

示例响应

状态代码:: 200

{
  "items": [
    {
      "name": "exampleDatabase01",
      "type": "azure_sql_db",
      "isLeafNode": false,
      "isEntity": true,
      "itemPath": {
        "path": "exampleDatabase01",
        "extendedProperties": {
          "resourceGroup": "test-rg",
          "serverEndpoint": "testsqlserver01.database.windows.net",
          "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
        }
      },
      "properties": {
        "resourceId": "/subscriptions/12345678-1234-5678-1234-86b7251e0353/resourceGroups/test-rg/providers/Microsoft.Sql/servers/testsqlserver01/databases/exampleDatabase01"
      }
    },
    {
      "name": "exampleDatabase02",
      "type": "azure_sql_db",
      "isLeafNode": false,
      "isEntity": true,
      "itemPath": {
        "path": "exampleDatabase02",
        "extendedProperties": {
          "resourceGroup": "test-rg",
          "serverEndpoint": "testsqlserver01.database.windows.net",
          "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
        }
      },
      "properties": {
        "resourceId": "/subscriptions/12345678-1234-5678-1234-86b7251e0353/resourceGroups/test-rg/providers/Microsoft.Sql/servers/testsqlserver01/databases/exampleDatabase02"
      }
    }
  ]
}

Step 5 Discovery Navigate from database

示例请求

HTTP

POST {endpoint}/datamap/api/navigate?maxpagesize=100&continuationToken=<token>&api-version=2024-03-01-preview

{
  "navigationMode": "assetType",
  "itemPath": {
    "path": "/azure_sql_server/testsqlserver01/databases/exampleDatabase01",
    "extendedProperties": {
      "resourceGroup": "test-rg",
      "serverEndpoint": "testsqlserver01.database.windows.net",
      "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
    }
  },
  "properties": {}
}

示例响应

状态代码:: 200

{
  "items": [
    {
      "properties": {},
      "name": "schemas",
      "type": "schemas",
      "isLeafNode": false,
      "isEntity": false,
      "itemPath": {
        "path": "schemas",
        "extendedProperties": {
          "resourceGroup": "test-rg",
          "serverEndpoint": "testsqlserver01.database.windows.net",
          "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
        }
      }
    }
  ]
}

Step 6 Discovery Navigate from schemas category

示例请求

HTTP

POST {endpoint}/datamap/api/navigate?maxpagesize=100&continuationToken=<token>&api-version=2024-03-01-preview

{
  "navigationMode": "assetType",
  "itemPath": {
    "path": "/azure_sql_server/testsqlserver01/databases/schemas",
    "extendedProperties": {
      "resourceGroup": "test-rg",
      "serverEndpoint": "testsqlserver01.database.windows.net",
      "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
    }
  },
  "properties": {}
}

示例响应

状态代码:: 200

{
  "items": [
    {
      "name": "schema01",
      "type": "azure_sql_schema",
      "isLeafNode": false,
      "isEntity": true,
      "itemPath": {
        "path": "schema01",
        "extendedProperties": {
          "resourceGroup": "test-rg",
          "serverEndpoint": "testsqlserver01.database.windows.net",
          "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
        }
      },
      "properties": {
        "resourceId": "/subscriptions/12345678-1234-5678-1234-86b7251e0353/resourceGroups/test-rg/providers/Microsoft.Sql/servers/testsqlserver01/databases/exampleDatabase01/schemas/schema01"
      }
    },
    {
      "name": "schema02",
      "type": "azure_sql_schema",
      "isLeafNode": false,
      "isEntity": true,
      "itemPath": {
        "path": "schema02",
        "extendedProperties": {
          "resourceGroup": "test-rg",
          "serverEndpoint": "testsqlserver01.database.windows.net",
          "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
        }
      },
      "properties": {
        "resourceId": "/subscriptions/12345678-1234-5678-1234-86b7251e0353/resourceGroups/test-rg/providers/Microsoft.Sql/servers/testsqlserver01/databases/exampleDatabase01/schemas/schema02"
      }
    }
  ]
}

Step 7 Discovery Navigate from schema

示例请求

HTTP

POST {endpoint}/datamap/api/navigate?maxpagesize=100&continuationToken=<token>&api-version=2024-03-01-preview

{
  "navigationMode": "assetType",
  "itemPath": {
    "path": "/azure_sql_server/testsqlserver01/databases/exampleDatabase01/schemas/schema01",
    "extendedProperties": {
      "resourceGroup": "test-rg",
      "serverEndpoint": "testsqlserver01.database.windows.net",
      "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
    }
  },
  "properties": {}
}

示例响应

状态代码:: 200

{
  "items": [
    {
      "properties": {},
      "name": "tables",
      "type": "tables",
      "isLeafNode": false,
      "isEntity": false,
      "itemPath": {
        "path": "tables",
        "extendedProperties": {
          "resourceGroup": "test-rg",
          "serverEndpoint": "testsqlserver01.database.windows.net",
          "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
        }
      }
    },
    {
      "properties": {},
      "name": "views",
      "type": "views",
      "isLeafNode": false,
      "isEntity": false,
      "itemPath": {
        "path": "views",
        "extendedProperties": {
          "resourceGroup": "test-rg",
          "serverEndpoint": "testsqlserver01.database.windows.net",
          "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
        }
      }
    },
    {
      "properties": {},
      "name": "stored_procedures",
      "type": "stored_procedures",
      "isLeafNode": false,
      "isEntity": false,
      "itemPath": {
        "path": "stored_procedures",
        "extendedProperties": {
          "resourceGroup": "test-rg",
          "serverEndpoint": "testsqlserver01.database.windows.net",
          "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
        }
      }
    }
  ]
}

Step 8 Discovery Navigate from tables category

示例请求

HTTP

POST {endpoint}/datamap/api/navigate?maxpagesize=100&continuationToken=<token>&api-version=2024-03-01-preview

{
  "navigationMode": "assetType",
  "itemPath": {
    "path": "/azure_sql_server/testsqlserver01/databases/schemas/schema01/tables",
    "extendedProperties": {
      "resourceGroup": "test-rg",
      "serverEndpoint": "testsqlserver01.database.windows.net",
      "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
    }
  },
  "properties": {}
}

示例响应

状态代码:: 200

{
  "items": [
    {
      "name": "table01",
      "type": "azure_sql_table",
      "isLeafNode": true,
      "isEntity": true,
      "itemPath": {
        "path": "table01",
        "extendedProperties": {
          "resourceGroup": "test-rg",
          "serverEndpoint": "testsqlserver01.database.windows.net",
          "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
        }
      },
      "properties": {
        "resourceId": "/subscriptions/12345678-1234-5678-1234-86b7251e0353/resourceGroups/test-rg/providers/Microsoft.Sql/servers/testsqlserver01/databases/exampleDatabase01/schemas/schema01/tables/table01"
      }
    },
    {
      "name": "table02",
      "type": "azure_sql_table",
      "isLeafNode": true,
      "isEntity": true,
      "itemPath": {
        "path": "table02",
        "extendedProperties": {
          "resourceGroup": "test-rg",
          "serverEndpoint": "testsqlserver01.database.windows.net",
          "subscriptionId": "12345678-1234-5678-1234-86b7251e0353"
        }
      },
      "properties": {
        "resourceId": "/subscriptions/12345678-1234-5678-1234-86b7251e0353/resourceGroups/test-rg/providers/Microsoft.Sql/servers/testsqlserver01/databases/exampleDatabase01/schemas/schema01/tables/table02"
      }
    }
  ]
}

定义

名称	说明
AtlasErrorResponse	来自服务的错误响应
ItemPath	导航请求的标识符。
NavigationItem	NavigationResult 的项有效负载。
NavigationMode	导航模式。
NavigationRequest	导航 API 的请求有效负载。
NavigationResult	导航 API 的响应有效负载。

AtlasErrorResponse

Object

来自服务的错误响应

名称	类型	说明
errorCode	string	错误代码。
errorMessage	string	错误消息。
requestId	string (uuid)	请求 ID。

ItemPath

Object

导航请求的标识符。

名称	类型	说明
extendedProperties	object	itemPath 的扩展属性通常从最后一个导航响应中获取。虽然不强制提供，但包括它们可以提高性能。否则，可能会对性能产生一些影响。
path	string	物料的标识符。路径以空字符串或单个斜杠开头。若要进一步导航，需要使用上一个导航响应的相对项路径与斜杠连接，形成完整的 itemPath。

NavigationItem

Object

NavigationResult 的项有效负载。

名称	类型	说明
count	integer (int32)	顶级资产的计数。如果请求有效负载“includeNextLevelAssetCount”为 false，则不会返回。
isEntity	boolean	该项是否为 Entity。如果是，则可以获取给定其 itemPath 的实体的完整定义
isLeafNode	boolean	指示该项是否为叶节点。如果是，则无法进一步导航。
itemPath	ItemPath	导航请求的标识符。
name	string	项的名称。
properties	object	导航元素的其他属性。
type	string	项的类型名称。例如 EntityType。

NavigationMode

枚举

导航模式。

值	说明
assetType
azureResourceHierarchy

NavigationRequest

Object

导航 API 的请求有效负载。

名称	类型	说明
includeNextLevelAssetCount	boolean	是否返回下一级资产计数。
itemPath	ItemPath	导航请求的标识符。
navigationMode	NavigationMode	导航模式。
properties	object	项的其他属性。

NavigationResult

Object

导航 API 的响应有效负载。

名称	类型	说明
continuationToken	string	用于获取下一批数据的令牌。如果没有更多数据，则不存在。
items	NavigationItem[]	NavigationResult 的项有效负载。

通过

Discovery - Navigation

URI 参数

请求正文

响应

安全性

OAuth2Auth

作用域

示例

Step 1 Discovery Navigate from root

示例请求

示例响应

Step 2 Discovery Navigate with specific source type

示例请求

示例响应

Step 3 Discovery Navigate from server

示例请求

示例响应

Step 4 Discovery Navigate from databases category

示例请求

示例响应

Step 5 Discovery Navigate from database

示例请求

示例响应

Step 6 Discovery Navigate from schemas category

示例请求

示例响应

Step 7 Discovery Navigate from schema

示例请求

示例响应

Step 8 Discovery Navigate from tables category

示例请求

示例响应

定义

AtlasErrorResponse

ItemPath

NavigationItem

NavigationMode

NavigationRequest

NavigationResult