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

meraki.organizations.getOpenapiSpec

Explore with Pulumi AI

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = meraki.organizations.getOpenapiSpec({
        organizationId: "string",
        version: 1,
    });
    export const merakiOrganizationsOpenapiSpecExample = example.then(example => example.item);
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.organizations.get_openapi_spec(organization_id="string",
        version=1)
    pulumi.export("merakiOrganizationsOpenapiSpecExample", example.item)
    
    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.GetOpenapiSpec(ctx, &organizations.GetOpenapiSpecArgs{
    			OrganizationId: "string",
    			Version:        pulumi.IntRef(1),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiOrganizationsOpenapiSpecExample", example.Item)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Meraki.Organizations.GetOpenapiSpec.Invoke(new()
        {
            OrganizationId = "string",
            Version = 1,
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiOrganizationsOpenapiSpecExample"] = example.Apply(getOpenapiSpecResult => getOpenapiSpecResult.Item),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.organizations.OrganizationsFunctions;
    import com.pulumi.meraki.organizations.inputs.GetOpenapiSpecArgs;
    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) {
            final var example = OrganizationsFunctions.getOpenapiSpec(GetOpenapiSpecArgs.builder()
                .organizationId("string")
                .version(1)
                .build());
    
            ctx.export("merakiOrganizationsOpenapiSpecExample", example.applyValue(getOpenapiSpecResult -> getOpenapiSpecResult.item()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: meraki:organizations:getOpenapiSpec
          Arguments:
            organizationId: string
            version: 1
    outputs:
      merakiOrganizationsOpenapiSpecExample: ${example.item}
    

    Using getOpenapiSpec

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getOpenapiSpec(args: GetOpenapiSpecArgs, opts?: InvokeOptions): Promise<GetOpenapiSpecResult>
    function getOpenapiSpecOutput(args: GetOpenapiSpecOutputArgs, opts?: InvokeOptions): Output<GetOpenapiSpecResult>
    def get_openapi_spec(organization_id: Optional[str] = None,
                         version: Optional[int] = None,
                         opts: Optional[InvokeOptions] = None) -> GetOpenapiSpecResult
    def get_openapi_spec_output(organization_id: Optional[pulumi.Input[str]] = None,
                         version: Optional[pulumi.Input[int]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetOpenapiSpecResult]
    func GetOpenapiSpec(ctx *Context, args *GetOpenapiSpecArgs, opts ...InvokeOption) (*GetOpenapiSpecResult, error)
    func GetOpenapiSpecOutput(ctx *Context, args *GetOpenapiSpecOutputArgs, opts ...InvokeOption) GetOpenapiSpecResultOutput

    > Note: This function is named GetOpenapiSpec in the Go SDK.

    public static class GetOpenapiSpec 
    {
        public static Task<GetOpenapiSpecResult> InvokeAsync(GetOpenapiSpecArgs args, InvokeOptions? opts = null)
        public static Output<GetOpenapiSpecResult> Invoke(GetOpenapiSpecInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOpenapiSpecResult> getOpenapiSpec(GetOpenapiSpecArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: meraki:organizations/getOpenapiSpec:getOpenapiSpec
      arguments:
        # arguments dictionary

    The following arguments are supported:

    OrganizationId string
    organizationId path parameter. Organization ID
    Version int
    version query parameter. OpenAPI Specification version to return. Default is 2
    OrganizationId string
    organizationId path parameter. Organization ID
    Version int
    version query parameter. OpenAPI Specification version to return. Default is 2
    organizationId String
    organizationId path parameter. Organization ID
    version Integer
    version query parameter. OpenAPI Specification version to return. Default is 2
    organizationId string
    organizationId path parameter. Organization ID
    version number
    version query parameter. OpenAPI Specification version to return. Default is 2
    organization_id str
    organizationId path parameter. Organization ID
    version int
    version query parameter. OpenAPI Specification version to return. Default is 2
    organizationId String
    organizationId path parameter. Organization ID
    version Number
    version query parameter. OpenAPI Specification version to return. Default is 2

    getOpenapiSpec Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetOpenapiSpecItem
    OrganizationId string
    organizationId path parameter. Organization ID
    Version int
    version query parameter. OpenAPI Specification version to return. Default is 2
    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetOpenapiSpecItem
    OrganizationId string
    organizationId path parameter. Organization ID
    Version int
    version query parameter. OpenAPI Specification version to return. Default is 2
    id String
    The provider-assigned unique ID for this managed resource.
    item GetOpenapiSpecItem
    organizationId String
    organizationId path parameter. Organization ID
    version Integer
    version query parameter. OpenAPI Specification version to return. Default is 2
    id string
    The provider-assigned unique ID for this managed resource.
    item GetOpenapiSpecItem
    organizationId string
    organizationId path parameter. Organization ID
    version number
    version query parameter. OpenAPI Specification version to return. Default is 2
    id str
    The provider-assigned unique ID for this managed resource.
    item GetOpenapiSpecItem
    organization_id str
    organizationId path parameter. Organization ID
    version int
    version query parameter. OpenAPI Specification version to return. Default is 2
    id String
    The provider-assigned unique ID for this managed resource.
    item Property Map
    organizationId String
    organizationId path parameter. Organization ID
    version Number
    version query parameter. OpenAPI Specification version to return. Default is 2

    Supporting Types

    GetOpenapiSpecItem

    GetOpenapiSpecItemInfo

    Description string
    Title string
    Version string
    Description string
    Title string
    Version string
    description String
    title String
    version String
    description string
    title string
    version string
    description String
    title String
    version String

    GetOpenapiSpecItemPaths

    GetOpenapiSpecItemPathsOrganizations

    GetOpenapiSpecItemPathsOrganizationsGet

    GetOpenapiSpecItemPathsOrganizationsGetResponses

    GetOpenapiSpecItemPathsOrganizationsGetResponsesStatus200

    GetOpenapiSpecItemPathsOrganizationsGetResponsesStatus200Examples

    GetOpenapiSpecItemPathsOrganizationsGetResponsesStatus200ExamplesApplicationJson

    Id string
    Name string
    Id string
    Name string
    id String
    name String
    id string
    name string
    id str
    name str
    id String
    name String

    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