Factories interface

  • Reference
Package:
@azure/arm-datafactory

Interface representing a Factories.

Methods

configureFactoryRepo(string, FactoryRepoUpdate, FactoriesConfigureFactoryRepoOptionalParams)

Updates a factory's repo information.
createOrUpdate(string, string, Factory, FactoriesCreateOrUpdateOptionalParams)

Creates or updates a factory.
delete(string, string, FactoriesDeleteOptionalParams)

Deletes a factory.
get(string, string, FactoriesGetOptionalParams)

Gets a factory.
getDataPlaneAccess(string, string, UserAccessPolicy, FactoriesGetDataPlaneAccessOptionalParams)

Get Data Plane access.
getGitHubAccessToken(string, string, GitHubAccessTokenRequest, FactoriesGetGitHubAccessTokenOptionalParams)

Get GitHub Access Token.
list(FactoriesListOptionalParams)

Lists factories under the specified subscription.
listByResourceGroup(string, FactoriesListByResourceGroupOptionalParams)

Lists factories.
update(string, string, FactoryUpdateParameters, FactoriesUpdateOptionalParams)

Updates a factory.

Method Details

configureFactoryRepo(string, FactoryRepoUpdate, FactoriesConfigureFactoryRepoOptionalParams)

Updates a factory's repo information.

function configureFactoryRepo(locationId: string, factoryRepoUpdate: FactoryRepoUpdate, options?: FactoriesConfigureFactoryRepoOptionalParams): Promise<Factory>

Parameters

locationId

string

The location identifier.

factoryRepoUpdate
FactoryRepoUpdate

Update factory repo request definition.

options
FactoriesConfigureFactoryRepoOptionalParams

The options parameters.

Returns

Promise<Factory>

createOrUpdate(string, string, Factory, FactoriesCreateOrUpdateOptionalParams)

Creates or updates a factory.

function createOrUpdate(resourceGroupName: string, factoryName: string, factory: Factory, options?: FactoriesCreateOrUpdateOptionalParams): Promise<Factory>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

factory
Factory

Factory resource definition.

options
FactoriesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Factory>

delete(string, string, FactoriesDeleteOptionalParams)

Deletes a factory.

function delete(resourceGroupName: string, factoryName: string, options?: FactoriesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

options
FactoriesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, FactoriesGetOptionalParams)

Gets a factory.

function get(resourceGroupName: string, factoryName: string, options?: FactoriesGetOptionalParams): Promise<Factory>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

options
FactoriesGetOptionalParams

The options parameters.

Returns

Promise<Factory>

getDataPlaneAccess(string, string, UserAccessPolicy, FactoriesGetDataPlaneAccessOptionalParams)

Get Data Plane access.

function getDataPlaneAccess(resourceGroupName: string, factoryName: string, policy: UserAccessPolicy, options?: FactoriesGetDataPlaneAccessOptionalParams): Promise<AccessPolicyResponse>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

policy
UserAccessPolicy

Data Plane user access policy definition.

options
FactoriesGetDataPlaneAccessOptionalParams

The options parameters.

Returns

Promise<AccessPolicyResponse>

getGitHubAccessToken(string, string, GitHubAccessTokenRequest, FactoriesGetGitHubAccessTokenOptionalParams)

Get GitHub Access Token.

function getGitHubAccessToken(resourceGroupName: string, factoryName: string, gitHubAccessTokenRequest: GitHubAccessTokenRequest, options?: FactoriesGetGitHubAccessTokenOptionalParams): Promise<GitHubAccessTokenResponse>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

gitHubAccessTokenRequest
GitHubAccessTokenRequest

Get GitHub access token request definition.

options
FactoriesGetGitHubAccessTokenOptionalParams

The options parameters.

Returns

Promise<GitHubAccessTokenResponse>

list(FactoriesListOptionalParams)

Lists factories under the specified subscription.

function list(options?: FactoriesListOptionalParams): PagedAsyncIterableIterator<Factory, Factory[], PageSettings>

Parameters

options
FactoriesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Factory, Factory[], PageSettings>

listByResourceGroup(string, FactoriesListByResourceGroupOptionalParams)

Lists factories.

function listByResourceGroup(resourceGroupName: string, options?: FactoriesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Factory, Factory[], PageSettings>

Parameters

resourceGroupName

string

The resource group name.

options
FactoriesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Factory, Factory[], PageSettings>

update(string, string, FactoryUpdateParameters, FactoriesUpdateOptionalParams)

Updates a factory.

function update(resourceGroupName: string, factoryName: string, factoryUpdateParameters: FactoryUpdateParameters, options?: FactoriesUpdateOptionalParams): Promise<Factory>

Parameters

resourceGroupName

string

The resource group name.

factoryName

string

The factory name.

factoryUpdateParameters
FactoryUpdateParameters

The parameters for updating a factory.

options
FactoriesUpdateOptionalParams

The options parameters.

Returns

Promise<Factory>