SchemaRegistryOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventHubManagementClient's

<xref:schema_registry> attribute.

Inheritance
builtins.object
SchemaRegistryOperations

Constructor

SchemaRegistryOperations(*args, **kwargs)

Methods

create_or_update

Creates or Updates an EventHub schema group.
delete

Deletes an EventHub schema group.
get

Gets the details of an EventHub schema group.
list_by_namespace

Gets all the Schema Groups in a Namespace.

create_or_update

Creates or Updates an EventHub schema group.

create_or_update(resource_group_name: str, namespace_name: str, schema_group_name: str, parameters: _models.SchemaGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SchemaGroup

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.
namespace_name
Required
str

The Namespace name. Required.
schema_group_name
Required
str

The Schema Group name. Required.
parameters
Required
SchemaGroup or IO[bytes]

Parameters supplied to create an Event Hub resource. Is either a SchemaGroup type or a IO[bytes] type. Required.

Returns

Type Description
SchemaGroup

SchemaGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Deletes an EventHub schema group.

delete(resource_group_name: str, namespace_name: str, schema_group_name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.
namespace_name
Required
str

The Namespace name. Required.
schema_group_name
Required
str

The Schema Group name. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets the details of an EventHub schema group.

get(resource_group_name: str, namespace_name: str, schema_group_name: str, **kwargs: Any) -> SchemaGroup

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.
namespace_name
Required
str

The Namespace name. Required.
schema_group_name
Required
str

The Schema Group name. Required.

Returns

Type Description
SchemaGroup

SchemaGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_namespace

Gets all the Schema Groups in a Namespace.

list_by_namespace(resource_group_name: str, namespace_name: str, skip: int | None = None, top: int | None = None, **kwargs: Any) -> Iterable[SchemaGroup]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.
namespace_name
Required
str

The Namespace name. Required.
skip
Required
int

Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls. Default value is None.
top
Required
int

May be used to limit the number of results to the most recent N usageDetails. Default value is None.

Returns

Type Description
ItemPaged[SchemaGroup]

An iterator like instance of either SchemaGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.eventhub.v2024_01_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventhub\\v2024_01_01\\models\\__init__.py'>