Share via


ApplicationInsightsExtensions.GetWorkbooks Method

Definition

Overloads

GetWorkbooks(ResourceGroupResource)

Gets a collection of WorkbookResources in the ResourceGroupResource. MockingTo mock this method, please mock GetWorkbooks() instead.

GetWorkbooks(SubscriptionResource, CategoryType, IEnumerable<String>, Nullable<Boolean>, CancellationToken)

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

GetWorkbooks(ResourceGroupResource)

Source:
ApplicationInsightsExtensions.cs

Gets a collection of WorkbookResources in the ResourceGroupResource. MockingTo mock this method, please mock GetWorkbooks() instead.

public static Azure.ResourceManager.ApplicationInsights.WorkbookCollection GetWorkbooks (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource);
static member GetWorkbooks : Azure.ResourceManager.Resources.ResourceGroupResource -> Azure.ResourceManager.ApplicationInsights.WorkbookCollection
<Extension()>
Public Function GetWorkbooks (resourceGroupResource As ResourceGroupResource) As WorkbookCollection

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

Returns

An object representing collection of WorkbookResources and their operations over a WorkbookResource.

Exceptions

resourceGroupResource is null.

Applies to

GetWorkbooks(SubscriptionResource, CategoryType, IEnumerable<String>, Nullable<Boolean>, CancellationToken)

Source:
ApplicationInsightsExtensions.cs

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.Pageable<Azure.ResourceManager.ApplicationInsights.WorkbookResource> GetWorkbooks (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 GetWorkbooks : Azure.ResourceManager.Resources.SubscriptionResource * Azure.ResourceManager.ApplicationInsights.Models.CategoryType * seq<string> * Nullable<bool> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApplicationInsights.WorkbookResource>
<Extension()>
Public Function GetWorkbooks (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 Pageable(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

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

Exceptions

subscriptionResource is null.

Applies to