Docs Packages
  1. Packages
  2. Dynatrace
  3. API Docs
  4. DashboardSharing
Dynatrace v0.1.0 published on Wednesday, May 24, 2023 by Lbrlabs
lbrlabs/pulumi-dynatrace

dynatrace.DashboardSharing

Explore with Pulumi AI

dynatrace logo
Dynatrace v0.1.0 published on Wednesday, May 24, 2023 by Lbrlabs
lbrlabs/pulumi-dynatrace

    Dynatrace Documentation

    • Share Dynatrace dashboards - https://www.dynatrace.com/support/help/how-to-use-dynatrace/dashboards-and-charts/dashboards/share-dashboards

    • Dashboards API - https://www.dynatrace.com/support/help/dynatrace-api/configuration-api/dashboards-api

    Create DashboardSharing Resource

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

    Constructor syntax

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

@overload
def DashboardSharing(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     dashboard_id: Optional[str] = None,
                     enabled: Optional[bool] = None,
                     permissions: Optional[DashboardSharingPermissionsArgs] = None,
                     preset: Optional[bool] = None,
                     public: Optional[DashboardSharingPublicArgs] = None)
    func NewDashboardSharing(ctx *Context, name string, args DashboardSharingArgs, opts ...ResourceOption) (*DashboardSharing, error)
    public DashboardSharing(string name, DashboardSharingArgs args, CustomResourceOptions? opts = null)
    public DashboardSharing(String name, DashboardSharingArgs args)
public DashboardSharing(String name, DashboardSharingArgs args, CustomResourceOptions options)

    type: dynatrace:DashboardSharing
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 DashboardSharingArgs
    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 DashboardSharingArgs
    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 DashboardSharingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DashboardSharingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DashboardSharingArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var dashboardSharingResource = new Dynatrace.DashboardSharing("dashboardSharingResource", new()
{
    DashboardId = "string",
    Enabled = false,
    Permissions = new Dynatrace.Inputs.DashboardSharingPermissionsArgs
    {
        Permissions = new[]
        {
            new Dynatrace.Inputs.DashboardSharingPermissionsPermissionArgs
            {
                Level = "string",
                Type = "string",
                Id = "string",
            },
        },
    },
    Preset = false,
    Public = new Dynatrace.Inputs.DashboardSharingPublicArgs
    {
        ManagementZones = new[]
        {
            "string",
        },
        Urls = 
        {
            { "string", "string" },
        },
    },
});

    example, err := dynatrace.NewDashboardSharing(ctx, "dashboardSharingResource", &dynatrace.DashboardSharingArgs{
	DashboardId: pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Permissions: &dynatrace.DashboardSharingPermissionsArgs{
		Permissions: dynatrace.DashboardSharingPermissionsPermissionArray{
			&dynatrace.DashboardSharingPermissionsPermissionArgs{
				Level: pulumi.String("string"),
				Type:  pulumi.String("string"),
				Id:    pulumi.String("string"),
			},
		},
	},
	Preset: pulumi.Bool(false),
	Public: &dynatrace.DashboardSharingPublicArgs{
		ManagementZones: pulumi.StringArray{
			pulumi.String("string"),
		},
		Urls: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
})

    var dashboardSharingResource = new DashboardSharing("dashboardSharingResource", DashboardSharingArgs.builder()        
    .dashboardId("string")
    .enabled(false)
    .permissions(DashboardSharingPermissionsArgs.builder()
        .permissions(DashboardSharingPermissionsPermissionArgs.builder()
            .level("string")
            .type("string")
            .id("string")
            .build())
        .build())
    .preset(false)
    .public_(DashboardSharingPublicArgs.builder()
        .managementZones("string")
        .urls(Map.of("string", "string"))
        .build())
    .build());

    dashboard_sharing_resource = dynatrace.DashboardSharing("dashboardSharingResource",
    dashboard_id="string",
    enabled=False,
    permissions=dynatrace.DashboardSharingPermissionsArgs(
        permissions=[dynatrace.DashboardSharingPermissionsPermissionArgs(
            level="string",
            type="string",
            id="string",
        )],
    ),
    preset=False,
    public=dynatrace.DashboardSharingPublicArgs(
        management_zones=["string"],
        urls={
            "string": "string",
        },
    ))

    const dashboardSharingResource = new dynatrace.DashboardSharing("dashboardSharingResource", {
    dashboardId: "string",
    enabled: false,
    permissions: {
        permissions: [{
            level: "string",
            type: "string",
            id: "string",
        }],
    },
    preset: false,
    "public": {
        managementZones: ["string"],
        urls: {
            string: "string",
        },
    },
});

    type: dynatrace:DashboardSharing
properties:
    dashboardId: string
    enabled: false
    permissions:
        permissions:
            - id: string
              level: string
              type: string
    preset: false
    public:
        managementZones:
            - string
        urls:
            string: string

    DashboardSharing Resource Properties

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

    Inputs

    The DashboardSharing resource accepts the following input properties:

    DashboardId string
    The Dynatrace entity ID of the dashboard
    Enabled bool
    The dashboard is shared (true) or private (false)
    Permissions Lbrlabs.PulumiPackage.Dynatrace.Inputs.DashboardSharingPermissions
    Access permissions of the dashboard
    Preset bool
    If true the dashboard will be marked as preset
    Public Lbrlabs.PulumiPackage.Dynatrace.Inputs.DashboardSharingPublic
    Configuration of the anonymous access to the dashboard
    DashboardId string
    The Dynatrace entity ID of the dashboard
    Enabled bool
    The dashboard is shared (true) or private (false)
    Permissions DashboardSharingPermissionsArgs
    Access permissions of the dashboard
    Preset bool
    If true the dashboard will be marked as preset
    Public DashboardSharingPublicArgs
    Configuration of the anonymous access to the dashboard
    dashboardId String
    The Dynatrace entity ID of the dashboard
    enabled Boolean
    The dashboard is shared (true) or private (false)
    permissions DashboardSharingPermissions
    Access permissions of the dashboard
    preset Boolean
    If true the dashboard will be marked as preset
    public_ DashboardSharingPublic
    Configuration of the anonymous access to the dashboard
    dashboardId string
    The Dynatrace entity ID of the dashboard
    enabled boolean
    The dashboard is shared (true) or private (false)
    permissions DashboardSharingPermissions
    Access permissions of the dashboard
    preset boolean
    If true the dashboard will be marked as preset
    public DashboardSharingPublic
    Configuration of the anonymous access to the dashboard
    dashboard_id str
    The Dynatrace entity ID of the dashboard
    enabled bool
    The dashboard is shared (true) or private (false)
    permissions DashboardSharingPermissionsArgs
    Access permissions of the dashboard
    preset bool
    If true the dashboard will be marked as preset
    public DashboardSharingPublicArgs
    Configuration of the anonymous access to the dashboard
    dashboardId String
    The Dynatrace entity ID of the dashboard
    enabled Boolean
    The dashboard is shared (true) or private (false)
    permissions Property Map
    Access permissions of the dashboard
    preset Boolean
    If true the dashboard will be marked as preset
    public Property Map
    Configuration of the anonymous access to the dashboard

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DashboardSharing 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 DashboardSharing Resource

    Get an existing DashboardSharing 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?: DashboardSharingState, opts?: CustomResourceOptions): DashboardSharing
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dashboard_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        permissions: Optional[DashboardSharingPermissionsArgs] = None,
        preset: Optional[bool] = None,
        public: Optional[DashboardSharingPublicArgs] = None) -> DashboardSharing
    func GetDashboardSharing(ctx *Context, name string, id IDInput, state *DashboardSharingState, opts ...ResourceOption) (*DashboardSharing, error)
    public static DashboardSharing Get(string name, Input<string> id, DashboardSharingState? state, CustomResourceOptions? opts = null)
    public static DashboardSharing get(String name, Output<String> id, DashboardSharingState 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 Dynatrace entity ID of the dashboard
    Enabled bool
    The dashboard is shared (true) or private (false)
    Permissions Lbrlabs.PulumiPackage.Dynatrace.Inputs.DashboardSharingPermissions
    Access permissions of the dashboard
    Preset bool
    If true the dashboard will be marked as preset
    Public Lbrlabs.PulumiPackage.Dynatrace.Inputs.DashboardSharingPublic
    Configuration of the anonymous access to the dashboard
    DashboardId string
    The Dynatrace entity ID of the dashboard
    Enabled bool
    The dashboard is shared (true) or private (false)
    Permissions DashboardSharingPermissionsArgs
    Access permissions of the dashboard
    Preset bool
    If true the dashboard will be marked as preset
    Public DashboardSharingPublicArgs
    Configuration of the anonymous access to the dashboard
    dashboardId String
    The Dynatrace entity ID of the dashboard
    enabled Boolean
    The dashboard is shared (true) or private (false)
    permissions DashboardSharingPermissions
    Access permissions of the dashboard
    preset Boolean
    If true the dashboard will be marked as preset
    public_ DashboardSharingPublic
    Configuration of the anonymous access to the dashboard
    dashboardId string
    The Dynatrace entity ID of the dashboard
    enabled boolean
    The dashboard is shared (true) or private (false)
    permissions DashboardSharingPermissions
    Access permissions of the dashboard
    preset boolean
    If true the dashboard will be marked as preset
    public DashboardSharingPublic
    Configuration of the anonymous access to the dashboard
    dashboard_id str
    The Dynatrace entity ID of the dashboard
    enabled bool
    The dashboard is shared (true) or private (false)
    permissions DashboardSharingPermissionsArgs
    Access permissions of the dashboard
    preset bool
    If true the dashboard will be marked as preset
    public DashboardSharingPublicArgs
    Configuration of the anonymous access to the dashboard
    dashboardId String
    The Dynatrace entity ID of the dashboard
    enabled Boolean
    The dashboard is shared (true) or private (false)
    permissions Property Map
    Access permissions of the dashboard
    preset Boolean
    If true the dashboard will be marked as preset
    public Property Map
    Configuration of the anonymous access to the dashboard

    Supporting Types

    DashboardSharingPermissions, DashboardSharingPermissionsArgs

    Permissions []DashboardSharingPermissionsPermission
    Access permissions of the dashboard
    permissions List<DashboardSharingPermissionsPermission>
    Access permissions of the dashboard
    permissions DashboardSharingPermissionsPermission[]
    Access permissions of the dashboard
    permissions List<Property Map>
    Access permissions of the dashboard

    DashboardSharingPermissionsPermission, DashboardSharingPermissionsPermissionArgs

    Level string
    Type string
    Id string
    The ID of this resource.
    Level string
    Type string
    Id string
    The ID of this resource.
    level String
    type String
    id String
    The ID of this resource.
    level string
    type string
    id string
    The ID of this resource.
    level str
    type str
    id str
    The ID of this resource.
    level String
    type String
    id String
    The ID of this resource.

    DashboardSharingPublic, DashboardSharingPublicArgs

    ManagementZones List<string>
    A list of management zones that can display data on the publicly shared dashboard.
    Urls Dictionary<string, string>
    ManagementZones []string
    A list of management zones that can display data on the publicly shared dashboard.
    Urls map[string]string
    managementZones List<String>
    A list of management zones that can display data on the publicly shared dashboard.
    urls Map<String,String>
    managementZones string[]
    A list of management zones that can display data on the publicly shared dashboard.
    urls {[key: string]: string}
    management_zones Sequence[str]
    A list of management zones that can display data on the publicly shared dashboard.
    urls Mapping[str, str]
    managementZones List<String>
    A list of management zones that can display data on the publicly shared dashboard.
    urls Map<String>

    Package Details

    Repository
    dynatrace lbrlabs/pulumi-dynatrace
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dynatrace Terraform Provider.
    dynatrace logo
    Dynatrace v0.1.0 published on Wednesday, May 24, 2023 by Lbrlabs
    lbrlabs/pulumi-dynatrace