1. Packages
  2. Azure Native
  3. API Docs
  4. portal
  5. getDashboard
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

azure-native.portal.getDashboard

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

    Gets the Dashboard. Azure REST API version: 2020-09-01-preview.

    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>
    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]
    func LookupDashboard(ctx *Context, args *LookupDashboardArgs, opts ...InvokeOption) (*LookupDashboardResult, error)
    func LookupDashboardOutput(ctx *Context, args *LookupDashboardOutputArgs, opts ...InvokeOption) LookupDashboardResultOutput

    > 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)
    }
    public static CompletableFuture<GetDashboardResult> getDashboard(GetDashboardArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:portal:getDashboard
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DashboardName string

    The name of the dashboard.

    ResourceGroupName string

    The name of the resource group.

    DashboardName string

    The name of the dashboard.

    ResourceGroupName string

    The name of the resource group.

    dashboardName String

    The name of the dashboard.

    resourceGroupName String

    The name of the resource group.

    dashboardName string

    The name of the dashboard.

    resourceGroupName string

    The name of the resource group.

    dashboard_name str

    The name of the dashboard.

    resource_group_name str

    The name of the resource group.

    dashboardName String

    The name of the dashboard.

    resourceGroupName String

    The name of the resource group.

    getDashboard Result

    The following output properties are available:

    Id string

    Resource Id

    Location string

    Resource location

    Name string

    Resource name

    Type string

    Resource type

    Lenses List<Pulumi.AzureNative.Portal.Outputs.DashboardLensResponse>

    The dashboard lenses.

    Metadata Dictionary<string, object>

    The dashboard metadata.

    Tags Dictionary<string, string>

    Resource tags

    Id string

    Resource Id

    Location string

    Resource location

    Name string

    Resource name

    Type string

    Resource type

    Lenses []DashboardLensResponse

    The dashboard lenses.

    Metadata map[string]interface{}

    The dashboard metadata.

    Tags map[string]string

    Resource tags

    id String

    Resource Id

    location String

    Resource location

    name String

    Resource name

    type String

    Resource type

    lenses List<DashboardLensResponse>

    The dashboard lenses.

    metadata Map<String,Object>

    The dashboard metadata.

    tags Map<String,String>

    Resource tags

    id string

    Resource Id

    location string

    Resource location

    name string

    Resource name

    type string

    Resource type

    lenses DashboardLensResponse[]

    The dashboard lenses.

    metadata {[key: string]: any}

    The dashboard metadata.

    tags {[key: string]: string}

    Resource tags

    id str

    Resource Id

    location str

    Resource location

    name str

    Resource name

    type str

    Resource type

    lenses Sequence[DashboardLensResponse]

    The dashboard lenses.

    metadata Mapping[str, Any]

    The dashboard metadata.

    tags Mapping[str, str]

    Resource tags

    id String

    Resource Id

    location String

    Resource location

    name String

    Resource name

    type String

    Resource type

    lenses List<Property Map>

    The dashboard lenses.

    metadata Map<Any>

    The dashboard metadata.

    tags Map<String>

    Resource tags

    Supporting Types

    DashboardLensResponse

    Order int

    The lens order.

    Parts List<Pulumi.AzureNative.Portal.Inputs.DashboardPartsResponse>

    The dashboard parts.

    Metadata Dictionary<string, object>

    The dashboard len's metadata.

    Order int

    The lens order.

    Parts []DashboardPartsResponse

    The dashboard parts.

    Metadata map[string]interface{}

    The dashboard len's metadata.

    order Integer

    The lens order.

    parts List<DashboardPartsResponse>

    The dashboard parts.

    metadata Map<String,Object>

    The dashboard len's metadata.

    order number

    The lens order.

    parts DashboardPartsResponse[]

    The dashboard parts.

    metadata {[key: string]: any}

    The dashboard len's metadata.

    order int

    The lens order.

    parts Sequence[DashboardPartsResponse]

    The dashboard parts.

    metadata Mapping[str, Any]

    The dashboard len's metadata.

    order Number

    The lens order.

    parts List<Property Map>

    The dashboard parts.

    metadata Map<Any>

    The dashboard len's metadata.

    DashboardPartsResponse

    Position DashboardPartsResponsePosition

    The dashboard's part position.

    Metadata MarkdownPartMetadataResponse

    The dashboard part's metadata.

    position DashboardPartsResponsePosition

    The dashboard's part position.

    metadata MarkdownPartMetadataResponse

    The dashboard part's metadata.

    position DashboardPartsResponsePosition

    The dashboard's part position.

    metadata MarkdownPartMetadataResponse

    The dashboard part's metadata.

    position DashboardPartsResponsePosition

    The dashboard's part position.

    metadata MarkdownPartMetadataResponse

    The dashboard part's metadata.

    position Property Map

    The dashboard's part position.

    metadata Property Map

    The dashboard part's metadata.

    DashboardPartsResponsePosition

    ColSpan int

    The dashboard's part column span.

    RowSpan int

    The dashboard's part row span.

    X int

    The dashboard's part x coordinate.

    Y int

    The dashboard's part y coordinate.

    Metadata Dictionary<string, object>

    The dashboard part's metadata.

    ColSpan int

    The dashboard's part column span.

    RowSpan int

    The dashboard's part row span.

    X int

    The dashboard's part x coordinate.

    Y int

    The dashboard's part y coordinate.

    Metadata map[string]interface{}

    The dashboard part's metadata.

    colSpan Integer

    The dashboard's part column span.

    rowSpan Integer

    The dashboard's part row span.

    x Integer

    The dashboard's part x coordinate.

    y Integer

    The dashboard's part y coordinate.

    metadata Map<String,Object>

    The dashboard part's metadata.

    colSpan number

    The dashboard's part column span.

    rowSpan number

    The dashboard's part row span.

    x number

    The dashboard's part x coordinate.

    y number

    The dashboard's part y coordinate.

    metadata {[key: string]: any}

    The dashboard part's metadata.

    col_span int

    The dashboard's part column span.

    row_span int

    The dashboard's part row span.

    x int

    The dashboard's part x coordinate.

    y int

    The dashboard's part y coordinate.

    metadata Mapping[str, Any]

    The dashboard part's metadata.

    colSpan Number

    The dashboard's part column span.

    rowSpan Number

    The dashboard's part row span.

    x Number

    The dashboard's part x coordinate.

    y Number

    The dashboard's part y coordinate.

    metadata Map<Any>

    The dashboard part's metadata.

    MarkdownPartMetadataResponse

    Inputs List<object>

    Input to dashboard part.

    Settings Pulumi.AzureNative.Portal.Inputs.MarkdownPartMetadataResponseSettings

    Markdown part settings.

    Inputs []interface{}

    Input to dashboard part.

    Settings MarkdownPartMetadataResponseSettings

    Markdown part settings.

    inputs List<Object>

    Input to dashboard part.

    settings MarkdownPartMetadataResponseSettings

    Markdown part settings.

    inputs any[]

    Input to dashboard part.

    settings MarkdownPartMetadataResponseSettings

    Markdown part settings.

    inputs Sequence[Any]

    Input to dashboard part.

    settings MarkdownPartMetadataResponseSettings

    Markdown part settings.

    inputs List<Any>

    Input to dashboard part.

    settings Property Map

    Markdown part settings.

    MarkdownPartMetadataResponseContent

    Settings MarkdownPartMetadataResponseSettingsSettings

    The setting of the content of markdown part.

    settings MarkdownPartMetadataResponseSettingsSettings

    The setting of the content of markdown part.

    settings MarkdownPartMetadataResponseSettingsSettings

    The setting of the content of markdown part.

    settings MarkdownPartMetadataResponseSettingsSettings

    The setting of the content of markdown part.

    settings Property Map

    The setting of the content of markdown part.

    MarkdownPartMetadataResponseSettings

    Content MarkdownPartMetadataResponseContent

    The content of markdown part.

    content MarkdownPartMetadataResponseContent

    The content of markdown part.

    content MarkdownPartMetadataResponseContent

    The content of markdown part.

    content MarkdownPartMetadataResponseContent

    The content of markdown part.

    content Property Map

    The content of markdown part.

    MarkdownPartMetadataResponseSettingsSettings

    Content string

    The content of the markdown part.

    MarkdownSource int

    The source of the content of the markdown part.

    MarkdownUri string

    The uri of markdown content.

    Subtitle string

    The subtitle of the markdown part.

    Title string

    The title of the markdown part.

    Content string

    The content of the markdown part.

    MarkdownSource int

    The source of the content of the markdown part.

    MarkdownUri string

    The uri of markdown content.

    Subtitle string

    The subtitle of the markdown part.

    Title string

    The title of the markdown part.

    content String

    The content of the markdown part.

    markdownSource Integer

    The source of the content of the markdown part.

    markdownUri String

    The uri of markdown content.

    subtitle String

    The subtitle of the markdown part.

    title String

    The title of the markdown part.

    content string

    The content of the markdown part.

    markdownSource number

    The source of the content of the markdown part.

    markdownUri string

    The uri of markdown content.

    subtitle string

    The subtitle of the markdown part.

    title string

    The title of the markdown part.

    content str

    The content of the markdown part.

    markdown_source int

    The source of the content of the markdown part.

    markdown_uri str

    The uri of markdown content.

    subtitle str

    The subtitle of the markdown part.

    title str

    The title of the markdown part.

    content String

    The content of the markdown part.

    markdownSource Number

    The source of the content of the markdown part.

    markdownUri String

    The uri of markdown content.

    subtitle String

    The subtitle of the markdown part.

    title String

    The title of the markdown part.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi