Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scm Provider
  3. API Docs
  4. getVariable
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

scm.getVariable

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

    Retrieves a config item.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";

const example = scm.getVariable({
    id: "1234-56-789",
});

    import pulumi
import pulumi_scm as scm

example = scm.get_variable(id="1234-56-789")

    package main

import (
	"github.com/pulumi/pulumi-scm/sdk/go/scm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scm.LookupVariable(ctx, &scm.LookupVariableArgs{
			Id: "1234-56-789",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;

return await Deployment.RunAsync(() => 
{
    var example = Scm.GetVariable.Invoke(new()
    {
        Id = "1234-56-789",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.ScmFunctions;
import com.pulumi.scm.inputs.GetVariableArgs;
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 = ScmFunctions.getVariable(GetVariableArgs.builder()
            .id("1234-56-789")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: scm:getVariable
      Arguments:
        id: 1234-56-789

    Using getVariable

    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 getVariable(args: GetVariableArgs, opts?: InvokeOptions): Promise<GetVariableResult>
function getVariableOutput(args: GetVariableOutputArgs, opts?: InvokeOptions): Output<GetVariableResult>
    def get_variable(device: Optional[str] = None,
                 folder: Optional[str] = None,
                 id: Optional[str] = None,
                 snippet: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetVariableResult
def get_variable_output(device: Optional[pulumi.Input[str]] = None,
                 folder: Optional[pulumi.Input[str]] = None,
                 id: Optional[pulumi.Input[str]] = None,
                 snippet: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetVariableResult]
    func LookupVariable(ctx *Context, args *LookupVariableArgs, opts ...InvokeOption) (*LookupVariableResult, error)
func LookupVariableOutput(ctx *Context, args *LookupVariableOutputArgs, opts ...InvokeOption) LookupVariableResultOutput

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

    public static class GetVariable 
{
    public static Task<GetVariableResult> InvokeAsync(GetVariableArgs args, InvokeOptions? opts = null)
    public static Output<GetVariableResult> Invoke(GetVariableInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVariableResult> getVariable(GetVariableArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: scm:index/getVariable:getVariable
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The Id param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Snippet string
    The Snippet param.
    Id string
    The Id param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Snippet string
    The Snippet param.
    id String
    The Id param.
    device String
    The Device param.
    folder String
    The Folder param.
    snippet String
    The Snippet param.
    id string
    The Id param.
    device string
    The Device param.
    folder string
    The Folder param.
    snippet string
    The Snippet param.
    id str
    The Id param.
    device str
    The Device param.
    folder str
    The Folder param.
    snippet str
    The Snippet param.
    id String
    The Id param.
    device String
    The Device param.
    folder String
    The Folder param.
    snippet String
    The Snippet param.

    getVariable Result

    The following output properties are available:

    Description string
    The Description param.
    Id string
    The Id param.
    Name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Overridden bool
    The Overridden param.
    Tfid string
    Type string
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    Value string
    value can accept either string or integer.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Snippet string
    The Snippet param.
    Description string
    The Description param.
    Id string
    The Id param.
    Name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Overridden bool
    The Overridden param.
    Tfid string
    Type string
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    Value string
    value can accept either string or integer.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Snippet string
    The Snippet param.
    description String
    The Description param.
    id String
    The Id param.
    name String
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    overridden Boolean
    The Overridden param.
    tfid String
    type String
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    value String
    value can accept either string or integer.
    device String
    The Device param.
    folder String
    The Folder param.
    snippet String
    The Snippet param.
    description string
    The Description param.
    id string
    The Id param.
    name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    overridden boolean
    The Overridden param.
    tfid string
    type string
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    value string
    value can accept either string or integer.
    device string
    The Device param.
    folder string
    The Folder param.
    snippet string
    The Snippet param.
    description str
    The Description param.
    id str
    The Id param.
    name str
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    overridden bool
    The Overridden param.
    tfid str
    type str
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    value str
    value can accept either string or integer.
    device str
    The Device param.
    folder str
    The Folder param.
    snippet str
    The Snippet param.
    description String
    The Description param.
    id String
    The Id param.
    name String
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    overridden Boolean
    The Overridden param.
    tfid String
    type String
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    value String
    value can accept either string or integer.
    device String
    The Device param.
    folder String
    The Folder param.
    snippet String
    The Snippet param.

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
    pulumi/pulumi-scm