Collections - List Collections

Dienst:

Purview

API-Version:

2019-11-01-preview

Listet die Sammlungen im Konto auf.

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

Mit optionalen Parametern:

GET {endpoint}/collections?api-version=2019-11-01-preview&$skipToken={$skipToken}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Der Kontoendpunkt Ihres Purview-Kontos. Beispiel: https://{accountName}.purview.azure.com/account/
api-version	query	True	string	Die zu verwendende API-Version.
$skipToken	query		string

Antworten

Name	Typ	Beschreibung
200 OK	CollectionList	Erfolg
Other Status Codes	ErrorResponseModel	Eine vom Anbieter empfangene Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Collections_ListCollections

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

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

{
  "value": [
    {
      "name": "mycollection1",
      "friendlyName": "Finance",
      "parentCollection": {
        "type": "CollectionReference",
        "referenceName": "accountName"
      },
      "collectionProvisioningState": "Succeeded"
    }
  ]
}

Definitionen

Name	Beschreibung
Collection	Sammlungsressource.
CollectionList	Ausgelagerte Liste von Sammlungen.
collectionProvisioningState	Ruft den Zustand der Bereitstellung ab.
CollectionReference	Verweis auf eine Sammlung.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
Error	Ruft den Fehler ab oder legt den Fehler fest.
ErrorModel	Standardfehlermodell
ErrorResponseModel	Standardmodell für die Fehlerantwort
lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.
SystemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Collection

Sammlungsressource.

Name	Typ	Beschreibung
collectionProvisioningState	collectionProvisioningState	Ruft den Zustand der Bereitstellung ab.
description	string	Ruft die Beschreibung ab oder legt sie fest.
friendlyName	string	Ruft den Anzeigenamen der Auflistung ab oder legt den Anzeigenamen fest.
name	string	Ruft den Namen ab.
parentCollection	CollectionReference	Ruft den Verweis auf die übergeordnete Auflistung ab oder legt diese fest.
systemData	SystemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

CollectionList

Ausgelagerte Liste von Sammlungen.

Name	Typ	Beschreibung
count	integer	Gesamtzahl der Elemente.
nextLink	string	Die URL der nächsten Ergebnisseite.
value	Collection[]	Sammlung von Elementen vom Typ Ergebnisse.

collectionProvisioningState

Ruft den Zustand der Bereitstellung ab.

Name	Typ	Beschreibung
Creating	string
Deleting	string
Failed	string
Moving	string
Succeeded	string
Unknown	string

CollectionReference

Verweis auf eine Sammlung.

Name	Typ	Beschreibung
referenceName	string	Ruft den Verweisnamen ab oder legt den Verweisnamen fest.
type	string	Ruft die Verweistypeigenschaft ab oder legt sie fest.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Ruft den Fehler ab oder legt den Fehler fest.

Name	Typ	Beschreibung
code	string	Ruft den Code ab oder legt den Code fest.
details	ErrorModel[]	Ruft die Details ab oder legt sie fest.
message	string	Ruft die Nachrichten ab oder legt sie fest.
target	string	Ruft das Ziel ab oder legt es fest.

ErrorModel

Standardfehlermodell

Name	Typ	Beschreibung
code	string	Ruft den Code ab oder legt den Code fest.
details	ErrorModel[]	Ruft die Details ab oder legt sie fest.
message	string	Ruft die Nachrichten ab oder legt sie fest.
target	string	Ruft das Ziel ab oder legt es fest.

ErrorResponseModel

Standardmodell für die Fehlerantwort

Name	Typ	Beschreibung
error	Error	Ruft den Fehler ab oder legt den Fehler fest.

lastModifiedByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC).
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.