GrafanaImpl | @azure/arm-dashboard

Class containing Grafana operations.

Hierarchy

GrafanaImpl

Implements

Grafana

Index

Constructors

constructor

Methods

Constructors

constructor

new GrafanaImpl(client: DashboardManagementClient): GrafanaImpl

- Defined in operations/grafana.ts:40
Initialize a new instance of the class Grafana class.

Parameters
- client: DashboardManagementClient
  
  Reference to the service client
Returns GrafanaImpl

Methods

beginCreate

beginCreate(resourceGroupName: string, workspaceName: string, requestBodyParameters: ManagedGrafana, options?: GrafanaCreateOptionalParams): Promise<PollerLike<PollOperationState<GrafanaCreateResponse>, GrafanaCreateResponse>>

Implementation of Grafana.beginCreate
- Defined in operations/grafana.ts:195
Create or update a workspace for Grafana resource. This API is idempotent, so user can either create a new grafana or update an existing grafana.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The workspace name of Azure Managed Grafana.
- requestBodyParameters: ManagedGrafana
  
  The grafana resource type.
- Optional options: GrafanaCreateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GrafanaCreateResponse>, GrafanaCreateResponse>>

beginCreateAndWait

beginCreateAndWait(resourceGroupName: string, workspaceName: string, requestBodyParameters: ManagedGrafana, options?: GrafanaCreateOptionalParams): Promise<GrafanaCreateResponse>

Implementation of Grafana.beginCreateAndWait
- Defined in operations/grafana.ts:264
Create or update a workspace for Grafana resource. This API is idempotent, so user can either create a new grafana or update an existing grafana.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The workspace name of Azure Managed Grafana.
- requestBodyParameters: ManagedGrafana
  
  The grafana resource type.
- Optional options: GrafanaCreateOptionalParams
  
  The options parameters.
Returns Promise<GrafanaCreateResponse>

beginDelete

beginDelete(resourceGroupName: string, workspaceName: string, options?: GrafanaDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of Grafana.beginDelete
- Defined in operations/grafana.ts:304
Delete a workspace for Grafana resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The workspace name of Azure Managed Grafana.
- Optional options: GrafanaDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, workspaceName: string, options?: GrafanaDeleteOptionalParams): Promise<void>

Implementation of Grafana.beginDeleteAndWait
- Defined in operations/grafana.ts:368
Delete a workspace for Grafana resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The workspace name of Azure Managed Grafana.
- Optional options: GrafanaDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, workspaceName: string, options?: GrafanaGetOptionalParams): Promise<GrafanaGetResponse>

Implementation of Grafana.get
- Defined in operations/grafana.ts:176
Get the properties of a specific workspace for Grafana resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The workspace name of Azure Managed Grafana.
- Optional options: GrafanaGetOptionalParams
  
  The options parameters.
Returns Promise<GrafanaGetResponse>

list

list(options?: GrafanaListOptionalParams): PagedAsyncIterableIterator<ManagedGrafana>

Implementation of Grafana.list
- Defined in operations/grafana.ts:54
List all resources of workspaces for Grafana under the specified subscription.

Parameters
- Optional options: GrafanaListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedGrafana>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: GrafanaListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ManagedGrafana>

Implementation of Grafana.listByResourceGroup
- Defined in operations/grafana.ts:97
List all resources of workspaces for Grafana under the specified resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: GrafanaListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedGrafana>

update

update(resourceGroupName: string, workspaceName: string, requestBodyParameters: ManagedGrafanaUpdateParameters, options?: GrafanaUpdateOptionalParams): Promise<GrafanaUpdateResponse>

Implementation of Grafana.update
- Defined in operations/grafana.ts:286
Update a workspace for Grafana resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The workspace name of Azure Managed Grafana.
- requestBodyParameters: ManagedGrafanaUpdateParameters
  
  The parameters for a PATCH request to a grafana resource.
- Optional options: GrafanaUpdateOptionalParams
  
  The options parameters.
Returns Promise<GrafanaUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: DashboardManagementClient

Returns GrafanaImpl

Methods

beginCreate

Parameters

resourceGroupName: string

workspaceName: string

requestBodyParameters: ManagedGrafana

Optional options: GrafanaCreateOptionalParams

Returns Promise<PollerLike<PollOperationState<GrafanaCreateResponse>, GrafanaCreateResponse>>

beginCreateAndWait

Parameters

resourceGroupName: string

workspaceName: string

requestBodyParameters: ManagedGrafana

Optional options: GrafanaCreateOptionalParams

Returns Promise<GrafanaCreateResponse>

beginDelete

Parameters

resourceGroupName: string

workspaceName: string

Optional options: GrafanaDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

workspaceName: string

Optional options: GrafanaDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

workspaceName: string

Optional options: GrafanaGetOptionalParams

Returns Promise<GrafanaGetResponse>

list

Parameters

Optional options: GrafanaListOptionalParams

Returns PagedAsyncIterableIterator<ManagedGrafana>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: GrafanaListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<ManagedGrafana>

update

Parameters

resourceGroupName: string

workspaceName: string

requestBodyParameters: ManagedGrafanaUpdateParameters

Optional options: GrafanaUpdateOptionalParams

Returns Promise<GrafanaUpdateResponse>