PurviewCollection.GetCollectionAsync(RequestOptions) Method

Definition

Namespace:

Azure.Analytics.Purview.Administration

Assembly:

Azure.Analytics.Purview.Administration.dll

Package:

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

Source:

PurviewCollection.cs

Get a collection.

public virtual System.Threading.Tasks.Task<Azure.Response> GetCollectionAsync (Azure.RequestOptions options);

abstract member GetCollectionAsync : Azure.RequestOptions -> System.Threading.Tasks.Task<Azure.Response>
override this.GetCollectionAsync : Azure.RequestOptions -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetCollectionAsync (options As RequestOptions) As Task(Of Response)

Parameters

options

Azure.RequestOptions

The request options.

Returns

Task<Response>

Remarks

Schema for Response Body:

{
              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
              }
            }