AzureBareMetalInstances interface
Interface representing a AzureBareMetalInstances.
Methods
| begin |
The operation to restart an Azure Bare Metal Instance |
| begin |
The operation to restart an Azure Bare Metal Instance |
| begin |
The operation to shutdown an Azure Bare Metal Instance |
| begin |
The operation to shutdown an Azure Bare Metal Instance |
| begin |
The operation to start an Azure Bare Metal instance |
| begin |
The operation to start an Azure Bare Metal instance |
| get(string, string, Azure |
Gets an Azure Bare Metal Instance for the specified subscription, resource group, and instance name. |
| list |
Gets a list of Azure Bare Metal Instances in the specified subscription and resource group. The operations returns various properties of each Azure Bare Metal Instance. |
| list |
Returns a list of Azure Bare Metal Instances in the specified subscription. The operations returns various properties of each Azure Bare Metal Instance. |
| update(string, string, Tags, Azure |
Patches the Tags field of a Azure Bare Metal Instance for the specified subscription, resource group, and instance name. |
Method Details
beginRestart(string, string, AzureBareMetalInstancesRestartOptionalParams)
The operation to restart an Azure Bare Metal Instance
function beginRestart(resourceGroupName: string, azureBareMetalInstanceName: string, options?: AzureBareMetalInstancesRestartOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- azureBareMetalInstanceName
-
string
Name of the Azure Bare Metal Instance, also known as the ResourceName.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>
beginRestartAndWait(string, string, AzureBareMetalInstancesRestartOptionalParams)
The operation to restart an Azure Bare Metal Instance
function beginRestartAndWait(resourceGroupName: string, azureBareMetalInstanceName: string, options?: AzureBareMetalInstancesRestartOptionalParams): Promise<OperationStatus>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- azureBareMetalInstanceName
-
string
Name of the Azure Bare Metal Instance, also known as the ResourceName.
The options parameters.
Returns
Promise<OperationStatus>
beginShutdown(string, string, AzureBareMetalInstancesShutdownOptionalParams)
The operation to shutdown an Azure Bare Metal Instance
function beginShutdown(resourceGroupName: string, azureBareMetalInstanceName: string, options?: AzureBareMetalInstancesShutdownOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- azureBareMetalInstanceName
-
string
Name of the Azure Bare Metal Instance, also known as the ResourceName.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>
beginShutdownAndWait(string, string, AzureBareMetalInstancesShutdownOptionalParams)
The operation to shutdown an Azure Bare Metal Instance
function beginShutdownAndWait(resourceGroupName: string, azureBareMetalInstanceName: string, options?: AzureBareMetalInstancesShutdownOptionalParams): Promise<OperationStatus>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- azureBareMetalInstanceName
-
string
Name of the Azure Bare Metal Instance, also known as the ResourceName.
The options parameters.
Returns
Promise<OperationStatus>
beginStart(string, string, AzureBareMetalInstancesStartOptionalParams)
The operation to start an Azure Bare Metal instance
function beginStart(resourceGroupName: string, azureBareMetalInstanceName: string, options?: AzureBareMetalInstancesStartOptionalParams): Promise<SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- azureBareMetalInstanceName
-
string
Name of the Azure Bare Metal Instance, also known as the ResourceName.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<OperationStatus>, OperationStatus>>
beginStartAndWait(string, string, AzureBareMetalInstancesStartOptionalParams)
The operation to start an Azure Bare Metal instance
function beginStartAndWait(resourceGroupName: string, azureBareMetalInstanceName: string, options?: AzureBareMetalInstancesStartOptionalParams): Promise<OperationStatus>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- azureBareMetalInstanceName
-
string
Name of the Azure Bare Metal Instance, also known as the ResourceName.
The options parameters.
Returns
Promise<OperationStatus>
get(string, string, AzureBareMetalInstancesGetOptionalParams)
Gets an Azure Bare Metal Instance for the specified subscription, resource group, and instance name.
function get(resourceGroupName: string, azureBareMetalInstanceName: string, options?: AzureBareMetalInstancesGetOptionalParams): Promise<AzureBareMetalInstance>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- azureBareMetalInstanceName
-
string
Name of the Azure Bare Metal Instance, also known as the ResourceName.
The options parameters.
Returns
Promise<AzureBareMetalInstance>
listByResourceGroup(string, AzureBareMetalInstancesListByResourceGroupOptionalParams)
Gets a list of Azure Bare Metal Instances in the specified subscription and resource group. The operations returns various properties of each Azure Bare Metal Instance.
function listByResourceGroup(resourceGroupName: string, options?: AzureBareMetalInstancesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<AzureBareMetalInstance, AzureBareMetalInstance[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(AzureBareMetalInstancesListBySubscriptionOptionalParams)
Returns a list of Azure Bare Metal Instances in the specified subscription. The operations returns various properties of each Azure Bare Metal Instance.
function listBySubscription(options?: AzureBareMetalInstancesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<AzureBareMetalInstance, AzureBareMetalInstance[], PageSettings>Parameters
The options parameters.
Returns
update(string, string, Tags, AzureBareMetalInstancesUpdateOptionalParams)
Patches the Tags field of a Azure Bare Metal Instance for the specified subscription, resource group, and instance name.
function update(resourceGroupName: string, azureBareMetalInstanceName: string, tagsParameter: Tags, options?: AzureBareMetalInstancesUpdateOptionalParams): Promise<AzureBareMetalInstance>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- azureBareMetalInstanceName
-
string
Name of the Azure Bare Metal Instance, also known as the ResourceName.
- tagsParameter
- Tags
Request body that only contains the new Tags field
The options parameters.
Returns
Promise<AzureBareMetalInstance>
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for