Condividi tramite

LoadTestRunClient.GetMetricNamespaces Method

Definition

Namespace:
Azure.Developer.LoadTesting
Assembly:
Azure.Developer.LoadTesting.dll
Package:
Azure.Developer.LoadTesting v1.0.2
Package:
Azure.Developer.LoadTesting v1.3.0-beta.1

Overloads

Name Description
GetMetricNamespaces(String, RequestContext)

[Protocol Method] List the metric namespaces for a load test run.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetMetricNamespaces(String, CancellationToken)

List the metric namespaces for a load test run.

GetMetricNamespaces(String, RequestContext)

Source:
LoadTestRunClient.cs
Source:
LoadTestRunClient.cs

[Protocol Method] List the metric namespaces for a load test run.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. 
public virtual Azure.Response GetMetricNamespaces(string testRunId, Azure.RequestContext context = default);
public virtual Azure.Response GetMetricNamespaces(string testRunId, Azure.RequestContext context);
abstract member GetMetricNamespaces : string * Azure.RequestContext -> Azure.Response
override this.GetMetricNamespaces : string * Azure.RequestContext -> Azure.Response
Public Overridable Function GetMetricNamespaces (testRunId As String, Optional context As RequestContext = Nothing) As Response
Public Overridable Function GetMetricNamespaces (testRunId As String, context As RequestContext) As 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 options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

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 GetMetricNamespaces and parse the result.

Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
LoadTestRunClient client = new LoadTestRunClient(endpoint, credential);

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

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

This sample shows how to call GetMetricNamespaces with all parameters and parse the result.

Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
LoadTestRunClient client = new LoadTestRunClient(endpoint, credential);

Response response = client.GetMetricNamespaces("<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.
}

Applies to

GetMetricNamespaces(String, CancellationToken)

Source:
LoadTestRunClient.cs

List the metric namespaces for a load test run.

public virtual Azure.Response<Azure.Developer.LoadTesting.MetricNamespaces> GetMetricNamespaces(string testRunId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetMetricNamespaces : string * System.Threading.CancellationToken -> Azure.Response<Azure.Developer.LoadTesting.MetricNamespaces>
override this.GetMetricNamespaces : string * System.Threading.CancellationToken -> Azure.Response<Azure.Developer.LoadTesting.MetricNamespaces>
Public Overridable Function GetMetricNamespaces (testRunId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of MetricNamespaces)

Parameters

testRunId
String

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

cancellationToken
CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Response<MetricNamespaces>

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.

Applies to