ChaosExtensions.GetChaosExperimentsAsync Method

Definition

Namespace:

Azure.ResourceManager.Chaos

Assembly:

Azure.ResourceManager.Chaos.dll

Package:

Azure.ResourceManager.Chaos v1.0.0

Source:

ChaosExtensions.cs

Get a list of Experiment resources in a subscription.

• Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/experiments
• Operation Id: Experiments_ListAll
• Default Api Version: 2024-01-01
• Resource: ChaosExperimentResource

public static Azure.AsyncPageable<Azure.ResourceManager.Chaos.ChaosExperimentResource> GetChaosExperimentsAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, bool? running = default, string continuationToken = default, System.Threading.CancellationToken cancellationToken = default);

static member GetChaosExperimentsAsync : Azure.ResourceManager.Resources.SubscriptionResource * Nullable<bool> * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Chaos.ChaosExperimentResource>

<Extension()>
Public Function GetChaosExperimentsAsync (subscriptionResource As SubscriptionResource, Optional running As Nullable(Of Boolean) = Nothing, Optional continuationToken As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ChaosExperimentResource)

Parameters

subscriptionResource

SubscriptionResource

The SubscriptionResource instance the method will execute against.

running

Nullable<Boolean>

Optional value that indicates whether to filter results based on if the Experiment is currently running. If null, then the results will not be filtered.

continuationToken

String

String that sets the continuation token.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

AsyncPageable<ChaosExperimentResource>

An async collection of ChaosExperimentResource that may take multiple service requests to iterate over.

Exceptions

ArgumentNullException

subscriptionResource is null.