LoadTestRunClient.GetServerMetricsConfigAsync(String, RequestContext) Método

Definição

Namespace:

Azure.Developer.LoadTesting

Assembly:

Azure.Developer.LoadTesting.dll

Pacote:

Azure.Developer.LoadTesting v1.0.1

Origem:

LoadTestRunClient.cs

Liste a configuração de métricas do servidor para a execução de teste fornecida.

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

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

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

Parâmetros

testRunId

String

O nome exclusivo para a execução do teste de carga deve conter apenas caracteres alfabéticos, numéricos, sublinhados ou hifens de minúsculas.

context

RequestContext

O contexto de solicitação, que pode substituir os comportamentos padrão do pipeline do cliente por chamada.

Retornos

Task<Response>

A resposta retornada do serviço. Os detalhes do esquema do corpo da resposta estão na seção Comentários abaixo.

Exceções

ArgumentNullException

testRunId é nulo.

ArgumentException

testRunId é uma cadeia de caracteres vazia e esperava-se que não estivesse vazia.

RequestFailedException

O serviço retornou um código de status sem êxito.

Exemplos

Este exemplo mostra como chamar GetServerMetricsConfigAsync com os parâmetros necessários e analisar o resultado.

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

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

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("testRunId").ToString());
Console.WriteLine(result.GetProperty("metrics").GetProperty("<test>").GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("metrics").GetProperty("<test>").GetProperty("resourceId").ToString());
Console.WriteLine(result.GetProperty("metrics").GetProperty("<test>").GetProperty("metricNamespace").ToString());
Console.WriteLine(result.GetProperty("metrics").GetProperty("<test>").GetProperty("displayDescription").ToString());
Console.WriteLine(result.GetProperty("metrics").GetProperty("<test>").GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("metrics").GetProperty("<test>").GetProperty("aggregation").ToString());
Console.WriteLine(result.GetProperty("metrics").GetProperty("<test>").GetProperty("unit").ToString());
Console.WriteLine(result.GetProperty("metrics").GetProperty("<test>").GetProperty("resourceType").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("createdBy").ToString());
Console.WriteLine(result.GetProperty("lastModifiedDateTime").ToString());
Console.WriteLine(result.GetProperty("lastModifiedBy").ToString());

Comentários

Abaixo está o esquema JSON para o conteúdo da resposta.

Corpo da resposta:

Esquema para TestRunServerMetricConfig:

{
  testRunId: string, # Optional. Test run identifier
  metrics: Dictionary<string, ResourceMetric>, # Optional. Azure resource metrics collection {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id).
  createdDateTime: string (ISO 8601 Format), # Optional. The creation datetime(ISO 8601 literal format).
  createdBy: string, # Optional. The user that created.
  lastModifiedDateTime: string (ISO 8601 Format), # Optional. The last Modified datetime(ISO 8601 literal format).
  lastModifiedBy: string, # Optional. The user that last modified.
}