Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Dynatrace
  3. API Docs
  4. Document
Dynatrace v0.16.0 published on Tuesday, Sep 10, 2024 by Pulumiverse
pulumiverse/pulumi-dynatrace

dynatrace.Document

Explore with Pulumi AI

dynatrace logo
Dynatrace v0.16.0 published on Tuesday, Sep 10, 2024 by Pulumiverse
pulumiverse/pulumi-dynatrace

    This resource is excluded by default in the export utility. You can, of course, specify that resource explicitly in order to export it. In that case, don’t forget to specify the environment variables DYNATRACE_AUTOMATION_CLIENT_ID and DYNATRACE_AUTOMATION_CLIENT_SECRET for authentication.

    Dynatrace Documentation

    • Dynatrace Documents - https://########.apps.dynatrace.com/platform/swagger-ui/index.html?urls.primaryName=Document%20Service

    Prerequisites

    Using this resource requires an OAuth client to be configured within your account settings. The scopes of the OAuth Client need to include Create and edit documents (document:documents:write), View documents (document:documents:read), Delete documents (document:documents:delete).

    Finally the provider configuration requires the credentials for that OAuth Client. The configuration section of your provider needs to look like this.

    import * as pulumi from "@pulumi/pulumi";

    import pulumi

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

    {}

    In order to handle credentials in a secure manner we recommend to use the environment variables DYNATRACE_AUTOMATION_CLIENT_ID and DYNATRACE_AUTOMATION_CLIENT_SECRET as an alternative.

    Create Document Resource

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

    Constructor syntax

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

@overload
def Document(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             content: Optional[str] = None,
             type: Optional[str] = None,
             actor: Optional[str] = None,
             name: Optional[str] = None,
             owner: Optional[str] = None,
             private: Optional[bool] = None)
    func NewDocument(ctx *Context, name string, args DocumentArgs, opts ...ResourceOption) (*Document, error)
    public Document(string name, DocumentArgs args, CustomResourceOptions? opts = null)
    public Document(String name, DocumentArgs args)
public Document(String name, DocumentArgs args, CustomResourceOptions options)

    type: dynatrace:Document
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 DocumentArgs
    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 DocumentArgs
    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 DocumentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DocumentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DocumentArgs
    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 documentResource = new Dynatrace.Document("documentResource", new()
{
    Content = "string",
    Type = "string",
    Actor = "string",
    Name = "string",
    Owner = "string",
    Private = false,
});

    example, err := dynatrace.NewDocument(ctx, "documentResource", &dynatrace.DocumentArgs{
	Content: pulumi.String("string"),
	Type:    pulumi.String("string"),
	Actor:   pulumi.String("string"),
	Name:    pulumi.String("string"),
	Owner:   pulumi.String("string"),
	Private: pulumi.Bool(false),
})

    var documentResource = new Document("documentResource", DocumentArgs.builder()
    .content("string")
    .type("string")
    .actor("string")
    .name("string")
    .owner("string")
    .private_(false)
    .build());

    document_resource = dynatrace.Document("documentResource",
    content="string",
    type="string",
    actor="string",
    name="string",
    owner="string",
    private=False)

    const documentResource = new dynatrace.Document("documentResource", {
    content: "string",
    type: "string",
    actor: "string",
    name: "string",
    owner: "string",
    "private": false,
});

    type: dynatrace:Document
properties:
    actor: string
    content: string
    name: string
    owner: string
    private: false
    type: string

    Document 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 Document resource accepts the following input properties:

    Content string
    Document content as JSON
    Type string
    Type of the document. Possible Values are dashboard and notebook
    Actor string
    The user context the executions of the document will happen with
    Name string
    The name/name of the document
    Owner string
    The ID of the owner of this document
    Private bool
    Specifies whether the document is private or readable by everybody
    Content string
    Document content as JSON
    Type string
    Type of the document. Possible Values are dashboard and notebook
    Actor string
    The user context the executions of the document will happen with
    Name string
    The name/name of the document
    Owner string
    The ID of the owner of this document
    Private bool
    Specifies whether the document is private or readable by everybody
    content String
    Document content as JSON
    type String
    Type of the document. Possible Values are dashboard and notebook
    actor String
    The user context the executions of the document will happen with
    name String
    The name/name of the document
    owner String
    The ID of the owner of this document
    private_ Boolean
    Specifies whether the document is private or readable by everybody
    content string
    Document content as JSON
    type string
    Type of the document. Possible Values are dashboard and notebook
    actor string
    The user context the executions of the document will happen with
    name string
    The name/name of the document
    owner string
    The ID of the owner of this document
    private boolean
    Specifies whether the document is private or readable by everybody
    content str
    Document content as JSON
    type str
    Type of the document. Possible Values are dashboard and notebook
    actor str
    The user context the executions of the document will happen with
    name str
    The name/name of the document
    owner str
    The ID of the owner of this document
    private bool
    Specifies whether the document is private or readable by everybody
    content String
    Document content as JSON
    type String
    Type of the document. Possible Values are dashboard and notebook
    actor String
    The user context the executions of the document will happen with
    name String
    The name/name of the document
    owner String
    The ID of the owner of this document
    private Boolean
    Specifies whether the document is private or readable by everybody

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the document
    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version of the document
    id String
    The provider-assigned unique ID for this managed resource.
    version Integer
    The version of the document
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    The version of the document
    id str
    The provider-assigned unique ID for this managed resource.
    version int
    The version of the document
    id String
    The provider-assigned unique ID for this managed resource.
    version Number
    The version of the document

    Look up Existing Document Resource

    Get an existing Document 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?: DocumentState, opts?: CustomResourceOptions): Document
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        actor: Optional[str] = None,
        content: Optional[str] = None,
        name: Optional[str] = None,
        owner: Optional[str] = None,
        private: Optional[bool] = None,
        type: Optional[str] = None,
        version: Optional[int] = None) -> Document
    func GetDocument(ctx *Context, name string, id IDInput, state *DocumentState, opts ...ResourceOption) (*Document, error)
    public static Document Get(string name, Input<string> id, DocumentState? state, CustomResourceOptions? opts = null)
    public static Document get(String name, Output<String> id, DocumentState 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:
    Actor string
    The user context the executions of the document will happen with
    Content string
    Document content as JSON
    Name string
    The name/name of the document
    Owner string
    The ID of the owner of this document
    Private bool
    Specifies whether the document is private or readable by everybody
    Type string
    Type of the document. Possible Values are dashboard and notebook
    Version int
    The version of the document
    Actor string
    The user context the executions of the document will happen with
    Content string
    Document content as JSON
    Name string
    The name/name of the document
    Owner string
    The ID of the owner of this document
    Private bool
    Specifies whether the document is private or readable by everybody
    Type string
    Type of the document. Possible Values are dashboard and notebook
    Version int
    The version of the document
    actor String
    The user context the executions of the document will happen with
    content String
    Document content as JSON
    name String
    The name/name of the document
    owner String
    The ID of the owner of this document
    private_ Boolean
    Specifies whether the document is private or readable by everybody
    type String
    Type of the document. Possible Values are dashboard and notebook
    version Integer
    The version of the document
    actor string
    The user context the executions of the document will happen with
    content string
    Document content as JSON
    name string
    The name/name of the document
    owner string
    The ID of the owner of this document
    private boolean
    Specifies whether the document is private or readable by everybody
    type string
    Type of the document. Possible Values are dashboard and notebook
    version number
    The version of the document
    actor str
    The user context the executions of the document will happen with
    content str
    Document content as JSON
    name str
    The name/name of the document
    owner str
    The ID of the owner of this document
    private bool
    Specifies whether the document is private or readable by everybody
    type str
    Type of the document. Possible Values are dashboard and notebook
    version int
    The version of the document
    actor String
    The user context the executions of the document will happen with
    content String
    Document content as JSON
    name String
    The name/name of the document
    owner String
    The ID of the owner of this document
    private Boolean
    Specifies whether the document is private or readable by everybody
    type String
    Type of the document. Possible Values are dashboard and notebook
    version Number
    The version of the document

    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.16.0 published on Tuesday, Sep 10, 2024 by Pulumiverse
    pulumiverse/pulumi-dynatrace