ChangeDataCaptureOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:change_data_capture> attribute.

Constructor

ChangeDataCaptureOperations(*args, **kwargs)

Methods

create_or_update	Creates or updates a change data capture resource.
delete	Deletes a change data capture.
get	Gets a change data capture.
list_by_factory	Lists all resources of type change data capture.
start	Starts a change data capture.
status	Gets the current status for the change data capture resource.
stop	Stops a change data capture.

create_or_update

Creates or updates a change data capture resource.

create_or_update(resource_group_name: str, factory_name: str, change_data_capture_name: str, change_data_capture: _models.ChangeDataCaptureResource, *, content_type: str = 'application/json', etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> _models.ChangeDataCaptureResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
change_data_capture_name Required	str The change data capture name. Required.
change_data_capture Required	ChangeDataCaptureResource or ChangeDataCaptureResource or IO[bytes] Change data capture resource definition. Is either a ChangeDataCaptureResource type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Default value is None. Default value: None
match_condition	MatchConditions The match condition to use upon the etag. Default value is None. Default value: None

Returns

Type	Description
ChangeDataCaptureResource	ChangeDataCaptureResource. The ChangeDataCaptureResource is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

delete

Deletes a change data capture.

delete(resource_group_name: str, factory_name: str, change_data_capture_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
change_data_capture_name Required	str The change data capture name. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

get

Gets a change data capture.

get(resource_group_name: str, factory_name: str, change_data_capture_name: str, *, etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> ChangeDataCaptureResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
change_data_capture_name Required	str The change data capture name. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Default value is None. Default value: None
match_condition	MatchConditions The match condition to use upon the etag. Default value is None. Default value: None

Returns

Type	Description
ChangeDataCaptureResource	ChangeDataCaptureResource. The ChangeDataCaptureResource is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_by_factory

Lists all resources of type change data capture.

list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) -> ItemPaged[ChangeDataCaptureResource]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.

Returns

Type	Description
ItemPaged[ChangeDataCaptureResource]	An iterator like instance of ChangeDataCaptureResource

Exceptions

Type	Description
HttpResponseError

start

Starts a change data capture.

start(resource_group_name: str, factory_name: str, change_data_capture_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
change_data_capture_name Required	str The change data capture name. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

status

Gets the current status for the change data capture resource.

status(resource_group_name: str, factory_name: str, change_data_capture_name: str, **kwargs: Any) -> str

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
change_data_capture_name Required	str The change data capture name. Required.

Returns

Type	Description
str	str

Exceptions

Type	Description
HttpResponseError

stop

Stops a change data capture.

stop(resource_group_name: str, factory_name: str, change_data_capture_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
change_data_capture_name Required	str The change data capture name. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?