Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Dynatrace
  3. API Docs
  4. Report
Dynatrace v0.21.0 published on Sunday, Nov 17, 2024 by Pulumiverse
lbrlabs/pulumi-dynatrace

dynatrace.Report

Explore with Pulumi AI

dynatrace logo
Dynatrace v0.21.0 published on Sunday, Nov 17, 2024 by Pulumiverse
lbrlabs/pulumi-dynatrace

    This resource requires the API token scopes Read configuration (ReadConfig) and Write configuration (WriteConfig)

    Dynatrace Documentation

    • Subscribe to Dynatrace dashboard reports - https://docs.dynatrace.com/docs/observe-and-explore/dashboards-classic/dashboards/subscribe-to-dashboard-reports

    • Reports API - https://docs.dynatrace.com/docs/dynatrace-api/configuration-api/reports-api

    Create Report Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Report(name: string, args: ReportArgs, opts?: CustomResourceOptions);
    @overload
def Report(resource_name: str,
           args: ReportArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Report(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           dashboard_id: Optional[str] = None,
           type: Optional[str] = None,
           email_notifications: Optional[bool] = None,
           subscriptions: Optional[ReportSubscriptionsArgs] = None)
    func NewReport(ctx *Context, name string, args ReportArgs, opts ...ResourceOption) (*Report, error)
    public Report(string name, ReportArgs args, CustomResourceOptions? opts = null)
    public Report(String name, ReportArgs args)
public Report(String name, ReportArgs args, CustomResourceOptions options)

    type: dynatrace:Report
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ReportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ReportArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ReportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReportArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var reportResource = new Dynatrace.Report("reportResource", new()
{
    DashboardId = "string",
    Type = "string",
    EmailNotifications = false,
    Subscriptions = new Dynatrace.Inputs.ReportSubscriptionsArgs
    {
        Months = new[]
        {
            "string",
        },
        Weeks = new[]
        {
            "string",
        },
    },
});

    example, err := dynatrace.NewReport(ctx, "reportResource", &dynatrace.ReportArgs{
	DashboardId:        pulumi.String("string"),
	Type:               pulumi.String("string"),
	EmailNotifications: pulumi.Bool(false),
	Subscriptions: &dynatrace.ReportSubscriptionsArgs{
		Months: pulumi.StringArray{
			pulumi.String("string"),
		},
		Weeks: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

    var reportResource = new Report("reportResource", ReportArgs.builder()
    .dashboardId("string")
    .type("string")
    .emailNotifications(false)
    .subscriptions(ReportSubscriptionsArgs.builder()
        .months("string")
        .weeks("string")
        .build())
    .build());

    report_resource = dynatrace.Report("reportResource",
    dashboard_id="string",
    type="string",
    email_notifications=False,
    subscriptions={
        "months": ["string"],
        "weeks": ["string"],
    })

    const reportResource = new dynatrace.Report("reportResource", {
    dashboardId: "string",
    type: "string",
    emailNotifications: false,
    subscriptions: {
        months: ["string"],
        weeks: ["string"],
    },
});

    type: dynatrace:Report
properties:
    dashboardId: string
    emailNotifications: false
    subscriptions:
        months:
            - string
        weeks:
            - string
    type: string

    Report Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Report resource accepts the following input properties:

    DashboardId string
    The ID of the associated dashboard
    Type string
    The type of report
    EmailNotifications bool
    The email notifications for the dashboard report are enabled (true) or disabled (false).
    Subscriptions Pulumiverse.Dynatrace.Inputs.ReportSubscriptions
    A list of the report subscribers
    DashboardId string
    The ID of the associated dashboard
    Type string
    The type of report
    EmailNotifications bool
    The email notifications for the dashboard report are enabled (true) or disabled (false).
    Subscriptions ReportSubscriptionsArgs
    A list of the report subscribers
    dashboardId String
    The ID of the associated dashboard
    type String
    The type of report
    emailNotifications Boolean
    The email notifications for the dashboard report are enabled (true) or disabled (false).
    subscriptions ReportSubscriptions
    A list of the report subscribers
    dashboardId string
    The ID of the associated dashboard
    type string
    The type of report
    emailNotifications boolean
    The email notifications for the dashboard report are enabled (true) or disabled (false).
    subscriptions ReportSubscriptions
    A list of the report subscribers
    dashboard_id str
    The ID of the associated dashboard
    type str
    The type of report
    email_notifications bool
    The email notifications for the dashboard report are enabled (true) or disabled (false).
    subscriptions ReportSubscriptionsArgs
    A list of the report subscribers
    dashboardId String
    The ID of the associated dashboard
    type String
    The type of report
    emailNotifications Boolean
    The email notifications for the dashboard report are enabled (true) or disabled (false).
    subscriptions Property Map
    A list of the report subscribers

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Report resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Report Resource

    Get an existing Report resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ReportState, opts?: CustomResourceOptions): Report
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dashboard_id: Optional[str] = None,
        email_notifications: Optional[bool] = None,
        subscriptions: Optional[ReportSubscriptionsArgs] = None,
        type: Optional[str] = None) -> Report
    func GetReport(ctx *Context, name string, id IDInput, state *ReportState, opts ...ResourceOption) (*Report, error)
    public static Report Get(string name, Input<string> id, ReportState? state, CustomResourceOptions? opts = null)
    public static Report get(String name, Output<String> id, ReportState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DashboardId string
    The ID of the associated dashboard
    EmailNotifications bool
    The email notifications for the dashboard report are enabled (true) or disabled (false).
    Subscriptions Pulumiverse.Dynatrace.Inputs.ReportSubscriptions
    A list of the report subscribers
    Type string
    The type of report
    DashboardId string
    The ID of the associated dashboard
    EmailNotifications bool
    The email notifications for the dashboard report are enabled (true) or disabled (false).
    Subscriptions ReportSubscriptionsArgs
    A list of the report subscribers
    Type string
    The type of report
    dashboardId String
    The ID of the associated dashboard
    emailNotifications Boolean
    The email notifications for the dashboard report are enabled (true) or disabled (false).
    subscriptions ReportSubscriptions
    A list of the report subscribers
    type String
    The type of report
    dashboardId string
    The ID of the associated dashboard
    emailNotifications boolean
    The email notifications for the dashboard report are enabled (true) or disabled (false).
    subscriptions ReportSubscriptions
    A list of the report subscribers
    type string
    The type of report
    dashboard_id str
    The ID of the associated dashboard
    email_notifications bool
    The email notifications for the dashboard report are enabled (true) or disabled (false).
    subscriptions ReportSubscriptionsArgs
    A list of the report subscribers
    type str
    The type of report
    dashboardId String
    The ID of the associated dashboard
    emailNotifications Boolean
    The email notifications for the dashboard report are enabled (true) or disabled (false).
    subscriptions Property Map
    A list of the report subscribers
    type String
    The type of report

    Supporting Types

    ReportSubscriptions, ReportSubscriptionsArgs

    Months List<string>
    A list of monthly subscribers. Monthly subscribers receive the report on the first Monday of the month at midnight. You can specify email addresses or Dynatrace user IDs here.
    Weeks List<string>
    A list of weekly subscribers. Weekly subscribers receive the report every Monday at midnight. You can specify email addresses or Dynatrace user IDs here.
    Months []string
    A list of monthly subscribers. Monthly subscribers receive the report on the first Monday of the month at midnight. You can specify email addresses or Dynatrace user IDs here.
    Weeks []string
    A list of weekly subscribers. Weekly subscribers receive the report every Monday at midnight. You can specify email addresses or Dynatrace user IDs here.
    months List<String>
    A list of monthly subscribers. Monthly subscribers receive the report on the first Monday of the month at midnight. You can specify email addresses or Dynatrace user IDs here.
    weeks List<String>
    A list of weekly subscribers. Weekly subscribers receive the report every Monday at midnight. You can specify email addresses or Dynatrace user IDs here.
    months string[]
    A list of monthly subscribers. Monthly subscribers receive the report on the first Monday of the month at midnight. You can specify email addresses or Dynatrace user IDs here.
    weeks string[]
    A list of weekly subscribers. Weekly subscribers receive the report every Monday at midnight. You can specify email addresses or Dynatrace user IDs here.
    months Sequence[str]
    A list of monthly subscribers. Monthly subscribers receive the report on the first Monday of the month at midnight. You can specify email addresses or Dynatrace user IDs here.
    weeks Sequence[str]
    A list of weekly subscribers. Weekly subscribers receive the report every Monday at midnight. You can specify email addresses or Dynatrace user IDs here.
    months List<String>
    A list of monthly subscribers. Monthly subscribers receive the report on the first Monday of the month at midnight. You can specify email addresses or Dynatrace user IDs here.
    weeks List<String>
    A list of weekly subscribers. Weekly subscribers receive the report every Monday at midnight. You can specify email addresses or Dynatrace user IDs here.

    Package Details

    Repository
    dynatrace pulumiverse/pulumi-dynatrace
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dynatrace Terraform Provider.
    dynatrace logo
    Dynatrace v0.21.0 published on Sunday, Nov 17, 2024 by Pulumiverse
    lbrlabs/pulumi-dynatrace