GET Stream

GET 
/workspaces/:workspaceId/stream-groups/:streamGroupName/streams/:streamName

GET Stream

Request

Path Parameters

workspaceId uuidrequired
streamGroupName stringrequired
streamName stringrequired

Responses

200

Stream.

application/json

Schema

Schema

name stringrequired
streamGroupName stringrequired
workspaceId uuidrequired

properties

object

required

concatenationMode int32required

Possible values: [None, WithNewLines, WithoutNewLines]

batchCompletionTimeout

object

required

isEnabled booleanrequired

timeout [d.]hh:mm:ss[.fffffff]nullable

batchIdAutoFillPattern

object

required

isEnabled booleanrequired

pattern stringnullable

messageIdAutoFillPattern

object

required

isEnabled booleanrequired

pattern stringnullable

gatewayConfig

object

isEnabled boolean

iotHubAccessPath int32

Possible values: [Auto, File, Telemetry]

priority int32

messageCompression int32

Possible values: [None, BrotliFastest]

bufferMaximalSize

object

isEnabled boolean

sizeInMebiBytes int32nullable

messageTtl

object

isEnabled boolean

duration [d.]hh:mm:ss[.fffffff]nullable

isDurable boolean

dedicatedDeviceStreamBuffer

object

isEnabled boolean

maxSizeInMebiBytes int32nullable

partitioning

object

required

partitionCount int32

isReadyToAcceptMessages boolean
egressRoutes string[]

Example (from schema)

{
  "name": "string",
  "streamGroupName": "string",
  "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "properties": {
    "concatenationMode": "None",
    "batchCompletionTimeout": {
      "isEnabled": true,
      "timeout": "1.12:34:00"
    },
    "batchIdAutoFillPattern": {
      "isEnabled": true,
      "pattern": "string"
    },
    "messageIdAutoFillPattern": {
      "isEnabled": true,
      "pattern": "string"
    },
    "gatewayConfig": {
      "isEnabled": true,
      "iotHubAccessPath": "Auto",
      "priority": 0,
      "messageCompression": "None",
      "bufferMaximalSize": {
        "isEnabled": true,
        "sizeInMebiBytes": 0
      },
      "messageTtl": {
        "isEnabled": true,
        "duration": "1.12:34:00"
      },
      "isDurable": true,
      "dedicatedDeviceStreamBuffer": {
        "isEnabled": true,
        "maxSizeInMebiBytes": 0
      }
    }
  },
  "partitioning": {
    "partitionCount": 0,
    "isReadyToAcceptMessages": true
  },
  "egressRoutes": [
    "string"
  ]
}

404

Stream, stream group or workspace not found.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

423

Workspace is disabled.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...