Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/monitor-ingestion

Package version

Index

Type aliases

UploadResult

UploadResult: { errors: Array<UploadLogsError>; uploadStatus: "Failure" | "PartialFailure" } | { uploadStatus: "Success" }

Result type for upload operation

UploadStatus

UploadStatus: "Failure" | "PartialFailure" | "Success"

Type representing whether all or few logs succeeded uploading

Variables

Const DEFAULT_MAX_CONCURRENCY

DEFAULT_MAX_CONCURRENCY: 1 = 1

Const defaultIngestionScope

defaultIngestionScope: "https://monitor.azure.com//.default" = "https://monitor.azure.com//.default"

Const gZippingPolicyName

gZippingPolicyName: "GzippingPolicy" = "GzippingPolicy"

Name of the {@link gZippingPolicy} Name of the {@link gZippingPolicy}

Const gzip

gzip: any = promisify(zlib.gzip)

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Functions

concurrentRun

  • concurrentRun<T>(maxConcurrency: number, inputData: Array<T>, callback: (args: T) => Promise<void>): Promise<void>
  • Type parameters

    • T

    Parameters

    • maxConcurrency: number
    • inputData: Array<T>
    • callback: (args: T) => Promise<void>
        • (args: T): Promise<void>
        • Parameters

          • args: T

          Returns Promise<void>

    Returns Promise<void>

getBinarySize

  • getBinarySize(text: string | ArrayBuffer | NodeJS.ArrayBufferView | SharedArrayBuffer): number
  • Parameters

    • text: string | ArrayBuffer | NodeJS.ArrayBufferView | SharedArrayBuffer

    Returns number

gzipping

  • gzipping(body: any): Promise<Buffer>

Object literals

Const ErrorAdditionalInfo

ErrorAdditionalInfo: object

type

type: object

className

className: string = "ErrorAdditionalInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

info

info: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "info"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "any"

type

type: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const ErrorDetail

ErrorDetail: object

type

type: object

className

className: string = "ErrorDetail"

name

name: string = "Composite"

modelProperties

modelProperties: object

additionalInfo

additionalInfo: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "additionalInfo"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorAdditionalInfo"

name

name: string = "Composite"

code

code: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorDetail"

name

name: string = "Composite"

message

message: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const ErrorResponse

ErrorResponse: object

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorDetail"

name

name: string = "Composite"

Const GZippingPolicy

GZippingPolicy: object

name

name: string = gZippingPolicyName

sendRequest

  • sendRequest(req: any, next: any): unknown
  • sendRequest(req: any, next: any): unknown

Const GeneratedMonitorIngestionClientUploadExceptionHeaders

GeneratedMonitorIngestionClientUploadExceptionHeaders: object

type

type: object

className

className: string = "GeneratedMonitorIngestionClientUploadExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

xMsErrorCode

xMsErrorCode: object

serializedName

serializedName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2021-11-01-preview"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const body

body: object

parameterPath

parameterPath: string = "body"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "body"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "any"

Const contentEncoding

contentEncoding: object

parameterPath

parameterPath: Object = ["options", "contentEncoding"]

mapper

mapper: object

serializedName

serializedName: string = "Content-Encoding"

type

type: object

name

name: string = "String"

Const contentType

contentType: object

parameterPath

parameterPath: Object = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const ruleId

ruleId: object

parameterPath

parameterPath: string = "ruleId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "ruleId"

type

type: object

name

name: string = "String"

Const stream

stream: object

parameterPath

parameterPath: string = "stream"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "stream"

type

type: object

name

name: string = "String"

Const uploadOperationSpec

uploadOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType,Parameters.accept,Parameters.contentEncoding,Parameters.xMsClientRequestId]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/dataCollectionRules/{ruleId}/streams/{stream}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.body

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.ruleId, Parameters.stream]

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

headersMapper

headersMapper: any = Mappers.GeneratedMonitorIngestionClientUploadExceptionHeaders

Const xMsClientRequestId

xMsClientRequestId: object

parameterPath

parameterPath: Object = ["options", "xMsClientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-client-request-id"

type

type: object

name

name: string = "String"

Generated using TypeDoc