BaselinesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:baselines> attribute.
Constructor
BaselinesOperations(*args, **kwargs)Methods
| list |
Lists the metric baseline values for a resource. |
list
Lists the metric baseline values for a resource.
list(resource_uri: str, metricnames: str | None = None, metricnamespace: str | None = None, timespan: str | None = None, interval: timedelta | None = None, aggregation: str | None = None, sensitivities: str | None = None, filter: str | None = None, result_type: str | ResultType | None = None, **kwargs: Any) -> ItemPaged[SingleMetricBaseline]Parameters
| Name | Description |
|---|---|
|
resource_uri
Required
|
The identifier of the resource. Required. |
|
metricnames
|
The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be 'Metric%2Name1'. Default value is None. Default value: None
|
|
metricnamespace
|
Metric namespace that contains the requested metric names. Default value is None. Default value: None
|
|
timespan
|
The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'. Default value is None. Default value: None
|
|
interval
|
The interval (i.e. timegrain) of the query. Default value is None. Default value: None
|
|
aggregation
|
The list of aggregation types (comma separated) to retrieve. Default value is None. Default value: None
|
|
sensitivities
|
The list of sensitivities (comma separated) to retrieve. Default value is None. Default value: None
|
|
filter
|
The $filter is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of C where A = a1 and B = b1 or b2 $filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*' - Invalid variant: $filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2' This is invalid because the logical or operator cannot separate two different metadata names. - Return all time series where A = a1, B = b1 and C = c1: $filter=A eq 'a1' and B eq 'b1' and C eq 'c1' - Return all time series where A = a1 $filter=A eq 'a1' and B eq '' and C eq ''. Special case: When dimension name or dimension value uses round brackets. Eg: When dimension name is dim (test) 1 Instead of using $filter= "dim (test) 1 eq '' " use **$filter= "dim %2528test%2529 1 eq '' "** When dimension name is dim (test) 3 and dimension value is dim3 (test) val Instead of using $filter= "dim (test) 3 eq 'dim3 (test) val' " use $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' ". Default value is None. Default value: None
|
|
result_type
|
str or
ResultType
Allows retrieving only metadata of the baseline. On data request all information is retrieved. Known values are: "Data" and "Metadata". Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either SingleMetricBaseline or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.monitor.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv181\\Lib\\site-packages\\azure\\mgmt\\monitor\\models\\__init__.py'>