Share via


ChaosExtensions.GetChaosExperimentAsync Method

Definition

Get a Experiment resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}
  • Operation Id: Experiments_Get
  • Default Api Version: 2024-01-01
  • Resource: ChaosExperimentResource
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Chaos.ChaosExperimentResource>> GetChaosExperimentAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string experimentName, System.Threading.CancellationToken cancellationToken = default);
static member GetChaosExperimentAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Chaos.ChaosExperimentResource>>
<Extension()>
Public Function GetChaosExperimentAsync (resourceGroupResource As ResourceGroupResource, experimentName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ChaosExperimentResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

experimentName
String

String that represents a Experiment resource name.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or experimentName is null.

experimentName is an empty string, and was expected to be non-empty.

Applies to