Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
meraki.organizations.Base
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";
const example = new meraki.organizations.Base("example", {
management: {
details: [{
name: "MSP ID",
value: "123456",
}],
},
name: "My organization",
});
export const merakiOrganizationsExample = example;
import pulumi
import pulumi_meraki as meraki
example = meraki.organizations.Base("example",
management={
"details": [{
"name": "MSP ID",
"value": "123456",
}],
},
name="My organization")
pulumi.export("merakiOrganizationsExample", 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.Newbase(ctx, "example", &organizations.baseArgs{
Management: &organizations.BaseManagementArgs{
Details: organizations.BaseManagementDetailArray{
&organizations.BaseManagementDetailArgs{
Name: pulumi.String("MSP ID"),
Value: pulumi.String("123456"),
},
},
},
Name: pulumi.String("My organization"),
})
if err != nil {
return err
}
ctx.Export("merakiOrganizationsExample", 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.Base("example", new()
{
Management = new Meraki.Organizations.Inputs.BaseManagementArgs
{
Details = new[]
{
new Meraki.Organizations.Inputs.BaseManagementDetailArgs
{
Name = "MSP ID",
Value = "123456",
},
},
},
Name = "My organization",
});
return new Dictionary<string, object?>
{
["merakiOrganizationsExample"] = example,
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.organizations.base;
import com.pulumi.meraki.organizations.BaseArgs;
import com.pulumi.meraki.organizations.inputs.BaseManagementArgs;
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 Base("example", BaseArgs.builder()
.management(BaseManagementArgs.builder()
.details(BaseManagementDetailArgs.builder()
.name("MSP ID")
.value("123456")
.build())
.build())
.name("My organization")
.build());
ctx.export("merakiOrganizationsExample", example);
}
}
resources:
example:
type: meraki:organizations:base
properties:
management:
details:
- name: MSP ID
value: '123456'
name: My organization
outputs:
merakiOrganizationsExample: ${example}
Create Base Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Base(name: string, args?: BaseArgs, opts?: CustomResourceOptions);
@overload
def Base(resource_name: str,
args: Optional[BaseArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Base(resource_name: str,
opts: Optional[ResourceOptions] = None,
api: Optional[BaseApiArgs] = None,
management: Optional[BaseManagementArgs] = None,
name: Optional[str] = None,
organization_id: Optional[str] = None)
func NewBase(ctx *Context, name string, args *BaseArgs, opts ...ResourceOption) (*Base, error)
public Base(string name, BaseArgs? args = null, CustomResourceOptions? opts = null)
type: meraki:organizations/base:base
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 BaseArgs
- 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 BaseArgs
- 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 BaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BaseArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Base 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 Base resource accepts the following input properties:
- Api
Base
Api Args - API related settings
- Management
Base
Management Args - Information about the organization's management system
- Name string
- Organization name
- Organization
Id string - organizationId path parameter. Organization ID
- Api
Base
Api Args - API related settings
- Management
Base
Management Args - Information about the organization's management system
- Name string
- Organization name
- Organization
Id string - organizationId path parameter. Organization ID
- api
Base
Api Args - API related settings
- management
Base
Management Args - Information about the organization's management system
- name String
- Organization name
- organization
Id String - organizationId path parameter. Organization ID
- api
Base
Api Args - API related settings
- management
Base
Management Args - Information about the organization's management system
- name string
- Organization name
- organization
Id string - organizationId path parameter. Organization ID
- api
Base
Api Args - API related settings
- management
Base
Management Args - Information about the organization's management system
- name str
- Organization name
- organization_
id str - organizationId path parameter. Organization ID
- api Property Map
- API related settings
- management Property Map
- Information about the organization's management system
- name String
- Organization name
- organization
Id String - organizationId path parameter. Organization ID
Outputs
All input properties are implicitly available as output properties. Additionally, the Base resource produces the following output properties:
- cloud Property Map
- Data for this organization
- id String
- The provider-assigned unique ID for this managed resource.
- licensing Property Map
- Licensing related settings
- url String
- Organization URL
Look up Existing Base Resource
Get an existing Base 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?: BaseState, opts?: CustomResourceOptions): Base
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api: Optional[BaseApiArgs] = None,
cloud: Optional[BaseCloudArgs] = None,
licensing: Optional[BaseLicensingArgs] = None,
management: Optional[BaseManagementArgs] = None,
name: Optional[str] = None,
organization_id: Optional[str] = None,
url: Optional[str] = None) -> Base
func GetBase(ctx *Context, name string, id IDInput, state *BaseState, opts ...ResourceOption) (*Base, error)
public static Base Get(string name, Input<string> id, BaseState? state, CustomResourceOptions? opts = null)
public static Base get(String name, Output<String> id, BaseState 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.
- Api
Base
Api Args - API related settings
- Cloud
Base
Cloud Args - Data for this organization
- Licensing
Base
Licensing Args - Licensing related settings
- Management
Base
Management Args - Information about the organization's management system
- Name string
- Organization name
- Organization
Id string - organizationId path parameter. Organization ID
- Url string
- Organization URL
- Api
Base
Api Args - API related settings
- Cloud
Base
Cloud Args - Data for this organization
- Licensing
Base
Licensing Args - Licensing related settings
- Management
Base
Management Args - Information about the organization's management system
- Name string
- Organization name
- Organization
Id string - organizationId path parameter. Organization ID
- Url string
- Organization URL
- api
Base
Api Args - API related settings
- cloud
Base
Cloud Args - Data for this organization
- licensing
Base
Licensing Args - Licensing related settings
- management
Base
Management Args - Information about the organization's management system
- name String
- Organization name
- organization
Id String - organizationId path parameter. Organization ID
- url String
- Organization URL
- api
Base
Api Args - API related settings
- cloud
Base
Cloud Args - Data for this organization
- licensing
Base
Licensing Args - Licensing related settings
- management
Base
Management Args - Information about the organization's management system
- name string
- Organization name
- organization
Id string - organizationId path parameter. Organization ID
- url string
- Organization URL
- api
Base
Api Args - API related settings
- cloud
Base
Cloud Args - Data for this organization
- licensing
Base
Licensing Args - Licensing related settings
- management
Base
Management Args - Information about the organization's management system
- name str
- Organization name
- organization_
id str - organizationId path parameter. Organization ID
- url str
- Organization URL
- api Property Map
- API related settings
- cloud Property Map
- Data for this organization
- licensing Property Map
- Licensing related settings
- management Property Map
- Information about the organization's management system
- name String
- Organization name
- organization
Id String - organizationId path parameter. Organization ID
- url String
- Organization URL
Supporting Types
BaseApi, BaseApiArgs
- Enabled bool
- Enable API access
- Enabled bool
- Enable API access
- enabled Boolean
- Enable API access
- enabled boolean
- Enable API access
- enabled bool
- Enable API access
- enabled Boolean
- Enable API access
BaseCloud, BaseCloudArgs
- Region
Base
Cloud Region - Region info
- Region
Base
Cloud Region - Region info
- region
Base
Cloud Region - Region info
- region
Base
Cloud Region - Region info
- region
Base
Cloud Region - Region info
- region Property Map
- Region info
BaseCloudRegion, BaseCloudRegionArgs
- Name string
- Name of region
- Name string
- Name of region
- name String
- Name of region
- name string
- Name of region
- name str
- Name of region
- name String
- Name of region
BaseLicensing, BaseLicensingArgs
- Model string
- Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
- Model string
- Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
- model String
- Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
- model string
- Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
- model str
- Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
- model String
- Organization licensing model. Can be 'co-term', 'per-device', or 'subscription'.
BaseManagement, BaseManagementArgs
- Details
List<Base
Management Detail> - Details related to organization management, possibly empty. Details may be named 'MSP ID', 'IP restriction mode for API', or 'IP restriction mode for dashboard', if the organization admin has configured any.
- Details
[]Base
Management Detail - Details related to organization management, possibly empty. Details may be named 'MSP ID', 'IP restriction mode for API', or 'IP restriction mode for dashboard', if the organization admin has configured any.
- details
List<Base
Management Detail> - Details related to organization management, possibly empty. Details may be named 'MSP ID', 'IP restriction mode for API', or 'IP restriction mode for dashboard', if the organization admin has configured any.
- details
Base
Management Detail[] - Details related to organization management, possibly empty. Details may be named 'MSP ID', 'IP restriction mode for API', or 'IP restriction mode for dashboard', if the organization admin has configured any.
- details
Sequence[Base
Management Detail] - Details related to organization management, possibly empty. Details may be named 'MSP ID', 'IP restriction mode for API', or 'IP restriction mode for dashboard', if the organization admin has configured any.
- details List<Property Map>
- Details related to organization management, possibly empty. Details may be named 'MSP ID', 'IP restriction mode for API', or 'IP restriction mode for dashboard', if the organization admin has configured any.
BaseManagementDetail, BaseManagementDetailArgs
Import
$ pulumi import meraki:organizations/base:base example "organization_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- meraki pulumi/pulumi-meraki
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
meraki
Terraform Provider.