Cisco Meraki v0.3.2, Sep 24 24

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

meraki.organizations.NetworksCombine

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

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.organizations.NetworksCombine;
import com.pulumi.meraki.organizations.NetworksCombineArgs;
import com.pulumi.meraki.organizations.inputs.NetworksCombineParametersArgs;
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 NetworksCombine("example", NetworksCombineArgs.builder()
            .organizationId("string")
            .parameters(NetworksCombineParametersArgs.builder()
                .enrollment_string("my-enrollment-string")
                .name("Long Island Office")
                .network_ids(                
                    "N_1234",
                    "N_5678")
                .build())
            .build());

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

resources:
  example:
    type: meraki:organizations:NetworksCombine
    properties:
      organizationId: string
      parameters:
        enrollment_string: my-enrollment-string
        name: Long Island Office
        network_ids:
          - N_1234
          - N_5678
outputs:
  merakiOrganizationsNetworksCombineExample: ${example}

Create NetworksCombine Resource

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

Constructor syntax

new NetworksCombine(name: string, args: NetworksCombineArgs, opts?: CustomResourceOptions);

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

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

func NewNetworksCombine(ctx *Context, name string, args NetworksCombineArgs, opts ...ResourceOption) (*NetworksCombine, error)

public NetworksCombine(string name, NetworksCombineArgs args, CustomResourceOptions? opts = null)

public NetworksCombine(String name, NetworksCombineArgs args)
public NetworksCombine(String name, NetworksCombineArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args NetworksCombineArgs: 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 networksCombineResource = new Meraki.Organizations.NetworksCombine("networksCombineResource", new()
{
    OrganizationId = "string",
    Parameters = new Meraki.Organizations.Inputs.NetworksCombineParametersArgs
    {
        EnrollmentString = "string",
        Name = "string",
        NetworkIds = new[]
        {
            "string",
        },
    },
});

example, err := organizations.NewNetworksCombine(ctx, "networksCombineResource", &organizations.NetworksCombineArgs{
	OrganizationId: pulumi.String("string"),
	Parameters: &organizations.NetworksCombineParametersArgs{
		EnrollmentString: pulumi.String("string"),
		Name:             pulumi.String("string"),
		NetworkIds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

var networksCombineResource = new NetworksCombine("networksCombineResource", NetworksCombineArgs.builder()
    .organizationId("string")
    .parameters(NetworksCombineParametersArgs.builder()
        .enrollmentString("string")
        .name("string")
        .networkIds("string")
        .build())
    .build());

networks_combine_resource = meraki.organizations.NetworksCombine("networksCombineResource",
    organization_id="string",
    parameters={
        "enrollment_string": "string",
        "name": "string",
        "network_ids": ["string"],
    })

const networksCombineResource = new meraki.organizations.NetworksCombine("networksCombineResource", {
    organizationId: "string",
    parameters: {
        enrollmentString: "string",
        name: "string",
        networkIds: ["string"],
    },
});

type: meraki:organizations:NetworksCombine
properties:
    organizationId: string
    parameters:
        enrollmentString: string
        name: string
        networkIds:
            - string

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

OrganizationId string: organizationId path parameter. Organization ID
Parameters NetworksCombineParameters

OrganizationId string: organizationId path parameter. Organization ID
Parameters NetworksCombineParametersArgs

organizationId String: organizationId path parameter. Organization ID
parameters NetworksCombineParameters

organizationId string: organizationId path parameter. Organization ID
parameters NetworksCombineParameters

organization_id str: organizationId path parameter. Organization ID
parameters NetworksCombineParametersArgs

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

Outputs

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

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

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

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

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

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

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

Look up Existing NetworksCombine Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        item: Optional[NetworksCombineItemArgs] = None,
        organization_id: Optional[str] = None,
        parameters: Optional[NetworksCombineParametersArgs] = None) -> NetworksCombine

func GetNetworksCombine(ctx *Context, name string, id IDInput, state *NetworksCombineState, opts ...ResourceOption) (*NetworksCombine, error)

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

public static NetworksCombine get(String name, Output<String> id, NetworksCombineState 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 NetworksCombineItem
OrganizationId string: organizationId path parameter. Organization ID
Parameters NetworksCombineParameters

Item NetworksCombineItemArgs
OrganizationId string: organizationId path parameter. Organization ID
Parameters NetworksCombineParametersArgs

item NetworksCombineItem
organizationId String: organizationId path parameter. Organization ID
parameters NetworksCombineParameters

item NetworksCombineItem
organizationId string: organizationId path parameter. Organization ID
parameters NetworksCombineParameters

item NetworksCombineItemArgs
organization_id str: organizationId path parameter. Organization ID
parameters NetworksCombineParametersArgs

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

Supporting Types

NetworksCombineItem, NetworksCombineItemArgs

ResultingNetwork NetworksCombineItemResultingNetwork: Network after the combination

ResultingNetwork NetworksCombineItemResultingNetwork: Network after the combination

resultingNetwork NetworksCombineItemResultingNetwork: Network after the combination

resultingNetwork NetworksCombineItemResultingNetwork: Network after the combination

resulting_network NetworksCombineItemResultingNetwork: Network after the combination

resultingNetwork Property Map: Network after the combination

NetworksCombineItemResultingNetwork, NetworksCombineItemResultingNetworkArgs

EnrollmentString string: Enrollment string for the network
Id string: Network ID
IsBoundToConfigTemplate bool: If the network is bound to a config template
Name string: Network name
Notes string: Notes for the network
OrganizationId string: Organization ID
ProductTypes List<string>: List of the product types that the network supports
Tags List<string>: Network tags
TimeZone string: Timezone of the network
Url string: URL to the network Dashboard UI

EnrollmentString string: Enrollment string for the network
Id string: Network ID
IsBoundToConfigTemplate bool: If the network is bound to a config template
Name string: Network name
Notes string: Notes for the network
OrganizationId string: Organization ID
ProductTypes []string: List of the product types that the network supports
Tags []string: Network tags
TimeZone string: Timezone of the network
Url string: URL to the network Dashboard UI

enrollmentString String: Enrollment string for the network
id String: Network ID
isBoundToConfigTemplate Boolean: If the network is bound to a config template
name String: Network name
notes String: Notes for the network
organizationId String: Organization ID
productTypes List<String>: List of the product types that the network supports
tags List<String>: Network tags
timeZone String: Timezone of the network
url String: URL to the network Dashboard UI

enrollmentString string: Enrollment string for the network
id string: Network ID
isBoundToConfigTemplate boolean: If the network is bound to a config template
name string: Network name
notes string: Notes for the network
organizationId string: Organization ID
productTypes string[]: List of the product types that the network supports
tags string[]: Network tags
timeZone string: Timezone of the network
url string: URL to the network Dashboard UI

enrollment_string str: Enrollment string for the network
id str: Network ID
is_bound_to_config_template bool: If the network is bound to a config template
name str: Network name
notes str: Notes for the network
organization_id str: Organization ID
product_types Sequence[str]: List of the product types that the network supports
tags Sequence[str]: Network tags
time_zone str: Timezone of the network
url str: URL to the network Dashboard UI

enrollmentString String: Enrollment string for the network
id String: Network ID
isBoundToConfigTemplate Boolean: If the network is bound to a config template
name String: Network name
notes String: Notes for the network
organizationId String: Organization ID
productTypes List<String>: List of the product types that the network supports
tags List<String>: Network tags
timeZone String: Timezone of the network
url String: URL to the network Dashboard UI

NetworksCombineParameters, NetworksCombineParametersArgs

EnrollmentString string: A unique identifier which can be used for device enrollment or easy access through the Meraki SM Registration page or the Self Service Portal. Please note that changing this field may cause existing bookmarks to break. All networks that are part of this combined network will have their enrollment string appended by '-network_type'. If left empty, all exisitng enrollment strings will be deleted.
Name string: The name of the combined network
NetworkIds List<string>: A list of the network IDs that will be combined. If an ID of a combined network is included in this list, the other networks in the list will be grouped into that network

EnrollmentString string: A unique identifier which can be used for device enrollment or easy access through the Meraki SM Registration page or the Self Service Portal. Please note that changing this field may cause existing bookmarks to break. All networks that are part of this combined network will have their enrollment string appended by '-network_type'. If left empty, all exisitng enrollment strings will be deleted.
Name string: The name of the combined network
NetworkIds []string: A list of the network IDs that will be combined. If an ID of a combined network is included in this list, the other networks in the list will be grouped into that network

enrollmentString String: A unique identifier which can be used for device enrollment or easy access through the Meraki SM Registration page or the Self Service Portal. Please note that changing this field may cause existing bookmarks to break. All networks that are part of this combined network will have their enrollment string appended by '-network_type'. If left empty, all exisitng enrollment strings will be deleted.
name String: The name of the combined network
networkIds List<String>: A list of the network IDs that will be combined. If an ID of a combined network is included in this list, the other networks in the list will be grouped into that network

enrollmentString string: A unique identifier which can be used for device enrollment or easy access through the Meraki SM Registration page or the Self Service Portal. Please note that changing this field may cause existing bookmarks to break. All networks that are part of this combined network will have their enrollment string appended by '-network_type'. If left empty, all exisitng enrollment strings will be deleted.
name string: The name of the combined network
networkIds string[]: A list of the network IDs that will be combined. If an ID of a combined network is included in this list, the other networks in the list will be grouped into that network

enrollment_string str: A unique identifier which can be used for device enrollment or easy access through the Meraki SM Registration page or the Self Service Portal. Please note that changing this field may cause existing bookmarks to break. All networks that are part of this combined network will have their enrollment string appended by '-network_type'. If left empty, all exisitng enrollment strings will be deleted.
name str: The name of the combined network
network_ids Sequence[str]: A list of the network IDs that will be combined. If an ID of a combined network is included in this list, the other networks in the list will be grouped into that network

enrollmentString String: A unique identifier which can be used for device enrollment or easy access through the Meraki SM Registration page or the Self Service Portal. Please note that changing this field may cause existing bookmarks to break. All networks that are part of this combined network will have their enrollment string appended by '-network_type'. If left empty, all exisitng enrollment strings will be deleted.
name String: The name of the combined network
networkIds List<String>: A list of the network IDs that will be combined. If an ID of a combined network is included in this list, the other networks in the list will be grouped into that network

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.NetworksCombine

On this page

On this page

Example Usage

Create NetworksCombine Resource

Constructor syntax

Parameters

Constructor example

NetworksCombine Resource Properties

Inputs

Outputs

Look up Existing NetworksCombine Resource

Supporting Types

NetworksCombineItem, NetworksCombineItemArgs

NetworksCombineItemResultingNetwork, NetworksCombineItemResultingNetworkArgs

NetworksCombineParameters, NetworksCombineParametersArgs

Package Details

On this page

On this page