1. Packages
  2. Azure Native
  3. API Docs
  4. datafactory
  5. GlobalParameter
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.datafactory.GlobalParameter

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Global parameters resource type. Azure REST API version: 2018-06-01. Prior API version in Azure Native 1.x: 2018-06-01.

    Example Usage

    GlobalParameters_Create

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var globalParameter = new AzureNative.DataFactory.GlobalParameter("globalParameter", new()
        {
            FactoryName = "exampleFactoryName",
            GlobalParameterName = "default",
            Properties = 
            {
                { "waitTime", new AzureNative.DataFactory.Inputs.GlobalParameterSpecificationArgs
                {
                    Type = AzureNative.DataFactory.GlobalParameterType.Int,
                    Value = 5,
                } },
            },
            ResourceGroupName = "exampleResourceGroup",
        });
    
    });
    
    package main
    
    import (
    	datafactory "github.com/pulumi/pulumi-azure-native-sdk/datafactory/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := datafactory.NewGlobalParameter(ctx, "globalParameter", &datafactory.GlobalParameterArgs{
    			FactoryName:         pulumi.String("exampleFactoryName"),
    			GlobalParameterName: pulumi.String("default"),
    			Properties: datafactory.GlobalParameterSpecificationMap{
    				"waitTime": &datafactory.GlobalParameterSpecificationArgs{
    					Type:  pulumi.String(datafactory.GlobalParameterTypeInt),
    					Value: pulumi.Any(5),
    				},
    			},
    			ResourceGroupName: pulumi.String("exampleResourceGroup"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.datafactory.GlobalParameter;
    import com.pulumi.azurenative.datafactory.GlobalParameterArgs;
    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 globalParameter = new GlobalParameter("globalParameter", GlobalParameterArgs.builder()
                .factoryName("exampleFactoryName")
                .globalParameterName("default")
                .properties(Map.of("waitTime", Map.ofEntries(
                    Map.entry("type", "Int"),
                    Map.entry("value", 5)
                )))
                .resourceGroupName("exampleResourceGroup")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    global_parameter = azure_native.datafactory.GlobalParameter("globalParameter",
        factory_name="exampleFactoryName",
        global_parameter_name="default",
        properties={
            "waitTime": {
                "type": azure_native.datafactory.GlobalParameterType.INT,
                "value": 5,
            },
        },
        resource_group_name="exampleResourceGroup")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const globalParameter = new azure_native.datafactory.GlobalParameter("globalParameter", {
        factoryName: "exampleFactoryName",
        globalParameterName: "default",
        properties: {
            waitTime: {
                type: azure_native.datafactory.GlobalParameterType.Int,
                value: 5,
            },
        },
        resourceGroupName: "exampleResourceGroup",
    });
    
    resources:
      globalParameter:
        type: azure-native:datafactory:GlobalParameter
        properties:
          factoryName: exampleFactoryName
          globalParameterName: default
          properties:
            waitTime:
              type: Int
              value: 5
          resourceGroupName: exampleResourceGroup
    

    GlobalParameters_Update

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var globalParameter = new AzureNative.DataFactory.GlobalParameter("globalParameter", new()
        {
            FactoryName = "exampleFactoryName",
            GlobalParameterName = "default",
            Properties = 
            {
                { "waitTime", new AzureNative.DataFactory.Inputs.GlobalParameterSpecificationArgs
                {
                    Type = AzureNative.DataFactory.GlobalParameterType.Int,
                    Value = 5,
                } },
            },
            ResourceGroupName = "exampleResourceGroup",
        });
    
    });
    
    package main
    
    import (
    	datafactory "github.com/pulumi/pulumi-azure-native-sdk/datafactory/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := datafactory.NewGlobalParameter(ctx, "globalParameter", &datafactory.GlobalParameterArgs{
    			FactoryName:         pulumi.String("exampleFactoryName"),
    			GlobalParameterName: pulumi.String("default"),
    			Properties: datafactory.GlobalParameterSpecificationMap{
    				"waitTime": &datafactory.GlobalParameterSpecificationArgs{
    					Type:  pulumi.String(datafactory.GlobalParameterTypeInt),
    					Value: pulumi.Any(5),
    				},
    			},
    			ResourceGroupName: pulumi.String("exampleResourceGroup"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.datafactory.GlobalParameter;
    import com.pulumi.azurenative.datafactory.GlobalParameterArgs;
    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 globalParameter = new GlobalParameter("globalParameter", GlobalParameterArgs.builder()
                .factoryName("exampleFactoryName")
                .globalParameterName("default")
                .properties(Map.of("waitTime", Map.ofEntries(
                    Map.entry("type", "Int"),
                    Map.entry("value", 5)
                )))
                .resourceGroupName("exampleResourceGroup")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    global_parameter = azure_native.datafactory.GlobalParameter("globalParameter",
        factory_name="exampleFactoryName",
        global_parameter_name="default",
        properties={
            "waitTime": {
                "type": azure_native.datafactory.GlobalParameterType.INT,
                "value": 5,
            },
        },
        resource_group_name="exampleResourceGroup")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const globalParameter = new azure_native.datafactory.GlobalParameter("globalParameter", {
        factoryName: "exampleFactoryName",
        globalParameterName: "default",
        properties: {
            waitTime: {
                type: azure_native.datafactory.GlobalParameterType.Int,
                value: 5,
            },
        },
        resourceGroupName: "exampleResourceGroup",
    });
    
    resources:
      globalParameter:
        type: azure-native:datafactory:GlobalParameter
        properties:
          factoryName: exampleFactoryName
          globalParameterName: default
          properties:
            waitTime:
              type: Int
              value: 5
          resourceGroupName: exampleResourceGroup
    

    Create GlobalParameter Resource

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

    Constructor syntax

    new GlobalParameter(name: string, args: GlobalParameterArgs, opts?: CustomResourceOptions);
    @overload
    def GlobalParameter(resource_name: str,
                        args: GlobalParameterArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def GlobalParameter(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        factory_name: Optional[str] = None,
                        properties: Optional[Mapping[str, GlobalParameterSpecificationArgs]] = None,
                        resource_group_name: Optional[str] = None,
                        global_parameter_name: Optional[str] = None)
    func NewGlobalParameter(ctx *Context, name string, args GlobalParameterArgs, opts ...ResourceOption) (*GlobalParameter, error)
    public GlobalParameter(string name, GlobalParameterArgs args, CustomResourceOptions? opts = null)
    public GlobalParameter(String name, GlobalParameterArgs args)
    public GlobalParameter(String name, GlobalParameterArgs args, CustomResourceOptions options)
    
    type: azure-native:datafactory:GlobalParameter
    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 GlobalParameterArgs
    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 GlobalParameterArgs
    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 GlobalParameterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GlobalParameterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GlobalParameterArgs
    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 globalParameterResource = new AzureNative.DataFactory.GlobalParameter("globalParameterResource", new()
    {
        FactoryName = "string",
        Properties = 
        {
            { "string", new AzureNative.DataFactory.Inputs.GlobalParameterSpecificationArgs
            {
                Type = "string",
                Value = "any",
            } },
        },
        ResourceGroupName = "string",
        GlobalParameterName = "string",
    });
    
    example, err := datafactory.NewGlobalParameter(ctx, "globalParameterResource", &datafactory.GlobalParameterArgs{
    	FactoryName: pulumi.String("string"),
    	Properties: datafactory.GlobalParameterSpecificationMap{
    		"string": &datafactory.GlobalParameterSpecificationArgs{
    			Type:  pulumi.String("string"),
    			Value: pulumi.Any("any"),
    		},
    	},
    	ResourceGroupName:   pulumi.String("string"),
    	GlobalParameterName: pulumi.String("string"),
    })
    
    var globalParameterResource = new GlobalParameter("globalParameterResource", GlobalParameterArgs.builder()
        .factoryName("string")
        .properties(Map.of("string", Map.ofEntries(
            Map.entry("type", "string"),
            Map.entry("value", "any")
        )))
        .resourceGroupName("string")
        .globalParameterName("string")
        .build());
    
    global_parameter_resource = azure_native.datafactory.GlobalParameter("globalParameterResource",
        factory_name="string",
        properties={
            "string": {
                "type": "string",
                "value": "any",
            },
        },
        resource_group_name="string",
        global_parameter_name="string")
    
    const globalParameterResource = new azure_native.datafactory.GlobalParameter("globalParameterResource", {
        factoryName: "string",
        properties: {
            string: {
                type: "string",
                value: "any",
            },
        },
        resourceGroupName: "string",
        globalParameterName: "string",
    });
    
    type: azure-native:datafactory:GlobalParameter
    properties:
        factoryName: string
        globalParameterName: string
        properties:
            string:
                type: string
                value: any
        resourceGroupName: string
    

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

    FactoryName string
    The factory name.
    Properties Dictionary<string, Pulumi.AzureNative.DataFactory.Inputs.GlobalParameterSpecificationArgs>
    Properties of the global parameter.
    ResourceGroupName string
    The resource group name.
    GlobalParameterName string
    The global parameter name.
    FactoryName string
    The factory name.
    Properties map[string]GlobalParameterSpecificationArgs
    Properties of the global parameter.
    ResourceGroupName string
    The resource group name.
    GlobalParameterName string
    The global parameter name.
    factoryName String
    The factory name.
    properties Map<String,GlobalParameterSpecificationArgs>
    Properties of the global parameter.
    resourceGroupName String
    The resource group name.
    globalParameterName String
    The global parameter name.
    factoryName string
    The factory name.
    properties {[key: string]: GlobalParameterSpecificationArgs}
    Properties of the global parameter.
    resourceGroupName string
    The resource group name.
    globalParameterName string
    The global parameter name.
    factory_name str
    The factory name.
    properties Mapping[str, GlobalParameterSpecificationArgs]
    Properties of the global parameter.
    resource_group_name str
    The resource group name.
    global_parameter_name str
    The global parameter name.
    factoryName String
    The factory name.
    properties Map<Property Map>
    Properties of the global parameter.
    resourceGroupName String
    The resource group name.
    globalParameterName String
    The global parameter name.

    Outputs

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

    Etag string
    Etag identifies change in the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name.
    Type string
    The resource type.
    Etag string
    Etag identifies change in the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name.
    Type string
    The resource type.
    etag String
    Etag identifies change in the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name.
    type String
    The resource type.
    etag string
    Etag identifies change in the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name.
    type string
    The resource type.
    etag str
    Etag identifies change in the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name.
    type str
    The resource type.
    etag String
    Etag identifies change in the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name.
    type String
    The resource type.

    Supporting Types

    GlobalParameterSpecification, GlobalParameterSpecificationArgs

    Type string | Pulumi.AzureNative.DataFactory.GlobalParameterType
    Global Parameter type.
    Value object
    Value of parameter.
    Type string | GlobalParameterType
    Global Parameter type.
    Value interface{}
    Value of parameter.
    type String | GlobalParameterType
    Global Parameter type.
    value Object
    Value of parameter.
    type string | GlobalParameterType
    Global Parameter type.
    value any
    Value of parameter.
    type str | GlobalParameterType
    Global Parameter type.
    value Any
    Value of parameter.
    type String | "Object" | "String" | "Int" | "Float" | "Bool" | "Array"
    Global Parameter type.
    value Any
    Value of parameter.

    GlobalParameterSpecificationResponse, GlobalParameterSpecificationResponseArgs

    Type string
    Global Parameter type.
    Value object
    Value of parameter.
    Type string
    Global Parameter type.
    Value interface{}
    Value of parameter.
    type String
    Global Parameter type.
    value Object
    Value of parameter.
    type string
    Global Parameter type.
    value any
    Value of parameter.
    type str
    Global Parameter type.
    value Any
    Value of parameter.
    type String
    Global Parameter type.
    value Any
    Value of parameter.

    GlobalParameterType, GlobalParameterTypeArgs

    Object
    Object
    String
    String
    Int
    Int
    Float
    Float
    Bool
    Bool
    Array
    Array
    GlobalParameterTypeObject
    Object
    GlobalParameterTypeString
    String
    GlobalParameterTypeInt
    Int
    GlobalParameterTypeFloat
    Float
    GlobalParameterTypeBool
    Bool
    GlobalParameterTypeArray
    Array
    Object
    Object
    String
    String
    Int
    Int
    Float
    Float
    Bool
    Bool
    Array
    Array
    Object
    Object
    String
    String
    Int
    Int
    Float
    Float
    Bool
    Bool
    Array
    Array
    OBJECT
    Object
    STRING
    String
    INT
    Int
    FLOAT
    Float
    BOOL
    Bool
    ARRAY
    Array
    "Object"
    Object
    "String"
    String
    "Int"
    Int
    "Float"
    Float
    "Bool"
    Bool
    "Array"
    Array

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:datafactory:GlobalParameter default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi