We recommend using Azure Native.
Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
azure.automation.getStringVariable
Explore with Pulumi AI
Use this data source to access information about an existing Automation String Variable.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.automation.getStringVariable({
name: "tfex-example-var",
resourceGroupName: "tfex-example-rg",
automationAccountName: "tfex-example-account",
});
export const variableId = example.then(example => example.id);
import pulumi
import pulumi_azure as azure
example = azure.automation.get_string_variable(name="tfex-example-var",
resource_group_name="tfex-example-rg",
automation_account_name="tfex-example-account")
pulumi.export("variableId", example.id)
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/automation"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := automation.LookupStringVariable(ctx, &automation.LookupStringVariableArgs{
Name: "tfex-example-var",
ResourceGroupName: "tfex-example-rg",
AutomationAccountName: "tfex-example-account",
}, nil)
if err != nil {
return err
}
ctx.Export("variableId", example.Id)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.Automation.GetStringVariable.Invoke(new()
{
Name = "tfex-example-var",
ResourceGroupName = "tfex-example-rg",
AutomationAccountName = "tfex-example-account",
});
return new Dictionary<string, object?>
{
["variableId"] = example.Apply(getStringVariableResult => getStringVariableResult.Id),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.automation.AutomationFunctions;
import com.pulumi.azure.automation.inputs.GetStringVariableArgs;
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 = AutomationFunctions.getStringVariable(GetStringVariableArgs.builder()
.name("tfex-example-var")
.resourceGroupName("tfex-example-rg")
.automationAccountName("tfex-example-account")
.build());
ctx.export("variableId", example.applyValue(getStringVariableResult -> getStringVariableResult.id()));
}
}
variables:
example:
fn::invoke:
Function: azure:automation:getStringVariable
Arguments:
name: tfex-example-var
resourceGroupName: tfex-example-rg
automationAccountName: tfex-example-account
outputs:
variableId: ${example.id}
Using getStringVariable
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 getStringVariable(args: GetStringVariableArgs, opts?: InvokeOptions): Promise<GetStringVariableResult>
function getStringVariableOutput(args: GetStringVariableOutputArgs, opts?: InvokeOptions): Output<GetStringVariableResult>
def get_string_variable(automation_account_name: Optional[str] = None,
name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetStringVariableResult
def get_string_variable_output(automation_account_name: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetStringVariableResult]
func LookupStringVariable(ctx *Context, args *LookupStringVariableArgs, opts ...InvokeOption) (*LookupStringVariableResult, error)
func LookupStringVariableOutput(ctx *Context, args *LookupStringVariableOutputArgs, opts ...InvokeOption) LookupStringVariableResultOutput
> Note: This function is named LookupStringVariable
in the Go SDK.
public static class GetStringVariable
{
public static Task<GetStringVariableResult> InvokeAsync(GetStringVariableArgs args, InvokeOptions? opts = null)
public static Output<GetStringVariableResult> Invoke(GetStringVariableInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetStringVariableResult> getStringVariable(GetStringVariableArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure:automation/getStringVariable:getStringVariable
arguments:
# arguments dictionary
The following arguments are supported:
- Automation
Account stringName - The name of the automation account in which the Automation Variable exists.
- Name string
- The name of the Automation Variable.
- Resource
Group stringName - The Name of the Resource Group where the automation account exists.
- Automation
Account stringName - The name of the automation account in which the Automation Variable exists.
- Name string
- The name of the Automation Variable.
- Resource
Group stringName - The Name of the Resource Group where the automation account exists.
- automation
Account StringName - The name of the automation account in which the Automation Variable exists.
- name String
- The name of the Automation Variable.
- resource
Group StringName - The Name of the Resource Group where the automation account exists.
- automation
Account stringName - The name of the automation account in which the Automation Variable exists.
- name string
- The name of the Automation Variable.
- resource
Group stringName - The Name of the Resource Group where the automation account exists.
- automation_
account_ strname - The name of the automation account in which the Automation Variable exists.
- name str
- The name of the Automation Variable.
- resource_
group_ strname - The Name of the Resource Group where the automation account exists.
- automation
Account StringName - The name of the automation account in which the Automation Variable exists.
- name String
- The name of the Automation Variable.
- resource
Group StringName - The Name of the Resource Group where the automation account exists.
getStringVariable Result
The following output properties are available:
- Automation
Account stringName - Description string
- The description of the Automation Variable.
- Encrypted bool
- Specifies if the Automation Variable is encrypted. Defaults to
false
. - Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource
Group stringName - Value string
- The value of the Automation Variable as a
string
.
- Automation
Account stringName - Description string
- The description of the Automation Variable.
- Encrypted bool
- Specifies if the Automation Variable is encrypted. Defaults to
false
. - Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource
Group stringName - Value string
- The value of the Automation Variable as a
string
.
- automation
Account StringName - description String
- The description of the Automation Variable.
- encrypted Boolean
- Specifies if the Automation Variable is encrypted. Defaults to
false
. - id String
- The provider-assigned unique ID for this managed resource.
- name String
- resource
Group StringName - value String
- The value of the Automation Variable as a
string
.
- automation
Account stringName - description string
- The description of the Automation Variable.
- encrypted boolean
- Specifies if the Automation Variable is encrypted. Defaults to
false
. - id string
- The provider-assigned unique ID for this managed resource.
- name string
- resource
Group stringName - value string
- The value of the Automation Variable as a
string
.
- automation_
account_ strname - description str
- The description of the Automation Variable.
- encrypted bool
- Specifies if the Automation Variable is encrypted. Defaults to
false
. - id str
- The provider-assigned unique ID for this managed resource.
- name str
- resource_
group_ strname - value str
- The value of the Automation Variable as a
string
.
- automation
Account StringName - description String
- The description of the Automation Variable.
- encrypted Boolean
- Specifies if the Automation Variable is encrypted. Defaults to
false
. - id String
- The provider-assigned unique ID for this managed resource.
- name String
- resource
Group StringName - value String
- The value of the Automation Variable as a
string
.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.