Share via

Grafana interface

  • Reference
Package:
@azure/arm-dashboard

Interface representing a Grafana.

Methods

beginCreate(string, string, ManagedGrafana, GrafanaCreateOptionalParams)

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.
beginCreateAndWait(string, string, ManagedGrafana, GrafanaCreateOptionalParams)

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.
beginDelete(string, string, GrafanaDeleteOptionalParams)

Delete a workspace for Grafana resource.
beginDeleteAndWait(string, string, GrafanaDeleteOptionalParams)

Delete a workspace for Grafana resource.
checkEnterpriseDetails(string, string, GrafanaCheckEnterpriseDetailsOptionalParams)

Retrieve enterprise add-on details information
fetchAvailablePlugins(string, string, GrafanaFetchAvailablePluginsOptionalParams)
get(string, string, GrafanaGetOptionalParams)

Get the properties of a specific workspace for Grafana resource.
list(GrafanaListOptionalParams)

List all resources of workspaces for Grafana under the specified subscription.
listByResourceGroup(string, GrafanaListByResourceGroupOptionalParams)

List all resources of workspaces for Grafana under the specified resource group.
update(string, string, ManagedGrafanaUpdateParameters, GrafanaUpdateOptionalParams)

Update a workspace for Grafana resource.

Method Details

beginCreate(string, string, ManagedGrafana, GrafanaCreateOptionalParams)

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.

function beginCreate(resourceGroupName: string, workspaceName: string, requestBodyParameters: ManagedGrafana, options?: GrafanaCreateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedGrafana>, ManagedGrafana>>

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.

options
GrafanaCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedGrafana>, ManagedGrafana>>

beginCreateAndWait(string, string, ManagedGrafana, GrafanaCreateOptionalParams)

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.

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

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.

options
GrafanaCreateOptionalParams

The options parameters.

Returns

Promise<ManagedGrafana>

beginDelete(string, string, GrafanaDeleteOptionalParams)

Delete a workspace for Grafana resource.

function beginDelete(resourceGroupName: string, workspaceName: string, options?: GrafanaDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The workspace name of Azure Managed Grafana.

options
GrafanaDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, GrafanaDeleteOptionalParams)

Delete a workspace for Grafana resource.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The workspace name of Azure Managed Grafana.

options
GrafanaDeleteOptionalParams

The options parameters.

Returns

Promise<void>

checkEnterpriseDetails(string, string, GrafanaCheckEnterpriseDetailsOptionalParams)

Retrieve enterprise add-on details information

function checkEnterpriseDetails(resourceGroupName: string, workspaceName: string, options?: GrafanaCheckEnterpriseDetailsOptionalParams): Promise<EnterpriseDetails>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The workspace name of Azure Managed Grafana.

options
GrafanaCheckEnterpriseDetailsOptionalParams

The options parameters.

Returns

Promise<EnterpriseDetails>

fetchAvailablePlugins(string, string, GrafanaFetchAvailablePluginsOptionalParams) 

function fetchAvailablePlugins(resourceGroupName: string, workspaceName: string, options?: GrafanaFetchAvailablePluginsOptionalParams): Promise<GrafanaAvailablePluginListResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The workspace name of Azure Managed Grafana.

options
GrafanaFetchAvailablePluginsOptionalParams

The options parameters.

Returns

Promise<GrafanaAvailablePluginListResponse>

get(string, string, GrafanaGetOptionalParams)

Get the properties of a specific workspace for Grafana resource.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The workspace name of Azure Managed Grafana.

options
GrafanaGetOptionalParams

The options parameters.

Returns

Promise<ManagedGrafana>

list(GrafanaListOptionalParams)

List all resources of workspaces for Grafana under the specified subscription.

function list(options?: GrafanaListOptionalParams): PagedAsyncIterableIterator<ManagedGrafana, ManagedGrafana[], PageSettings>

Parameters

options
GrafanaListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedGrafana, ManagedGrafana[], PageSettings>

listByResourceGroup(string, GrafanaListByResourceGroupOptionalParams)

List all resources of workspaces for Grafana under the specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: GrafanaListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ManagedGrafana, ManagedGrafana[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options
GrafanaListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedGrafana, ManagedGrafana[], PageSettings>

update(string, string, ManagedGrafanaUpdateParameters, GrafanaUpdateOptionalParams)

Update a workspace for Grafana resource.

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

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.

options
GrafanaUpdateOptionalParams

The options parameters.

Returns

Promise<ManagedGrafana>