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

meraki.networks.SmDevicesCheckin

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

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.networks.SmDevicesCheckin;
    import com.pulumi.meraki.networks.SmDevicesCheckinArgs;
    import com.pulumi.meraki.networks.inputs.SmDevicesCheckinParametersArgs;
    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 SmDevicesCheckin("example", SmDevicesCheckinArgs.builder()
                .networkId("string")
                .parameters(SmDevicesCheckinParametersArgs.builder()
                    .ids(                
                        "1284392014819",
                        "2983092129865")
                    .scope(                
                        "withAny",
                        "tag1",
                        "tag2")
                    .serials(                
                        "XY0XX0Y0X0",
                        "A01B01CD00E",
                        "X02YZ1ZYZX")
                    .wifi_macs("00:11:22:33:44:55")
                    .build())
                .build());
    
            ctx.export("merakiNetworksSmDevicesCheckinExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:networks:SmDevicesCheckin
        properties:
          networkId: string
          parameters:
            ids:
              - '1284392014819'
              - '2983092129865'
            scope:
              - withAny
              - tag1
              - tag2
            serials:
              - XY0XX0Y0X0
              - A01B01CD00E
              - X02YZ1ZYZX
            wifi_macs:
              - 00:11:22:33:44:55
    outputs:
      merakiNetworksSmDevicesCheckinExample: ${example}
    

    Create SmDevicesCheckin Resource

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

    Constructor syntax

    new SmDevicesCheckin(name: string, args: SmDevicesCheckinArgs, opts?: CustomResourceOptions);
    @overload
    def SmDevicesCheckin(resource_name: str,
                         args: SmDevicesCheckinArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def SmDevicesCheckin(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         network_id: Optional[str] = None,
                         parameters: Optional[SmDevicesCheckinParametersArgs] = None)
    func NewSmDevicesCheckin(ctx *Context, name string, args SmDevicesCheckinArgs, opts ...ResourceOption) (*SmDevicesCheckin, error)
    public SmDevicesCheckin(string name, SmDevicesCheckinArgs args, CustomResourceOptions? opts = null)
    public SmDevicesCheckin(String name, SmDevicesCheckinArgs args)
    public SmDevicesCheckin(String name, SmDevicesCheckinArgs args, CustomResourceOptions options)
    
    type: meraki:networks:SmDevicesCheckin
    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 SmDevicesCheckinArgs
    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 SmDevicesCheckinArgs
    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 SmDevicesCheckinArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SmDevicesCheckinArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SmDevicesCheckinArgs
    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 smDevicesCheckinResource = new Meraki.Networks.SmDevicesCheckin("smDevicesCheckinResource", new()
    {
        NetworkId = "string",
        Parameters = new Meraki.Networks.Inputs.SmDevicesCheckinParametersArgs
        {
            Ids = new[]
            {
                "string",
            },
            Scopes = new[]
            {
                "string",
            },
            Serials = new[]
            {
                "string",
            },
            WifiMacs = new[]
            {
                "string",
            },
        },
    });
    
    example, err := networks.NewSmDevicesCheckin(ctx, "smDevicesCheckinResource", &networks.SmDevicesCheckinArgs{
    	NetworkId: pulumi.String("string"),
    	Parameters: &networks.SmDevicesCheckinParametersArgs{
    		Ids: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		Scopes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		Serials: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		WifiMacs: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    })
    
    var smDevicesCheckinResource = new SmDevicesCheckin("smDevicesCheckinResource", SmDevicesCheckinArgs.builder()
        .networkId("string")
        .parameters(SmDevicesCheckinParametersArgs.builder()
            .ids("string")
            .scopes("string")
            .serials("string")
            .wifiMacs("string")
            .build())
        .build());
    
    sm_devices_checkin_resource = meraki.networks.SmDevicesCheckin("smDevicesCheckinResource",
        network_id="string",
        parameters={
            "ids": ["string"],
            "scopes": ["string"],
            "serials": ["string"],
            "wifi_macs": ["string"],
        })
    
    const smDevicesCheckinResource = new meraki.networks.SmDevicesCheckin("smDevicesCheckinResource", {
        networkId: "string",
        parameters: {
            ids: ["string"],
            scopes: ["string"],
            serials: ["string"],
            wifiMacs: ["string"],
        },
    });
    
    type: meraki:networks:SmDevicesCheckin
    properties:
        networkId: string
        parameters:
            ids:
                - string
            scopes:
                - string
            serials:
                - string
            wifiMacs:
                - string
    

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

    NetworkId string
    networkId path parameter. Network ID
    Parameters SmDevicesCheckinParameters
    NetworkId string
    networkId path parameter. Network ID
    Parameters SmDevicesCheckinParametersArgs
    networkId String
    networkId path parameter. Network ID
    parameters SmDevicesCheckinParameters
    networkId string
    networkId path parameter. Network ID
    parameters SmDevicesCheckinParameters
    network_id str
    networkId path parameter. Network ID
    parameters SmDevicesCheckinParametersArgs
    networkId String
    networkId path parameter. Network ID
    parameters Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Item SmDevicesCheckinItem
    Id string
    The provider-assigned unique ID for this managed resource.
    Item SmDevicesCheckinItem
    id String
    The provider-assigned unique ID for this managed resource.
    item SmDevicesCheckinItem
    id string
    The provider-assigned unique ID for this managed resource.
    item SmDevicesCheckinItem
    id str
    The provider-assigned unique ID for this managed resource.
    item SmDevicesCheckinItem
    id String
    The provider-assigned unique ID for this managed resource.
    item Property Map

    Look up Existing SmDevicesCheckin Resource

    Get an existing SmDevicesCheckin 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?: SmDevicesCheckinState, opts?: CustomResourceOptions): SmDevicesCheckin
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            item: Optional[SmDevicesCheckinItemArgs] = None,
            network_id: Optional[str] = None,
            parameters: Optional[SmDevicesCheckinParametersArgs] = None) -> SmDevicesCheckin
    func GetSmDevicesCheckin(ctx *Context, name string, id IDInput, state *SmDevicesCheckinState, opts ...ResourceOption) (*SmDevicesCheckin, error)
    public static SmDevicesCheckin Get(string name, Input<string> id, SmDevicesCheckinState? state, CustomResourceOptions? opts = null)
    public static SmDevicesCheckin get(String name, Output<String> id, SmDevicesCheckinState 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:
    item Property Map
    networkId String
    networkId path parameter. Network ID
    parameters Property Map

    Supporting Types

    SmDevicesCheckinItem, SmDevicesCheckinItemArgs

    Ids List<string>
    The Meraki Ids of the set of devices.
    Ids []string
    The Meraki Ids of the set of devices.
    ids List<String>
    The Meraki Ids of the set of devices.
    ids string[]
    The Meraki Ids of the set of devices.
    ids Sequence[str]
    The Meraki Ids of the set of devices.
    ids List<String>
    The Meraki Ids of the set of devices.

    SmDevicesCheckinParameters, SmDevicesCheckinParametersArgs

    Ids List<string>
    The ids of the devices to be checked-in.
    Scopes List<string>
    The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be checked-in.
    Serials List<string>
    The serials of the devices to be checked-in.
    WifiMacs List<string>
    The wifiMacs of the devices to be checked-in.
    Ids []string
    The ids of the devices to be checked-in.
    Scopes []string
    The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be checked-in.
    Serials []string
    The serials of the devices to be checked-in.
    WifiMacs []string
    The wifiMacs of the devices to be checked-in.
    ids List<String>
    The ids of the devices to be checked-in.
    scopes List<String>
    The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be checked-in.
    serials List<String>
    The serials of the devices to be checked-in.
    wifiMacs List<String>
    The wifiMacs of the devices to be checked-in.
    ids string[]
    The ids of the devices to be checked-in.
    scopes string[]
    The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be checked-in.
    serials string[]
    The serials of the devices to be checked-in.
    wifiMacs string[]
    The wifiMacs of the devices to be checked-in.
    ids Sequence[str]
    The ids of the devices to be checked-in.
    scopes Sequence[str]
    The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be checked-in.
    serials Sequence[str]
    The serials of the devices to be checked-in.
    wifi_macs Sequence[str]
    The wifiMacs of the devices to be checked-in.
    ids List<String>
    The ids of the devices to be checked-in.
    scopes List<String>
    The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be checked-in.
    serials List<String>
    The serials of the devices to be checked-in.
    wifiMacs List<String>
    The wifiMacs of the devices to be checked-in.

    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