Builders interface

Package:

@azure/arm-appcontainers

Interface representing a Builders.

Methods

beginCreateOrUpdate(string, string, BuilderResource, BuildersCreateOrUpdateOptionalParams)	Create or update a BuilderResource
beginCreateOrUpdateAndWait(string, string, BuilderResource, BuildersCreateOrUpdateOptionalParams)	Create or update a BuilderResource
beginDelete(string, string, BuildersDeleteOptionalParams)	Delete a BuilderResource
beginDeleteAndWait(string, string, BuildersDeleteOptionalParams)	Delete a BuilderResource
beginUpdate(string, string, BuilderResourceUpdate, BuildersUpdateOptionalParams)	Update a BuilderResource
beginUpdateAndWait(string, string, BuilderResourceUpdate, BuildersUpdateOptionalParams)	Update a BuilderResource
get(string, string, BuildersGetOptionalParams)	Get a BuilderResource
listByResourceGroup(string, BuildersListByResourceGroupOptionalParams)	List BuilderResource resources by resource group
listBySubscription(BuildersListBySubscriptionOptionalParams)	List BuilderResource resources by subscription ID

Method Details

beginCreateOrUpdate(string, string, BuilderResource, BuildersCreateOrUpdateOptionalParams)

Create or update a BuilderResource

function beginCreateOrUpdate(resourceGroupName: string, builderName: string, builderEnvelope: BuilderResource, options?: BuildersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BuilderResource>, BuilderResource>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

builderName

string

The name of the builder.

builderEnvelope

BuilderResource

Resource create parameters.

options

BuildersCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, BuilderResource, BuildersCreateOrUpdateOptionalParams)

Create or update a BuilderResource

function beginCreateOrUpdateAndWait(resourceGroupName: string, builderName: string, builderEnvelope: BuilderResource, options?: BuildersCreateOrUpdateOptionalParams): Promise<BuilderResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

builderName

string

The name of the builder.

builderEnvelope

BuilderResource

Resource create parameters.

options

BuildersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<BuilderResource>

beginDelete(string, string, BuildersDeleteOptionalParams)

Delete a BuilderResource

function beginDelete(resourceGroupName: string, builderName: string, options?: BuildersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<BuildersDeleteHeaders>, BuildersDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

builderName

string

The name of the builder.

options

BuildersDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, BuildersDeleteOptionalParams)

Delete a BuilderResource

function beginDeleteAndWait(resourceGroupName: string, builderName: string, options?: BuildersDeleteOptionalParams): Promise<BuildersDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

builderName

string

The name of the builder.

options

BuildersDeleteOptionalParams

The options parameters.

Returns

Promise<BuildersDeleteHeaders>

beginUpdate(string, string, BuilderResourceUpdate, BuildersUpdateOptionalParams)

Update a BuilderResource

function beginUpdate(resourceGroupName: string, builderName: string, builderEnvelope: BuilderResourceUpdate, options?: BuildersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BuilderResource>, BuilderResource>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

builderName

string

The name of the builder.

builderEnvelope

BuilderResourceUpdate

The resource properties to be updated.

options

BuildersUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, BuilderResourceUpdate, BuildersUpdateOptionalParams)

Update a BuilderResource

function beginUpdateAndWait(resourceGroupName: string, builderName: string, builderEnvelope: BuilderResourceUpdate, options?: BuildersUpdateOptionalParams): Promise<BuilderResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

builderName

string

The name of the builder.

builderEnvelope

BuilderResourceUpdate

The resource properties to be updated.

options

BuildersUpdateOptionalParams

The options parameters.

Returns

Promise<BuilderResource>

get(string, string, BuildersGetOptionalParams)

Get a BuilderResource

function get(resourceGroupName: string, builderName: string, options?: BuildersGetOptionalParams): Promise<BuilderResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

builderName

string

The name of the builder.

options

BuildersGetOptionalParams

The options parameters.

Returns

Promise<BuilderResource>

listByResourceGroup(string, BuildersListByResourceGroupOptionalParams)

List BuilderResource resources by resource group

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

BuildersListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<BuilderResource, BuilderResource[], PageSettings>

listBySubscription(BuildersListBySubscriptionOptionalParams)

List BuilderResource resources by subscription ID

function listBySubscription(options?: BuildersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<BuilderResource, BuilderResource[], PageSettings>

Parameters

options

BuildersListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<BuilderResource, BuilderResource[], PageSettings>