Collections - List Collections

Servicio:

Purview

Versión de la API:

2019-11-01-preview

Enumera las colecciones de la cuenta.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Punto de conexión de la cuenta de Purview. Ejemplo: https://{accountName}.purview.azure.com/account/
api-version	query	True	string	La versión de api que se va a usar.
$skipToken	query		string

Respuestas

Nombre	Tipo	Description
200 OK	CollectionList	Correcto
Other Status Codes	ErrorResponseModel	Respuesta de error recibida del proveedor.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Collections_ListCollections

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

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"
    }
  ]
}

Definiciones

Nombre	Description
Collection	Recurso de colección.
CollectionList	Lista paginada de colecciones.
collectionProvisioningState	Obtiene el estado del aprovisionamiento.
CollectionReference	Referencia a una colección.
createdByType	Tipo de identidad que creó el recurso.
Error	Obtiene o establece el error.
ErrorModel	Modelo de error predeterminado
ErrorResponseModel	Modelo de respuesta de error predeterminado
lastModifiedByType	Tipo de identidad que modificó por última vez el recurso.
SystemData	Metadatos relacionados con la creación y la última modificación del recurso.

Collection

Recurso de colección.

Nombre	Tipo	Description
collectionProvisioningState	collectionProvisioningState	Obtiene el estado del aprovisionamiento.
description	string	Obtiene o establece la descripción.
friendlyName	string	Obtiene o establece el nombre descriptivo de la colección.
name	string	Obtiene el nombre.
parentCollection	CollectionReference	Obtiene o establece la referencia de la colección primaria.
systemData	SystemData	Metadatos relacionados con la creación y la última modificación del recurso.

CollectionList

Lista paginada de colecciones.

Nombre	Tipo	Description
count	integer	Recuento total de elementos.
nextLink	string	Dirección URL de la página de resultados siguiente.
value	Collection[]	Colección de elementos de tipo resultados.

collectionProvisioningState

Obtiene el estado del aprovisionamiento.

Nombre	Tipo	Description
Creating	string
Deleting	string
Failed	string
Moving	string
Succeeded	string
Unknown	string

CollectionReference

Referencia a una colección.

Nombre	Tipo	Description
referenceName	string	Obtiene o establece el nombre de referencia.
type	string	Obtiene o establece la propiedad de tipo de referencia.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Obtiene o establece el error.

Nombre	Tipo	Description
code	string	Obtiene o establece el código.
details	ErrorModel[]	Obtiene o establece los detalles.
message	string	Obtiene o establece los mensajes.
target	string	Obtiene o establece el destino.

ErrorModel

Modelo de error predeterminado

Nombre	Tipo	Description
code	string	Obtiene o establece el código.
details	ErrorModel[]	Obtiene o establece los detalles.
message	string	Obtiene o establece los mensajes.
target	string	Obtiene o establece el destino.

ErrorResponseModel

Modelo de respuesta de error predeterminado

Nombre	Tipo	Description
error	Error	Obtiene o establece el error.

lastModifiedByType

Tipo de identidad que modificó por última vez el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC).
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	lastModifiedByType	Tipo de identidad que modificó por última vez el recurso.