Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/schema-registry

Package version

Index

Type aliases

GeneratedResponse

Union of all generated client's responses.

GeneratedSchemaIdResponse

Union of generated client's responses that return schema ID.

GeneratedSchemaResponse

GeneratedSchemaResponse: SchemaGetByIdResponse

Union of generated client's responses that return schema content.

SchemaGetByIdResponse

SchemaGetByIdResponse: SchemaGetByIdHeaders & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: string; parsedHeaders: SchemaGetByIdHeaders }; body: string }

Contains response data for the getById operation.

SchemaQueryIdByContentResponse

SchemaQueryIdByContentResponse: SchemaQueryIdByContentHeaders & SchemaId & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SchemaId; parsedHeaders: SchemaQueryIdByContentHeaders } }

Contains response data for the queryIdByContent operation.

SchemaRegisterResponse

SchemaRegisterResponse: SchemaRegisterHeaders & SchemaId & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SchemaId; parsedHeaders: SchemaRegisterHeaders } }

Contains response data for the register operation.

SerializationType

SerializationType: "avro"

Defines values for SerializationType.

Variables

Const DEFAULT_SCOPE

DEFAULT_SCOPE: "https://eventhubs.azure.net/.default" = "https://eventhubs.azure.net/.default"

Const LIB_INFO

LIB_INFO: string = `azsdk-js-schema-registry/${SDK_VERSION}`

Const SDK_VERSION

SDK_VERSION: string = "1.0.0-beta.1"

Const logger

logger: any = createClientLogger("schema-registry")

The @azure/logger configuration for the schema-registry package.

Const packageName

packageName: "@azure/schema-registry" = "@azure/schema-registry"

Const packageVersion

packageVersion: "1.0.0-beta.1" = "1.0.0-beta.1"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers, /* isXml */ false)

Functions

convertPipelineOptions

  • convertPipelineOptions(options: PipelineOptions): InternalPipelineOptions
  • Converts PipelineOptions to InternalPipelineOptions. Adds logger and user agent prefix.

    Parameters

    • options: PipelineOptions

    Returns InternalPipelineOptions

convertResponse

convertSchemaIdResponse

convertSchemaResponse

createPipeline

  • createPipeline(options: PipelineOptions, credential: TokenCredential): ServiceClientOptions
  • Builds ServiceClientOptions from PipelineOptions and credentials. Sets up logger and user agent prefix.

    Parameters

    • options: PipelineOptions
    • credential: TokenCredential

    Returns ServiceClientOptions

Object literals

Const SchemaGetByIdHeaders

SchemaGetByIdHeaders: object

type

type: object

className

className: string = "SchemaGetByIdHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

xSchemaId

xSchemaId: object

serializedName

serializedName: string = "x-schema-id"

type

type: object

name

name: string = "String"

xSchemaIdLocation

xSchemaIdLocation: object

serializedName

serializedName: string = "x-schema-id-location"

type

type: object

name

name: string = "String"

xSchemaType

xSchemaType: object

serializedName

serializedName: string = "x-schema-type"

type

type: object

name

name: string = "String"

xSchemaVersion

xSchemaVersion: object

serializedName

serializedName: string = "x-schema-version"

type

type: object

name

name: string = "Number"

Const SchemaId

SchemaId: object

type

type: object

className

className: string = "SchemaId"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const SchemaQueryIdByContentHeaders

SchemaQueryIdByContentHeaders: object

type

type: object

className

className: string = "SchemaQueryIdByContentHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

xSchemaId

xSchemaId: object

serializedName

serializedName: string = "x-schema-id"

type

type: object

name

name: string = "String"

xSchemaIdLocation

xSchemaIdLocation: object

serializedName

serializedName: string = "x-schema-id-location"

type

type: object

name

name: string = "String"

xSchemaType

xSchemaType: object

serializedName

serializedName: string = "x-schema-type"

type

type: object

name

name: string = "String"

xSchemaVersion

xSchemaVersion: object

serializedName

serializedName: string = "x-schema-version"

type

type: object

name

name: string = "Number"

Const SchemaRegisterHeaders

SchemaRegisterHeaders: object

type

type: object

className

className: string = "SchemaRegisterHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

xSchemaId

xSchemaId: object

serializedName

serializedName: string = "x-schema-id"

type

type: object

name

name: string = "String"

xSchemaIdLocation

xSchemaIdLocation: object

serializedName

serializedName: string = "x-schema-id-location"

type

type: object

name

name: string = "String"

xSchemaType

xSchemaType: object

serializedName

serializedName: string = "x-schema-type"

type

type: object

name

name: string = "String"

xSchemaVersion

xSchemaVersion: object

serializedName

serializedName: string = "x-schema-version"

type

type: object

name

name: string = "Number"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2017-04"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

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 getByIdOperationSpec

getByIdOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "/$schemagroups/getSchemaById/{schema-id}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.schemaId]

responses

responses: object

200

200: object

headersMapper

headersMapper: any = Mappers.SchemaGetByIdHeaders

bodyMapper

bodyMapper: object

type

type: object

name

name: string = "String"

default

default: object

bodyMapper

bodyMapper: object

type

type: object

name

name: string = "String"

Const groupName

groupName: object

parameterPath

parameterPath: string = "groupName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "group-name"

type

type: object

name

name: string = "String"

Const queryIdByContentOperationSpec

queryIdByContentOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType, Parameters.xSchemaType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/$schemagroups/{group-name}/schemas/{schema-name}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.schemaContent

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.groupName,Parameters.schemaName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SchemaId

headersMapper

headersMapper: any = Mappers.SchemaQueryIdByContentHeaders

default

default: object

bodyMapper

bodyMapper: object

type

type: object

name

name: string = "String"

Const registerOperationSpec

registerOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType, Parameters.xSchemaType]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/$schemagroups/{group-name}/schemas/{schema-name}"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.schemaContent

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint,Parameters.groupName,Parameters.schemaName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SchemaId

headersMapper

headersMapper: any = Mappers.SchemaRegisterHeaders

default

default: object

bodyMapper

bodyMapper: object

type

type: object

name

name: string = "String"

Const schemaContent

schemaContent: object

parameterPath

parameterPath: string = "schemaContent"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "schemaContent"

type

type: object

name

name: string = "String"

Const schemaId

schemaId: object

parameterPath

parameterPath: string = "schemaId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "schema-id"

type

type: object

name

name: string = "String"

Const schemaName

schemaName: object

parameterPath

parameterPath: string = "schemaName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "schema-name"

type

type: object

name

name: string = "String"

Const xSchemaType

xSchemaType: object

parameterPath

parameterPath: string = "xSchemaType"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "X-Schema-Type"

type

type: object

name

name: string = "String"

Generated using TypeDoc