次の方法で共有


Collections - Get Collection

1 つのコレクションを取得する

GET {endpoint}/collections/{collectionName}?api-version=2019-11-01-preview

URI パラメーター

名前 / 必須 説明
collectionName
path True

string

endpoint
path True

string

Purview アカウントのアカウント エンドポイント。 例: https://{accountName}.purview.azure.com/account/

api-version
query True

string

使用する API バージョン。

応答

名前 説明
200 OK

Collection

Success

Other Status Codes

ErrorResponseModel

プロバイダーから受信したエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

Collections_GetCollection

要求のサンプル

GET {endpoint}/collections/myCollection1?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
{
  "name": "mycollection1",
  "friendlyName": "Finance",
  "parentCollection": {
    "type": "CollectionReference",
    "referenceName": "accountName"
  },
  "collectionProvisioningState": "Succeeded"
}

定義

名前 説明
Collection

コレクション リソース。

collectionProvisioningState

プロビジョニングの状態を取得します。

CollectionReference

コレクションへの参照。

createdByType

リソースを作成した ID の種類。

Error

エラーを取得または設定します。

ErrorModel

既定のエラー モデル

ErrorResponseModel

既定のエラー応答モデル

lastModifiedByType

リソースを最後に変更した ID の種類。

SystemData

リソースの作成と最後の変更に関連するメタデータ。

Collection

コレクション リソース。

名前 説明
collectionProvisioningState

collectionProvisioningState

プロビジョニングの状態を取得します。

description

string

説明を取得または設定します。

friendlyName

string

コレクションのフレンドリ名を取得または設定します。

name

string

名前を取得します。

parentCollection

CollectionReference

親コレクション参照を取得または設定します。

systemData

SystemData

リソースの作成と最後の変更に関連するメタデータ。

collectionProvisioningState

プロビジョニングの状態を取得します。

名前 説明
Creating

string

Deleting

string

Failed

string

Moving

string

Succeeded

string

Unknown

string

CollectionReference

コレクションへの参照。

名前 説明
referenceName

string

参照名を取得または設定します。

type

string

参照型プロパティを取得または設定します。

createdByType

リソースを作成した ID の種類。

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

Error

エラーを取得または設定します。

名前 説明
code

string

コードを取得または設定します。

details

ErrorModel[]

詳細を取得または設定します。

message

string

メッセージを取得または設定します。

target

string

ターゲットを取得または設定します。

ErrorModel

既定のエラー モデル

名前 説明
code

string

コードを取得または設定します。

details

ErrorModel[]

詳細を取得または設定します。

message

string

メッセージを取得または設定します。

target

string

ターゲットを取得または設定します。

ErrorResponseModel

既定のエラー応答モデル

名前 説明
error

Error

エラーを取得または設定します。

lastModifiedByType

リソースを最後に変更した ID の種類。

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

SystemData

リソースの作成と最後の変更に関連するメタデータ。

名前 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。

createdBy

string

リソースを作成した ID。

createdByType

createdByType

リソースを作成した ID の種類。

lastModifiedAt

string

リソースの最後の変更のタイムスタンプ (UTC)。

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

lastModifiedByType

リソースを最後に変更した ID の種類。