1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. DevicesClaim
Meraki v0.1.2 published on Tuesday, May 21, 2024 by Pulumi

meraki.networks.DevicesClaim

Explore with Pulumi AI

meraki logo
Meraki v0.1.2 published on Tuesday, May 21, 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.networks.DevicesClaim("example", {
        networkId: "string",
        parameters: {
            serials: [
                "Q234-ABCD-0001",
                "Q234-ABCD-0002",
                "Q234-ABCD-0003",
            ],
        },
    });
    export const merakiNetworksDevicesClaimExample = example;
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.networks.DevicesClaim("example",
        network_id="string",
        parameters=meraki.networks.DevicesClaimParametersArgs(
            serials=[
                "Q234-ABCD-0001",
                "Q234-ABCD-0002",
                "Q234-ABCD-0003",
            ],
        ))
    pulumi.export("merakiNetworksDevicesClaimExample", example)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/networks"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := networks.NewDevicesClaim(ctx, "example", &networks.DevicesClaimArgs{
    			NetworkId: pulumi.String("string"),
    			Parameters: &networks.DevicesClaimParametersArgs{
    				Serials: pulumi.StringArray{
    					pulumi.String("Q234-ABCD-0001"),
    					pulumi.String("Q234-ABCD-0002"),
    					pulumi.String("Q234-ABCD-0003"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiNetworksDevicesClaimExample", example)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Meraki.Networks.DevicesClaim("example", new()
        {
            NetworkId = "string",
            Parameters = new Meraki.Networks.Inputs.DevicesClaimParametersArgs
            {
                Serials = new[]
                {
                    "Q234-ABCD-0001",
                    "Q234-ABCD-0002",
                    "Q234-ABCD-0003",
                },
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiNetworksDevicesClaimExample"] = example,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.networks.DevicesClaim;
    import com.pulumi.meraki.networks.DevicesClaimArgs;
    import com.pulumi.meraki.networks.inputs.DevicesClaimParametersArgs;
    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 DevicesClaim("example", DevicesClaimArgs.builder()        
                .networkId("string")
                .parameters(DevicesClaimParametersArgs.builder()
                    .serials(                
                        "Q234-ABCD-0001",
                        "Q234-ABCD-0002",
                        "Q234-ABCD-0003")
                    .build())
                .build());
    
            ctx.export("merakiNetworksDevicesClaimExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:networks:DevicesClaim
        properties:
          networkId: string
          parameters:
            serials:
              - Q234-ABCD-0001
              - Q234-ABCD-0002
              - Q234-ABCD-0003
    outputs:
      merakiNetworksDevicesClaimExample: ${example}
    

    Create DevicesClaim Resource

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

    Constructor syntax

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

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

    NetworkId string
    networkId path parameter. Network ID
    Parameters DevicesClaimParameters
    NetworkId string
    networkId path parameter. Network ID
    Parameters DevicesClaimParametersArgs
    networkId String
    networkId path parameter. Network ID
    parameters DevicesClaimParameters
    networkId string
    networkId path parameter. Network ID
    parameters DevicesClaimParameters
    network_id str
    networkId path parameter. Network ID
    parameters DevicesClaimParametersArgs
    networkId String
    networkId path parameter. Network ID
    parameters Property Map

    Outputs

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

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

    Look up Existing DevicesClaim Resource

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

    Supporting Types

    DevicesClaimItem, DevicesClaimItemArgs

    Serials List<string>
    The serials of the devices
    Serials []string
    The serials of the devices
    serials List<String>
    The serials of the devices
    serials string[]
    The serials of the devices
    serials Sequence[str]
    The serials of the devices
    serials List<String>
    The serials of the devices

    DevicesClaimParameters, DevicesClaimParametersArgs

    Serials List<string>
    A list of serials of devices to claim
    Serials []string
    A list of serials of devices to claim
    serials List<String>
    A list of serials of devices to claim
    serials string[]
    A list of serials of devices to claim
    serials Sequence[str]
    A list of serials of devices to claim
    serials List<String>
    A list of serials of devices to claim

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Meraki v0.1.2 published on Tuesday, May 21, 2024 by Pulumi