Machines interface
Interface representing a Machines.
Methods
| begin |
Creates or updates a machine in the specified agent pool. |
| begin |
Creates or updates a machine in the specified agent pool. |
| get(string, string, string, string, Machines |
Get a specific machine in the specified agent pool. |
| list(string, string, string, Machines |
Gets a list of machines in the specified agent pool. |
Method Details
beginCreateOrUpdate(string, string, string, string, Machine, MachinesCreateOrUpdateOptionalParams)
Creates or updates a machine in the specified agent pool.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, agentPoolName: string, machineName: string, parameters: Machine, options?: MachinesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<MachinesCreateOrUpdateResponse>, MachinesCreateOrUpdateResponse>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
- machineName
-
string
Host name of the machine.
- parameters
- Machine
The machine to create or update.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<MachinesCreateOrUpdateResponse>, MachinesCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, Machine, MachinesCreateOrUpdateOptionalParams)
Creates or updates a machine in the specified agent pool.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, agentPoolName: string, machineName: string, parameters: Machine, options?: MachinesCreateOrUpdateOptionalParams): Promise<MachinesCreateOrUpdateResponse>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
- machineName
-
string
Host name of the machine.
- parameters
- Machine
The machine to create or update.
The options parameters.
Returns
Promise<MachinesCreateOrUpdateResponse>
get(string, string, string, string, MachinesGetOptionalParams)
Get a specific machine in the specified agent pool.
function get(resourceGroupName: string, resourceName: string, agentPoolName: string, machineName: string, options?: MachinesGetOptionalParams): Promise<Machine>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
- machineName
-
string
Host name of the machine.
- options
- MachinesGetOptionalParams
The options parameters.
Returns
Promise<Machine>
list(string, string, string, MachinesListOptionalParams)
Gets a list of machines in the specified agent pool.
function list(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: MachinesListOptionalParams): PagedAsyncIterableIterator<Machine, Machine[], PageSettings>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
- options
- MachinesListOptionalParams
The options parameters.