Microsoft.Dashboard (stable:2024-10-01)

2025/01/21 • 26 new methods

Operations_List (new)
Description List all available API operations provided by Microsoft.Dashboard.
Reference Link ¶

⚼ Request

GET:  /providers/Microsoft.Dashboard/operations
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
isDataAction: boolean ,
display:
{
provider: string ,
resource: string ,
operation: string ,
description: string ,
}
,
origin: enum ,
actionType: enum ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Grafana_List (new)
Description List all resources of workspaces for Grafana under the specified subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Dashboard/grafana
{
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
name: string ,
type: string ,
sku:
{
name: string ,
}
,
properties:
{
provisioningState: enum ,
grafanaVersion: string ,
endpoint: string ,
publicNetworkAccess: enum ,
zoneRedundancy: enum ,
apiKey: enum ,
deterministicOutboundIP: enum ,
outboundIPs:
[
string ,
]
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupIds:
[
string ,
]
,
provisioningState: enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope: enum ,
grafanaIntegrations:
{
azureMonitorWorkspaceIntegrations:
[
{
azureMonitorWorkspaceResourceId: string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
marketplacePlanId: string ,
marketplaceAutoRenew: enum ,
}
,
grafanaConfigurations:
{
smtp:
{
enabled: boolean ,
host: string ,
user: string ,
password: string ,
fromAddress: string ,
fromName: string ,
startTLSPolicy: enum ,
skipVerify: boolean ,
}
,
snapshots:
{
externalEnabled: boolean ,
}
,
users:
{
viewersCanEdit: boolean ,
}
,
security:
{
csrfAlwaysCheck: boolean ,
}
,
}
,
grafanaPlugins: object ,
grafanaMajorVersion: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Grafana_ListByResourceGroup (new)
Description List all resources of workspaces for Grafana under the specified resource group.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
name: string ,
type: string ,
sku:
{
name: string ,
}
,
properties:
{
provisioningState: enum ,
grafanaVersion: string ,
endpoint: string ,
publicNetworkAccess: enum ,
zoneRedundancy: enum ,
apiKey: enum ,
deterministicOutboundIP: enum ,
outboundIPs:
[
string ,
]
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupIds:
[
string ,
]
,
provisioningState: enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope: enum ,
grafanaIntegrations:
{
azureMonitorWorkspaceIntegrations:
[
{
azureMonitorWorkspaceResourceId: string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
marketplacePlanId: string ,
marketplaceAutoRenew: enum ,
}
,
grafanaConfigurations:
{
smtp:
{
enabled: boolean ,
host: string ,
user: string ,
password: string ,
fromAddress: string ,
fromName: string ,
startTLSPolicy: enum ,
skipVerify: boolean ,
}
,
snapshots:
{
externalEnabled: boolean ,
}
,
users:
{
viewersCanEdit: boolean ,
}
,
security:
{
csrfAlwaysCheck: boolean ,
}
,
}
,
grafanaPlugins: object ,
grafanaMajorVersion: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Grafana_Get (new)
Description Get the properties of a specific workspace for Grafana resource.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
api-version: string ,
}

⚐ Response (200)

{
id: string ,
name: string ,
type: string ,
sku:
{
name: string ,
}
,
properties:
{
provisioningState: enum ,
grafanaVersion: string ,
endpoint: string ,
publicNetworkAccess: enum ,
zoneRedundancy: enum ,
apiKey: enum ,
deterministicOutboundIP: enum ,
outboundIPs:
[
string ,
]
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupIds:
[
string ,
]
,
provisioningState: enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope: enum ,
grafanaIntegrations:
{
azureMonitorWorkspaceIntegrations:
[
{
azureMonitorWorkspaceResourceId: string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
marketplacePlanId: string ,
marketplaceAutoRenew: enum ,
}
,
grafanaConfigurations:
{
smtp:
{
enabled: boolean ,
host: string ,
user: string ,
password: string ,
fromAddress: string ,
fromName: string ,
startTLSPolicy: enum ,
skipVerify: boolean ,
}
,
snapshots:
{
externalEnabled: boolean ,
}
,
users:
{
viewersCanEdit: boolean ,
}
,
security:
{
csrfAlwaysCheck: boolean ,
}
,
}
,
grafanaPlugins: object ,
grafanaMajorVersion: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Grafana_Create (new)
Description 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.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
api-version: string ,
requestBodyParameters:
{
id: string ,
name: string ,
type: string ,
sku:
{
name: string ,
}
,
properties:
{
provisioningState: enum ,
grafanaVersion: string ,
endpoint: string ,
publicNetworkAccess: enum ,
zoneRedundancy: enum ,
apiKey: enum ,
deterministicOutboundIP: enum ,
outboundIPs:
[
string ,
]
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupIds:
[
string ,
]
,
provisioningState: enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope: enum ,
grafanaIntegrations:
{
azureMonitorWorkspaceIntegrations:
[
{
azureMonitorWorkspaceResourceId: string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
marketplacePlanId: string ,
marketplaceAutoRenew: enum ,
}
,
grafanaConfigurations:
{
smtp:
{
enabled: boolean ,
host: string ,
user: string ,
password: string ,
fromAddress: string ,
fromName: string ,
startTLSPolicy: enum ,
skipVerify: boolean ,
}
,
snapshots:
{
externalEnabled: boolean ,
}
,
users:
{
viewersCanEdit: boolean ,
}
,
security:
{
csrfAlwaysCheck: boolean ,
}
,
}
,
grafanaPlugins: object ,
grafanaMajorVersion: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
}
,
}

⚐ Response (200)

{
id: string ,
name: string ,
type: string ,
sku:
{
name: string ,
}
,
properties:
{
provisioningState: enum ,
grafanaVersion: string ,
endpoint: string ,
publicNetworkAccess: enum ,
zoneRedundancy: enum ,
apiKey: enum ,
deterministicOutboundIP: enum ,
outboundIPs:
[
string ,
]
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupIds:
[
string ,
]
,
provisioningState: enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope: enum ,
grafanaIntegrations:
{
azureMonitorWorkspaceIntegrations:
[
{
azureMonitorWorkspaceResourceId: string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
marketplacePlanId: string ,
marketplaceAutoRenew: enum ,
}
,
grafanaConfigurations:
{
smtp:
{
enabled: boolean ,
host: string ,
user: string ,
password: string ,
fromAddress: string ,
fromName: string ,
startTLSPolicy: enum ,
skipVerify: boolean ,
}
,
snapshots:
{
externalEnabled: boolean ,
}
,
users:
{
viewersCanEdit: boolean ,
}
,
security:
{
csrfAlwaysCheck: boolean ,
}
,
}
,
grafanaPlugins: object ,
grafanaMajorVersion: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
id: string ,
name: string ,
type: string ,
sku:
{
name: string ,
}
,
properties:
{
provisioningState: enum ,
grafanaVersion: string ,
endpoint: string ,
publicNetworkAccess: enum ,
zoneRedundancy: enum ,
apiKey: enum ,
deterministicOutboundIP: enum ,
outboundIPs:
[
string ,
]
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupIds:
[
string ,
]
,
provisioningState: enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope: enum ,
grafanaIntegrations:
{
azureMonitorWorkspaceIntegrations:
[
{
azureMonitorWorkspaceResourceId: string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
marketplacePlanId: string ,
marketplaceAutoRenew: enum ,
}
,
grafanaConfigurations:
{
smtp:
{
enabled: boolean ,
host: string ,
user: string ,
password: string ,
fromAddress: string ,
fromName: string ,
startTLSPolicy: enum ,
skipVerify: boolean ,
}
,
snapshots:
{
externalEnabled: boolean ,
}
,
users:
{
viewersCanEdit: boolean ,
}
,
security:
{
csrfAlwaysCheck: boolean ,
}
,
}
,
grafanaPlugins: object ,
grafanaMajorVersion: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Grafana_Update (new)
Description Update a workspace for Grafana resource.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
api-version: string ,
requestBodyParameters:
{
sku:
{
name: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
tags: object ,
properties:
{
zoneRedundancy: enum ,
apiKey: enum ,
deterministicOutboundIP: enum ,
publicNetworkAccess: enum ,
grafanaIntegrations:
{
azureMonitorWorkspaceIntegrations:
[
{
azureMonitorWorkspaceResourceId: string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
marketplacePlanId: string ,
marketplaceAutoRenew: enum ,
}
,
grafanaConfigurations:
{
smtp:
{
enabled: boolean ,
host: string ,
user: string ,
password: string ,
fromAddress: string ,
fromName: string ,
startTLSPolicy: enum ,
skipVerify: boolean ,
}
,
snapshots:
{
externalEnabled: boolean ,
}
,
users:
{
viewersCanEdit: boolean ,
}
,
security:
{
csrfAlwaysCheck: boolean ,
}
,
}
,
grafanaPlugins: object ,
grafanaMajorVersion: string ,
}
,
}
,
}

⚐ Response (200)

{
id: string ,
name: string ,
type: string ,
sku:
{
name: string ,
}
,
properties:
{
provisioningState: enum ,
grafanaVersion: string ,
endpoint: string ,
publicNetworkAccess: enum ,
zoneRedundancy: enum ,
apiKey: enum ,
deterministicOutboundIP: enum ,
outboundIPs:
[
string ,
]
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupIds:
[
string ,
]
,
provisioningState: enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope: enum ,
grafanaIntegrations:
{
azureMonitorWorkspaceIntegrations:
[
{
azureMonitorWorkspaceResourceId: string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
marketplacePlanId: string ,
marketplaceAutoRenew: enum ,
}
,
grafanaConfigurations:
{
smtp:
{
enabled: boolean ,
host: string ,
user: string ,
password: string ,
fromAddress: string ,
fromName: string ,
startTLSPolicy: enum ,
skipVerify: boolean ,
}
,
snapshots:
{
externalEnabled: boolean ,
}
,
users:
{
viewersCanEdit: boolean ,
}
,
security:
{
csrfAlwaysCheck: boolean ,
}
,
}
,
grafanaPlugins: object ,
grafanaMajorVersion: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
id: string ,
name: string ,
type: string ,
sku:
{
name: string ,
}
,
properties:
{
provisioningState: enum ,
grafanaVersion: string ,
endpoint: string ,
publicNetworkAccess: enum ,
zoneRedundancy: enum ,
apiKey: enum ,
deterministicOutboundIP: enum ,
outboundIPs:
[
string ,
]
,
privateEndpointConnections:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupIds:
[
string ,
]
,
provisioningState: enum ,
}
,
}
,
]
,
autoGeneratedDomainNameLabelScope: enum ,
grafanaIntegrations:
{
azureMonitorWorkspaceIntegrations:
[
{
azureMonitorWorkspaceResourceId: string ,
}
,
]
,
}
,
enterpriseConfigurations:
{
marketplacePlanId: string ,
marketplaceAutoRenew: enum ,
}
,
grafanaConfigurations:
{
smtp:
{
enabled: boolean ,
host: string ,
user: string ,
password: string ,
fromAddress: string ,
fromName: string ,
startTLSPolicy: enum ,
skipVerify: boolean ,
}
,
snapshots:
{
externalEnabled: boolean ,
}
,
users:
{
viewersCanEdit: boolean ,
}
,
security:
{
csrfAlwaysCheck: boolean ,
}
,
}
,
grafanaPlugins: object ,
grafanaMajorVersion: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
tags: object ,
location: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Grafana_Delete (new)
Description Delete a workspace for Grafana resource.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description Get private endpoint connections.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
api-version: string ,
privateEndpointConnectionName: string ,
}

⚐ Response (200)

{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupIds:
[
string ,
]
,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Approve (new)
Description Manual approve private endpoint connection
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
api-version: string ,
privateEndpointConnectionName: string ,
body:
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupIds:
[
string ,
]
,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupIds:
[
string ,
]
,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description Delete private endpoint connection
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
api-version: string ,
privateEndpointConnectionName: string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (new)
Description Get private endpoint connection
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/privateEndpointConnections
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
groupIds:
[
string ,
]
,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateLinkResources_List (new)
Description List all private link resources information for this grafana resource
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/privateLinkResources
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
groupId: string ,
requiredMembers:
[
string ,
]
,
requiredZoneNames:
[
string ,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (new)
Description Get specific private link resource information for this grafana resource
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/privateLinkResources/{privateLinkResourceName}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
api-version: string ,
privateLinkResourceName: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
groupId: string ,
requiredMembers:
[
string ,
]
,
requiredZoneNames:
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Grafana_CheckEnterpriseDetails (new)
Description Retrieve enterprise add-on details information
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/checkEnterpriseDetails
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
api-version: string ,
}

⚐ Response (200)

{
saasSubscriptionDetails:
{
planId: string ,
offerId: string ,
publisherId: string ,
term:
{
termUnit: string ,
startDate: string ,
endDate: string ,
}
,
}
,
marketplaceTrialQuota:
{
availablePromotion: enum ,
grafanaResourceId: string ,
trialStartAt: string ,
trialEndAt: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Grafana_FetchAvailablePlugins (new)
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/fetchAvailablePlugins
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
pluginId: string ,
name: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ManagedPrivateEndpoints_List (new)
Description List all managed private endpoints of a grafana resource.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/managedPrivateEndpoints
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
privateLinkResourceId: string ,
privateLinkResourceRegion: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
connectionState:
{
status: enum ,
description: string ,
}
,
privateLinkServiceUrl: string ,
privateLinkServicePrivateIP: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ManagedPrivateEndpoints_Refresh (new)
Description Refresh and sync managed private endpoints of a grafana resource to latest state.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/refreshManagedPrivateEndpoints
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ManagedPrivateEndpoints_Get (new)
Description Get a specific managed private endpoint of a grafana resource.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/managedPrivateEndpoints/{managedPrivateEndpointName}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
managedPrivateEndpointName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
privateLinkResourceId: string ,
privateLinkResourceRegion: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
connectionState:
{
status: enum ,
description: string ,
}
,
privateLinkServiceUrl: string ,
privateLinkServicePrivateIP: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ManagedPrivateEndpoints_Create (new)
Description Create or update a managed private endpoint for a grafana resource.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/managedPrivateEndpoints/{managedPrivateEndpointName}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
managedPrivateEndpointName: string ,
api-version: string ,
requestBodyParameters:
{
properties:
{
provisioningState: enum ,
privateLinkResourceId: string ,
privateLinkResourceRegion: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
connectionState:
{
status: enum ,
description: string ,
}
,
privateLinkServiceUrl: string ,
privateLinkServicePrivateIP: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
privateLinkResourceId: string ,
privateLinkResourceRegion: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
connectionState:
{
status: enum ,
description: string ,
}
,
privateLinkServiceUrl: string ,
privateLinkServicePrivateIP: string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
properties:
{
provisioningState: enum ,
privateLinkResourceId: string ,
privateLinkResourceRegion: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
connectionState:
{
status: enum ,
description: string ,
}
,
privateLinkServiceUrl: string ,
privateLinkServicePrivateIP: string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ManagedPrivateEndpoints_Update (new)
Description Update a managed private endpoint for an existing grafana resource.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/managedPrivateEndpoints/{managedPrivateEndpointName}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
managedPrivateEndpointName: string ,
api-version: string ,
requestBodyParameters:
{
tags: object ,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
privateLinkResourceId: string ,
privateLinkResourceRegion: string ,
groupIds:
[
string ,
]
,
requestMessage: string ,
connectionState:
{