Load Test Run - Get Server Metrics Config

Serviço:

Azure Load Testing

Versão da API:

2022-11-01

Obter a configuração de métricas de servidor associadas para a execução de teste fornecida.

GET https://{endpoint}/test-runs/{testRunId}/server-metrics-config?api-version=2022-11-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string
testRunId	path	True	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	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.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	TestRunServerMetricsConfiguration	A solicitação foi bem-sucedida.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Segurança

Oauth2

OAuth 2.0 Flow com a ID do Microsoft Entra.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

Nome	Description
https://cnt-prod.loadtesting.azure.com/.default

Exemplos

List server metrics configuration for the given test run.

Solicitação de exemplo

HTTP

GET https://{endpoint}/test-runs/12345678-1234-1234-1234-123456789012/server-metrics-config?api-version=2022-11-01

Resposta de exemplo

Código de status:

200

{
  "testRunId": "12316678-1234-1234-1234-122451189012",
  "metrics": {
    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource",
      "metricNamespace": "microsoft.insights/components",
      "displayDescription": "sample description",
      "name": "requests/duration",
      "aggregation": "Average",
      "unit": null,
      "resourceType": "microsoft.insights/components"
    }
  },
  "createdDateTime": "2021-12-05T16:43:46.072Z",
  "createdBy": "user@contoso.com",
  "lastModifiedDateTime": "2021-12-05T16:43:46.072Z",
  "lastModifiedBy": "user@contoso.com"
}

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
ResourceMetric	Definição de métrica associada para determinadas métricas do recurso do azure ( Consulte : https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).
TestRunServerMetricsConfiguration	Testar a configuração de métricas do servidor de execução

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

ResourceMetric

Objeto

Definição de métrica associada para determinadas métricas do recurso do azure ( Consulte : https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).

Nome	Tipo	Description
aggregation	string	Agregação de métrica.
displayDescription	string	Descrição da métrica.
id	string	Nome exclusivo para métrica.
metricNamespace	string	Espaço no nome da métrica.
name	string	O valor invariável do nome da métrica
resourceId	string (arm-id)	ID de recurso do Azure.
resourceType	string	Tipo de recurso do Azure.
unit	string	Unidade de métrica.

TestRunServerMetricsConfiguration

Objeto

Testar a configuração de métricas do servidor de execução

Nome	Tipo	Description
createdBy	string	O usuário que criou.
createdDateTime	string (date-time)	O formato literal datetime (RFC 3339).
lastModifiedBy	string	O usuário que modificou pela última vez.
lastModifiedDateTime	string (date-time)	O último datetime modificado (formato literal RFC 3339).
metrics	<string,  ResourceMetric>	Coleção de métricas de recursos do Azure {id de métrica: objeto de métrica} (Consulte: https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition para id de métrica).
testRunId	string	Identificador de execução de teste