BuildServiceOperations interface

Interface representing a BuildServiceOperations.

Methods

beginCreateOrUpdate(string, string, string, BuildService, BuildServiceCreateOrUpdateOptionalParams)

Create a build service resource.

beginCreateOrUpdateAndWait(string, string, string, BuildService, BuildServiceCreateOrUpdateOptionalParams)

Create a build service resource.

beginDeleteBuild(string, string, string, string, BuildServiceDeleteBuildOptionalParams)

delete a KPack build.

beginDeleteBuildAndWait(string, string, string, string, BuildServiceDeleteBuildOptionalParams)

delete a KPack build.

createOrUpdateBuild(string, string, string, string, Build, BuildServiceCreateOrUpdateBuildOptionalParams)

Create or update a KPack build.

getBuild(string, string, string, string, BuildServiceGetBuildOptionalParams)

Get a KPack build.

getBuildResult(string, string, string, string, string, BuildServiceGetBuildResultOptionalParams)

Get a KPack build result.

getBuildResultLog(string, string, string, string, string, BuildServiceGetBuildResultLogOptionalParams)

Get a KPack build result log download URL.

getBuildService(string, string, string, BuildServiceGetBuildServiceOptionalParams)

Get a build service resource.

getResourceUploadUrl(string, string, string, BuildServiceGetResourceUploadUrlOptionalParams)

Get an resource upload URL for build service, which may be artifacts or source archive.

getSupportedBuildpack(string, string, string, string, BuildServiceGetSupportedBuildpackOptionalParams)

Get the supported buildpack resource.

getSupportedStack(string, string, string, string, BuildServiceGetSupportedStackOptionalParams)

Get the supported stack resource.

listBuildResults(string, string, string, string, BuildServiceListBuildResultsOptionalParams)

List KPack build results.

listBuilds(string, string, string, BuildServiceListBuildsOptionalParams)

List KPack builds.

listBuildServices(string, string, BuildServiceListBuildServicesOptionalParams)

List build services resource.

listSupportedBuildpacks(string, string, string, BuildServiceListSupportedBuildpacksOptionalParams)

Get all supported buildpacks.

listSupportedStacks(string, string, string, BuildServiceListSupportedStacksOptionalParams)

Get all supported stacks.

Method Details

beginCreateOrUpdate(string, string, string, BuildService, BuildServiceCreateOrUpdateOptionalParams)

Create a build service resource.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, buildServiceName: string, buildService: BuildService, options?: BuildServiceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BuildService>, BuildService>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

buildService
BuildService

Parameters for the create operation

options
BuildServiceCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<BuildService>, BuildService>>

beginCreateOrUpdateAndWait(string, string, string, BuildService, BuildServiceCreateOrUpdateOptionalParams)

Create a build service resource.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, buildServiceName: string, buildService: BuildService, options?: BuildServiceCreateOrUpdateOptionalParams): Promise<BuildService>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

buildService
BuildService

Parameters for the create operation

options
BuildServiceCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<BuildService>

beginDeleteBuild(string, string, string, string, BuildServiceDeleteBuildOptionalParams)

delete a KPack build.

function beginDeleteBuild(resourceGroupName: string, serviceName: string, buildServiceName: string, buildName: string, options?: BuildServiceDeleteBuildOptionalParams): Promise<SimplePollerLike<OperationState<BuildServiceDeleteBuildHeaders>, BuildServiceDeleteBuildHeaders>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

buildName

string

The name of the build resource.

options
BuildServiceDeleteBuildOptionalParams

The options parameters.

Returns

beginDeleteBuildAndWait(string, string, string, string, BuildServiceDeleteBuildOptionalParams)

delete a KPack build.

function beginDeleteBuildAndWait(resourceGroupName: string, serviceName: string, buildServiceName: string, buildName: string, options?: BuildServiceDeleteBuildOptionalParams): Promise<BuildServiceDeleteBuildHeaders>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

buildName

string

The name of the build resource.

options
BuildServiceDeleteBuildOptionalParams

The options parameters.

Returns

createOrUpdateBuild(string, string, string, string, Build, BuildServiceCreateOrUpdateBuildOptionalParams)

Create or update a KPack build.

function createOrUpdateBuild(resourceGroupName: string, serviceName: string, buildServiceName: string, buildName: string, build: Build, options?: BuildServiceCreateOrUpdateBuildOptionalParams): Promise<Build>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

buildName

string

The name of the build resource.

build
Build

Parameters for the create or update operation

options
BuildServiceCreateOrUpdateBuildOptionalParams

The options parameters.

Returns

Promise<Build>

getBuild(string, string, string, string, BuildServiceGetBuildOptionalParams)

Get a KPack build.

function getBuild(resourceGroupName: string, serviceName: string, buildServiceName: string, buildName: string, options?: BuildServiceGetBuildOptionalParams): Promise<Build>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

buildName

string

The name of the build resource.

options
BuildServiceGetBuildOptionalParams

The options parameters.

Returns

Promise<Build>

getBuildResult(string, string, string, string, string, BuildServiceGetBuildResultOptionalParams)

Get a KPack build result.

function getBuildResult(resourceGroupName: string, serviceName: string, buildServiceName: string, buildName: string, buildResultName: string, options?: BuildServiceGetBuildResultOptionalParams): Promise<BuildResult>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

buildName

string

The name of the build resource.

buildResultName

string

The name of the build result resource.

options
BuildServiceGetBuildResultOptionalParams

The options parameters.

Returns

Promise<BuildResult>

getBuildResultLog(string, string, string, string, string, BuildServiceGetBuildResultLogOptionalParams)

Get a KPack build result log download URL.

function getBuildResultLog(resourceGroupName: string, serviceName: string, buildServiceName: string, buildName: string, buildResultName: string, options?: BuildServiceGetBuildResultLogOptionalParams): Promise<BuildResultLog>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

buildName

string

The name of the build resource.

buildResultName

string

The name of the build result resource.

options
BuildServiceGetBuildResultLogOptionalParams

The options parameters.

Returns

Promise<BuildResultLog>

getBuildService(string, string, string, BuildServiceGetBuildServiceOptionalParams)

Get a build service resource.

function getBuildService(resourceGroupName: string, serviceName: string, buildServiceName: string, options?: BuildServiceGetBuildServiceOptionalParams): Promise<BuildService>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

options
BuildServiceGetBuildServiceOptionalParams

The options parameters.

Returns

Promise<BuildService>

getResourceUploadUrl(string, string, string, BuildServiceGetResourceUploadUrlOptionalParams)

Get an resource upload URL for build service, which may be artifacts or source archive.

function getResourceUploadUrl(resourceGroupName: string, serviceName: string, buildServiceName: string, options?: BuildServiceGetResourceUploadUrlOptionalParams): Promise<ResourceUploadDefinition>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

options
BuildServiceGetResourceUploadUrlOptionalParams

The options parameters.

Returns

getSupportedBuildpack(string, string, string, string, BuildServiceGetSupportedBuildpackOptionalParams)

Get the supported buildpack resource.

function getSupportedBuildpack(resourceGroupName: string, serviceName: string, buildServiceName: string, buildpackName: string, options?: BuildServiceGetSupportedBuildpackOptionalParams): Promise<SupportedBuildpackResource>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

buildpackName

string

The name of the buildpack resource.

options
BuildServiceGetSupportedBuildpackOptionalParams

The options parameters.

Returns

getSupportedStack(string, string, string, string, BuildServiceGetSupportedStackOptionalParams)

Get the supported stack resource.

function getSupportedStack(resourceGroupName: string, serviceName: string, buildServiceName: string, stackName: string, options?: BuildServiceGetSupportedStackOptionalParams): Promise<SupportedStackResource>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

stackName

string

The name of the stack resource.

options
BuildServiceGetSupportedStackOptionalParams

The options parameters.

Returns

listBuildResults(string, string, string, string, BuildServiceListBuildResultsOptionalParams)

List KPack build results.

function listBuildResults(resourceGroupName: string, serviceName: string, buildServiceName: string, buildName: string, options?: BuildServiceListBuildResultsOptionalParams): PagedAsyncIterableIterator<BuildResult, BuildResult[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

buildName

string

The name of the build resource.

options
BuildServiceListBuildResultsOptionalParams

The options parameters.

Returns

listBuilds(string, string, string, BuildServiceListBuildsOptionalParams)

List KPack builds.

function listBuilds(resourceGroupName: string, serviceName: string, buildServiceName: string, options?: BuildServiceListBuildsOptionalParams): PagedAsyncIterableIterator<Build, Build[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

options
BuildServiceListBuildsOptionalParams

The options parameters.

Returns

listBuildServices(string, string, BuildServiceListBuildServicesOptionalParams)

List build services resource.

function listBuildServices(resourceGroupName: string, serviceName: string, options?: BuildServiceListBuildServicesOptionalParams): PagedAsyncIterableIterator<BuildService, BuildService[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

options
BuildServiceListBuildServicesOptionalParams

The options parameters.

Returns

listSupportedBuildpacks(string, string, string, BuildServiceListSupportedBuildpacksOptionalParams)

Get all supported buildpacks.

function listSupportedBuildpacks(resourceGroupName: string, serviceName: string, buildServiceName: string, options?: BuildServiceListSupportedBuildpacksOptionalParams): Promise<SupportedBuildpacksCollection>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

options
BuildServiceListSupportedBuildpacksOptionalParams

The options parameters.

Returns

listSupportedStacks(string, string, string, BuildServiceListSupportedStacksOptionalParams)

Get all supported stacks.

function listSupportedStacks(resourceGroupName: string, serviceName: string, buildServiceName: string, options?: BuildServiceListSupportedStacksOptionalParams): Promise<SupportedStacksCollection>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serviceName

string

The name of the Service resource.

buildServiceName

string

The name of the build service resource.

options
BuildServiceListSupportedStacksOptionalParams

The options parameters.

Returns