1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. Experiment
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.44.1 published on Thursday, Jun 6, 2024 by Pulumi

azure-native.network.Experiment

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.44.1 published on Thursday, Jun 6, 2024 by Pulumi

    Defines the properties of an Experiment Azure REST API version: 2019-11-01. Prior API version in Azure Native 1.x: 2019-11-01.

    Example Usage

    Creates an Experiment

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var experiment = new AzureNative.Network.Experiment("experiment", new()
        {
            Description = "this is my first experiment!",
            EnabledState = AzureNative.Network.State.Enabled,
            EndpointA = new AzureNative.Network.Inputs.ExperimentEndpointArgs
            {
                Endpoint = "endpointA.net",
                Name = "endpoint A",
            },
            EndpointB = new AzureNative.Network.Inputs.ExperimentEndpointArgs
            {
                Endpoint = "endpointB.net",
                Name = "endpoint B",
            },
            ExperimentName = "MyExperiment",
            ProfileName = "MyProfile",
            ResourceGroupName = "MyResourceGroup",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/network/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := network.NewExperiment(ctx, "experiment", &network.ExperimentArgs{
    			Description:  pulumi.String("this is my first experiment!"),
    			EnabledState: pulumi.String(network.StateEnabled),
    			EndpointA: &network.ExperimentEndpointArgs{
    				Endpoint: pulumi.String("endpointA.net"),
    				Name:     pulumi.String("endpoint A"),
    			},
    			EndpointB: &network.ExperimentEndpointArgs{
    				Endpoint: pulumi.String("endpointB.net"),
    				Name:     pulumi.String("endpoint B"),
    			},
    			ExperimentName:    pulumi.String("MyExperiment"),
    			ProfileName:       pulumi.String("MyProfile"),
    			ResourceGroupName: pulumi.String("MyResourceGroup"),
    		})
    		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.network.Experiment;
    import com.pulumi.azurenative.network.ExperimentArgs;
    import com.pulumi.azurenative.network.inputs.ExperimentEndpointArgs;
    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 experiment = new Experiment("experiment", ExperimentArgs.builder()
                .description("this is my first experiment!")
                .enabledState("Enabled")
                .endpointA(ExperimentEndpointArgs.builder()
                    .endpoint("endpointA.net")
                    .name("endpoint A")
                    .build())
                .endpointB(ExperimentEndpointArgs.builder()
                    .endpoint("endpointB.net")
                    .name("endpoint B")
                    .build())
                .experimentName("MyExperiment")
                .profileName("MyProfile")
                .resourceGroupName("MyResourceGroup")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    experiment = azure_native.network.Experiment("experiment",
        description="this is my first experiment!",
        enabled_state=azure_native.network.State.ENABLED,
        endpoint_a=azure_native.network.ExperimentEndpointArgs(
            endpoint="endpointA.net",
            name="endpoint A",
        ),
        endpoint_b=azure_native.network.ExperimentEndpointArgs(
            endpoint="endpointB.net",
            name="endpoint B",
        ),
        experiment_name="MyExperiment",
        profile_name="MyProfile",
        resource_group_name="MyResourceGroup")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const experiment = new azure_native.network.Experiment("experiment", {
        description: "this is my first experiment!",
        enabledState: azure_native.network.State.Enabled,
        endpointA: {
            endpoint: "endpointA.net",
            name: "endpoint A",
        },
        endpointB: {
            endpoint: "endpointB.net",
            name: "endpoint B",
        },
        experimentName: "MyExperiment",
        profileName: "MyProfile",
        resourceGroupName: "MyResourceGroup",
    });
    
    resources:
      experiment:
        type: azure-native:network:Experiment
        properties:
          description: this is my first experiment!
          enabledState: Enabled
          endpointA:
            endpoint: endpointA.net
            name: endpoint A
          endpointB:
            endpoint: endpointB.net
            name: endpoint B
          experimentName: MyExperiment
          profileName: MyProfile
          resourceGroupName: MyResourceGroup
    

    Create Experiment Resource

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

    Constructor syntax

    new Experiment(name: string, args: ExperimentArgs, opts?: CustomResourceOptions);
    @overload
    def Experiment(resource_name: str,
                   args: ExperimentArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Experiment(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   profile_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   description: Optional[str] = None,
                   enabled_state: Optional[Union[str, State]] = None,
                   endpoint_a: Optional[ExperimentEndpointArgs] = None,
                   endpoint_b: Optional[ExperimentEndpointArgs] = None,
                   experiment_name: Optional[str] = None,
                   location: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewExperiment(ctx *Context, name string, args ExperimentArgs, opts ...ResourceOption) (*Experiment, error)
    public Experiment(string name, ExperimentArgs args, CustomResourceOptions? opts = null)
    public Experiment(String name, ExperimentArgs args)
    public Experiment(String name, ExperimentArgs args, CustomResourceOptions options)
    
    type: azure-native:network:Experiment
    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 ExperimentArgs
    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 ExperimentArgs
    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 ExperimentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExperimentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExperimentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var azure_nativeExperimentResource = new AzureNative.Network.Experiment("azure-nativeExperimentResource", new()
    {
        ProfileName = "string",
        ResourceGroupName = "string",
        Description = "string",
        EnabledState = "string",
        EndpointA = new AzureNative.Network.Inputs.ExperimentEndpointArgs
        {
            Endpoint = "string",
            Name = "string",
        },
        EndpointB = new AzureNative.Network.Inputs.ExperimentEndpointArgs
        {
            Endpoint = "string",
            Name = "string",
        },
        ExperimentName = "string",
        Location = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := network.NewExperiment(ctx, "azure-nativeExperimentResource", &network.ExperimentArgs{
    ProfileName: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    Description: pulumi.String("string"),
    EnabledState: pulumi.String("string"),
    EndpointA: &network.ExperimentEndpointArgs{
    Endpoint: pulumi.String("string"),
    Name: pulumi.String("string"),
    },
    EndpointB: &network.ExperimentEndpointArgs{
    Endpoint: pulumi.String("string"),
    Name: pulumi.String("string"),
    },
    ExperimentName: pulumi.String("string"),
    Location: pulumi.String("string"),
    Tags: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    })
    
    var azure_nativeExperimentResource = new Experiment("azure-nativeExperimentResource", ExperimentArgs.builder()
        .profileName("string")
        .resourceGroupName("string")
        .description("string")
        .enabledState("string")
        .endpointA(ExperimentEndpointArgs.builder()
            .endpoint("string")
            .name("string")
            .build())
        .endpointB(ExperimentEndpointArgs.builder()
            .endpoint("string")
            .name("string")
            .build())
        .experimentName("string")
        .location("string")
        .tags(Map.of("string", "string"))
        .build());
    
    azure_native_experiment_resource = azure_native.network.Experiment("azure-nativeExperimentResource",
        profile_name="string",
        resource_group_name="string",
        description="string",
        enabled_state="string",
        endpoint_a=azure_native.network.ExperimentEndpointArgs(
            endpoint="string",
            name="string",
        ),
        endpoint_b=azure_native.network.ExperimentEndpointArgs(
            endpoint="string",
            name="string",
        ),
        experiment_name="string",
        location="string",
        tags={
            "string": "string",
        })
    
    const azure_nativeExperimentResource = new azure_native.network.Experiment("azure-nativeExperimentResource", {
        profileName: "string",
        resourceGroupName: "string",
        description: "string",
        enabledState: "string",
        endpointA: {
            endpoint: "string",
            name: "string",
        },
        endpointB: {
            endpoint: "string",
            name: "string",
        },
        experimentName: "string",
        location: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:network:Experiment
    properties:
        description: string
        enabledState: string
        endpointA:
            endpoint: string
            name: string
        endpointB:
            endpoint: string
            name: string
        experimentName: string
        location: string
        profileName: string
        resourceGroupName: string
        tags:
            string: string
    

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

    ProfileName string
    The Profile identifier associated with the Tenant and Partner
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    Description string
    The description of the details or intents of the Experiment
    EnabledState string | Pulumi.AzureNative.Network.State
    The state of the Experiment
    EndpointA Pulumi.AzureNative.Network.Inputs.ExperimentEndpoint
    The endpoint A of an experiment
    EndpointB Pulumi.AzureNative.Network.Inputs.ExperimentEndpoint
    The endpoint B of an experiment
    ExperimentName string
    The Experiment identifier associated with the Experiment
    Location string
    Resource location.
    Tags Dictionary<string, string>
    Resource tags.
    ProfileName string
    The Profile identifier associated with the Tenant and Partner
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    Description string
    The description of the details or intents of the Experiment
    EnabledState string | State
    The state of the Experiment
    EndpointA ExperimentEndpointArgs
    The endpoint A of an experiment
    EndpointB ExperimentEndpointArgs
    The endpoint B of an experiment
    ExperimentName string
    The Experiment identifier associated with the Experiment
    Location string
    Resource location.
    Tags map[string]string
    Resource tags.
    profileName String
    The Profile identifier associated with the Tenant and Partner
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    description String
    The description of the details or intents of the Experiment
    enabledState String | State
    The state of the Experiment
    endpointA ExperimentEndpoint
    The endpoint A of an experiment
    endpointB ExperimentEndpoint
    The endpoint B of an experiment
    experimentName String
    The Experiment identifier associated with the Experiment
    location String
    Resource location.
    tags Map<String,String>
    Resource tags.
    profileName string
    The Profile identifier associated with the Tenant and Partner
    resourceGroupName string
    Name of the Resource group within the Azure subscription.
    description string
    The description of the details or intents of the Experiment
    enabledState string | State
    The state of the Experiment
    endpointA ExperimentEndpoint
    The endpoint A of an experiment
    endpointB ExperimentEndpoint
    The endpoint B of an experiment
    experimentName string
    The Experiment identifier associated with the Experiment
    location string
    Resource location.
    tags {[key: string]: string}
    Resource tags.
    profile_name str
    The Profile identifier associated with the Tenant and Partner
    resource_group_name str
    Name of the Resource group within the Azure subscription.
    description str
    The description of the details or intents of the Experiment
    enabled_state str | State
    The state of the Experiment
    endpoint_a ExperimentEndpointArgs
    The endpoint A of an experiment
    endpoint_b ExperimentEndpointArgs
    The endpoint B of an experiment
    experiment_name str
    The Experiment identifier associated with the Experiment
    location str
    Resource location.
    tags Mapping[str, str]
    Resource tags.
    profileName String
    The Profile identifier associated with the Tenant and Partner
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    description String
    The description of the details or intents of the Experiment
    enabledState String | "Enabled" | "Disabled"
    The state of the Experiment
    endpointA Property Map
    The endpoint A of an experiment
    endpointB Property Map
    The endpoint B of an experiment
    experimentName String
    The Experiment identifier associated with the Experiment
    location String
    Resource location.
    tags Map<String>
    Resource tags.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    ResourceState string
    Resource status.
    ScriptFileUri string
    The uri to the Script used in the Experiment
    Status string
    The description of Experiment status from the server side
    Type string
    Resource type.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    ResourceState string
    Resource status.
    ScriptFileUri string
    The uri to the Script used in the Experiment
    Status string
    The description of Experiment status from the server side
    Type string
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    resourceState String
    Resource status.
    scriptFileUri String
    The uri to the Script used in the Experiment
    status String
    The description of Experiment status from the server side
    type String
    Resource type.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    resourceState string
    Resource status.
    scriptFileUri string
    The uri to the Script used in the Experiment
    status string
    The description of Experiment status from the server side
    type string
    Resource type.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name.
    resource_state str
    Resource status.
    script_file_uri str
    The uri to the Script used in the Experiment
    status str
    The description of Experiment status from the server side
    type str
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    resourceState String
    Resource status.
    scriptFileUri String
    The uri to the Script used in the Experiment
    status String
    The description of Experiment status from the server side
    type String
    Resource type.

    Supporting Types

    ExperimentEndpoint, ExperimentEndpointArgs

    Endpoint string
    The endpoint URL
    Name string
    The name of the endpoint
    Endpoint string
    The endpoint URL
    Name string
    The name of the endpoint
    endpoint String
    The endpoint URL
    name String
    The name of the endpoint
    endpoint string
    The endpoint URL
    name string
    The name of the endpoint
    endpoint str
    The endpoint URL
    name str
    The name of the endpoint
    endpoint String
    The endpoint URL
    name String
    The name of the endpoint

    ExperimentEndpointResponse, ExperimentEndpointResponseArgs

    Endpoint string
    The endpoint URL
    Name string
    The name of the endpoint
    Endpoint string
    The endpoint URL
    Name string
    The name of the endpoint
    endpoint String
    The endpoint URL
    name String
    The name of the endpoint
    endpoint string
    The endpoint URL
    name string
    The name of the endpoint
    endpoint str
    The endpoint URL
    name str
    The name of the endpoint
    endpoint String
    The endpoint URL
    name String
    The name of the endpoint

    State, StateArgs

    Enabled
    Enabled
    Disabled
    Disabled
    StateEnabled
    Enabled
    StateDisabled
    Disabled
    Enabled
    Enabled
    Disabled
    Disabled
    Enabled
    Enabled
    Disabled
    Disabled
    ENABLED
    Enabled
    DISABLED
    Disabled
    "Enabled"
    Enabled
    "Disabled"
    Disabled

    Import

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

    $ pulumi import azure-native:network:Experiment MyExperiment /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName} 
    

    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.44.1 published on Thursday, Jun 6, 2024 by Pulumi