Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. portal
  5. getDashboard
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.portal.getDashboard

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the Dashboard.

Uses Azure REST API version 2022-12-01-preview.

Other available API versions: 2019-01-01-preview, 2020-09-01-preview, 2025-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native portal [ApiVersion]. See the version guide for details.

Using getDashboard

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDashboard(args: GetDashboardArgs, opts?: InvokeOptions): Promise<GetDashboardResult>
function getDashboardOutput(args: GetDashboardOutputArgs, opts?: InvokeOptions): Output<GetDashboardResult>
Copy
def get_dashboard(dashboard_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDashboardResult
def get_dashboard_output(dashboard_name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetDashboardResult]
Copy
func LookupDashboard(ctx *Context, args *LookupDashboardArgs, opts ...InvokeOption) (*LookupDashboardResult, error)
func LookupDashboardOutput(ctx *Context, args *LookupDashboardOutputArgs, opts ...InvokeOption) LookupDashboardResultOutput
Copy

> Note: This function is named LookupDashboard in the Go SDK.

public static class GetDashboard 
{
    public static Task<GetDashboardResult> InvokeAsync(GetDashboardArgs args, InvokeOptions? opts = null)
    public static Output<GetDashboardResult> Invoke(GetDashboardInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDashboardResult> getDashboard(GetDashboardArgs args, InvokeOptions options)
public static Output<GetDashboardResult> getDashboard(GetDashboardArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:portal:getDashboard
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DashboardName
This property is required.
Changes to this property will trigger replacement.
string
The name of the dashboard.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
DashboardName
This property is required.
Changes to this property will trigger replacement.
string
The name of the dashboard.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
dashboardName
This property is required.
Changes to this property will trigger replacement.
String
The name of the dashboard.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
dashboardName
This property is required.
Changes to this property will trigger replacement.
string
The name of the dashboard.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
dashboard_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the dashboard.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
dashboardName
This property is required.
Changes to this property will trigger replacement.
String
The name of the dashboard.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getDashboard Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties Pulumi.AzureNative.Portal.Outputs.DashboardPropertiesWithProvisioningStateResponse
The resource-specific properties for this resource.
SystemData Pulumi.AzureNative.Portal.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties DashboardPropertiesWithProvisioningStateResponse
The resource-specific properties for this resource.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
properties DashboardPropertiesWithProvisioningStateResponse
The resource-specific properties for this resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string
The geo-location where the resource lives
name string
The name of the resource
properties DashboardPropertiesWithProvisioningStateResponse
The resource-specific properties for this resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str
The geo-location where the resource lives
name str
The name of the resource
properties DashboardPropertiesWithProvisioningStateResponse
The resource-specific properties for this resource.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
properties Property Map
The resource-specific properties for this resource.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String>
Resource tags.

Supporting Types

DashboardLensResponse

Order This property is required. int
The lens order.
Parts This property is required. List<Pulumi.AzureNative.Portal.Inputs.DashboardPartsResponse>
The dashboard parts.
Metadata object
The dashboard len's metadata.
Order This property is required. int
The lens order.
Parts This property is required. []DashboardPartsResponse
The dashboard parts.
Metadata interface{}
The dashboard len's metadata.
order This property is required. Integer
The lens order.
parts This property is required. List<DashboardPartsResponse>
The dashboard parts.
metadata Object
The dashboard len's metadata.
order This property is required. number
The lens order.
parts This property is required. DashboardPartsResponse[]
The dashboard parts.
metadata any
The dashboard len's metadata.
order This property is required. int
The lens order.
parts This property is required. Sequence[DashboardPartsResponse]
The dashboard parts.
metadata Any
The dashboard len's metadata.
order This property is required. Number
The lens order.
parts This property is required. List<Property Map>
The dashboard parts.
metadata Any
The dashboard len's metadata.

DashboardPartMetadataResponse

Type This property is required. string
The type of dashboard part.
Inputs List<object>
Inputs to dashboard part.
Settings Dictionary<string, object>
Settings of dashboard part.
Type This property is required. string
The type of dashboard part.
Inputs []interface{}
Inputs to dashboard part.
Settings map[string]interface{}
Settings of dashboard part.
type This property is required. String
The type of dashboard part.
inputs List<Object>
Inputs to dashboard part.
settings Map<String,Object>
Settings of dashboard part.
type This property is required. string
The type of dashboard part.
inputs any[]
Inputs to dashboard part.
settings {[key: string]: any}
Settings of dashboard part.
type This property is required. str
The type of dashboard part.
inputs Sequence[Any]
Inputs to dashboard part.
settings Mapping[str, Any]
Settings of dashboard part.
type This property is required. String
The type of dashboard part.
inputs List<Any>
Inputs to dashboard part.
settings Map<Any>
Settings of dashboard part.

DashboardPartsPositionResponse

ColSpan This property is required. int
The dashboard's part column span.
RowSpan This property is required. int
The dashboard's part row span.
X This property is required. int
The dashboard's part x coordinate.
Y This property is required. int
The dashboard's part y coordinate.
Metadata object
The dashboard part's metadata.
ColSpan This property is required. int
The dashboard's part column span.
RowSpan This property is required. int
The dashboard's part row span.
X This property is required. int
The dashboard's part x coordinate.
Y This property is required. int
The dashboard's part y coordinate.
Metadata interface{}
The dashboard part's metadata.
colSpan This property is required. Integer
The dashboard's part column span.
rowSpan This property is required. Integer
The dashboard's part row span.
x This property is required. Integer
The dashboard's part x coordinate.
y This property is required. Integer
The dashboard's part y coordinate.
metadata Object
The dashboard part's metadata.
colSpan This property is required. number
The dashboard's part column span.
rowSpan This property is required. number
The dashboard's part row span.
x This property is required. number
The dashboard's part x coordinate.
y This property is required. number
The dashboard's part y coordinate.
metadata any
The dashboard part's metadata.
col_span This property is required. int
The dashboard's part column span.
row_span This property is required. int
The dashboard's part row span.
x This property is required. int
The dashboard's part x coordinate.
y This property is required. int
The dashboard's part y coordinate.
metadata Any
The dashboard part's metadata.
colSpan This property is required. Number
The dashboard's part column span.
rowSpan This property is required. Number
The dashboard's part row span.
x This property is required. Number
The dashboard's part x coordinate.
y This property is required. Number
The dashboard's part y coordinate.
metadata Any
The dashboard part's metadata.

DashboardPartsResponse

Position This property is required. DashboardPartsPositionResponse
The dashboard's part position.
Metadata DashboardPartMetadataResponse
The dashboard's part metadata.
position This property is required. DashboardPartsPositionResponse
The dashboard's part position.
metadata DashboardPartMetadataResponse
The dashboard's part metadata.
position This property is required. DashboardPartsPositionResponse
The dashboard's part position.
metadata DashboardPartMetadataResponse
The dashboard's part metadata.
position This property is required. DashboardPartsPositionResponse
The dashboard's part position.
metadata DashboardPartMetadataResponse
The dashboard's part metadata.
position This property is required. Property Map
The dashboard's part position.
metadata Property Map
The dashboard's part metadata.

DashboardPropertiesWithProvisioningStateResponse

ProvisioningState This property is required. string
The status of the last operation.
Lenses List<Pulumi.AzureNative.Portal.Inputs.DashboardLensResponse>
The dashboard lenses.
Metadata object
The dashboard metadata.
ProvisioningState This property is required. string
The status of the last operation.
Lenses []DashboardLensResponse
The dashboard lenses.
Metadata interface{}
The dashboard metadata.
provisioningState This property is required. String
The status of the last operation.
lenses List<DashboardLensResponse>
The dashboard lenses.
metadata Object
The dashboard metadata.
provisioningState This property is required. string
The status of the last operation.
lenses DashboardLensResponse[]
The dashboard lenses.
metadata any
The dashboard metadata.
provisioning_state This property is required. str
The status of the last operation.
lenses Sequence[DashboardLensResponse]
The dashboard lenses.
metadata Any
The dashboard metadata.
provisioningState This property is required. String
The status of the last operation.
lenses List<Property Map>
The dashboard lenses.
metadata Any
The dashboard metadata.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native