Azure Native v2.90.0, Mar 27 25

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native.chaos.getExperiment

Explore with Pulumi AI

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

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.

TypeScript
Python
Go
C#
Java
YAML

function getExperiment(args: GetExperimentArgs, opts?: InvokeOptions): Promise<GetExperimentResult>
function getExperimentOutput(args: GetExperimentOutputArgs, opts?: InvokeOptions): Output<GetExperimentResult>

def get_experiment(experiment_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,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetExperimentResult]

func LookupExperiment(ctx *Context, args *LookupExperimentArgs, opts ...InvokeOption) (*LookupExperimentResult, error)
func LookupExperimentOutput(ctx *Context, args *LookupExperimentOutputArgs, opts ...InvokeOption) LookupExperimentResultOutput

> 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)
}

public static CompletableFuture<GetExperimentResult> getExperiment(GetExperimentArgs args, InvokeOptions options)
public static Output<GetExperimentResult> getExperiment(GetExperimentArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:chaos:getExperiment
  arguments:
    # arguments dictionary

The following arguments are supported:

ExperimentName string: String that represents a Experiment resource name.
ResourceGroupName string: String that represents an Azure resource group.

ExperimentName string: String that represents a Experiment resource name.
ResourceGroupName string: String that represents an Azure resource group.

experimentName String: String that represents a Experiment resource name.
resourceGroupName String: String that represents an Azure resource group.

experimentName string: String that represents a Experiment resource name.
resourceGroupName string: String that represents an Azure resource group.

experiment_name str: String that represents a Experiment resource name.
resource_group_name str: String that represents an Azure resource group.

experimentName String: String that represents a Experiment resource name.
resourceGroupName String: String that represents an Azure resource group.

getExperiment Result

The following output properties are available:

Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string: The geo-location where the resource lives
Name string: The name of the resource
Properties Pulumi.AzureNative.Chaos.Outputs.ExperimentPropertiesResponse: The properties of the experiment resource.
SystemData Pulumi.AzureNative.Chaos.Outputs.SystemDataResponse: The system metadata of the experiment resource.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Identity Pulumi.AzureNative.Chaos.Outputs.ResourceIdentityResponse: The identity of the experiment resource.
Tags Dictionary<string, string>: Resource tags.

Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string: The geo-location where the resource lives
Name string: The name of the resource
Properties ExperimentPropertiesResponse: The properties of the experiment resource.
SystemData SystemDataResponse: The system metadata of the experiment resource.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Identity ResourceIdentityResponse: The identity of the experiment resource.
Tags map[string]string: Resource tags.

id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String: The geo-location where the resource lives
name String: The name of the resource
properties ExperimentPropertiesResponse: The properties of the experiment resource.
systemData SystemDataResponse: The system metadata of the experiment resource.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity ResourceIdentityResponse: The identity of the experiment resource.
tags Map<String,String>: Resource tags.

id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string: The geo-location where the resource lives
name string: The name of the resource
properties ExperimentPropertiesResponse: The properties of the experiment resource.
systemData SystemDataResponse: The system metadata of the experiment resource.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity ResourceIdentityResponse: The identity of the experiment resource.
tags {[key: string]: string}: Resource tags.

id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str: The geo-location where the resource lives
name str: The name of the resource
properties ExperimentPropertiesResponse: The properties of the experiment resource.
system_data SystemDataResponse: The system metadata of the experiment resource.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity ResourceIdentityResponse: The identity of the experiment resource.
tags Mapping[str, str]: Resource tags.

id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String: The geo-location where the resource lives
name String: The name of the resource
properties Property Map: The properties of the experiment resource.
systemData Property Map: The system metadata of the experiment resource.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity Property Map: The identity of the experiment resource.
tags Map<String>: Resource tags.

Supporting Types

BranchResponse

Actions List<object>: List of actions.
Name string: String of the branch name.

Actions []interface{}: List of actions.
Name string: String of the branch name.

actions List<Object>: List of actions.
name String: String of the branch name.

actions (ContinuousActionResponse | DelayActionResponse | DiscreteActionResponse)[]: List of actions.
name string: String of the branch name.

actions Sequence[Union[ContinuousActionResponse, DelayActionResponse, DiscreteActionResponse]]: List of actions.
name str: String of the branch name.

actions List<Property Map | Property Map | Property Map>: List of actions.
name String: String of the branch name.

ContinuousActionResponse

Duration string: ISO8601 formatted string that represents a duration.
Name string: String that represents a Capability URN.
Parameters List<Pulumi.AzureNative.Chaos.Inputs.KeyValuePairResponse>: List of key value pairs.
SelectorId string: String that represents a selector.

Duration string: ISO8601 formatted string that represents a duration.
Name string: String that represents a Capability URN.
Parameters []KeyValuePairResponse: List of key value pairs.
SelectorId string: String that represents a selector.

duration String: ISO8601 formatted string that represents a duration.
name String: String that represents a Capability URN.
parameters List<KeyValuePairResponse>: List of key value pairs.
selectorId String: String that represents a selector.

duration string: ISO8601 formatted string that represents a duration.
name string: String that represents a Capability URN.
parameters KeyValuePairResponse[]: List of key value pairs.
selectorId string: String that represents a selector.

duration str: ISO8601 formatted string that represents a duration.
name str: String that represents a Capability URN.
parameters Sequence[KeyValuePairResponse]: List of key value pairs.
selector_id str: String that represents a selector.

duration String: ISO8601 formatted string that represents a duration.
name String: String that represents a Capability URN.
parameters List<Property Map>: List of key value pairs.
selectorId String: String that represents a selector.

DelayActionResponse

Duration string: ISO8601 formatted string that represents a duration.
Name string: String that represents a Capability URN.

Duration string: ISO8601 formatted string that represents a duration.
Name string: String that represents a Capability URN.

duration String: ISO8601 formatted string that represents a duration.
name String: String that represents a Capability URN.

duration string: ISO8601 formatted string that represents a duration.
name string: String that represents a Capability URN.

duration str: ISO8601 formatted string that represents a duration.
name str: String that represents a Capability URN.

duration String: ISO8601 formatted string that represents a duration.
name String: String that represents a Capability URN.

DiscreteActionResponse

Name string: String that represents a Capability URN.
Parameters List<Pulumi.AzureNative.Chaos.Inputs.KeyValuePairResponse>: List of key value pairs.
SelectorId string: String that represents a selector.

Name string: String that represents a Capability URN.
Parameters []KeyValuePairResponse: List of key value pairs.
SelectorId string: String that represents a selector.

name String: String that represents a Capability URN.
parameters List<KeyValuePairResponse>: List of key value pairs.
selectorId String: String that represents a selector.

name string: String that represents a Capability URN.
parameters KeyValuePairResponse[]: List of key value pairs.
selectorId string: String that represents a selector.

name str: String that represents a Capability URN.
parameters Sequence[KeyValuePairResponse]: List of key value pairs.
selector_id str: String that represents a selector.

name String: String that represents a Capability URN.
parameters List<Property Map>: List of key value pairs.
selectorId String: String that represents a selector.

ExperimentPropertiesResponse

Selectors List<Union<Pulumi.AzureNative.Chaos.Inputs.ListSelectorResponse, Pulumi.AzureNative.Chaos.Inputs.QuerySelectorResponse>>: List of selectors.
Steps List<Pulumi.AzureNative.Chaos.Inputs.StepResponse>: List of steps.
StartOnCreation bool: A boolean value that indicates if experiment should be started on creation or not.

Selectors []interface{}: List of selectors.
Steps []StepResponse: List of steps.
StartOnCreation bool: A boolean value that indicates if experiment should be started on creation or not.

selectors List<Either<ListSelectorResponse,QuerySelectorResponse>>: List of selectors.
steps List<StepResponse>: List of steps.
startOnCreation Boolean: A boolean value that indicates if experiment should be started on creation or not.

selectors (ListSelectorResponse | QuerySelectorResponse)[]: List of selectors.
steps StepResponse[]: List of steps.
startOnCreation boolean: A boolean value that indicates if experiment should be started on creation or not.

selectors Sequence[Union[ListSelectorResponse, QuerySelectorResponse]]: List of selectors.
steps Sequence[StepResponse]: List of steps.
start_on_creation bool: A boolean value that indicates if experiment should be started on creation or not.

selectors List<Property Map | Property Map>: List of selectors.
steps List<Property Map>: List of steps.
startOnCreation Boolean: A boolean value that indicates if experiment should be started on creation or not.

KeyValuePairResponse

Key string: The name of the setting for the action.
Value string: The value of the setting for the action.

Key string: The name of the setting for the action.
Value string: The value of the setting for the action.

key String: The name of the setting for the action.
value String: The value of the setting for the action.

key string: The name of the setting for the action.
value string: The value of the setting for the action.

key str: The name of the setting for the action.
value str: The value of the setting for the action.

key String: The name of the setting for the action.
value String: The value of the setting for the action.

ListSelectorResponse

Id string: String of the selector ID.
Targets List<Pulumi.AzureNative.Chaos.Inputs.TargetReferenceResponse>: List of Target references.
Filter Pulumi.AzureNative.Chaos.Inputs.SimpleFilterResponse: Model that represents available filter types that can be applied to a targets list.

Id string: String of the selector ID.
Targets []TargetReferenceResponse: List of Target references.
Filter SimpleFilterResponse: Model that represents available filter types that can be applied to a targets list.

id String: String of the selector ID.
targets List<TargetReferenceResponse>: List of Target references.
filter SimpleFilterResponse: Model that represents available filter types that can be applied to a targets list.

id string: String of the selector ID.
targets TargetReferenceResponse[]: List of Target references.
filter SimpleFilterResponse: Model that represents available filter types that can be applied to a targets list.

id str: String of the selector ID.
targets Sequence[TargetReferenceResponse]: List of Target references.
filter SimpleFilterResponse: Model that represents available filter types that can be applied to a targets list.

id String: String of the selector ID.
targets List<Property Map>: List of Target references.
filter Property Map: Model that represents available filter types that can be applied to a targets list.

QuerySelectorResponse

Id string: String of the selector ID.
QueryString string: Azure Resource Graph (ARG) Query Language query for target resources.
SubscriptionIds List<string>: Subscription id list to scope resource query.
Filter Pulumi.AzureNative.Chaos.Inputs.SimpleFilterResponse: Model that represents available filter types that can be applied to a targets list.

Id string: String of the selector ID.
QueryString string: Azure Resource Graph (ARG) Query Language query for target resources.
SubscriptionIds []string: Subscription id list to scope resource query.
Filter SimpleFilterResponse: Model that represents available filter types that can be applied to a targets list.

id String: String of the selector ID.
queryString String: Azure Resource Graph (ARG) Query Language query for target resources.
subscriptionIds List<String>: Subscription id list to scope resource query.
filter SimpleFilterResponse: Model that represents available filter types that can be applied to a targets list.

id string: String of the selector ID.
queryString string: Azure Resource Graph (ARG) Query Language query for target resources.
subscriptionIds string[]: Subscription id list to scope resource query.
filter SimpleFilterResponse: Model that represents available filter types that can be applied to a targets list.

id str: String of the selector ID.
query_string str: Azure Resource Graph (ARG) Query Language query for target resources.
subscription_ids Sequence[str]: Subscription id list to scope resource query.
filter SimpleFilterResponse: Model that represents available filter types that can be applied to a targets list.

id String: String of the selector ID.
queryString String: Azure Resource Graph (ARG) Query Language query for target resources.
subscriptionIds List<String>: Subscription id list to scope resource query.
filter Property Map: Model that represents available filter types that can be applied to a targets list.

ResourceIdentityResponse

PrincipalId string: GUID that represents the principal ID of this resource identity.
TenantId string: GUID that represents the tenant ID of this resource identity.
Type string: String of the resource identity type.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Chaos.Inputs.UserAssignedIdentityResponse>: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

PrincipalId string: GUID that represents the principal ID of this resource identity.
TenantId string: GUID that represents the tenant ID of this resource identity.
Type string: String of the resource identity type.
UserAssignedIdentities map[string]UserAssignedIdentityResponse: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

principalId String: GUID that represents the principal ID of this resource identity.
tenantId String: GUID that represents the tenant ID of this resource identity.
type String: String of the resource identity type.
userAssignedIdentities Map<String,UserAssignedIdentityResponse>: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

principalId string: GUID that represents the principal ID of this resource identity.
tenantId string: GUID that represents the tenant ID of this resource identity.
type string: String of the resource identity type.
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

principal_id str: GUID that represents the principal ID of this resource identity.
tenant_id str: GUID that represents the tenant ID of this resource identity.
type str: String of the resource identity type.
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

principalId String: GUID that represents the principal ID of this resource identity.
tenantId String: GUID that represents the tenant ID of this resource identity.
type String: String of the resource identity type.
userAssignedIdentities Map<Property Map>: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

SimpleFilterParametersResponse

Zones List<string>: List of Azure availability zones to filter targets by.

Zones []string: List of Azure availability zones to filter targets by.

zones List<String>: List of Azure availability zones to filter targets by.

zones string[]: List of Azure availability zones to filter targets by.

zones Sequence[str]: List of Azure availability zones to filter targets by.

zones List<String>: List of Azure availability zones to filter targets by.

SimpleFilterResponse

Parameters Pulumi.AzureNative.Chaos.Inputs.SimpleFilterParametersResponse: Model that represents the Simple filter parameters.

Parameters SimpleFilterParametersResponse: Model that represents the Simple filter parameters.

parameters SimpleFilterParametersResponse: Model that represents the Simple filter parameters.

parameters SimpleFilterParametersResponse: Model that represents the Simple filter parameters.

parameters SimpleFilterParametersResponse: Model that represents the Simple filter parameters.

parameters Property Map: Model that represents the Simple filter parameters.

StepResponse

Branches List<Pulumi.AzureNative.Chaos.Inputs.BranchResponse>: List of branches.
Name string: String of the step name.

Branches []BranchResponse: List of branches.
Name string: String of the step name.

branches List<BranchResponse>: List of branches.
name String: String of the step name.

branches BranchResponse[]: List of branches.
name string: String of the step name.

branches Sequence[BranchResponse]: List of branches.
name str: String of the step name.

branches List<Property Map>: List of branches.
name String: String of the step name.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

TargetReferenceResponse

Id string: String of the resource ID of a Target resource.
Type string: Enum of the Target reference type.

Id string: String of the resource ID of a Target resource.
Type string: Enum of the Target reference type.

id String: String of the resource ID of a Target resource.
type String: Enum of the Target reference type.

id string: String of the resource ID of a Target resource.
type string: Enum of the Target reference type.

id str: String of the resource ID of a Target resource.
type str: Enum of the Target reference type.

id String: String of the resource ID of a Target resource.
type String: Enum of the Target reference type.

UserAssignedIdentityResponse

ClientId string: The client ID of the assigned identity.
PrincipalId string: The principal ID of the assigned identity.

ClientId string: The client ID of the assigned identity.
PrincipalId string: The principal ID of the assigned identity.

clientId String: The client ID of the assigned identity.
principalId String: The principal ID of the assigned identity.

clientId string: The client ID of the assigned identity.
principalId string: The principal ID of the assigned identity.

client_id str: The client ID of the assigned identity.
principal_id str: The principal ID of the assigned identity.

clientId String: The client ID of the assigned identity.
principalId String: The principal ID of the assigned identity.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.chaos.getExperiment

On this page

On this page

Using getExperiment

getExperiment Result

Supporting Types

BranchResponse

ContinuousActionResponse

DelayActionResponse

DiscreteActionResponse

ExperimentPropertiesResponse

KeyValuePairResponse

ListSelectorResponse

QuerySelectorResponse

ResourceIdentityResponse

SimpleFilterParametersResponse

SimpleFilterResponse

StepResponse

SystemDataResponse

TargetReferenceResponse

UserAssignedIdentityResponse

Package Details

On this page

On this page