FactoriesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:factories> attribute.

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 FactoryRepoUpdate or IO[bytes] The request body. Is either a FactoryRepoUpdate type or a IO[bytes] type. Required.

Returns

Type	Description
Factory	Factory. The Factory is compatible with MutableMapping

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, *, content_type: str = 'application/json', etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> _models.Factory

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.
factory Required	Factory or Factory or IO[bytes] Factory resource definition. Is either a Factory 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
Factory	Factory. The Factory is compatible with MutableMapping

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 name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

get

Gets a factory.

get(resource_group_name: str, factory_name: str, *, etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> Factory | 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.

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
Factory, None	Factory or None. The Factory is compatible with MutableMapping

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 name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
policy Required	UserAccessPolicy or 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. The AccessPolicyResponse is compatible with MutableMapping

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 name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
git_hub_access_token_request Required	GitHubAccessTokenRequest or 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. The GitHubAccessTokenResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

Lists factories under the specified subscription.

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Lists factories.

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

Parameters

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

Returns

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

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 name of the resource group. The name is case insensitive. Required.
factory_name Required	str The factory name. Required.
factory_update_parameters Required	FactoryUpdateParameters or 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. The Factory is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?