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-Fluss.

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 der Sammlungen.
collectionProvisioningState	Ruft den Status der Bereitstellung ab.
CollectionReference	Verweisen auf eine Auflistung.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
Error	Ruft den Fehler ab oder legt den Fehler fest.
ErrorModel	Standardfehlermodell
ErrorResponseModel	Standardfehlerantwortmodell
lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.
SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

Collection

Objekt

Sammlungsressource.

Name	Typ	Beschreibung
collectionProvisioningState	collectionProvisioningState	Ruft den Status der Bereitstellung ab.
description	string	Ruft die Beschreibung ab oder legt sie fest.
friendlyName	string	Dient zum Abrufen oder Festlegen des Anzeigenamens der Auflistung.
name	string	Ruft den Namen ab.
parentCollection	CollectionReference	Dient zum Abrufen oder Festlegen des übergeordneten Auflistungsverweises.
systemData	SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CollectionList

Objekt

Ausgelagerte Liste der Sammlungen.

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

collectionProvisioningState

Enumeration

Ruft den Status der Bereitstellung ab.

Wert	Beschreibung
Creating
Deleting
Failed
Moving
Succeeded
Unknown

CollectionReference

Objekt

Verweisen auf eine Auflistung.

Name	Typ	Beschreibung
referenceName	string	Ruft den Verweisnamen ab oder legt den Namen fest.
type	string	Dient zum Abrufen oder Festlegen der Verweistypeigenschaft.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

Error

Objekt

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 diese fest.
message	string	Ruft die Nachrichten ab oder legt sie fest.
target	string	Ruft das Ziel ab oder legt es fest.

ErrorModel

Objekt

Standardfehlermodell

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

ErrorResponseModel

Objekt

Standardfehlerantwortmodell

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

lastModifiedByType

Enumeration

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

Wert	Beschreibung
Application
Key
ManagedIdentity
User

SystemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	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 (date-time)	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.