Collections - List Collections

Referência

Serviço:: Purview

Versão da API:: 2019-11-01-preview

Lista as coleções na conta.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	O ponto de extremidade da conta do Purview. Exemplo: https://{accountName}.purview.azure.com/account/
api-version	query	True	string	A versão da API a ser usada.
$skipToken	query		string

Respostas

Nome	Tipo	Description
200 OK	CollectionList	Êxito
Other Status Codes	ErrorResponseModel	Uma resposta de erro recebida do provedor.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Collections_ListCollections

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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"
    }
  ]
}

Definições

Nome	Description
Collection	Recurso de coleção.
CollectionList	Lista de coleções paginada.
collectionProvisioningState	Obtém o estado do provisionamento.
CollectionReference	Referência a uma coleção.
createdByType	O tipo de identidade que criou o recurso.
Error	Obtém ou define o erro.
ErrorModel	Modelo de erro padrão
ErrorResponseModel	Modelo de resposta de erro padrão
lastModifiedByType	O tipo de identidade que modificou o recurso pela última vez.
SystemData	Metadados relativos à criação e à última modificação do recurso.

Collection

Recurso de coleção.

Nome	Tipo	Description
collectionProvisioningState	collectionProvisioningState	Obtém o estado do provisionamento.
description	string	Obtém ou define a descrição.
friendlyName	string	Obtém ou define o nome amigável da coleção.
name	string	Obtém o nome.
parentCollection	CollectionReference	Obtém ou define a referência de coleção pai.
systemData	SystemData	Metadados relativos à criação e à última modificação do recurso.

CollectionList

Lista de coleções paginada.

Nome	Tipo	Description
count	integer	Contagem total de itens.
nextLink	string	A URL da próxima página de resultados.
value	Collection[]	Coleção de itens de resultados de tipo.

collectionProvisioningState

Obtém o estado do provisionamento.

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

CollectionReference

Referência a uma coleção.

Nome	Tipo	Description
referenceName	string	Obtém ou define o nome de referência.
type	string	Obtém ou define a propriedade de tipo de referência.

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Obtém ou define o erro.

Nome	Tipo	Description
code	string	Obtém ou define o código.
details	ErrorModel[]	Obtém ou define os detalhes.
message	string	Obtém ou define as mensagens.
target	string	Obtém ou define o destino.

ErrorModel

Modelo de erro padrão

Nome	Tipo	Description
code	string	Obtém ou define o código.
details	ErrorModel[]	Obtém ou define os detalhes.
message	string	Obtém ou define as mensagens.
target	string	Obtém ou define o destino.

ErrorResponseModel

Modelo de resposta de erro padrão

Nome	Tipo	Description
error	Error	Obtém ou define o erro.

lastModifiedByType

O tipo de identidade que modificou o recurso pela última vez.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC).
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	lastModifiedByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via