Collections - Get Collection Path
コレクション パスを表す親名と親フレンドリ名チェーンを取得します。
GET {endpoint}/collections/{collectionName}/getCollectionPath?api-version=2019-11-01-preview
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
collection
|
path | True |
string |
|
|
endpoint
|
path | True |
string |
Purview アカウントのアカウント エンドポイント。 例: https://{accountName}.purview.azure.com/account/ |
|
api-version
|
query | True |
string |
使用する API バージョン。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
成功 |
|
| Other Status Codes |
プロバイダーから受信したエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
例
Collections_GetCollectionPath
要求のサンプル
GET {endpoint}/collections/myCollection1/getCollectionPath?api-version=2019-11-01-preview
応答のサンプル
Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
{
"parentNameChain": [
"account1",
"parent1"
],
"parentFriendlyNameChain": [
"Test account friendly name",
"parent1"
]
}
定義
| 名前 | 説明 |
|---|---|
|
Collection |
コレクション リソース。 |
| Error |
エラーを取得または設定します。 |
|
Error |
既定のエラー モデル |
|
Error |
既定のエラー応答モデル |
CollectionPathResponse
コレクション リソース。
| 名前 | 型 | 説明 |
|---|---|---|
| parentFriendlyNameChain |
string[] |
既定の (ルート) コレクションから始まり、直前の親で終わる先祖のフレンドリ名。 |
| parentNameChain |
string[] |
既定の (ルート) コレクションから始まり、直前の親で終わる先祖の名前。 |
Error
エラーを取得または設定します。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
コードを取得または設定します。 |
| details |
詳細を取得または設定します。 |
|
| message |
string |
メッセージを取得または設定します。 |
| target |
string |
ターゲットを取得または設定します。 |
ErrorModel
既定のエラー モデル
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
コードを取得または設定します。 |
| details |
詳細を取得または設定します。 |
|
| message |
string |
メッセージを取得または設定します。 |
| target |
string |
ターゲットを取得または設定します。 |
ErrorResponseModel
既定のエラー応答モデル
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラーを取得または設定します。 |