Package version:

Interface Factories

Interface representing a Factories.

interface Factories {
    configureFactoryRepo(locationId: string, factoryRepoUpdate: FactoryRepoUpdate, options?: FactoriesConfigureFactoryRepoOptionalParams): Promise<Factory>;
    createOrUpdate(resourceGroupName: string, factoryName: string, factory: Factory, options?: FactoriesCreateOrUpdateOptionalParams): Promise<Factory>;
    delete(resourceGroupName: string, factoryName: string, options?: FactoriesDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, factoryName: string, options?: FactoriesGetOptionalParams): Promise<Factory>;
    getDataPlaneAccess(resourceGroupName: string, factoryName: string, policy: UserAccessPolicy, options?: FactoriesGetDataPlaneAccessOptionalParams): Promise<AccessPolicyResponse>;
    getGitHubAccessToken(resourceGroupName: string, factoryName: string, gitHubAccessTokenRequest: GitHubAccessTokenRequest, options?: FactoriesGetGitHubAccessTokenOptionalParams): Promise<GitHubAccessTokenResponse>;
    list(options?: FactoriesListOptionalParams): PagedAsyncIterableIterator<Factory>;
    listByResourceGroup(resourceGroupName: string, options?: FactoriesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Factory>;
    update(resourceGroupName: string, factoryName: string, factoryUpdateParameters: FactoryUpdateParameters, options?: FactoriesUpdateOptionalParams): Promise<Factory>;
}

Index

Methods

configureFactoryRepo createOrUpdate delete get getDataPlaneAccess getGitHubAccessToken list listByResourceGroup update

Methods

configureFactoryRepo

configureFactoryRepo(locationId, factoryRepoUpdate, options?): Promise<Factory>
Updates a factory's repo information.
Parameters
- locationId: string
  The location identifier.
- factoryRepoUpdate: FactoryRepoUpdate
  Update factory repo request definition.
- Optionaloptions: FactoriesConfigureFactoryRepoOptionalParams
  The options parameters.
Returns Promise<Factory>
- Defined in operationsInterfaces/factories.ts:58

createOrUpdate

createOrUpdate(resourceGroupName, factoryName, factory, options?): Promise<Factory>
Creates or updates a factory.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- factory: Factory
  Factory resource definition.
- Optionaloptions: FactoriesCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<Factory>
- Defined in operationsInterfaces/factories.ts:70

delete

delete(resourceGroupName, factoryName, options?): Promise<void>
Deletes a factory.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- Optionaloptions: FactoriesDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/factories.ts:106

get

get(resourceGroupName, factoryName, options?): Promise<Factory>
Gets a factory.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- Optionaloptions: FactoriesGetOptionalParams
  The options parameters.
Returns Promise<Factory>
- Defined in operationsInterfaces/factories.ts:95

getDataPlaneAccess

getDataPlaneAccess(resourceGroupName, factoryName, policy, options?): Promise<AccessPolicyResponse>
Get Data Plane access.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- policy: UserAccessPolicy
  Data Plane user access policy definition.
- Optionaloptions: FactoriesGetDataPlaneAccessOptionalParams
  The options parameters.
Returns Promise<AccessPolicyResponse>
- Defined in operationsInterfaces/factories.ts:131

getGitHubAccessToken

getGitHubAccessToken(resourceGroupName, factoryName, gitHubAccessTokenRequest, options?): Promise<GitHubAccessTokenResponse>
Get GitHub Access Token.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- gitHubAccessTokenRequest: GitHubAccessTokenRequest
  Get GitHub access token request definition.
- Optionaloptions: FactoriesGetGitHubAccessTokenOptionalParams
  The options parameters.
Returns Promise<GitHubAccessTokenResponse>
- Defined in operationsInterfaces/factories.ts:118

list

list(options?): PagedAsyncIterableIterator<Factory>
Lists factories under the specified subscription.
Parameters
- Optionaloptions: FactoriesListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<Factory>
- Defined in operationsInterfaces/factories.ts:40

listByResourceGroup

listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<Factory>
Lists factories.
Parameters
- resourceGroupName: string
  The resource group name.
- Optionaloptions: FactoriesListByResourceGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<Factory>
- Defined in operationsInterfaces/factories.ts:48

update

update(resourceGroupName, factoryName, factoryUpdateParameters, options?): Promise<Factory>
Updates a factory.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- factoryUpdateParameters: FactoryUpdateParameters
  The parameters for updating a factory.
- Optionaloptions: FactoriesUpdateOptionalParams
  The options parameters.
Returns Promise<Factory>
- Defined in operationsInterfaces/factories.ts:83

Interface Factories

Index

Methods

Methods

configureFactoryRepo

Parameters

Returns Promise<Factory>

createOrUpdate

Parameters

Returns Promise<Factory>

delete

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<Factory>

getDataPlaneAccess

Parameters

Returns Promise<AccessPolicyResponse>

getGitHubAccessToken

Parameters

Returns Promise<GitHubAccessTokenResponse>

list

Parameters

Returns PagedAsyncIterableIterator<Factory>

listByResourceGroup

Parameters

Returns PagedAsyncIterableIterator<Factory>

update

Parameters

Returns Promise<Factory>

Settings