Share via


WorkbookCollection Class

Definition

A class representing a collection of WorkbookResource and their operations. Each WorkbookResource in the collection will belong to the same instance of ResourceGroupResource. To get a WorkbookCollection instance call the GetWorkbooks method from an instance of ResourceGroupResource.

public class WorkbookCollection : Azure.ResourceManager.ArmCollection
type WorkbookCollection = class
    inherit ArmCollection
Public Class WorkbookCollection
Inherits ArmCollection
Inheritance
WorkbookCollection

Constructors

WorkbookCollection()

Initializes a new instance of the WorkbookCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, WorkbookData, String, CancellationToken)

Create a new workbook.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks/{resourceName}
  • Operation Id: Workbooks_CreateOrUpdate
  • Default Api Version: 2022-04-01
  • Resource: WorkbookResource
CreateOrUpdateAsync(WaitUntil, String, WorkbookData, String, CancellationToken)

Create a new workbook.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks/{resourceName}
  • Operation Id: Workbooks_CreateOrUpdate
  • Default Api Version: 2022-04-01
  • Resource: WorkbookResource
Exists(String, Nullable<Boolean>, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks/{resourceName}
  • Operation Id: Workbooks_Get
  • Default Api Version: 2022-04-01
  • Resource: WorkbookResource
ExistsAsync(String, Nullable<Boolean>, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks/{resourceName}
  • Operation Id: Workbooks_Get
  • Default Api Version: 2022-04-01
  • Resource: WorkbookResource
Get(String, Nullable<Boolean>, CancellationToken)

Get a single workbook by its resourceName.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks/{resourceName}
  • Operation Id: Workbooks_Get
  • Default Api Version: 2022-04-01
  • Resource: WorkbookResource
GetAll(CategoryType, IEnumerable<String>, String, Nullable<Boolean>, CancellationToken)

Get all Workbooks defined within a specified resource group and category.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks
  • Operation Id: Workbooks_ListByResourceGroup
  • Default Api Version: 2022-04-01
  • Resource: WorkbookResource
GetAllAsync(CategoryType, IEnumerable<String>, String, Nullable<Boolean>, CancellationToken)

Get all Workbooks defined within a specified resource group and category.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks
  • Operation Id: Workbooks_ListByResourceGroup
  • Default Api Version: 2022-04-01
  • Resource: WorkbookResource
GetAsync(String, Nullable<Boolean>, CancellationToken)

Get a single workbook by its resourceName.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks/{resourceName}
  • Operation Id: Workbooks_Get
  • Default Api Version: 2022-04-01
  • Resource: WorkbookResource
GetIfExists(String, Nullable<Boolean>, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks/{resourceName}
  • Operation Id: Workbooks_Get
  • Default Api Version: 2022-04-01
  • Resource: WorkbookResource
GetIfExistsAsync(String, Nullable<Boolean>, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks/{resourceName}
  • Operation Id: Workbooks_Get
  • Default Api Version: 2022-04-01
  • Resource: WorkbookResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Applies to