Cisco Meraki v0.3.2, Sep 24 24

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

meraki.organizations.Claim

Explore with Pulumi AI

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.Claim("example", {
    organizationId: "string",
    parameters: {
        licenses: [{
            key: "Z2XXXXXXXXXX",
            mode: "addDevices",
        }],
        orders: ["4CXXXXXXX"],
        serials: ["Q234-ABCD-5678"],
    },
});
export const merakiOrganizationsClaimExample = example;

import pulumi
import pulumi_meraki as meraki

example = meraki.organizations.Claim("example",
    organization_id="string",
    parameters={
        "licenses": [{
            "key": "Z2XXXXXXXXXX",
            "mode": "addDevices",
        }],
        "orders": ["4CXXXXXXX"],
        "serials": ["Q234-ABCD-5678"],
    })
pulumi.export("merakiOrganizationsClaimExample", 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.NewClaim(ctx, "example", &organizations.ClaimArgs{
			OrganizationId: pulumi.String("string"),
			Parameters: &organizations.ClaimParametersArgs{
				Licenses: organizations.ClaimParametersLicenseArray{
					&organizations.ClaimParametersLicenseArgs{
						Key:  pulumi.String("Z2XXXXXXXXXX"),
						Mode: pulumi.String("addDevices"),
					},
				},
				Orders: pulumi.StringArray{
					pulumi.String("4CXXXXXXX"),
				},
				Serials: pulumi.StringArray{
					pulumi.String("Q234-ABCD-5678"),
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("merakiOrganizationsClaimExample", 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.Claim("example", new()
    {
        OrganizationId = "string",
        Parameters = new Meraki.Organizations.Inputs.ClaimParametersArgs
        {
            Licenses = new[]
            {
                new Meraki.Organizations.Inputs.ClaimParametersLicenseArgs
                {
                    Key = "Z2XXXXXXXXXX",
                    Mode = "addDevices",
                },
            },
            Orders = new[]
            {
                "4CXXXXXXX",
            },
            Serials = new[]
            {
                "Q234-ABCD-5678",
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["merakiOrganizationsClaimExample"] = example,
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.organizations.Claim;
import com.pulumi.meraki.organizations.ClaimArgs;
import com.pulumi.meraki.organizations.inputs.ClaimParametersArgs;
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 Claim("example", ClaimArgs.builder()
            .organizationId("string")
            .parameters(ClaimParametersArgs.builder()
                .licenses(ClaimParametersLicenseArgs.builder()
                    .key("Z2XXXXXXXXXX")
                    .mode("addDevices")
                    .build())
                .orders("4CXXXXXXX")
                .serials("Q234-ABCD-5678")
                .build())
            .build());

        ctx.export("merakiOrganizationsClaimExample", example);
    }
}

resources:
  example:
    type: meraki:organizations:Claim
    properties:
      organizationId: string
      parameters:
        licenses:
          - key: Z2XXXXXXXXXX
            mode: addDevices
        orders:
          - 4CXXXXXXX
        serials:
          - Q234-ABCD-5678
outputs:
  merakiOrganizationsClaimExample: ${example}

Create Claim Resource

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

Constructor syntax

new Claim(name: string, args: ClaimArgs, opts?: CustomResourceOptions);

@overload
def Claim(resource_name: str,
          args: ClaimArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Claim(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          organization_id: Optional[str] = None,
          parameters: Optional[ClaimParametersArgs] = None)

func NewClaim(ctx *Context, name string, args ClaimArgs, opts ...ResourceOption) (*Claim, error)

public Claim(string name, ClaimArgs args, CustomResourceOptions? opts = null)

public Claim(String name, ClaimArgs args)
public Claim(String name, ClaimArgs args, CustomResourceOptions options)

type: meraki:organizations:Claim
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 ClaimArgs: 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 ClaimArgs: 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 ClaimArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClaimArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ClaimArgs: 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 claimResource = new Meraki.Organizations.Claim("claimResource", new()
{
    OrganizationId = "string",
    Parameters = new Meraki.Organizations.Inputs.ClaimParametersArgs
    {
        Licenses = new[]
        {
            new Meraki.Organizations.Inputs.ClaimParametersLicenseArgs
            {
                Key = "string",
                Mode = "string",
            },
        },
        Orders = new[]
        {
            "string",
        },
        Serials = new[]
        {
            "string",
        },
    },
});

example, err := organizations.NewClaim(ctx, "claimResource", &organizations.ClaimArgs{
	OrganizationId: pulumi.String("string"),
	Parameters: &organizations.ClaimParametersArgs{
		Licenses: organizations.ClaimParametersLicenseArray{
			&organizations.ClaimParametersLicenseArgs{
				Key:  pulumi.String("string"),
				Mode: pulumi.String("string"),
			},
		},
		Orders: pulumi.StringArray{
			pulumi.String("string"),
		},
		Serials: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

var claimResource = new Claim("claimResource", ClaimArgs.builder()
    .organizationId("string")
    .parameters(ClaimParametersArgs.builder()
        .licenses(ClaimParametersLicenseArgs.builder()
            .key("string")
            .mode("string")
            .build())
        .orders("string")
        .serials("string")
        .build())
    .build());

claim_resource = meraki.organizations.Claim("claimResource",
    organization_id="string",
    parameters={
        "licenses": [{
            "key": "string",
            "mode": "string",
        }],
        "orders": ["string"],
        "serials": ["string"],
    })

const claimResource = new meraki.organizations.Claim("claimResource", {
    organizationId: "string",
    parameters: {
        licenses: [{
            key: "string",
            mode: "string",
        }],
        orders: ["string"],
        serials: ["string"],
    },
});

type: meraki:organizations:Claim
properties:
    organizationId: string
    parameters:
        licenses:
            - key: string
              mode: string
        orders:
            - string
        serials:
            - string

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

OrganizationId string: organizationId path parameter. Organization ID
Parameters ClaimParameters

OrganizationId string: organizationId path parameter. Organization ID
Parameters ClaimParametersArgs

organizationId String: organizationId path parameter. Organization ID
parameters ClaimParameters

organizationId string: organizationId path parameter. Organization ID
parameters ClaimParameters

organization_id str: organizationId path parameter. Organization ID
parameters ClaimParametersArgs

organizationId String: organizationId path parameter. Organization ID
parameters Property Map

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Item ClaimItem

Id string: The provider-assigned unique ID for this managed resource.
Item ClaimItem

id String: The provider-assigned unique ID for this managed resource.
item ClaimItem

id string: The provider-assigned unique ID for this managed resource.
item ClaimItem

id str: The provider-assigned unique ID for this managed resource.
item ClaimItem

id String: The provider-assigned unique ID for this managed resource.
item Property Map

Look up Existing Claim Resource

Get an existing Claim 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?: ClaimState, opts?: CustomResourceOptions): Claim

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        item: Optional[ClaimItemArgs] = None,
        organization_id: Optional[str] = None,
        parameters: Optional[ClaimParametersArgs] = None) -> Claim

func GetClaim(ctx *Context, name string, id IDInput, state *ClaimState, opts ...ResourceOption) (*Claim, error)

public static Claim Get(string name, Input<string> id, ClaimState? state, CustomResourceOptions? opts = null)

public static Claim get(String name, Output<String> id, ClaimState 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 ClaimItem
OrganizationId string: organizationId path parameter. Organization ID
Parameters ClaimParameters

Item ClaimItemArgs
OrganizationId string: organizationId path parameter. Organization ID
Parameters ClaimParametersArgs

item ClaimItem
organizationId String: organizationId path parameter. Organization ID
parameters ClaimParameters

item ClaimItem
organizationId string: organizationId path parameter. Organization ID
parameters ClaimParameters

item ClaimItemArgs
organization_id str: organizationId path parameter. Organization ID
parameters ClaimParametersArgs

item Property Map
organizationId String: organizationId path parameter. Organization ID
parameters Property Map

Supporting Types

ClaimItem, ClaimItemArgs

Licenses List<ClaimItemLicense>: The licenses claimed
Orders List<string>: The numbers of the orders claimed
Serials List<string>: The serials of the devices claimed

Licenses []ClaimItemLicense: The licenses claimed
Orders []string: The numbers of the orders claimed
Serials []string: The serials of the devices claimed

licenses List<ClaimItemLicense>: The licenses claimed
orders List<String>: The numbers of the orders claimed
serials List<String>: The serials of the devices claimed

licenses ClaimItemLicense[]: The licenses claimed
orders string[]: The numbers of the orders claimed
serials string[]: The serials of the devices claimed

licenses Sequence[ClaimItemLicense]: The licenses claimed
orders Sequence[str]: The numbers of the orders claimed
serials Sequence[str]: The serials of the devices claimed

licenses List<Property Map>: The licenses claimed
orders List<String>: The numbers of the orders claimed
serials List<String>: The serials of the devices claimed

ClaimItemLicense, ClaimItemLicenseArgs

Key string: The key of the license
Mode string: The mode of the license

Key string: The key of the license
Mode string: The mode of the license

key String: The key of the license
mode String: The mode of the license

key string: The key of the license
mode string: The mode of the license

key str: The key of the license
mode str: The mode of the license

key String: The key of the license
mode String: The mode of the license

ClaimParameters, ClaimParametersArgs

Licenses List<ClaimParametersLicense>: The licenses that should be claimed
Orders List<string>: The numbers of the orders that should be claimed
Serials List<string>: The serials of the devices that should be claimed

Licenses []ClaimParametersLicense: The licenses that should be claimed
Orders []string: The numbers of the orders that should be claimed
Serials []string: The serials of the devices that should be claimed

licenses List<ClaimParametersLicense>: The licenses that should be claimed
orders List<String>: The numbers of the orders that should be claimed
serials List<String>: The serials of the devices that should be claimed

licenses ClaimParametersLicense[]: The licenses that should be claimed
orders string[]: The numbers of the orders that should be claimed
serials string[]: The serials of the devices that should be claimed

licenses Sequence[ClaimParametersLicense]: The licenses that should be claimed
orders Sequence[str]: The numbers of the orders that should be claimed
serials Sequence[str]: The serials of the devices that should be claimed

licenses List<Property Map>: The licenses that should be claimed
orders List<String>: The numbers of the orders that should be claimed
serials List<String>: The serials of the devices that should be claimed

ClaimParametersLicense, ClaimParametersLicenseArgs

Key string: The key of the license
Mode string: Either 'renew' or 'addDevices'. 'addDevices' will increase the license limit, while 'renew' will extend the amount of time until expiration. Defaults to 'addDevices'. All licenses must be claimed with the same mode, and at most one renewal can be claimed at a time. This parameter is legacy and does not apply to organizations with per-device licensing enabled.

Key string: The key of the license
Mode string: Either 'renew' or 'addDevices'. 'addDevices' will increase the license limit, while 'renew' will extend the amount of time until expiration. Defaults to 'addDevices'. All licenses must be claimed with the same mode, and at most one renewal can be claimed at a time. This parameter is legacy and does not apply to organizations with per-device licensing enabled.

key String: The key of the license
mode String: Either 'renew' or 'addDevices'. 'addDevices' will increase the license limit, while 'renew' will extend the amount of time until expiration. Defaults to 'addDevices'. All licenses must be claimed with the same mode, and at most one renewal can be claimed at a time. This parameter is legacy and does not apply to organizations with per-device licensing enabled.

key string: The key of the license
mode string: Either 'renew' or 'addDevices'. 'addDevices' will increase the license limit, while 'renew' will extend the amount of time until expiration. Defaults to 'addDevices'. All licenses must be claimed with the same mode, and at most one renewal can be claimed at a time. This parameter is legacy and does not apply to organizations with per-device licensing enabled.

key str: The key of the license
mode str: Either 'renew' or 'addDevices'. 'addDevices' will increase the license limit, while 'renew' will extend the amount of time until expiration. Defaults to 'addDevices'. All licenses must be claimed with the same mode, and at most one renewal can be claimed at a time. This parameter is legacy and does not apply to organizations with per-device licensing enabled.

key String: The key of the license
mode String: Either 'renew' or 'addDevices'. 'addDevices' will increase the license limit, while 'renew' will extend the amount of time until expiration. Defaults to 'addDevices'. All licenses must be claimed with the same mode, and at most one renewal can be claimed at a time. This parameter is legacy and does not apply to organizations with per-device licensing enabled.

Package Details

Repository: meraki pulumi/pulumi-meraki
License: Apache-2.0
Notes: This Pulumi package is based on the meraki Terraform Provider.

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

pulumi/pulumi-meraki

meraki.organizations.Claim

On this page

On this page

Example Usage

Create Claim Resource

Constructor syntax

Parameters

Constructor example

Claim Resource Properties

Inputs

Outputs

Look up Existing Claim Resource

Supporting Types

ClaimItem, ClaimItemArgs

ClaimItemLicense, ClaimItemLicenseArgs

ClaimParameters, ClaimParametersArgs

ClaimParametersLicense, ClaimParametersLicenseArgs

Package Details

On this page

On this page