1. Packages
  2. Meraki Provider
  3. API Docs
  4. organizations
  5. Users
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

meraki.organizations.Users

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

    ~>Warning: This resource does not represent a real-world entity in Meraki Dashboard, therefore changing or deleting this resource on its own has no immediate effect. Instead, it is a task part of a Meraki Dashboard workflow. It is executed in Meraki without any additional verification. It does not check if it was executed before or if a similar configuration or action already existed previously.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = new meraki.organizations.Users("example", {
        organizationId: "string",
        userId: "string",
    });
    export const merakiOrganizationsUsersExample = example;
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.organizations.Users("example",
        organization_id="string",
        user_id="string")
    pulumi.export("merakiOrganizationsUsersExample", example)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/organizations"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := organizations.NewUsers(ctx, "example", &organizations.UsersArgs{
    			OrganizationId: pulumi.String("string"),
    			UserId:         pulumi.String("string"),
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiOrganizationsUsersExample", example)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Meraki.Organizations.Users("example", new()
        {
            OrganizationId = "string",
            UserId = "string",
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiOrganizationsUsersExample"] = example,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.organizations.Users;
    import com.pulumi.meraki.organizations.UsersArgs;
    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) {
            var example = new Users("example", UsersArgs.builder()
                .organizationId("string")
                .userId("string")
                .build());
    
            ctx.export("merakiOrganizationsUsersExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:organizations:Users
        properties:
          organizationId: string
          userId: string
    outputs:
      merakiOrganizationsUsersExample: ${example}
    

    Create Users Resource

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

    Constructor syntax

    new Users(name: string, args: UsersArgs, opts?: CustomResourceOptions);
    @overload
    def Users(resource_name: str,
              args: UsersArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Users(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              organization_id: Optional[str] = None,
              user_id: Optional[str] = None)
    func NewUsers(ctx *Context, name string, args UsersArgs, opts ...ResourceOption) (*Users, error)
    public Users(string name, UsersArgs args, CustomResourceOptions? opts = null)
    public Users(String name, UsersArgs args)
    public Users(String name, UsersArgs args, CustomResourceOptions options)
    
    type: meraki:organizations:Users
    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 UsersArgs
    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 UsersArgs
    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 UsersArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UsersArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UsersArgs
    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 usersResource = new Meraki.Organizations.Users("usersResource", new()
    {
        OrganizationId = "string",
        UserId = "string",
    });
    
    example, err := organizations.NewUsers(ctx, "usersResource", &organizations.UsersArgs{
    	OrganizationId: pulumi.String("string"),
    	UserId:         pulumi.String("string"),
    })
    
    var usersResource = new Users("usersResource", UsersArgs.builder()
        .organizationId("string")
        .userId("string")
        .build());
    
    users_resource = meraki.organizations.Users("usersResource",
        organization_id="string",
        user_id="string")
    
    const usersResource = new meraki.organizations.Users("usersResource", {
        organizationId: "string",
        userId: "string",
    });
    
    type: meraki:organizations:Users
    properties:
        organizationId: string
        userId: string
    

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

    OrganizationId string
    organizationId path parameter. Organization ID
    UserId string
    userId path parameter. User ID
    OrganizationId string
    organizationId path parameter. Organization ID
    UserId string
    userId path parameter. User ID
    organizationId String
    organizationId path parameter. Organization ID
    userId String
    userId path parameter. User ID
    organizationId string
    organizationId path parameter. Organization ID
    userId string
    userId path parameter. User ID
    organization_id str
    organizationId path parameter. Organization ID
    user_id str
    userId path parameter. User ID
    organizationId String
    organizationId path parameter. Organization ID
    userId String
    userId path parameter. User ID

    Outputs

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

    Get an existing Users 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?: UsersState, opts?: CustomResourceOptions): Users
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            organization_id: Optional[str] = None,
            user_id: Optional[str] = None) -> Users
    func GetUsers(ctx *Context, name string, id IDInput, state *UsersState, opts ...ResourceOption) (*Users, error)
    public static Users Get(string name, Input<string> id, UsersState? state, CustomResourceOptions? opts = null)
    public static Users get(String name, Output<String> id, UsersState 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:
    OrganizationId string
    organizationId path parameter. Organization ID
    UserId string
    userId path parameter. User ID
    OrganizationId string
    organizationId path parameter. Organization ID
    UserId string
    userId path parameter. User ID
    organizationId String
    organizationId path parameter. Organization ID
    userId String
    userId path parameter. User ID
    organizationId string
    organizationId path parameter. Organization ID
    userId string
    userId path parameter. User ID
    organization_id str
    organizationId path parameter. Organization ID
    user_id str
    userId path parameter. User ID
    organizationId String
    organizationId path parameter. Organization ID
    userId String
    userId path parameter. User ID

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi