Docs Packages
  1. Packages
  2. Grafana Cloud
  3. API Docs
  4. Organization
Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
pulumiverse/pulumi-grafana

grafana.Organization

Explore with Pulumi AI

grafana logo
Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
pulumiverse/pulumi-grafana

    Create Organization Resource

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

    Constructor syntax

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

@overload
def Organization(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 admin_user: Optional[str] = None,
                 admins: Optional[Sequence[str]] = None,
                 create_users: Optional[bool] = None,
                 editors: Optional[Sequence[str]] = None,
                 name: Optional[str] = None,
                 users_without_accesses: Optional[Sequence[str]] = None,
                 viewers: Optional[Sequence[str]] = None)
    func NewOrganization(ctx *Context, name string, args *OrganizationArgs, opts ...ResourceOption) (*Organization, error)
    public Organization(string name, OrganizationArgs? args = null, CustomResourceOptions? opts = null)
    public Organization(String name, OrganizationArgs args)
public Organization(String name, OrganizationArgs args, CustomResourceOptions options)

    type: grafana:Organization
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 OrganizationArgs
    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 OrganizationArgs
    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 OrganizationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationArgs
    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 organizationResource = new Grafana.Organization("organizationResource", new()
{
    AdminUser = "string",
    Admins = new[]
    {
        "string",
    },
    CreateUsers = false,
    Editors = new[]
    {
        "string",
    },
    Name = "string",
    UsersWithoutAccesses = new[]
    {
        "string",
    },
    Viewers = new[]
    {
        "string",
    },
});

    example, err := grafana.NewOrganization(ctx, "organizationResource", &grafana.OrganizationArgs{
	AdminUser: pulumi.String("string"),
	Admins: pulumi.StringArray{
		pulumi.String("string"),
	},
	CreateUsers: pulumi.Bool(false),
	Editors: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	UsersWithoutAccesses: pulumi.StringArray{
		pulumi.String("string"),
	},
	Viewers: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var organizationResource = new Organization("organizationResource", OrganizationArgs.builder()        
    .adminUser("string")
    .admins("string")
    .createUsers(false)
    .editors("string")
    .name("string")
    .usersWithoutAccesses("string")
    .viewers("string")
    .build());

    organization_resource = grafana.Organization("organizationResource",
    admin_user="string",
    admins=["string"],
    create_users=False,
    editors=["string"],
    name="string",
    users_without_accesses=["string"],
    viewers=["string"])

    const organizationResource = new grafana.Organization("organizationResource", {
    adminUser: "string",
    admins: ["string"],
    createUsers: false,
    editors: ["string"],
    name: "string",
    usersWithoutAccesses: ["string"],
    viewers: ["string"],
});

    type: grafana:Organization
properties:
    adminUser: string
    admins:
        - string
    createUsers: false
    editors:
        - string
    name: string
    usersWithoutAccesses:
        - string
    viewers:
        - string

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

    AdminUser string
    The login name of the configured default admin user for the Grafana installation. If unset, this value defaults to admin, the Grafana default. Grafana adds the default admin user to all organizations automatically upon creation, and this parameter keeps Terraform from removing it from organizations.
    Admins List<string>
    A list of email addresses corresponding to users who should be given admin access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    CreateUsers bool
    Whether or not to create Grafana users specified in the organization's membership if they don't already exist in Grafana. If unspecified, this parameter defaults to true, creating placeholder users with the name, login, and email set to the email of the user, and a random password. Setting this option to false will cause an error to be thrown for any users that do not already exist in Grafana.
    Editors List<string>
    A list of email addresses corresponding to users who should be given editor access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    Name string
    The display name for the Grafana organization created.
    UsersWithoutAccesses List<string>
    A list of email addresses corresponding to users who should be given none access to the organization. Note: users specified here must already exist in Grafana, unless 'create_users' is set to true. This feature is only available in Grafana 10.2+.
    Viewers List<string>
    A list of email addresses corresponding to users who should be given viewer access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    AdminUser string
    The login name of the configured default admin user for the Grafana installation. If unset, this value defaults to admin, the Grafana default. Grafana adds the default admin user to all organizations automatically upon creation, and this parameter keeps Terraform from removing it from organizations.
    Admins []string
    A list of email addresses corresponding to users who should be given admin access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    CreateUsers bool
    Whether or not to create Grafana users specified in the organization's membership if they don't already exist in Grafana. If unspecified, this parameter defaults to true, creating placeholder users with the name, login, and email set to the email of the user, and a random password. Setting this option to false will cause an error to be thrown for any users that do not already exist in Grafana.
    Editors []string
    A list of email addresses corresponding to users who should be given editor access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    Name string
    The display name for the Grafana organization created.
    UsersWithoutAccesses []string
    A list of email addresses corresponding to users who should be given none access to the organization. Note: users specified here must already exist in Grafana, unless 'create_users' is set to true. This feature is only available in Grafana 10.2+.
    Viewers []string
    A list of email addresses corresponding to users who should be given viewer access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    adminUser String
    The login name of the configured default admin user for the Grafana installation. If unset, this value defaults to admin, the Grafana default. Grafana adds the default admin user to all organizations automatically upon creation, and this parameter keeps Terraform from removing it from organizations.
    admins List<String>
    A list of email addresses corresponding to users who should be given admin access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    createUsers Boolean
    Whether or not to create Grafana users specified in the organization's membership if they don't already exist in Grafana. If unspecified, this parameter defaults to true, creating placeholder users with the name, login, and email set to the email of the user, and a random password. Setting this option to false will cause an error to be thrown for any users that do not already exist in Grafana.
    editors List<String>
    A list of email addresses corresponding to users who should be given editor access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    name String
    The display name for the Grafana organization created.
    usersWithoutAccesses List<String>
    A list of email addresses corresponding to users who should be given none access to the organization. Note: users specified here must already exist in Grafana, unless 'create_users' is set to true. This feature is only available in Grafana 10.2+.
    viewers List<String>
    A list of email addresses corresponding to users who should be given viewer access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    adminUser string
    The login name of the configured default admin user for the Grafana installation. If unset, this value defaults to admin, the Grafana default. Grafana adds the default admin user to all organizations automatically upon creation, and this parameter keeps Terraform from removing it from organizations.
    admins string[]
    A list of email addresses corresponding to users who should be given admin access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    createUsers boolean
    Whether or not to create Grafana users specified in the organization's membership if they don't already exist in Grafana. If unspecified, this parameter defaults to true, creating placeholder users with the name, login, and email set to the email of the user, and a random password. Setting this option to false will cause an error to be thrown for any users that do not already exist in Grafana.
    editors string[]
    A list of email addresses corresponding to users who should be given editor access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    name string
    The display name for the Grafana organization created.
    usersWithoutAccesses string[]
    A list of email addresses corresponding to users who should be given none access to the organization. Note: users specified here must already exist in Grafana, unless 'create_users' is set to true. This feature is only available in Grafana 10.2+.
    viewers string[]
    A list of email addresses corresponding to users who should be given viewer access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    admin_user str
    The login name of the configured default admin user for the Grafana installation. If unset, this value defaults to admin, the Grafana default. Grafana adds the default admin user to all organizations automatically upon creation, and this parameter keeps Terraform from removing it from organizations.
    admins Sequence[str]
    A list of email addresses corresponding to users who should be given admin access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    create_users bool
    Whether or not to create Grafana users specified in the organization's membership if they don't already exist in Grafana. If unspecified, this parameter defaults to true, creating placeholder users with the name, login, and email set to the email of the user, and a random password. Setting this option to false will cause an error to be thrown for any users that do not already exist in Grafana.
    editors Sequence[str]
    A list of email addresses corresponding to users who should be given editor access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    name str
    The display name for the Grafana organization created.
    users_without_accesses Sequence[str]
    A list of email addresses corresponding to users who should be given none access to the organization. Note: users specified here must already exist in Grafana, unless 'create_users' is set to true. This feature is only available in Grafana 10.2+.
    viewers Sequence[str]
    A list of email addresses corresponding to users who should be given viewer access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    adminUser String
    The login name of the configured default admin user for the Grafana installation. If unset, this value defaults to admin, the Grafana default. Grafana adds the default admin user to all organizations automatically upon creation, and this parameter keeps Terraform from removing it from organizations.
    admins List<String>
    A list of email addresses corresponding to users who should be given admin access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    createUsers Boolean
    Whether or not to create Grafana users specified in the organization's membership if they don't already exist in Grafana. If unspecified, this parameter defaults to true, creating placeholder users with the name, login, and email set to the email of the user, and a random password. Setting this option to false will cause an error to be thrown for any users that do not already exist in Grafana.
    editors List<String>
    A list of email addresses corresponding to users who should be given editor access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    name String
    The display name for the Grafana organization created.
    usersWithoutAccesses List<String>
    A list of email addresses corresponding to users who should be given none access to the organization. Note: users specified here must already exist in Grafana, unless 'create_users' is set to true. This feature is only available in Grafana 10.2+.
    viewers List<String>
    A list of email addresses corresponding to users who should be given viewer access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId int
    The organization id assigned to this organization by Grafana.
    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId int
    The organization id assigned to this organization by Grafana.
    id String
    The provider-assigned unique ID for this managed resource.
    orgId Integer
    The organization id assigned to this organization by Grafana.
    id string
    The provider-assigned unique ID for this managed resource.
    orgId number
    The organization id assigned to this organization by Grafana.
    id str
    The provider-assigned unique ID for this managed resource.
    org_id int
    The organization id assigned to this organization by Grafana.
    id String
    The provider-assigned unique ID for this managed resource.
    orgId Number
    The organization id assigned to this organization by Grafana.

    Look up Existing Organization Resource

    Get an existing Organization 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?: OrganizationState, opts?: CustomResourceOptions): Organization
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_user: Optional[str] = None,
        admins: Optional[Sequence[str]] = None,
        create_users: Optional[bool] = None,
        editors: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        org_id: Optional[int] = None,
        users_without_accesses: Optional[Sequence[str]] = None,
        viewers: Optional[Sequence[str]] = None) -> Organization
    func GetOrganization(ctx *Context, name string, id IDInput, state *OrganizationState, opts ...ResourceOption) (*Organization, error)
    public static Organization Get(string name, Input<string> id, OrganizationState? state, CustomResourceOptions? opts = null)
    public static Organization get(String name, Output<String> id, OrganizationState 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:
    AdminUser string
    The login name of the configured default admin user for the Grafana installation. If unset, this value defaults to admin, the Grafana default. Grafana adds the default admin user to all organizations automatically upon creation, and this parameter keeps Terraform from removing it from organizations.
    Admins List<string>
    A list of email addresses corresponding to users who should be given admin access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    CreateUsers bool
    Whether or not to create Grafana users specified in the organization's membership if they don't already exist in Grafana. If unspecified, this parameter defaults to true, creating placeholder users with the name, login, and email set to the email of the user, and a random password. Setting this option to false will cause an error to be thrown for any users that do not already exist in Grafana.
    Editors List<string>
    A list of email addresses corresponding to users who should be given editor access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    Name string
    The display name for the Grafana organization created.
    OrgId int
    The organization id assigned to this organization by Grafana.
    UsersWithoutAccesses List<string>
    A list of email addresses corresponding to users who should be given none access to the organization. Note: users specified here must already exist in Grafana, unless 'create_users' is set to true. This feature is only available in Grafana 10.2+.
    Viewers List<string>
    A list of email addresses corresponding to users who should be given viewer access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    AdminUser string
    The login name of the configured default admin user for the Grafana installation. If unset, this value defaults to admin, the Grafana default. Grafana adds the default admin user to all organizations automatically upon creation, and this parameter keeps Terraform from removing it from organizations.
    Admins []string
    A list of email addresses corresponding to users who should be given admin access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    CreateUsers bool
    Whether or not to create Grafana users specified in the organization's membership if they don't already exist in Grafana. If unspecified, this parameter defaults to true, creating placeholder users with the name, login, and email set to the email of the user, and a random password. Setting this option to false will cause an error to be thrown for any users that do not already exist in Grafana.
    Editors []string
    A list of email addresses corresponding to users who should be given editor access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    Name string
    The display name for the Grafana organization created.
    OrgId int
    The organization id assigned to this organization by Grafana.
    UsersWithoutAccesses []string
    A list of email addresses corresponding to users who should be given none access to the organization. Note: users specified here must already exist in Grafana, unless 'create_users' is set to true. This feature is only available in Grafana 10.2+.
    Viewers []string
    A list of email addresses corresponding to users who should be given viewer access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    adminUser String
    The login name of the configured default admin user for the Grafana installation. If unset, this value defaults to admin, the Grafana default. Grafana adds the default admin user to all organizations automatically upon creation, and this parameter keeps Terraform from removing it from organizations.
    admins List<String>
    A list of email addresses corresponding to users who should be given admin access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    createUsers Boolean
    Whether or not to create Grafana users specified in the organization's membership if they don't already exist in Grafana. If unspecified, this parameter defaults to true, creating placeholder users with the name, login, and email set to the email of the user, and a random password. Setting this option to false will cause an error to be thrown for any users that do not already exist in Grafana.
    editors List<String>
    A list of email addresses corresponding to users who should be given editor access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    name String
    The display name for the Grafana organization created.
    orgId Integer
    The organization id assigned to this organization by Grafana.
    usersWithoutAccesses List<String>
    A list of email addresses corresponding to users who should be given none access to the organization. Note: users specified here must already exist in Grafana, unless 'create_users' is set to true. This feature is only available in Grafana 10.2+.
    viewers List<String>
    A list of email addresses corresponding to users who should be given viewer access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    adminUser string
    The login name of the configured default admin user for the Grafana installation. If unset, this value defaults to admin, the Grafana default. Grafana adds the default admin user to all organizations automatically upon creation, and this parameter keeps Terraform from removing it from organizations.
    admins string[]
    A list of email addresses corresponding to users who should be given admin access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    createUsers boolean
    Whether or not to create Grafana users specified in the organization's membership if they don't already exist in Grafana. If unspecified, this parameter defaults to true, creating placeholder users with the name, login, and email set to the email of the user, and a random password. Setting this option to false will cause an error to be thrown for any users that do not already exist in Grafana.
    editors string[]
    A list of email addresses corresponding to users who should be given editor access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    name string
    The display name for the Grafana organization created.
    orgId number
    The organization id assigned to this organization by Grafana.
    usersWithoutAccesses string[]
    A list of email addresses corresponding to users who should be given none access to the organization. Note: users specified here must already exist in Grafana, unless 'create_users' is set to true. This feature is only available in Grafana 10.2+.
    viewers string[]
    A list of email addresses corresponding to users who should be given viewer access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    admin_user str
    The login name of the configured default admin user for the Grafana installation. If unset, this value defaults to admin, the Grafana default. Grafana adds the default admin user to all organizations automatically upon creation, and this parameter keeps Terraform from removing it from organizations.
    admins Sequence[str]
    A list of email addresses corresponding to users who should be given admin access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    create_users bool
    Whether or not to create Grafana users specified in the organization's membership if they don't already exist in Grafana. If unspecified, this parameter defaults to true, creating placeholder users with the name, login, and email set to the email of the user, and a random password. Setting this option to false will cause an error to be thrown for any users that do not already exist in Grafana.
    editors Sequence[str]
    A list of email addresses corresponding to users who should be given editor access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    name str
    The display name for the Grafana organization created.
    org_id int
    The organization id assigned to this organization by Grafana.
    users_without_accesses Sequence[str]
    A list of email addresses corresponding to users who should be given none access to the organization. Note: users specified here must already exist in Grafana, unless 'create_users' is set to true. This feature is only available in Grafana 10.2+.
    viewers Sequence[str]
    A list of email addresses corresponding to users who should be given viewer access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    adminUser String
    The login name of the configured default admin user for the Grafana installation. If unset, this value defaults to admin, the Grafana default. Grafana adds the default admin user to all organizations automatically upon creation, and this parameter keeps Terraform from removing it from organizations.
    admins List<String>
    A list of email addresses corresponding to users who should be given admin access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    createUsers Boolean
    Whether or not to create Grafana users specified in the organization's membership if they don't already exist in Grafana. If unspecified, this parameter defaults to true, creating placeholder users with the name, login, and email set to the email of the user, and a random password. Setting this option to false will cause an error to be thrown for any users that do not already exist in Grafana.
    editors List<String>
    A list of email addresses corresponding to users who should be given editor access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.
    name String
    The display name for the Grafana organization created.
    orgId Number
    The organization id assigned to this organization by Grafana.
    usersWithoutAccesses List<String>
    A list of email addresses corresponding to users who should be given none access to the organization. Note: users specified here must already exist in Grafana, unless 'create_users' is set to true. This feature is only available in Grafana 10.2+.
    viewers List<String>
    A list of email addresses corresponding to users who should be given viewer access to the organization. Note: users specified here must already exist in Grafana unless 'create_users' is set to true.

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
    pulumiverse/pulumi-grafana