@azure/arm-dashboard package

Classes

DashboardManagementClient

Interfaces

AzureMonitorWorkspaceIntegration

Integrations for Azure Monitor Workspace.

DashboardManagementClientOptionalParams

Optional parameters.

EnterpriseConfigurations

Enterprise settings of a Grafana instance

EnterpriseDetails

Enterprise details of a Grafana instance

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Grafana

Interface representing a Grafana.

GrafanaAvailablePlugin

Available plugins of grafana

GrafanaAvailablePluginListResponse
GrafanaCheckEnterpriseDetailsOptionalParams

Optional parameters.

GrafanaConfigurations

Server configurations of a Grafana instance

GrafanaCreateHeaders

Defines headers for Grafana_create operation.

GrafanaCreateOptionalParams

Optional parameters.

GrafanaDeleteHeaders

Defines headers for Grafana_delete operation.

GrafanaDeleteOptionalParams

Optional parameters.

GrafanaFetchAvailablePluginsOptionalParams

Optional parameters.

GrafanaGetOptionalParams

Optional parameters.

GrafanaIntegrations

GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios.

GrafanaListByResourceGroupNextOptionalParams

Optional parameters.

GrafanaListByResourceGroupOptionalParams

Optional parameters.

GrafanaListNextOptionalParams

Optional parameters.

GrafanaListOptionalParams

Optional parameters.

GrafanaPlugin

Plugin of Grafana

GrafanaUpdateHeaders

Defines headers for Grafana_update operation.

GrafanaUpdateOptionalParams

Optional parameters.

ManagedGrafana

The grafana resource type.

ManagedGrafanaListResponse
ManagedGrafanaProperties

Properties specific to the grafana resource.

ManagedGrafanaPropertiesUpdateParameters

The properties parameters for a PATCH request to a grafana resource.

ManagedGrafanaUpdateParameters

The parameters for a PATCH request to a grafana resource.

ManagedPrivateEndpointConnectionState

The state of managed private endpoint connection.

ManagedPrivateEndpointModel

The managed private endpoint resource type.

ManagedPrivateEndpointModelListResponse

The list of managed private endpoints of a grafana resource

ManagedPrivateEndpointUpdateParameters

The parameters for a PATCH request to a managed private endpoint.

ManagedPrivateEndpoints

Interface representing a ManagedPrivateEndpoints.

ManagedPrivateEndpointsCreateHeaders

Defines headers for ManagedPrivateEndpoints_create operation.

ManagedPrivateEndpointsCreateOptionalParams

Optional parameters.

ManagedPrivateEndpointsDeleteHeaders

Defines headers for ManagedPrivateEndpoints_delete operation.

ManagedPrivateEndpointsDeleteOptionalParams

Optional parameters.

ManagedPrivateEndpointsGetOptionalParams

Optional parameters.

ManagedPrivateEndpointsListNextOptionalParams

Optional parameters.

ManagedPrivateEndpointsListOptionalParams

Optional parameters.

ManagedPrivateEndpointsRefreshHeaders

Defines headers for ManagedPrivateEndpoints_refresh operation.

ManagedPrivateEndpointsRefreshOptionalParams

Optional parameters.

ManagedPrivateEndpointsUpdateHeaders

Defines headers for ManagedPrivateEndpoints_update operation.

ManagedPrivateEndpointsUpdateOptionalParams

Optional parameters.

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

MarketplaceTrialQuota

The allocation details of the per subscription free trial slot of the subscription.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for this particular operation.

OperationListResult

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

PrivateEndpoint

The Private Endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionListResult

List of private endpoint connection associated with the specified storage account

PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

PrivateEndpointConnectionsApproveHeaders

Defines headers for PrivateEndpointConnections_approve operation.

PrivateEndpointConnectionsApproveOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteHeaders

Defines headers for PrivateEndpointConnections_delete operation.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListNextOptionalParams

Optional parameters.

PrivateEndpointConnectionsListOptionalParams

Optional parameters.

PrivateLinkResource

A private link resource

PrivateLinkResourceListResult

A list of private link resources

PrivateLinkResources

Interface representing a PrivateLinkResources.

PrivateLinkResourcesGetOptionalParams

Optional parameters.

PrivateLinkResourcesListNextOptionalParams

Optional parameters.

PrivateLinkResourcesListOptionalParams

Optional parameters.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ResourceSku
SaasSubscriptionDetails

SaaS subscription details of a Grafana instance

Smtp

Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp

SubscriptionTerm

The current billing term of the SaaS Subscription.

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

UserAssignedIdentity

User assigned identity properties

Type Aliases

ActionType

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal

ApiKey

Defines values for ApiKey.
KnownApiKey can be used interchangeably with ApiKey, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled

AutoGeneratedDomainNameLabelScope

Defines values for AutoGeneratedDomainNameLabelScope.
KnownAutoGeneratedDomainNameLabelScope can be used interchangeably with AutoGeneratedDomainNameLabelScope, this enum contains the known values that the service supports.

Known values supported by the service

TenantReuse

AvailablePromotion

Defines values for AvailablePromotion.
KnownAvailablePromotion can be used interchangeably with AvailablePromotion, this enum contains the known values that the service supports.

Known values supported by the service

None
FreeTrial

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

DeterministicOutboundIP

Defines values for DeterministicOutboundIP.
KnownDeterministicOutboundIP can be used interchangeably with DeterministicOutboundIP, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled

GrafanaCheckEnterpriseDetailsResponse

Contains response data for the checkEnterpriseDetails operation.

GrafanaCreateResponse

Contains response data for the create operation.

GrafanaFetchAvailablePluginsResponse

Contains response data for the fetchAvailablePlugins operation.

GrafanaGetResponse

Contains response data for the get operation.

GrafanaListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

GrafanaListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

GrafanaListNextResponse

Contains response data for the listNext operation.

GrafanaListResponse

Contains response data for the list operation.

GrafanaUpdateResponse

Contains response data for the update operation.

ManagedPrivateEndpointConnectionStatus

Defines values for ManagedPrivateEndpointConnectionStatus.
KnownManagedPrivateEndpointConnectionStatus can be used interchangeably with ManagedPrivateEndpointConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected
Disconnected

ManagedPrivateEndpointsCreateResponse

Contains response data for the create operation.

ManagedPrivateEndpointsGetResponse

Contains response data for the get operation.

ManagedPrivateEndpointsListNextResponse

Contains response data for the listNext operation.

ManagedPrivateEndpointsListResponse

Contains response data for the list operation.

ManagedPrivateEndpointsUpdateResponse

Contains response data for the update operation.

ManagedServiceIdentityType

Defines values for ManagedServiceIdentityType.
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

MarketplaceAutoRenew

Defines values for MarketplaceAutoRenew.
KnownMarketplaceAutoRenew can be used interchangeably with MarketplaceAutoRenew, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

Origin

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system

PrivateEndpointConnectionProvisioningState

Defines values for PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Deleting
Failed

PrivateEndpointConnectionsApproveResponse

Contains response data for the approve operation.

PrivateEndpointConnectionsDeleteResponse

Contains response data for the delete operation.

PrivateEndpointConnectionsGetResponse

Contains response data for the get operation.

PrivateEndpointConnectionsListNextResponse

Contains response data for the listNext operation.

PrivateEndpointConnectionsListResponse

Contains response data for the list operation.

PrivateEndpointServiceConnectionStatus

Defines values for PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected

PrivateLinkResourcesGetResponse

Contains response data for the get operation.

PrivateLinkResourcesListNextResponse

Contains response data for the listNext operation.

PrivateLinkResourcesListResponse

Contains response data for the list operation.

ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Accepted
Creating
Updating
Deleting
Succeeded
Failed
Canceled
Deleted
NotSpecified

PublicNetworkAccess

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

StartTLSPolicy

Defines values for StartTLSPolicy.
KnownStartTLSPolicy can be used interchangeably with StartTLSPolicy, this enum contains the known values that the service supports.

Known values supported by the service

OpportunisticStartTLS
MandatoryStartTLS
NoStartTLS

ZoneRedundancy

Defines values for ZoneRedundancy.
KnownZoneRedundancy can be used interchangeably with ZoneRedundancy, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled

Enums

KnownActionType

Known values of ActionType that the service accepts.

KnownApiKey

Known values of ApiKey that the service accepts.

KnownAutoGeneratedDomainNameLabelScope

Known values of AutoGeneratedDomainNameLabelScope that the service accepts.

KnownAvailablePromotion

Known values of AvailablePromotion that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownDeterministicOutboundIP

Known values of DeterministicOutboundIP that the service accepts.

KnownManagedPrivateEndpointConnectionStatus

Known values of ManagedPrivateEndpointConnectionStatus that the service accepts.

KnownManagedServiceIdentityType

Known values of ManagedServiceIdentityType that the service accepts.

KnownMarketplaceAutoRenew

Known values of MarketplaceAutoRenew that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownPrivateEndpointConnectionProvisioningState

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

KnownPrivateEndpointServiceConnectionStatus

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownPublicNetworkAccess

Known values of PublicNetworkAccess that the service accepts.

KnownStartTLSPolicy

Known values of StartTLSPolicy that the service accepts.

KnownZoneRedundancy

Known values of ZoneRedundancy that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.