BareMetalMachines interface
Interface representing a BareMetalMachines.
Methods
begin |
Cordon the provided bare metal machine's Kubernetes node. |
begin |
Cordon the provided bare metal machine's Kubernetes node. |
begin |
Create a new bare metal machine or update the properties of the existing one. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. |
begin |
Create a new bare metal machine or update the properties of the existing one. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. |
begin |
Delete the provided bare metal machine. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. |
begin |
Delete the provided bare metal machine. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system. |
begin |
Power off the provided bare metal machine. |
begin |
Power off the provided bare metal machine. |
begin |
Reimage the provided bare metal machine. |
begin |
Reimage the provided bare metal machine. |
begin |
Replace the provided bare metal machine. |
begin |
Replace the provided bare metal machine. |
begin |
Restart the provided bare metal machine. |
begin |
Restart the provided bare metal machine. |
begin |
Run the command or the script on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available. |
begin |
Run the command or the script on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available. |
begin |
Run one or more data extractions on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available. |
begin |
Run one or more data extractions on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available. |
begin |
Run one or more read-only commands on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available. |
begin |
Run one or more read-only commands on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available. |
begin |
Start the provided bare metal machine. |
begin |
Start the provided bare metal machine. |
begin |
Uncordon the provided bare metal machine's Kubernetes node. |
begin |
Uncordon the provided bare metal machine's Kubernetes node. |
begin |
Patch properties of the provided bare metal machine, or update tags associated with the bare metal machine. Properties and tag updates can be done independently. |
begin |
Patch properties of the provided bare metal machine, or update tags associated with the bare metal machine. Properties and tag updates can be done independently. |
get(string, string, Bare |
Get properties of the provided bare metal machine. |
list |
Get a list of bare metal machines in the provided resource group. |
list |
Get a list of bare metal machines in the provided subscription. |
Method Details
beginCordon(string, string, BareMetalMachinesCordonOptionalParams)
Cordon the provided bare metal machine's Kubernetes node.
function beginCordon(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesCordonOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginCordonAndWait(string, string, BareMetalMachinesCordonOptionalParams)
Cordon the provided bare metal machine's Kubernetes node.
function beginCordonAndWait(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesCordonOptionalParams): Promise<OperationStatusResult>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<OperationStatusResult>
beginCreateOrUpdate(string, string, BareMetalMachine, BareMetalMachinesCreateOrUpdateOptionalParams)
Create a new bare metal machine or update the properties of the existing one. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
function beginCreateOrUpdate(resourceGroupName: string, bareMetalMachineName: string, bareMetalMachineParameters: BareMetalMachine, options?: BareMetalMachinesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BareMetalMachine>, BareMetalMachine>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
- bareMetalMachineParameters
- BareMetalMachine
The request body.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BareMetalMachine>, BareMetalMachine>>
beginCreateOrUpdateAndWait(string, string, BareMetalMachine, BareMetalMachinesCreateOrUpdateOptionalParams)
Create a new bare metal machine or update the properties of the existing one. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
function beginCreateOrUpdateAndWait(resourceGroupName: string, bareMetalMachineName: string, bareMetalMachineParameters: BareMetalMachine, options?: BareMetalMachinesCreateOrUpdateOptionalParams): Promise<BareMetalMachine>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
- bareMetalMachineParameters
- BareMetalMachine
The request body.
The options parameters.
Returns
Promise<BareMetalMachine>
beginDelete(string, string, BareMetalMachinesDeleteOptionalParams)
Delete the provided bare metal machine. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
function beginDelete(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, BareMetalMachinesDeleteOptionalParams)
Delete the provided bare metal machine. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
function beginDeleteAndWait(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesDeleteOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<void>
beginPowerOff(string, string, BareMetalMachinesPowerOffOptionalParams)
Power off the provided bare metal machine.
function beginPowerOff(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesPowerOffOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginPowerOffAndWait(string, string, BareMetalMachinesPowerOffOptionalParams)
Power off the provided bare metal machine.
function beginPowerOffAndWait(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesPowerOffOptionalParams): Promise<OperationStatusResult>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<OperationStatusResult>
beginReimage(string, string, BareMetalMachinesReimageOptionalParams)
Reimage the provided bare metal machine.
function beginReimage(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesReimageOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginReimageAndWait(string, string, BareMetalMachinesReimageOptionalParams)
Reimage the provided bare metal machine.
function beginReimageAndWait(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesReimageOptionalParams): Promise<OperationStatusResult>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<OperationStatusResult>
beginReplace(string, string, BareMetalMachinesReplaceOptionalParams)
Replace the provided bare metal machine.
function beginReplace(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesReplaceOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginReplaceAndWait(string, string, BareMetalMachinesReplaceOptionalParams)
Replace the provided bare metal machine.
function beginReplaceAndWait(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesReplaceOptionalParams): Promise<OperationStatusResult>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<OperationStatusResult>
beginRestart(string, string, BareMetalMachinesRestartOptionalParams)
Restart the provided bare metal machine.
function beginRestart(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesRestartOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginRestartAndWait(string, string, BareMetalMachinesRestartOptionalParams)
Restart the provided bare metal machine.
function beginRestartAndWait(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesRestartOptionalParams): Promise<OperationStatusResult>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<OperationStatusResult>
beginRunCommand(string, string, BareMetalMachineRunCommandParameters, BareMetalMachinesRunCommandOptionalParams)
Run the command or the script on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
function beginRunCommand(resourceGroupName: string, bareMetalMachineName: string, bareMetalMachineRunCommandParameters: BareMetalMachineRunCommandParameters, options?: BareMetalMachinesRunCommandOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
- bareMetalMachineRunCommandParameters
- BareMetalMachineRunCommandParameters
The request body.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginRunCommandAndWait(string, string, BareMetalMachineRunCommandParameters, BareMetalMachinesRunCommandOptionalParams)
Run the command or the script on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
function beginRunCommandAndWait(resourceGroupName: string, bareMetalMachineName: string, bareMetalMachineRunCommandParameters: BareMetalMachineRunCommandParameters, options?: BareMetalMachinesRunCommandOptionalParams): Promise<OperationStatusResult>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
- bareMetalMachineRunCommandParameters
- BareMetalMachineRunCommandParameters
The request body.
The options parameters.
Returns
Promise<OperationStatusResult>
beginRunDataExtracts(string, string, BareMetalMachineRunDataExtractsParameters, BareMetalMachinesRunDataExtractsOptionalParams)
Run one or more data extractions on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
function beginRunDataExtracts(resourceGroupName: string, bareMetalMachineName: string, bareMetalMachineRunDataExtractsParameters: BareMetalMachineRunDataExtractsParameters, options?: BareMetalMachinesRunDataExtractsOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
- bareMetalMachineRunDataExtractsParameters
- BareMetalMachineRunDataExtractsParameters
The request body.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginRunDataExtractsAndWait(string, string, BareMetalMachineRunDataExtractsParameters, BareMetalMachinesRunDataExtractsOptionalParams)
Run one or more data extractions on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
function beginRunDataExtractsAndWait(resourceGroupName: string, bareMetalMachineName: string, bareMetalMachineRunDataExtractsParameters: BareMetalMachineRunDataExtractsParameters, options?: BareMetalMachinesRunDataExtractsOptionalParams): Promise<OperationStatusResult>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
- bareMetalMachineRunDataExtractsParameters
- BareMetalMachineRunDataExtractsParameters
The request body.
The options parameters.
Returns
Promise<OperationStatusResult>
beginRunReadCommands(string, string, BareMetalMachineRunReadCommandsParameters, BareMetalMachinesRunReadCommandsOptionalParams)
Run one or more read-only commands on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
function beginRunReadCommands(resourceGroupName: string, bareMetalMachineName: string, bareMetalMachineRunReadCommandsParameters: BareMetalMachineRunReadCommandsParameters, options?: BareMetalMachinesRunReadCommandsOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
- bareMetalMachineRunReadCommandsParameters
- BareMetalMachineRunReadCommandsParameters
The request body.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginRunReadCommandsAndWait(string, string, BareMetalMachineRunReadCommandsParameters, BareMetalMachinesRunReadCommandsOptionalParams)
Run one or more read-only commands on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
function beginRunReadCommandsAndWait(resourceGroupName: string, bareMetalMachineName: string, bareMetalMachineRunReadCommandsParameters: BareMetalMachineRunReadCommandsParameters, options?: BareMetalMachinesRunReadCommandsOptionalParams): Promise<OperationStatusResult>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
- bareMetalMachineRunReadCommandsParameters
- BareMetalMachineRunReadCommandsParameters
The request body.
The options parameters.
Returns
Promise<OperationStatusResult>
beginStart(string, string, BareMetalMachinesStartOptionalParams)
Start the provided bare metal machine.
function beginStart(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesStartOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginStartAndWait(string, string, BareMetalMachinesStartOptionalParams)
Start the provided bare metal machine.
function beginStartAndWait(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesStartOptionalParams): Promise<OperationStatusResult>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<OperationStatusResult>
beginUncordon(string, string, BareMetalMachinesUncordonOptionalParams)
Uncordon the provided bare metal machine's Kubernetes node.
function beginUncordon(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesUncordonOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>
beginUncordonAndWait(string, string, BareMetalMachinesUncordonOptionalParams)
Uncordon the provided bare metal machine's Kubernetes node.
function beginUncordonAndWait(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesUncordonOptionalParams): Promise<OperationStatusResult>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<OperationStatusResult>
beginUpdate(string, string, BareMetalMachinesUpdateOptionalParams)
Patch properties of the provided bare metal machine, or update tags associated with the bare metal machine. Properties and tag updates can be done independently.
function beginUpdate(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BareMetalMachine>, BareMetalMachine>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BareMetalMachine>, BareMetalMachine>>
beginUpdateAndWait(string, string, BareMetalMachinesUpdateOptionalParams)
Patch properties of the provided bare metal machine, or update tags associated with the bare metal machine. Properties and tag updates can be done independently.
function beginUpdateAndWait(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesUpdateOptionalParams): Promise<BareMetalMachine>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<BareMetalMachine>
get(string, string, BareMetalMachinesGetOptionalParams)
Get properties of the provided bare metal machine.
function get(resourceGroupName: string, bareMetalMachineName: string, options?: BareMetalMachinesGetOptionalParams): Promise<BareMetalMachine>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- bareMetalMachineName
-
string
The name of the bare metal machine.
The options parameters.
Returns
Promise<BareMetalMachine>
listByResourceGroup(string, BareMetalMachinesListByResourceGroupOptionalParams)
Get a list of bare metal machines in the provided resource group.
function listByResourceGroup(resourceGroupName: string, options?: BareMetalMachinesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<BareMetalMachine, BareMetalMachine[], PageSettings>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(BareMetalMachinesListBySubscriptionOptionalParams)
Get a list of bare metal machines in the provided subscription.
function listBySubscription(options?: BareMetalMachinesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<BareMetalMachine, BareMetalMachine[], PageSettings>
Parameters
The options parameters.