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, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ChangeDataCaptureResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name. Required. |
|
factory_name
Required
|
The factory name. Required. |
|
change_data_capture_name
Required
|
The change data capture name. Required. |
|
change_data_capture
Required
|
Change data capture resource definition. Is either a ChangeDataCaptureResource type or a IO[bytes] type. Required. |
|
if_match
|
ETag of the change data capture entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
ChangeDataCaptureResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete
Deletes a change data capture.
delete(resource_group_name: str, factory_name: str, change_data_capture_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name. Required. |
|
factory_name
Required
|
The factory name. Required. |
|
change_data_capture_name
Required
|
The change data capture name. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets a change data capture.
get(resource_group_name: str, factory_name: str, change_data_capture_name: str, if_none_match: str | None = None, **kwargs: Any) -> ChangeDataCaptureResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name. Required. |
|
factory_name
Required
|
The factory name. Required. |
|
change_data_capture_name
Required
|
The change data capture name. Required. |
|
if_none_match
|
ETag of the change data capture entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
ChangeDataCaptureResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_factory
Lists all resources of type change data capture.
list_by_factory(resource_group_name: str, factory_name: str, **kwargs: Any) -> Iterable[ChangeDataCaptureResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name. Required. |
|
factory_name
Required
|
The factory name. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ChangeDataCaptureResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
start
Starts a change data capture.
start(resource_group_name: str, factory_name: str, change_data_capture_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name. Required. |
|
factory_name
Required
|
The factory name. Required. |
|
change_data_capture_name
Required
|
The change data capture name. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> strParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name. Required. |
|
factory_name
Required
|
The factory name. Required. |
|
change_data_capture_name
Required
|
The change data capture name. Required. |
Returns
| Type | Description |
|---|---|
|
str or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
stop
Stops a change data capture.
stop(resource_group_name: str, factory_name: str, change_data_capture_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name. Required. |
|
factory_name
Required
|
The factory name. Required. |
|
change_data_capture_name
Required
|
The change data capture name. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.datafactory.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv110\\Lib\\site-packages\\azure\\mgmt\\datafactory\\models\\__init__.py'>