Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/schema-registry

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

GeneratedResponse

GeneratedResponse: GeneratedSchemaResponse | GeneratedSchemaIdResponse

Union of all generated client's responses.

GeneratedSchemaIdResponse

GeneratedSchemaIdResponse: SchemaRegisterResponse | SchemaQueryIdByContentResponse

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 & { body: string }

Contains response data for the getById operation.

SchemaQueryIdByContentResponse

SchemaQueryIdByContentResponse: SchemaQueryIdByContentHeaders & SchemaId

Contains response data for the queryIdByContent operation.

SchemaRegisterResponse

SchemaRegisterResponse: SchemaRegisterHeaders & SchemaId

Contains response data for the register operation.

SerializationType

SerializationType: string

Defines values for SerializationType.
KnownSerializationType can be used interchangeably with SerializationType, this enum contains the known values that the service supports.

Known values supported by the service

avro: Avro Serialization schema type

Variables

Const DEFAULT_SCOPE

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

Const logger

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

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

Const serializer

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

Functions

convertResponse

getRawResponse

  • getRawResponse<TOptions, TResult>(f: (options: TOptions) => Promise<TResult>, options: TOptions): Promise<ReturnType<TResult>>

  • Type parameters

    • TOptions: OperationOptions

    • TResult

    Parameters

    • f: (options: TOptions) => Promise<TResult>
        • (options: TOptions): Promise<TResult>

        • Parameters

          • options: TOptions

          Returns Promise<TResult>

    • options: TOptions

    Returns Promise<ReturnType<TResult>>

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"

schemaId

schemaId: object

serializedName

serializedName: string = "schema-id"

type

type: object

name

name: string = "String"

schemaIdLocation

schemaIdLocation: object

serializedName

serializedName: string = "schema-id-location"

type

type: object

name

name: string = "String"

schemaVersion

schemaVersion: object

serializedName

serializedName: string = "schema-version"

type

type: object

name

name: string = "Number"

serializationType

serializationType: object

serializedName

serializedName: string = "serialization-type"

type

type: object

name

name: string = "String"

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"

schemaId

schemaId: object

serializedName

serializedName: string = "schema-id"

type

type: object

name

name: string = "String"

schemaIdLocation

schemaIdLocation: object

serializedName

serializedName: string = "schema-id-location"

type

type: object

name

name: string = "String"

schemaVersion

schemaVersion: object

serializedName

serializedName: string = "schema-version"

type

type: object

name

name: string = "Number"

serializationType

serializationType: object

serializedName

serializedName: string = "serialization-type"

type

type: object

name

name: string = "String"

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"

schemaId

schemaId: object

serializedName

serializedName: string = "schema-id"

type

type: object

name

name: string = "String"

schemaIdLocation

schemaIdLocation: object

serializedName

serializedName: string = "schema-id-location"

type

type: object

name

name: string = "String"

schemaVersion

schemaVersion: object

serializedName

serializedName: string = "schema-version"

type

type: object

name

name: string = "Number"

serializationType

serializationType: object

serializedName

serializedName: string = "serialization-type"

type

type: object

name

name: string = "String"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "text/plain; charset=utf-8"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const accept1

accept1: 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 = "2020-09-01-preview"

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 = "text/plain; charset=utf-8"

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

headerParameters

headerParameters: Object = [Parameters.accept]

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.accept1,Parameters.serializationType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "text"

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.accept1,Parameters.serializationType]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "text"

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 serializationType

serializationType: object

parameterPath

parameterPath: string = "serializationType"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "Serialization-Type"

type

type: object

name

name: string = "String"

Generated using TypeDoc