PurviewAccountClient.GetCollectionsAsync(RequestOptions, String) Method

Reference

Definition

Namespace:: Azure.Analytics.Purview.Administration

Assembly:: Azure.Analytics.Purview.Administration.dll

Package:: Azure.Analytics.Purview.Administration v1.0.0-beta.1

Source:: PurviewAccountClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

List the collections in the account.

public virtual Azure.AsyncPageable<BinaryData> GetCollectionsAsync (Azure.RequestOptions options, string skipToken = default);

abstract member GetCollectionsAsync : Azure.RequestOptions * string -> Azure.AsyncPageable<BinaryData>
override this.GetCollectionsAsync : Azure.RequestOptions * string -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetCollectionsAsync (options As RequestOptions, Optional skipToken As String = Nothing) As AsyncPageable(Of BinaryData)

Parameters

options: Azure.RequestOptions

The request options.

skipToken: String

The String to use.

Returns

AsyncPageable<BinaryData>

Remarks

Schema for Response Body:

{
              count: number,
              nextLink: string,
              value: [
                {
                  collectionProvisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "Failed" | "Succeeded",
                  description: string,
                  friendlyName: string,
                  name: string,
                  parentCollection: {
                    referenceName: string,
                    type: string
                  },
                  systemData: {
                    createdAt: string (ISO 8601 Format),
                    createdBy: string,
                    createdByType: "User" | "Application" | "ManagedIdentity" | "Key",
                    lastModifiedAt: string (ISO 8601 Format),
                    lastModifiedBy: string,
                    lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key"
                  }
                }
              ]
            }

Schema for Response Error:

{
              error: {
                code: string,
                details: [
                  {
                    code: string,
                    details: [ErrorModel],
                    message: string,
                    target: string
                  }
                ],
                message: string,
                target: string
              }
            }

Applies to

Share via