Metric.TryGetDataSeries Method

Definition

Namespace:

Microsoft.ApplicationInsights

Assembly:

Microsoft.ApplicationInsights.dll

Package:

Microsoft.ApplicationInsights v2.21.0

Overloads

TryGetDataSeries(MetricSeries, String, String, String, String, String, String, String, String)	Gets or creates the MetricSeries associated with the specified dimension values. This overload may only be used with 8-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.
TryGetDataSeries(MetricSeries, String, String, String, String, String, String, String)	Gets or creates the MetricSeries associated with the specified dimension values. This overload may only be used with 7-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.
TryGetDataSeries(MetricSeries, String, String, String, String, String, String)	Gets or creates the MetricSeries associated with the specified dimension values. This overload may only be used with 6-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.
TryGetDataSeries(MetricSeries, String, String, String, String, String)	Gets or creates the MetricSeries associated with the specified dimension values. This overload may only be used with 5-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.
TryGetDataSeries(MetricSeries, String, String, String, String)	Gets or creates the MetricSeries associated with the specified dimension values. This overload may only be used with 4-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.
TryGetDataSeries(MetricSeries)	Gets a MetricSeries associated with this metric. This overload gets the zero-dimensional MetricSeries associated with this metric. Every metric, regardless of its dimensionality, has such a zero-dimensional MetricSeries.
TryGetDataSeries(MetricSeries, String, String)	Gets or creates the MetricSeries associated with the specified dimension values. This overload may only be used with 2-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.
TryGetDataSeries(MetricSeries, Boolean, String[])	Gets or creates the MetricSeries associated with the specified dimension values. This overload used metrics of any valid dimensionality: The number of elements in the specified dimensionValues array must exactly match the dimensionality of this metric, and that array may not contain nulls. Specify a null-array for zero-dimensional metrics.
TryGetDataSeries(MetricSeries, String)	Gets or creates the MetricSeries associated with the specified dimension value. This overload may only be used with 1-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.
TryGetDataSeries(MetricSeries, String, String, String, String, String, String, String, String, String)	Gets or creates the MetricSeries associated with the specified dimension values. This overload may only be used with 9-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.
TryGetDataSeries(MetricSeries, String, String, String)	Gets or creates the MetricSeries associated with the specified dimension values. This overload may only be used with 3-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.
TryGetDataSeries(MetricSeries, String, String, String, String, String, String, String, String, String, String)	Gets or creates the MetricSeries associated with the specified dimension values. This overload may only be used with 10-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.

TryGetDataSeries(MetricSeries, String, String, String, String, String, String, String, String)

Gets or creates the MetricSeries associated with the specified dimension values.
This overload may only be used with 8-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.

public bool TryGetDataSeries (out Microsoft.ApplicationInsights.Metrics.MetricSeries series, string dimension1Value, string dimension2Value, string dimension3Value, string dimension4Value, string dimension5Value, string dimension6Value, string dimension7Value, string dimension8Value);

member this.TryGetDataSeries : MetricSeries * string * string * string * string * string * string * string * string -> bool

Public Function TryGetDataSeries (ByRef series As MetricSeries, dimension1Value As String, dimension2Value As String, dimension3Value As String, dimension4Value As String, dimension5Value As String, dimension6Value As String, dimension7Value As String, dimension8Value As String) As Boolean

Parameters

series

MetricSeries

If this method returns True: Will be set to the MetricSeries associated with the specified dimension value.
Otherwise: Will be set to null.

dimension1Value

String

The value of the 1st dimension.

dimension2Value

String

The value of the 2nd dimension.

dimension3Value

String

The value of the 3rd dimension.

dimension4Value

String

The value of the 4th dimension.

dimension5Value

String

The value of the 5th dimension.

dimension6Value

String

The value of the 6th dimension.

dimension7Value

String

The value of the 7th dimension.

dimension8Value

String

The value of the 8th dimension.

Returns

Boolean

True if the MetricSeries indicated by the specified dimension name could be retrieved (or created); False if the indicated series could not be retrieved or created because a dimension cap or a metric series cap was reached.

Exceptions

ArgumentException

If the number of specified dimension names does not match the dimensionality of this Metric.

TryGetDataSeries(MetricSeries, String, String, String, String, String, String, String)

Gets or creates the MetricSeries associated with the specified dimension values.
This overload may only be used with 7-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.

public bool TryGetDataSeries (out Microsoft.ApplicationInsights.Metrics.MetricSeries series, string dimension1Value, string dimension2Value, string dimension3Value, string dimension4Value, string dimension5Value, string dimension6Value, string dimension7Value);

member this.TryGetDataSeries : MetricSeries * string * string * string * string * string * string * string -> bool

Public Function TryGetDataSeries (ByRef series As MetricSeries, dimension1Value As String, dimension2Value As String, dimension3Value As String, dimension4Value As String, dimension5Value As String, dimension6Value As String, dimension7Value As String) As Boolean

Parameters

series

MetricSeries

If this method returns True: Will be set to the MetricSeries associated with the specified dimension value.
Otherwise: Will be set to null.

dimension1Value

String

The value of the 1st dimension.

dimension2Value

String

The value of the 2nd dimension.

dimension3Value

String

The value of the 3rd dimension.

dimension4Value

String

The value of the 4th dimension.

dimension5Value

String

The value of the 5th dimension.

dimension6Value

String

The value of the 6th dimension.

dimension7Value

String

The value of the 7th dimension.

Returns

Boolean

True if the MetricSeries indicated by the specified dimension name could be retrieved (or created); False if the indicated series could not be retrieved or created because a dimension cap or a metric series cap was reached.

Exceptions

ArgumentException

If the number of specified dimension names does not match the dimensionality of this Metric.

TryGetDataSeries(MetricSeries, String, String, String, String, String, String)

Gets or creates the MetricSeries associated with the specified dimension values.
This overload may only be used with 6-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.

public bool TryGetDataSeries (out Microsoft.ApplicationInsights.Metrics.MetricSeries series, string dimension1Value, string dimension2Value, string dimension3Value, string dimension4Value, string dimension5Value, string dimension6Value);

member this.TryGetDataSeries : MetricSeries * string * string * string * string * string * string -> bool

Public Function TryGetDataSeries (ByRef series As MetricSeries, dimension1Value As String, dimension2Value As String, dimension3Value As String, dimension4Value As String, dimension5Value As String, dimension6Value As String) As Boolean

Parameters

series

MetricSeries

If this method returns True: Will be set to the MetricSeries associated with the specified dimension value.
Otherwise: Will be set to null.

dimension1Value

String

The value of the 1st dimension.

dimension2Value

String

The value of the 2nd dimension.

dimension3Value

String

The value of the 3rd dimension.

dimension4Value

String

The value of the 4th dimension.

dimension5Value

String

The value of the 5th dimension.

dimension6Value

String

The value of the 6th dimension.

Returns

Boolean

True if the MetricSeries indicated by the specified dimension name could be retrieved (or created); False if the indicated series could not be retrieved or created because a dimension cap or a metric series cap was reached.

Exceptions

ArgumentException

If the number of specified dimension names does not match the dimensionality of this Metric.

TryGetDataSeries(MetricSeries, String, String, String, String, String)

Gets or creates the MetricSeries associated with the specified dimension values.
This overload may only be used with 5-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.

public bool TryGetDataSeries (out Microsoft.ApplicationInsights.Metrics.MetricSeries series, string dimension1Value, string dimension2Value, string dimension3Value, string dimension4Value, string dimension5Value);

member this.TryGetDataSeries : MetricSeries * string * string * string * string * string -> bool

Public Function TryGetDataSeries (ByRef series As MetricSeries, dimension1Value As String, dimension2Value As String, dimension3Value As String, dimension4Value As String, dimension5Value As String) As Boolean

Parameters

series

MetricSeries

If this method returns True: Will be set to the MetricSeries associated with the specified dimension value.
Otherwise: Will be set to null.

dimension1Value

String

The value of the 1st dimension.

dimension2Value

String

The value of the 2nd dimension.

dimension3Value

String

The value of the 3rd dimension.

dimension4Value

String

The value of the 4th dimension.

dimension5Value

String

The value of the 5th dimension.

Returns

Boolean

True if the MetricSeries indicated by the specified dimension name could be retrieved (or created); False if the indicated series could not be retrieved or created because a dimension cap or a metric series cap was reached.

Exceptions

ArgumentException

If the number of specified dimension names does not match the dimensionality of this Metric.

TryGetDataSeries(MetricSeries, String, String, String, String)

Gets or creates the MetricSeries associated with the specified dimension values.
This overload may only be used with 4-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.

public bool TryGetDataSeries (out Microsoft.ApplicationInsights.Metrics.MetricSeries series, string dimension1Value, string dimension2Value, string dimension3Value, string dimension4Value);

member this.TryGetDataSeries : MetricSeries * string * string * string * string -> bool

Public Function TryGetDataSeries (ByRef series As MetricSeries, dimension1Value As String, dimension2Value As String, dimension3Value As String, dimension4Value As String) As Boolean

Parameters

series

MetricSeries

If this method returns True: Will be set to the MetricSeries associated with the specified dimension value.
Otherwise: Will be set to null.

dimension1Value

String

The value of the 1st dimension.

dimension2Value

String

The value of the 2nd dimension.

dimension3Value

String

The value of the 3rd dimension.

dimension4Value

String

The value of the 4th dimension.

Returns

Boolean

True if the MetricSeries indicated by the specified dimension name could be retrieved (or created); False if the indicated series could not be retrieved or created because a dimension cap or a metric series cap was reached.

Exceptions

ArgumentException

If the number of specified dimension names does not match the dimensionality of this Metric.

TryGetDataSeries(MetricSeries)

Gets a MetricSeries associated with this metric.
This overload gets the zero-dimensional MetricSeries associated with this metric. Every metric, regardless of its dimensionality, has such a zero-dimensional MetricSeries.

public bool TryGetDataSeries (out Microsoft.ApplicationInsights.Metrics.MetricSeries series);

member this.TryGetDataSeries : MetricSeries -> bool

Public Function TryGetDataSeries (ByRef series As MetricSeries) As Boolean

Parameters

series

MetricSeries

Will be set to the zero-dimensional MetricSeries associated with this metric.

Returns

Boolean

True.

TryGetDataSeries(MetricSeries, String, String)

Gets or creates the MetricSeries associated with the specified dimension values.
This overload may only be used with 2-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.

public bool TryGetDataSeries (out Microsoft.ApplicationInsights.Metrics.MetricSeries series, string dimension1Value, string dimension2Value);

member this.TryGetDataSeries : MetricSeries * string * string -> bool

Public Function TryGetDataSeries (ByRef series As MetricSeries, dimension1Value As String, dimension2Value As String) As Boolean

Parameters

series

MetricSeries

If this method returns True: Will be set to the MetricSeries associated with the specified dimension value.
Otherwise: Will be set to null.

dimension1Value

String

The value of the 1st dimension.

dimension2Value

String

The value of the 2nd dimension.

Returns

Boolean

True if the MetricSeries indicated by the specified dimension name could be retrieved (or created); False if the indicated series could not be retrieved or created because a dimension cap or a metric series cap was reached.

Exceptions

ArgumentException

If the number of specified dimension names does not match the dimensionality of this Metric.

TryGetDataSeries(MetricSeries, Boolean, String[])

Gets or creates the MetricSeries associated with the specified dimension values.
This overload used metrics of any valid dimensionality: The number of elements in the specified dimensionValues array must exactly match the dimensionality of this metric, and that array may not contain nulls. Specify a null-array for zero-dimensional metrics.

public bool TryGetDataSeries (out Microsoft.ApplicationInsights.Metrics.MetricSeries series, bool createIfNotExists, params string[] dimensionValues);

member this.TryGetDataSeries : MetricSeries * bool * string[] -> bool

Public Function TryGetDataSeries (ByRef series As MetricSeries, createIfNotExists As Boolean, ParamArray dimensionValues As String()) As Boolean

Parameters

series

MetricSeries

If this method returns True: Will be set to the MetricSeries associated with the specified dimension values.
Otherwise: Will be set to null.

createIfNotExists

Boolean

Whether to attempt creating a metric series for the specified dimension values if it does not exist.

dimensionValues

String[]

The values of the dimensions for the required metric series.

Returns

Boolean

True if the MetricSeries indicated by the specified dimension names could be retrieved or created; False if the indicated series could not be retrieved or created because createIfNotExists is false or because a dimension cap or a metric series cap was reached.

Exceptions

ArgumentException

If the number of specified dimension names does not match the dimensionality of this Metric.

TryGetDataSeries(MetricSeries, String)

Gets or creates the MetricSeries associated with the specified dimension value.
This overload may only be used with 1-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.

public bool TryGetDataSeries (out Microsoft.ApplicationInsights.Metrics.MetricSeries series, string dimension1Value);

member this.TryGetDataSeries : MetricSeries * string -> bool

Public Function TryGetDataSeries (ByRef series As MetricSeries, dimension1Value As String) As Boolean

Parameters

series

MetricSeries

If this method returns True: Will be set to the MetricSeries associated with the specified dimension value.
Otherwise: Will be set to null.

dimension1Value

String

The value of the 1st dimension.

Returns

Boolean

True if the MetricSeries indicated by the specified dimension name could be retrieved (or created); False if the indicated series could not be retrieved or created because a dimension cap or a metric series cap was reached.

Exceptions

ArgumentException

If the number of specified dimension names does not match the dimensionality of this Metric.

TryGetDataSeries(MetricSeries, String, String, String, String, String, String, String, String, String)

Gets or creates the MetricSeries associated with the specified dimension values.
This overload may only be used with 9-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.

public bool TryGetDataSeries (out Microsoft.ApplicationInsights.Metrics.MetricSeries series, string dimension1Value, string dimension2Value, string dimension3Value, string dimension4Value, string dimension5Value, string dimension6Value, string dimension7Value, string dimension8Value, string dimension9Value);

member this.TryGetDataSeries : MetricSeries * string * string * string * string * string * string * string * string * string -> bool

Public Function TryGetDataSeries (ByRef series As MetricSeries, dimension1Value As String, dimension2Value As String, dimension3Value As String, dimension4Value As String, dimension5Value As String, dimension6Value As String, dimension7Value As String, dimension8Value As String, dimension9Value As String) As Boolean

Parameters

series

MetricSeries

If this method returns True: Will be set to the MetricSeries associated with the specified dimension value.
Otherwise: Will be set to null.

dimension1Value

String

The value of the 1st dimension.

dimension2Value

String

The value of the 2nd dimension.

dimension3Value

String

The value of the 3rd dimension.

dimension4Value

String

The value of the 4th dimension.

dimension5Value

String

The value of the 5th dimension.

dimension6Value

String

The value of the 6th dimension.

dimension7Value

String

The value of the 7th dimension.

dimension8Value

String

The value of the 8th dimension.

dimension9Value

String

The value of the 9th dimension.

Returns

Boolean

True if the MetricSeries indicated by the specified dimension name could be retrieved (or created); False if the indicated series could not be retrieved or created because a dimension cap or a metric series cap was reached.

Exceptions

ArgumentException

If the number of specified dimension names does not match the dimensionality of this Metric.

TryGetDataSeries(MetricSeries, String, String, String)

Gets or creates the MetricSeries associated with the specified dimension values.
This overload may only be used with 3-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.

public bool TryGetDataSeries (out Microsoft.ApplicationInsights.Metrics.MetricSeries series, string dimension1Value, string dimension2Value, string dimension3Value);

member this.TryGetDataSeries : MetricSeries * string * string * string -> bool

Public Function TryGetDataSeries (ByRef series As MetricSeries, dimension1Value As String, dimension2Value As String, dimension3Value As String) As Boolean

Parameters

series

MetricSeries

If this method returns True: Will be set to the MetricSeries associated with the specified dimension value.
Otherwise: Will be set to null.

dimension1Value

String

The value of the 1st dimension.

dimension2Value

String

The value of the 2nd dimension.

dimension3Value

String

The value of the 3rd dimension.

Returns

Boolean

True if the MetricSeries indicated by the specified dimension name could be retrieved (or created); False if the indicated series could not be retrieved or created because a dimension cap or a metric series cap was reached.

Exceptions

ArgumentException

If the number of specified dimension names does not match the dimensionality of this Metric.

TryGetDataSeries(MetricSeries, String, String, String, String, String, String, String, String, String, String)

Gets or creates the MetricSeries associated with the specified dimension values.
This overload may only be used with 10-dimensional metrics. Use other overloads to specify a matching number of dimension values for this metric.

public bool TryGetDataSeries (out Microsoft.ApplicationInsights.Metrics.MetricSeries series, string dimension1Value, string dimension2Value, string dimension3Value, string dimension4Value, string dimension5Value, string dimension6Value, string dimension7Value, string dimension8Value, string dimension9Value, string dimension10Value);

member this.TryGetDataSeries : MetricSeries * string * string * string * string * string * string * string * string * string * string -> bool

Public Function TryGetDataSeries (ByRef series As MetricSeries, dimension1Value As String, dimension2Value As String, dimension3Value As String, dimension4Value As String, dimension5Value As String, dimension6Value As String, dimension7Value As String, dimension8Value As String, dimension9Value As String, dimension10Value As String) As Boolean

Parameters

series

MetricSeries

If this method returns True: Will be set to the MetricSeries associated with the specified dimension value.
Otherwise: Will be set to null.

dimension1Value

String

The value of the 1st dimension.

dimension2Value

String

The value of the 2nd dimension.

dimension3Value

String

The value of the 3rd dimension.

dimension4Value

String

The value of the 4th dimension.

dimension5Value

String

The value of the 5th dimension.

dimension6Value

String

The value of the 6th dimension.

dimension7Value

String

The value of the 7th dimension.

dimension8Value

String

The value of the 8th dimension.

dimension9Value

String

The value of the 9th dimension.

dimension10Value

String

The value of the 10th dimension.

Returns

Boolean

True if the MetricSeries indicated by the specified dimension name could be retrieved (or created); False if the indicated series could not be retrieved or created because a dimension cap or a metric series cap was reached.

Exceptions

ArgumentException

If the number of specified dimension names does not match the dimensionality of this Metric.