MachinePools interface

Interface representing a MachinePools.

Methods

createOrUpdate(string, string, string, MachinePool, MachinePoolsCreateOrUpdateOptionalParams)

The operation returns properties of a MachinePool.

delete(string, string, string, MachinePoolsDeleteOptionalParams)

The operation returns nothing.

get(string, string, string, MachinePoolsGetOptionalParams)

The operation returns properties of a MachinePool.

list(string, string, MachinePoolsListOptionalParams)

The operation returns properties of each MachinePool.

update(string, string, string, MachinePoolUpdate, MachinePoolsUpdateOptionalParams)

The operation returns properties of a MachinePool.

Method Details

createOrUpdate(string, string, string, MachinePool, MachinePoolsCreateOrUpdateOptionalParams)

The operation returns properties of a MachinePool.

function createOrUpdate(resourceGroupName: string, resourceName: string, childResourceName: string, parameters: MachinePool, options?: MachinePoolsCreateOrUpdateOptionalParams): Promise<MachinePool>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the OpenShift cluster resource.

childResourceName

string

The name of the MachinePool resource.

parameters
MachinePool

The MachinePool resource.

options
MachinePoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<MachinePool>

delete(string, string, string, MachinePoolsDeleteOptionalParams)

The operation returns nothing.

function delete(resourceGroupName: string, resourceName: string, childResourceName: string, options?: MachinePoolsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the OpenShift cluster resource.

childResourceName

string

The name of the MachinePool resource.

options
MachinePoolsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, MachinePoolsGetOptionalParams)

The operation returns properties of a MachinePool.

function get(resourceGroupName: string, resourceName: string, childResourceName: string, options?: MachinePoolsGetOptionalParams): Promise<MachinePool>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the OpenShift cluster resource.

childResourceName

string

The name of the MachinePool resource.

options
MachinePoolsGetOptionalParams

The options parameters.

Returns

Promise<MachinePool>

list(string, string, MachinePoolsListOptionalParams)

The operation returns properties of each MachinePool.

function list(resourceGroupName: string, resourceName: string, options?: MachinePoolsListOptionalParams): PagedAsyncIterableIterator<MachinePool, MachinePool[], PageSettings>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the OpenShift cluster resource.

options
MachinePoolsListOptionalParams

The options parameters.

Returns

update(string, string, string, MachinePoolUpdate, MachinePoolsUpdateOptionalParams)

The operation returns properties of a MachinePool.

function update(resourceGroupName: string, resourceName: string, childResourceName: string, parameters: MachinePoolUpdate, options?: MachinePoolsUpdateOptionalParams): Promise<MachinePool>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the OpenShift cluster resource.

childResourceName

string

The name of the MachinePool resource.

parameters
MachinePoolUpdate

The MachinePool resource.

options
MachinePoolsUpdateOptionalParams

The options parameters.

Returns

Promise<MachinePool>