LoadTestRunClient.GetMetricNamespacesAsync(String, RequestContext) Method

Definition

Namespace:

Azure.Developer.LoadTesting

Assembly:

Azure.Developer.LoadTesting.dll

Package:

Azure.Developer.LoadTesting v1.0.1

Source:

LoadTestRunClient.cs

List the metric namespaces for a load test run.

public virtual System.Threading.Tasks.Task<Azure.Response> GetMetricNamespacesAsync (string testRunId, Azure.RequestContext context = default);

abstract member GetMetricNamespacesAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetMetricNamespacesAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetMetricNamespacesAsync (testRunId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

testRunId

String

Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service. Details of the response body schema are in the Remarks section below.

Exceptions

ArgumentNullException

testRunId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetMetricNamespacesAsync with required parameters and parse the result.

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new LoadTestRunClient(endpoint, credential);

Response response = await client.GetMetricNamespacesAsync("<testRunId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("value")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString());

Remarks

Below is the JSON schema for the response payload.

Response Body:

Schema for MetricNamespaceCollection:

{
  value: [
    {
      description: string, # Optional. The namespace description.
      name: string, # Optional. The metric namespace name.
    }
  ], # Required. The values for the metric namespaces.
}