Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. getExperiment
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.network.getExperiment

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Defines the properties of an Experiment Azure REST API version: 2019-11-01.

Using getExperiment

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 getExperiment(args: GetExperimentArgs, opts?: InvokeOptions): Promise<GetExperimentResult>
function getExperimentOutput(args: GetExperimentOutputArgs, opts?: InvokeOptions): Output<GetExperimentResult>
Copy
def get_experiment(experiment_name: Optional[str] = None,
                   profile_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetExperimentResult
def get_experiment_output(experiment_name: Optional[pulumi.Input[str]] = None,
                   profile_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetExperimentResult]
Copy
func LookupExperiment(ctx *Context, args *LookupExperimentArgs, opts ...InvokeOption) (*LookupExperimentResult, error)
func LookupExperimentOutput(ctx *Context, args *LookupExperimentOutputArgs, opts ...InvokeOption) LookupExperimentResultOutput
Copy

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

public static class GetExperiment 
{
    public static Task<GetExperimentResult> InvokeAsync(GetExperimentArgs args, InvokeOptions? opts = null)
    public static Output<GetExperimentResult> Invoke(GetExperimentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetExperimentResult> getExperiment(GetExperimentArgs args, InvokeOptions options)
public static Output<GetExperimentResult> getExperiment(GetExperimentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getExperiment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ExperimentName
This property is required.
Changes to this property will trigger replacement.
string
The Experiment identifier associated with the Experiment
ProfileName
This property is required.
Changes to this property will trigger replacement.
string
The Profile identifier associated with the Tenant and Partner
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
ExperimentName
This property is required.
Changes to this property will trigger replacement.
string
The Experiment identifier associated with the Experiment
ProfileName
This property is required.
Changes to this property will trigger replacement.
string
The Profile identifier associated with the Tenant and Partner
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
experimentName
This property is required.
Changes to this property will trigger replacement.
String
The Experiment identifier associated with the Experiment
profileName
This property is required.
Changes to this property will trigger replacement.
String
The Profile identifier associated with the Tenant and Partner
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.
experimentName
This property is required.
Changes to this property will trigger replacement.
string
The Experiment identifier associated with the Experiment
profileName
This property is required.
Changes to this property will trigger replacement.
string
The Profile identifier associated with the Tenant and Partner
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
experiment_name
This property is required.
Changes to this property will trigger replacement.
str
The Experiment identifier associated with the Experiment
profile_name
This property is required.
Changes to this property will trigger replacement.
str
The Profile identifier associated with the Tenant and Partner
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Resource group within the Azure subscription.
experimentName
This property is required.
Changes to this property will trigger replacement.
String
The Experiment identifier associated with the Experiment
profileName
This property is required.
Changes to this property will trigger replacement.
String
The Profile identifier associated with the Tenant and Partner
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.

getExperiment Result

The following output properties are available:

Id string
Resource ID.
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.
Description string
The description of the details or intents of the Experiment
EnabledState string
The state of the Experiment
EndpointA Pulumi.AzureNative.Network.Outputs.ExperimentEndpointResponse
The endpoint A of an experiment
EndpointB Pulumi.AzureNative.Network.Outputs.ExperimentEndpointResponse
The endpoint B of an experiment
Location string
Resource location.
Tags Dictionary<string, string>
Resource tags.
Id string
Resource ID.
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.
Description string
The description of the details or intents of the Experiment
EnabledState string
The state of the Experiment
EndpointA ExperimentEndpointResponse
The endpoint A of an experiment
EndpointB ExperimentEndpointResponse
The endpoint B of an experiment
Location string
Resource location.
Tags map[string]string
Resource tags.
id String
Resource ID.
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.
description String
The description of the details or intents of the Experiment
enabledState String
The state of the Experiment
endpointA ExperimentEndpointResponse
The endpoint A of an experiment
endpointB ExperimentEndpointResponse
The endpoint B of an experiment
location String
Resource location.
tags Map<String,String>
Resource tags.
id string
Resource ID.
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.
description string
The description of the details or intents of the Experiment
enabledState string
The state of the Experiment
endpointA ExperimentEndpointResponse
The endpoint A of an experiment
endpointB ExperimentEndpointResponse
The endpoint B of an experiment
location string
Resource location.
tags {[key: string]: string}
Resource tags.
id str
Resource ID.
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.
description str
The description of the details or intents of the Experiment
enabled_state str
The state of the Experiment
endpoint_a ExperimentEndpointResponse
The endpoint A of an experiment
endpoint_b ExperimentEndpointResponse
The endpoint B of an experiment
location str
Resource location.
tags Mapping[str, str]
Resource tags.
id String
Resource ID.
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.
description String
The description of the details or intents of the Experiment
enabledState String
The state of the Experiment
endpointA Property Map
The endpoint A of an experiment
endpointB Property Map
The endpoint B of an experiment
location String
Resource location.
tags Map<String>
Resource tags.

Supporting Types

ExperimentEndpointResponse

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native