• InfluxDB.Client API
Show / Hide Table of Contents
  • InfluxDB.Client
    • AuthorizationsApi
    • BucketsApi
    • ChecksApi
    • DeleteApi
    • IAuthorizationsApi
    • IBucketsApi
    • IChecksApi
    • IDeleteApi
    • IDomainObjectMapper
    • IInfluxDBClient
    • IInvokableScriptsApi
    • ILabelsApi
    • InfluxDBClient
    • InfluxDBClientFactory
    • InfluxDBClientOptions
    • InfluxDBClientOptions.AuthenticationScheme
    • InfluxDBClientOptions.Builder
    • INotificationEndpointsApi
    • INotificationRulesApi
    • InvokableScriptsApi
    • IOrganizationsApi
    • IQueryApi
    • IQueryApiSync
    • IScraperTargetsApi
    • ISourcesApi
    • ITasksApi
    • ITelegrafsApi
    • IUsersApi
    • IWriteApi
    • IWriteApiAsync
    • LabelsApi
    • NotificationEndpointsApi
    • NotificationRulesApi
    • OrganizationsApi
    • QueryApi
    • QueryApiSync
    • ScraperTargetsApi
    • SourcesApi
    • TasksApi
    • TelegrafsApi
    • UsersApi
    • WriteApi
    • WriteApiAsync
    • WriteOptions
    • WriteOptions.Builder
  • InfluxDB.Client.Api.Domain
    • AddResourceMemberRequestBody
    • AnalyzeQueryResponse
    • AnalyzeQueryResponseErrors
    • ArrayExpression
    • ArrayExpression.ArrayExpressionElementsAdapter
    • ASTResponse
    • Authorization
    • AuthorizationLinks
    • AuthorizationPostRequest
    • Authorizations
    • AuthorizationUpdateRequest
    • AuthorizationUpdateRequest.StatusEnum
    • Axes
    • Axis
    • Axis.BaseEnum
    • AxisScale
    • BadStatement
    • BandViewProperties
    • BandViewProperties.HoverDimensionEnum
    • BandViewProperties.ShapeEnum
    • BandViewProperties.TypeEnum
    • BinaryExpression
    • BinaryExpression.BinaryExpressionLeftAdapter
    • BinaryExpression.BinaryExpressionRightAdapter
    • Block
    • Block.BlockBodyAdapter
    • BooleanLiteral
    • Bucket
    • Bucket.TypeEnum
    • BucketLinks
    • BucketMetadataManifest
    • BucketRetentionRules
    • BucketRetentionRules.TypeEnum
    • Buckets
    • BucketShardMapping
    • BuilderAggregateFunctionType
    • BuilderConfig
    • BuilderConfigAggregateWindow
    • BuilderFunctionsType
    • BuilderTagsType
    • BuiltinStatement
    • CallExpression
    • CallExpression.CallExpressionArgumentsAdapter
    • CallExpression.CallExpressionCalleeAdapter
    • Cell
    • CellLinks
    • CellUpdate
    • CellWithViewProperties
    • Check
    • CheckBase
    • CheckBase.LastRunStatusEnum
    • CheckBaseLinks
    • CheckDiscriminator
    • CheckPatch
    • CheckPatch.StatusEnum
    • Checks
    • CheckStatusLevel
    • CheckViewProperties
    • CheckViewProperties.ShapeEnum
    • CheckViewProperties.TypeEnum
    • ConditionalExpression
    • ConditionalExpression.ConditionalExpressionAlternateAdapter
    • ConditionalExpression.ConditionalExpressionConsequentAdapter
    • ConditionalExpression.ConditionalExpressionTestAdapter
    • Config
    • ConstantVariableProperties
    • ConstantVariableProperties.TypeEnum
    • CreateCell
    • CreateDashboardRequest
    • CustomCheck
    • CustomCheck.TypeEnum
    • Dashboard
    • DashboardColor
    • DashboardColor.TypeEnum
    • DashboardLinks
    • DashboardMeta
    • DashboardQuery
    • Dashboards
    • DashboardWithViewProperties
    • DateTimeLiteral
    • DBRP
    • DBRPCreate
    • DBRPGet
    • DBRPs
    • DBRPUpdate
    • DeadmanCheck
    • DeadmanCheck.TypeEnum
    • DecimalPlaces
    • DeletePredicateRequest
    • Dialect
    • Dialect.AnnotationsEnum
    • Dialect.DateTimeFormatEnum
    • DictExpression
    • DictItem
    • DictItem.DictItemKeyAdapter
    • DictItem.DictItemValAdapter
    • Duration
    • DurationLiteral
    • Error
    • Error.CodeEnum
    • Expression
    • ExpressionStatement
    • ExpressionStatement.ExpressionStatementExpressionAdapter
    • Field
    • Field.TypeEnum
    • File
    • File.FileBodyAdapter
    • FloatLiteral
    • FluxResponse
    • FluxSuggestion
    • FluxSuggestions
    • FunctionExpression
    • FunctionExpression.FunctionExpressionBodyAdapter
    • GaugeViewProperties
    • GaugeViewProperties.ShapeEnum
    • GaugeViewProperties.TypeEnum
    • GreaterThreshold
    • GreaterThreshold.TypeEnum
    • HealthCheck
    • HealthCheck.StatusEnum
    • HeatmapViewProperties
    • HeatmapViewProperties.ShapeEnum
    • HeatmapViewProperties.TypeEnum
    • HistogramViewProperties
    • HistogramViewProperties.PositionEnum
    • HistogramViewProperties.ShapeEnum
    • HistogramViewProperties.TypeEnum
    • HTTPNotificationEndpoint
    • HTTPNotificationEndpoint.AuthMethodEnum
    • HTTPNotificationEndpoint.MethodEnum
    • HTTPNotificationRule
    • HTTPNotificationRuleBase
    • HTTPNotificationRuleBase.TypeEnum
    • Identifier
    • ImportDeclaration
    • IndexExpression
    • IndexExpression.IndexExpressionArrayAdapter
    • IndexExpression.IndexExpressionIndexAdapter
    • IntegerLiteral
    • IsOnboarding
    • Label
    • LabelCreateRequest
    • LabelMapping
    • LabelResponse
    • LabelsResponse
    • LabelUpdate
    • LanguageRequest
    • LegacyAuthorizationPostRequest
    • LesserThreshold
    • LesserThreshold.TypeEnum
    • LinePlusSingleStatProperties
    • LinePlusSingleStatProperties.HoverDimensionEnum
    • LinePlusSingleStatProperties.PositionEnum
    • LinePlusSingleStatProperties.ShapeEnum
    • LinePlusSingleStatProperties.TypeEnum
    • LineProtocolError
    • LineProtocolError.CodeEnum
    • LineProtocolLengthError
    • LineProtocolLengthError.CodeEnum
    • Links
    • ListStacksResponse
    • LogEvent
    • LogicalExpression
    • LogicalExpression.LogicalExpressionLeftAdapter
    • LogicalExpression.LogicalExpressionRightAdapter
    • Logs
    • MapVariableProperties
    • MapVariableProperties.TypeEnum
    • MarkdownViewProperties
    • MarkdownViewProperties.ShapeEnum
    • MarkdownViewProperties.TypeEnum
    • MemberAssignment
    • MemberAssignment.MemberAssignmentInitAdapter
    • MemberExpression
    • MemberExpression.MemberExpressionObjectAdapter
    • MemberExpression.MemberExpressionPropertyAdapter
    • MetadataBackup
    • MosaicViewProperties
    • MosaicViewProperties.HoverDimensionEnum
    • MosaicViewProperties.ShapeEnum
    • MosaicViewProperties.TypeEnum
    • Node
    • NotificationEndpoint
    • NotificationEndpointBase
    • NotificationEndpointBase.StatusEnum
    • NotificationEndpointBaseLinks
    • NotificationEndpointDiscriminator
    • NotificationEndpoints
    • NotificationEndpointType
    • NotificationEndpointUpdate
    • NotificationEndpointUpdate.StatusEnum
    • NotificationRule
    • NotificationRuleBase
    • NotificationRuleBase.LastRunStatusEnum
    • NotificationRuleBaseLinks
    • NotificationRuleDiscriminator
    • NotificationRules
    • NotificationRuleUpdate
    • NotificationRuleUpdate.StatusEnum
    • ObjectExpression
    • OnboardingRequest
    • OnboardingResponse
    • OptionStatement
    • OptionStatement.OptionStatementAssignmentAdapter
    • Organization
    • Organization.StatusEnum
    • OrganizationLinks
    • Organizations
    • Package
    • PackageClause
    • PagerDutyNotificationEndpoint
    • PagerDutyNotificationRule
    • PagerDutyNotificationRuleBase
    • PagerDutyNotificationRuleBase.TypeEnum
    • ParenExpression
    • ParenExpression.ParenExpressionExpressionAdapter
    • PasswordResetBody
    • PatchBucketRequest
    • PatchDashboardRequest
    • PatchOrganizationRequest
    • PatchRetentionRule
    • PatchRetentionRule.TypeEnum
    • PatchStackRequest
    • PatchStackRequestAdditionalResources
    • Permission
    • Permission.ActionEnum
    • PermissionResource
    • PipeExpression
    • PipeExpression.PipeExpressionArgumentAdapter
    • PipeLiteral
    • PostBucketRequest
    • PostOrganizationRequest
    • PostRestoreKVResponse
    • PostStackRequest
    • PostUser
    • PostUser.StatusEnum
    • Property
    • Property.PropertyKeyAdapter
    • Property.PropertyValueAdapter
    • PropertyKey
    • Query
    • Query.TypeEnum
    • QueryEditMode
    • QueryVariableProperties
    • QueryVariableProperties.TypeEnum
    • QueryVariablePropertiesValues
    • RangeThreshold
    • RangeThreshold.TypeEnum
    • Ready
    • Ready.StatusEnum
    • RegexpLiteral
    • RemoteConnection
    • RemoteConnectionCreationRequest
    • RemoteConnections
    • RemoteConnectionUpdateRequest
    • RenamableField
    • Replication
    • ReplicationCreationRequest
    • Replications
    • ReplicationUpdateRequest
    • ResourceMember
    • ResourceMember.RoleEnum
    • ResourceMembers
    • ResourceOwner
    • ResourceOwner.RoleEnum
    • ResourceOwners
    • RestoredBucketMappings
    • RetentionPolicyManifest
    • ReturnStatement
    • ReturnStatement.ReturnStatementArgumentAdapter
    • Routes
    • RoutesExternal
    • RoutesQuery
    • RoutesSystem
    • RuleStatusLevel
    • Run
    • Run.StatusEnum
    • RunLinks
    • RunManually
    • Runs
    • ScatterViewProperties
    • ScatterViewProperties.ShapeEnum
    • ScatterViewProperties.TypeEnum
    • SchemaType
    • ScraperTargetRequest
    • ScraperTargetRequest.TypeEnum
    • ScraperTargetResponse
    • ScraperTargetResponseLinks
    • ScraperTargetResponses
    • Script
    • ScriptCreateRequest
    • ScriptInvocationParams
    • ScriptLanguage
    • Scripts
    • ScriptUpdateRequest
    • SecretKeys
    • SecretKeysResponse
    • SecretKeysResponseLinks
    • ShardGroupManifest
    • ShardManifest
    • ShardOwner
    • SimpleTableViewProperties
    • SimpleTableViewProperties.ShapeEnum
    • SimpleTableViewProperties.TypeEnum
    • SingleStatViewProperties
    • SingleStatViewProperties.ShapeEnum
    • SingleStatViewProperties.TypeEnum
    • SlackNotificationEndpoint
    • SlackNotificationRule
    • SlackNotificationRuleBase
    • SlackNotificationRuleBase.TypeEnum
    • SMTPNotificationRule
    • SMTPNotificationRuleBase
    • SMTPNotificationRuleBase.TypeEnum
    • Source
    • Source.LanguagesEnum
    • Source.TypeEnum
    • SourceLinks
    • Sources
    • Stack
    • StackAssociations
    • StackEvents
    • StackLinks
    • StackResources
    • Statement
    • StaticLegend
    • StatusRule
    • StringLiteral
    • SubscriptionManifest
    • TableViewProperties
    • TableViewProperties.ShapeEnum
    • TableViewProperties.TypeEnum
    • TableViewPropertiesTableOptions
    • TableViewPropertiesTableOptions.WrappingEnum
    • TagRule
    • TagRule.OperatorEnum
    • TaskCreateRequest
    • TaskLinks
    • Tasks
    • TaskStatusType
    • TaskType
    • TaskType.LastRunStatusEnum
    • TaskUpdateRequest
    • Telegraf
    • TelegrafLinks
    • TelegrafPlugin
    • TelegrafPlugin.TypeEnum
    • TelegrafPluginRequest
    • TelegrafPluginRequestPlugins
    • TelegrafPlugins
    • TelegrafRequest
    • TelegrafRequestMetadata
    • Telegrafs
    • TelegramNotificationEndpoint
    • TelegramNotificationRule
    • TelegramNotificationRuleBase
    • TelegramNotificationRuleBase.ParseModeEnum
    • TelegramNotificationRuleBase.TypeEnum
    • TemplateApply
    • TemplateApplyRemotes
    • TemplateApplyTemplate
    • TemplateChart
    • TemplateChart.TemplateChartPropertiesAdapter
    • TemplateExportByID
    • TemplateExportByIDOrgIDs
    • TemplateExportByIDResourceFilters
    • TemplateExportByIDResources
    • TemplateKind
    • TemplateSummary
    • TemplateSummaryDiff
    • TemplateSummaryDiffBuckets
    • TemplateSummaryDiffBucketsNewOld
    • TemplateSummaryDiffChecks
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksNewAdapter
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksOldAdapter
    • TemplateSummaryDiffDashboards
    • TemplateSummaryDiffDashboardsNewOld
    • TemplateSummaryDiffLabelMappings
    • TemplateSummaryDiffLabels
    • TemplateSummaryDiffLabelsNewOld
    • TemplateSummaryDiffNotificationEndpoints
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsNewAdapter
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsOldAdapter
    • TemplateSummaryDiffNotificationRules
    • TemplateSummaryDiffNotificationRulesNewOld
    • TemplateSummaryDiffTasks
    • TemplateSummaryDiffTasksNewOld
    • TemplateSummaryDiffTelegrafConfigs
    • TemplateSummaryDiffVariables
    • TemplateSummaryDiffVariablesNewOld
    • TemplateSummaryDiffVariablesNewOld.TemplateSummary_Diff_variables_new_oldArgsAdapter
    • TemplateSummaryErrors
    • TemplateSummaryLabel
    • TemplateSummaryLabelProperties
    • TemplateSummarySummary
    • TemplateSummarySummaryBuckets
    • TemplateSummarySummaryDashboards
    • TemplateSummarySummaryLabelMappings
    • TemplateSummarySummaryNotificationRules
    • TemplateSummarySummaryStatusRules
    • TemplateSummarySummaryTagRules
    • TemplateSummarySummaryTasks
    • TemplateSummarySummaryVariables
    • TemplateSummarySummaryVariables.TemplateSummary_summary_variablesArgumentsAdapter
    • TestStatement
    • Threshold
    • ThresholdBase
    • ThresholdCheck
    • ThresholdCheck.TypeEnum
    • ThresholdCheckTags
    • UnaryExpression
    • UnaryExpression.UnaryExpressionArgumentAdapter
    • UnsignedIntegerLiteral
    • User
    • User.StatusEnum
    • UserLinks
    • Users
    • UsersLinks
    • Variable
    • Variable.VariableArgumentsAdapter
    • VariableAssignment
    • VariableAssignment.VariableAssignmentInitAdapter
    • VariableLinks
    • VariableProperties
    • Variables
    • View
    • View.ViewPropertiesAdapter
    • ViewLinks
    • ViewProperties
    • Views
    • WritePrecision
    • XYGeom
    • XYViewProperties
    • XYViewProperties.HoverDimensionEnum
    • XYViewProperties.PositionEnum
    • XYViewProperties.ShapeEnum
    • XYViewProperties.TypeEnum
  • InfluxDB.Client.Api.Service
    • AuthorizationsService
    • BackupService
    • BucketsService
    • CellsService
    • ChecksService
    • ConfigService
    • DashboardsService
    • DBRPsService
    • DeleteService
    • HealthService
    • IAuthorizationsService
    • IBackupService
    • IBucketsService
    • ICellsService
    • IChecksService
    • IConfigService
    • IDashboardsService
    • IDBRPsService
    • IDeleteService
    • IHealthService
    • IInvokableScriptsService
    • ILabelsService
    • ILegacyAuthorizationsService
    • IMetricsService
    • INotificationEndpointsService
    • INotificationRulesService
    • InvokableScriptsService
    • IOrganizationsService
    • IPingService
    • IQueryService
    • IReadyService
    • IRemoteConnectionsService
    • IReplicationsService
    • IResourcesService
    • IRestoreService
    • IRoutesService
    • IRulesService
    • IScraperTargetsService
    • ISecretsService
    • ISetupService
    • ISigninService
    • ISignoutService
    • ISourcesService
    • ITasksService
    • ITelegrafPluginsService
    • ITelegrafsService
    • ITemplatesService
    • IUsersService
    • IVariablesService
    • IViewsService
    • IWriteService
    • LabelsService
    • LegacyAuthorizationsService
    • MetricsService
    • NotificationEndpointsService
    • NotificationRulesService
    • OrganizationsService
    • PingService
    • QueryService
    • ReadyService
    • RemoteConnectionsService
    • ReplicationsService
    • ResourcesService
    • RestoreService
    • RoutesService
    • RulesService
    • ScraperTargetsService
    • SecretsService
    • SetupService
    • SigninService
    • SignoutService
    • SourcesService
    • TasksService
    • TelegrafPluginsService
    • TelegrafsService
    • TemplatesService
    • UsersService
    • VariablesService
    • ViewsService
    • WriteService
  • InfluxDB.Client.Core
    • Arguments
    • Column
    • LogLevel
    • Measurement
  • InfluxDB.Client.Core.Exceptions
    • BadGatewayException
    • BadRequestException
    • ForbiddenException
    • HttpException
    • HttpNotImplementedException
    • InfluxException
    • InternalServerErrorException
    • MethodNotAllowedException
    • NotAcceptableException
    • NotFoundException
    • PaymentRequiredException
    • ProxyAuthenticationRequiredException
    • RequestEntityTooLargeException
    • RequestTimeoutException
    • ServiceUnavailableException
    • TooManyRequestsException
    • UnauthorizedException
    • UnprocessableEntityException
  • InfluxDB.Client.Core.Flux.Domain
    • FluxColumn
    • FluxRecord
    • FluxTable
  • InfluxDB.Client.Core.Flux.Exceptions
    • FluxCsvParserException
    • FluxQueryException
  • InfluxDB.Client.Core.Flux.Serialization
    • AnnotatedCsvParser
    • IAnnotatedCsvParser
  • InfluxDB.Client.Domain
    • FindOptions
  • InfluxDB.Client.Flux
    • FluxClient
    • FluxClientFactory
    • FluxConnectionOptions
    • FluxConnectionOptions.AuthenticationType
    • IFluxClient
  • InfluxDB.Client.Linq
    • DefaultMemberNameResolver
    • IMemberNameResolver
    • InfluxDBQueryable<T>
    • MemberType
    • QueryableExtensions
    • QueryableOptimizerSettings
  • InfluxDB.Client.Writes
    • AbstractWriteEvent
    • InfluxDBEventArgs
    • PointData
    • PointData.Builder
    • PointSettings
    • WriteErrorEvent
    • WriteRetriableErrorEvent
    • WriteRuntimeExceptionEvent
    • WriteSuccessEvent

Interface ITelegrafsApi

Namespace: InfluxDB.Client
Assembly: InfluxDB.Client.dll
Syntax
public interface ITelegrafsApi

Methods

AddLabelAsync(Label, Telegraf, CancellationToken)

Add a label to a telegraf config.

Declaration
Task<Label> AddLabelAsync(Label label, Telegraf telegraf, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Label label

label to add

Telegraf telegraf

the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Label>

added label

AddLabelAsync(String, String, CancellationToken)

Add a label to a telegraf config.

Declaration
Task<Label> AddLabelAsync(string labelId, string telegrafId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String labelId

ID of label to add

System.String telegrafId

ID of the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Label>

added label

AddMemberAsync(User, Telegraf, CancellationToken)

Add telegraf config member.

Declaration
Task<ResourceMember> AddMemberAsync(User member, Telegraf telegraf, CancellationToken cancellationToken = null)
Parameters
Type Name Description
User member

user to add as member

Telegraf telegraf

the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<ResourceMember>

member added to telegraf

AddMemberAsync(String, String, CancellationToken)

Add telegraf config member.

Declaration
Task<ResourceMember> AddMemberAsync(string memberId, string telegrafId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String memberId

user ID to add as member

System.String telegrafId

ID of the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<ResourceMember>

member added to telegraf

AddOwnerAsync(User, Telegraf, CancellationToken)

Add telegraf config owner.

Declaration
Task<ResourceOwner> AddOwnerAsync(User owner, Telegraf telegraf, CancellationToken cancellationToken = null)
Parameters
Type Name Description
User owner

user to add as owner

Telegraf telegraf

the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<ResourceOwner>

telegraf config owner added

AddOwnerAsync(String, String, CancellationToken)

Add telegraf config owner.

Declaration
Task<ResourceOwner> AddOwnerAsync(string ownerId, string telegrafId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String ownerId

ID of user to add as owner

System.String telegrafId

ID of the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<ResourceOwner>

telegraf config owner added

CloneTelegrafAsync(String, Telegraf, CancellationToken)

Clone a telegraf config.

Declaration
Task<Telegraf> CloneTelegrafAsync(string clonedName, Telegraf telegraf, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String clonedName

name of cloned telegraf config

Telegraf telegraf

telegraf config to clone>

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Telegraf>

cloned telegraf config

CloneTelegrafAsync(String, String, CancellationToken)

Clone a telegraf config.

Declaration
Task<Telegraf> CloneTelegrafAsync(string clonedName, string telegrafId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String clonedName

name of cloned telegraf config

System.String telegrafId

ID of telegraf config to clone

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Telegraf>

cloned telegraf config

CreateAgentConfiguration()

Created default Telegraf Agent configuration. [agent] interval = "10s" round_interval = true metric_batch_size = 1000 metric_buffer_limit = 10000 collection_jitter = "0s" flush_jitter = "0s" precision = "" omit_hostname = false

Declaration
Dictionary<string, object> CreateAgentConfiguration()
Returns
Type Description
Dictionary<System.String, System.Object>

default configuration

CreateTelegrafAsync(TelegrafPluginRequest, CancellationToken)

Create a telegraf config.

Declaration
Task<Telegraf> CreateTelegrafAsync(TelegrafPluginRequest telegrafRequest, CancellationToken cancellationToken = null)
Parameters
Type Name Description
TelegrafPluginRequest telegrafRequest

Telegraf Configuration to create

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Telegraf>

Telegraf config created

CreateTelegrafAsync(String, String, Organization, Dictionary<String, Object>, List<TelegrafPlugin>, CancellationToken)

Create a telegraf config.

Declaration
Task<Telegraf> CreateTelegrafAsync(string name, string description, Organization org, Dictionary<string, object> agentConfiguration, List<TelegrafPlugin> plugins, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String name

Telegraf Configuration Name

System.String description

Telegraf Configuration Description

Organization org

The organization that owns this config

Dictionary<System.String, System.Object> agentConfiguration

The telegraf agent config

List<TelegrafPlugin> plugins

The telegraf plugins config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Telegraf>

Telegraf config created

CreateTelegrafAsync(String, String, Organization, List<TelegrafPlugin>, CancellationToken)

Create a telegraf config.

Declaration
Task<Telegraf> CreateTelegrafAsync(string name, string description, Organization org, List<TelegrafPlugin> plugins, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String name

Telegraf Configuration Name

System.String description

Telegraf Configuration Description

Organization org

The organization that owns this config

List<TelegrafPlugin> plugins

The telegraf plugins config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Telegraf>

Telegraf config created

CreateTelegrafAsync(String, String, Organization, String, TelegrafRequestMetadata, List<TelegrafPluginRequestPlugins>, CancellationToken)

Create a telegraf config.

Declaration
Task<Telegraf> CreateTelegrafAsync(string name, string description, Organization org, string config, TelegrafRequestMetadata metadata, List<TelegrafPluginRequestPlugins> plugins = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String name

Telegraf Configuration Name

System.String description

Telegraf Configuration Description

Organization org

The organization that owns this config

System.String config

ConfigTOML contains the raw toml config

TelegrafRequestMetadata metadata

Metadata for the config

List<TelegrafPluginRequestPlugins> plugins

Plugins to use.

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Telegraf>

Telegraf config created

CreateTelegrafAsync(String, String, String, Dictionary<String, Object>, List<TelegrafPlugin>, CancellationToken)

Create a telegraf config.

Declaration
Task<Telegraf> CreateTelegrafAsync(string name, string description, string orgId, Dictionary<string, object> agentConfiguration, List<TelegrafPlugin> plugins, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String name

Telegraf Configuration Name

System.String description

Telegraf Configuration Description

System.String orgId

The organization that owns this config

Dictionary<System.String, System.Object> agentConfiguration

The telegraf agent config

List<TelegrafPlugin> plugins

The telegraf plugins config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Telegraf>

Telegraf config created

CreateTelegrafAsync(String, String, String, List<TelegrafPlugin>, CancellationToken)

Create a telegraf config.

Declaration
Task<Telegraf> CreateTelegrafAsync(string name, string description, string orgId, List<TelegrafPlugin> plugins, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String name

Telegraf Configuration Name

System.String description

Telegraf Configuration Description

System.String orgId

The organization that owns this config

List<TelegrafPlugin> plugins

The telegraf plugins config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Telegraf>

Telegraf config created

CreateTelegrafAsync(String, String, String, String, TelegrafRequestMetadata, List<TelegrafPluginRequestPlugins>, CancellationToken)

Create a telegraf config.

Declaration
Task<Telegraf> CreateTelegrafAsync(string name, string description, string orgId, string config, TelegrafRequestMetadata metadata, List<TelegrafPluginRequestPlugins> plugins = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String name

Telegraf Configuration Name

System.String description

Telegraf Configuration Description

System.String orgId

The organization that owns this config

System.String config

ConfigTOML contains the raw toml config

TelegrafRequestMetadata metadata

Metadata for the config

List<TelegrafPluginRequestPlugins> plugins

Plugins to use.

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Telegraf>

Telegraf config created

DeleteLabelAsync(Label, Telegraf, CancellationToken)

Delete a label from a telegraf config.

Declaration
Task DeleteLabelAsync(Label label, Telegraf telegraf, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Label label

label to delete

Telegraf telegraf

the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task

delete has been accepted

DeleteLabelAsync(String, String, CancellationToken)

Delete a label from a telegraf config.

Declaration
Task DeleteLabelAsync(string labelId, string telegrafId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String labelId

ID of label to delete

System.String telegrafId

ID of the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task

delete has been accepted

DeleteMemberAsync(User, Telegraf, CancellationToken)

Removes a member from a telegraf config.

Declaration
Task DeleteMemberAsync(User member, Telegraf telegraf, CancellationToken cancellationToken = null)
Parameters
Type Name Description
User member

member to remove

Telegraf telegraf

the telegraf

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task

member removed

DeleteMemberAsync(String, String, CancellationToken)

Removes a member from a telegraf config.

Declaration
Task DeleteMemberAsync(string memberId, string telegrafId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String memberId

ID of member to remove

System.String telegrafId

ID of the telegraf

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task

member removed

DeleteOwnerAsync(User, Telegraf, CancellationToken)

Removes an owner from a telegraf config.

Declaration
Task DeleteOwnerAsync(User owner, Telegraf telegraf, CancellationToken cancellationToken = null)
Parameters
Type Name Description
User owner

owner to remove

Telegraf telegraf

the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task

owner removed

DeleteOwnerAsync(String, String, CancellationToken)

Removes an owner from a telegraf config.

Declaration
Task DeleteOwnerAsync(string ownerId, string telegrafId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String ownerId

ID of owner to remove

System.String telegrafId

ID of the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task

owner removed

DeleteTelegrafAsync(Telegraf, CancellationToken)

Delete a telegraf config.

Declaration
Task DeleteTelegrafAsync(Telegraf telegraf, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Telegraf telegraf

telegraf config to delete

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task

delete has been accepted

DeleteTelegrafAsync(String, CancellationToken)

Delete a telegraf config.

Declaration
Task DeleteTelegrafAsync(string telegrafId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafId

ID of telegraf config to delete

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task

delete has been accepted

FindTelegrafByIdAsync(String, CancellationToken)

Retrieve a telegraf config.

Declaration
Task<Telegraf> FindTelegrafByIdAsync(string telegrafId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafId

ID of telegraf config to get

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Telegraf>

telegraf config details

FindTelegrafsAsync(CancellationToken)

Returns a list of telegraf configs.

Declaration
Task<List<Telegraf>> FindTelegrafsAsync(CancellationToken cancellationToken = null)
Parameters
Type Name Description
CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<List<Telegraf>>

A list of telegraf configs

FindTelegrafsByOrgAsync(Organization, CancellationToken)

Returns a list of telegraf configs for specified organization.

Declaration
Task<List<Telegraf>> FindTelegrafsByOrgAsync(Organization organization, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Organization organization

specifies the organization of the telegraf configs

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<List<Telegraf>>

A list of telegraf configs

FindTelegrafsByOrgIdAsync(String, CancellationToken)

Returns a list of telegraf configs for specified organization.

Declaration
Task<List<Telegraf>> FindTelegrafsByOrgIdAsync(string orgId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String orgId

specifies the organization of the telegraf configs

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<List<Telegraf>>

A list of telegraf configs

GetLabelsAsync(Telegraf, CancellationToken)

List all labels for a telegraf config.

Declaration
Task<List<Label>> GetLabelsAsync(Telegraf telegraf, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Telegraf telegraf

the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<List<Label>>

a list of all labels for a telegraf config

GetLabelsAsync(String, CancellationToken)

List all labels for a telegraf config.

Declaration
Task<List<Label>> GetLabelsAsync(string telegrafId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafId

ID of the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<List<Label>>

a list of all labels for a telegraf config

GetMembersAsync(Telegraf, CancellationToken)

List all users with member privileges for a telegraf config.

Declaration
Task<List<ResourceMember>> GetMembersAsync(Telegraf telegraf, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Telegraf telegraf

the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<List<ResourceMember>>

a list of telegraf config members

GetMembersAsync(String, CancellationToken)

List all users with member privileges for a telegraf config.

Declaration
Task<List<ResourceMember>> GetMembersAsync(string telegrafId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafId

ID of the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<List<ResourceMember>>

a list of telegraf config members

GetOwnersAsync(Telegraf, CancellationToken)

List all owners of a telegraf config.

Declaration
Task<List<ResourceOwner>> GetOwnersAsync(Telegraf telegraf, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Telegraf telegraf

the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<List<ResourceOwner>>

a list of telegraf config owners

GetOwnersAsync(String, CancellationToken)

List all owners of a telegraf config.

Declaration
Task<List<ResourceOwner>> GetOwnersAsync(string telegrafId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafId

ID of the telegraf config

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<List<ResourceOwner>>

a list of telegraf config owners

GetTOMLAsync(Telegraf, CancellationToken)

Retrieve a telegraf config in TOML.

Declaration
Task<string> GetTOMLAsync(Telegraf telegraf, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Telegraf telegraf

telegraf config to get

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<System.String>

telegraf config details in TOML format

GetTOMLAsync(String, CancellationToken)

Retrieve a telegraf config in TOML.

Declaration
Task<string> GetTOMLAsync(string telegrafId, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafId

ID of telegraf config to get

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<System.String>

telegraf config details in TOML format

UpdateTelegrafAsync(Telegraf, CancellationToken)

Update a telegraf config.

Declaration
Task<Telegraf> UpdateTelegrafAsync(Telegraf telegraf, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Telegraf telegraf

telegraf config update to apply

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Telegraf>

An updated telegraf

UpdateTelegrafAsync(String, TelegrafPluginRequest, CancellationToken)

Update a telegraf config.

Declaration
Task<Telegraf> UpdateTelegrafAsync(string telegrafId, TelegrafPluginRequest telegrafRequest, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String telegrafId

ID of telegraf config

TelegrafPluginRequest telegrafRequest

telegraf config update to apply

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
Task<Telegraf>

An updated telegraf

In This Article
Back to top Generated by DocFX