Share via

FactoriesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataFactoryManagementClient's

<xref:factories> attribute.

Inheritance
builtins.object
FactoriesOperations

Constructor

FactoriesOperations(*args, **kwargs)

Methods

configure_factory_repo

Updates a factory's repo information.
create_or_update

Creates or updates a factory.
delete

Deletes a factory.
get

Gets a factory.
get_data_plane_access

Get Data Plane access.
get_git_hub_access_token

Get GitHub Access Token.
list

Lists factories under the specified subscription.
list_by_resource_group

Lists factories.
update

Updates a factory.

configure_factory_repo

Updates a factory's repo information.

configure_factory_repo(location_id: str, factory_repo_update: _models.FactoryRepoUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Factory

Parameters

Name Description
location_id
Required
str

The location identifier. Required.
factory_repo_update
Required
FactoryRepoUpdate or IO[bytes]

Update factory repo request definition. Is either a FactoryRepoUpdate type or a IO[bytes] type. Required.

Returns

Type Description
Factory

Factory or the result of cls(response)

Exceptions

Type Description
HttpResponseError

create_or_update

Creates or updates a factory.

create_or_update(resource_group_name: str, factory_name: str, factory: _models.Factory, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Factory

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
factory
Required
Factory or IO[bytes]

Factory resource definition. Is either a Factory type or a IO[bytes] type. Required.
if_match
Required
str

ETag of the factory entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

Returns

Type Description
Factory

Factory or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Deletes a factory.

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

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets a factory.

get(resource_group_name: str, factory_name: str, if_none_match: str | None = None, **kwargs: Any) -> Factory | None

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
if_none_match
Required
str

ETag of the factory 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.

Returns

Type Description
Factory,
None

Factory or None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_data_plane_access

Get Data Plane access.

get_data_plane_access(resource_group_name: str, factory_name: str, policy: _models.UserAccessPolicy, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AccessPolicyResponse

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
policy
Required
UserAccessPolicy or IO[bytes]

Data Plane user access policy definition. Is either a UserAccessPolicy type or a IO[bytes] type. Required.

Returns

Type Description
AccessPolicyResponse

AccessPolicyResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_git_hub_access_token

Get GitHub Access Token.

get_git_hub_access_token(resource_group_name: str, factory_name: str, git_hub_access_token_request: _models.GitHubAccessTokenRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.GitHubAccessTokenResponse

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
git_hub_access_token_request
Required
GitHubAccessTokenRequest or IO[bytes]

Get GitHub access token request definition. Is either a GitHubAccessTokenRequest type or a IO[bytes] type. Required.

Returns

Type Description
GitHubAccessTokenResponse

GitHubAccessTokenResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Lists factories under the specified subscription.

list(**kwargs: Any) -> Iterable[Factory]

Returns

Type Description
ItemPaged[Factory]

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

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Lists factories.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[Factory]

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.

Returns

Type Description
ItemPaged[Factory]

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

Exceptions

Type Description
HttpResponseError

update

Updates a factory.

update(resource_group_name: str, factory_name: str, factory_update_parameters: _models.FactoryUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Factory

Parameters

Name Description
resource_group_name
Required
str

The resource group name. Required.
factory_name
Required
str

The factory name. Required.
factory_update_parameters
Required
FactoryUpdateParameters or IO[bytes]

The parameters for updating a factory. Is either a FactoryUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
Factory

Factory or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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