Collections - Get Collection

Service:

Purview

Version d'API:

2019-11-01-preview

Obtenir un regroupement

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
collectionName	path	True	string
endpoint	path	True	string	Point de terminaison de compte de votre compte Purview. Exemple : https://{accountName}.purview.azure.com/account/
api-version	query	True	string	Version de l’API à utiliser.

Réponses

Nom	Type	Description
200 OK	Collection	Succès
Other Status Codes	ErrorResponseModel	Réponse d’erreur reçue du fournisseur.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Collections_GetCollection

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

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

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

Définitions

Nom	Description
Collection	Ressource de collection.
collectionProvisioningState	Obtient l’état de l’approvisionnement.
CollectionReference	Référence à une collection.
createdByType	Type d’identité qui a créé la ressource.
Error	Obtient ou définit l’erreur.
ErrorModel	Modèle d’erreur par défaut
ErrorResponseModel	Modèle de réponse d’erreur par défaut
lastModifiedByType	Type d’identité qui a modifié la dernière ressource.
SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

Collection

Object

Ressource de collection.

Nom	Type	Description
collectionProvisioningState	collectionProvisioningState	Obtient l’état de l’approvisionnement.
description	string	Obtient ou définit la description.
friendlyName	string	Obtient ou définit le nom convivial de la collection.
name	string	Obtient le nom.
parentCollection	CollectionReference	Obtient ou définit la référence de collection parente.
systemData	SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

collectionProvisioningState

Énumération

Obtient l’état de l’approvisionnement.

Valeur	Description
Creating
Deleting
Failed
Moving
Succeeded
Unknown

CollectionReference

Object

Référence à une collection.

Nom	Type	Description
referenceName	string	Obtient ou définit le nom de référence.
type	string	Obtient ou définit la propriété de type de référence.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
Application
Key
ManagedIdentity
User

Error

Object

Obtient ou définit l’erreur.

Nom	Type	Description
code	string	Obtient ou définit le code.
details	ErrorModel[]	Obtient ou définit les détails.
message	string	Obtient ou définit les messages.
target	string	Obtient ou définit la cible.

ErrorModel

Object

Modèle d’erreur par défaut

Nom	Type	Description
code	string	Obtient ou définit le code.
details	ErrorModel[]	Obtient ou définit les détails.
message	string	Obtient ou définit les messages.
target	string	Obtient ou définit la cible.

ErrorResponseModel

Object

Modèle de réponse d’erreur par défaut

Nom	Type	Description
error	Error	Obtient ou définit l’erreur.

lastModifiedByType

Énumération

Type d’identité qui a modifié la dernière ressource.

Valeur	Description
Application
Key
ManagedIdentity
User

SystemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de la ressource (UTC).
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	lastModifiedByType	Type d’identité qui a modifié la dernière ressource.