GET Stream Group

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

GET Stream Group

Request

Path Parameters

workspaceId uuidrequired
streamGroupName stringrequired

Responses

200

Stream group.

application/json

Schema

Schema

name stringrequired
workspaceId uuidrequired
ingressVersion int32required

Possible values: [V1, V2]

version int64required

properties

object

required

storage

object

required

isWorkspaceStorage booleanrequired

custom

object

blobServiceUri urirequired

storageAccountName stringrequired

defaultStream

object

required

isEnabled booleanrequired

streamName stringnullable
streams string[]required

Example (from schema)

{
  "name": "string",
  "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ingressVersion": "V1",
  "version": 0,
  "properties": {
    "storage": {
      "isWorkspaceStorage": true,
      "custom": {
        "blobServiceUri": "string",
        "storageAccountName": "string"
      }
    },
    "defaultStream": {
      "isEnabled": true,
      "streamName": "string"
    }
  },
  "streams": [
    "string"
  ]
}

404

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...