Collections - List Collections

Riferimento

Servizio:: Purview

Versione API:: 2019-11-01-preview

Elencare le raccolte nell'account.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint dell'account Purview. Esempio: https://{accountName}.purview.azure.com/account/
api-version	query	True	string	Versione dell'API da usare.
$skipToken	query		string

Risposte

Nome	Tipo	Descrizione
200 OK	CollectionList	Operazione riuscita
Other Status Codes	ErrorResponseModel	Risposta di errore ricevuta dal provider.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Collections_ListCollections

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
    }
  ]
}

Definizioni

Nome	Descrizione
Collection	Risorsa raccolta.
CollectionList	Elenco paginato delle raccolte.
collectionProvisioningState	Ottiene lo stato del provisioning.
CollectionReference	Riferimento a una raccolta.
createdByType	Tipo di identità che ha creato la risorsa.
Error	Ottiene o imposta l'errore.
ErrorModel	Modello di errore predefinito
ErrorResponseModel	Modello di risposta degli errori predefinito
lastModifiedByType	Tipo di identità che ha modificato l'ultima risorsa.
SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

Collection

Risorsa raccolta.

Nome	Tipo	Descrizione
collectionProvisioningState	collectionProvisioningState	Ottiene lo stato del provisioning.
description	string	Ottiene o imposta la descrizione.
friendlyName	string	Ottiene o imposta il nome descrittivo della raccolta.
name	string	Ottiene il nome.
parentCollection	CollectionReference	Ottiene o imposta il riferimento alla raccolta padre.
systemData	SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

CollectionList

Elenco paginato delle raccolte.

Nome	Tipo	Descrizione
count	integer	Numero totale di elementi.
nextLink	string	Url della pagina dei risultati successiva.
value	Collection[]	Raccolta di elementi di tipo risultati.

collectionProvisioningState

Ottiene lo stato del provisioning.

Nome	Tipo	Descrizione
Creating	string
Deleting	string
Failed	string
Moving	string
Succeeded	string
Unknown	string

CollectionReference

Riferimento a una raccolta.

Nome	Tipo	Descrizione
referenceName	string	Ottiene o imposta il nome di riferimento.
type	string	Ottiene o imposta la proprietà del tipo di riferimento.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Ottiene o imposta l'errore.

Nome	Tipo	Descrizione
code	string	Ottiene o imposta il codice.
details	ErrorModel[]	Ottiene o imposta i dettagli.
message	string	Ottiene o imposta i messaggi.
target	string	Ottiene o imposta la destinazione.

ErrorModel

Modello di errore predefinito

Nome	Tipo	Descrizione
code	string	Ottiene o imposta il codice.
details	ErrorModel[]	Ottiene o imposta i dettagli.
message	string	Ottiene o imposta i messaggi.
target	string	Ottiene o imposta la destinazione.

ErrorResponseModel

Modello di risposta degli errori predefinito

Nome	Tipo	Descrizione
error	Error	Ottiene o imposta l'errore.

lastModifiedByType

Tipo di identità che ha modificato l'ultima risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC).
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	lastModifiedByType	Tipo di identità che ha modificato l'ultima risorsa.

Condividi tramite