Share via


ApplicationInsightsExtensions.GetWorkbooksAsync Method

Definition

Get all Workbooks defined within a specified subscription and category.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Insights/workbooks
  • Operation Id: Workbooks_ListBySubscription
  • Default Api Version: 2022-04-01
  • Resource: WorkbookResource
public static Azure.AsyncPageable<Azure.ResourceManager.ApplicationInsights.WorkbookResource> GetWorkbooksAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.ResourceManager.ApplicationInsights.Models.CategoryType category, System.Collections.Generic.IEnumerable<string> tags = default, bool? canFetchContent = default, System.Threading.CancellationToken cancellationToken = default);
static member GetWorkbooksAsync : Azure.ResourceManager.Resources.SubscriptionResource * Azure.ResourceManager.ApplicationInsights.Models.CategoryType * seq<string> * Nullable<bool> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApplicationInsights.WorkbookResource>
<Extension()>
Public Function GetWorkbooksAsync (subscriptionResource As SubscriptionResource, category As CategoryType, Optional tags As IEnumerable(Of String) = Nothing, Optional canFetchContent As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of WorkbookResource)

Parameters

subscriptionResource
SubscriptionResource

The SubscriptionResource instance the method will execute against.

category
CategoryType

Category of workbook to return.

tags
IEnumerable<String>

Tags presents on each workbook returned.

canFetchContent
Nullable<Boolean>

Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

An async collection of WorkbookResource that may take multiple service requests to iterate over.

Exceptions

subscriptionResource is null.

Applies to