CREATE OR UPDATE Stream Group

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

CREATE OR UPDATE Stream Group

Request

Path Parameters

workspaceId uuidrequired
streamGroupName stringrequired

Header Parameters

If-None-Match string

To ensure that no existing stream group is updated pass If-None-Match header set to "*".

application/json

Body

properties

object

storage

object

useWorkspaceStorage booleannullable

custom

object

connectionString stringnullable

defaultStream

object

isEnabled booleanrequired

streamName stringnullable

Responses

200

Updated stream group.

application/json

Schema

Schema

name stringrequired
workspaceId uuidrequired

properties

object

required

storage

object

required

isWorkspaceStorage booleanrequired

custom

object

blobServiceUri urirequired

storageAccountName stringrequired

defaultStream

object

required

isEnabled booleanrequired

streamName stringnullable

Example (from schema)

{
  "name": "string",
  "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "properties": {
    "storage": {
      "isWorkspaceStorage": true,
      "custom": {
        "blobServiceUri": "string",
        "storageAccountName": "string"
      }
    },
    "defaultStream": {
      "isEnabled": true,
      "streamName": "string"
    }
  }
}

201

Created stream group

Response Headers

• Location

  string

  Endpoint URL of the created object.

application/json

Schema

Schema

name stringrequired
workspaceId uuidrequired

properties

object

required

storage

object

required

isWorkspaceStorage booleanrequired

custom

object

blobServiceUri urirequired

storageAccountName stringrequired

defaultStream

object

required

isEnabled booleanrequired

streamName stringnullable

Example (from schema)

{
  "name": "string",
  "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "properties": {
    "storage": {
      "isWorkspaceStorage": true,
      "custom": {
        "blobServiceUri": "string",
        "storageAccountName": "string"
      }
    },
    "defaultStream": {
      "isEnabled": true,
      "streamName": "string"
    }
  }
}

404

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