@azure/arm-baremetalinfrastructure package

Classes

BareMetalInfrastructureClient

Interfaces

AzureBareMetalInstance	AzureBareMetal instance info on Azure (ARM properties and AzureBareMetal properties)
AzureBareMetalInstances	Interface representing a AzureBareMetalInstances.
AzureBareMetalInstancesGetOptionalParams	Optional parameters.
AzureBareMetalInstancesListByResourceGroupNextOptionalParams	Optional parameters.
AzureBareMetalInstancesListByResourceGroupOptionalParams	Optional parameters.
AzureBareMetalInstancesListBySubscriptionNextOptionalParams	Optional parameters.
AzureBareMetalInstancesListBySubscriptionOptionalParams	Optional parameters.
AzureBareMetalInstancesListResult	The response from the List Azure Bare Metal Instances operation.
AzureBareMetalInstancesRestartHeaders	Defines headers for AzureBareMetalInstances_restart operation.
AzureBareMetalInstancesRestartOptionalParams	Optional parameters.
AzureBareMetalInstancesShutdownHeaders	Defines headers for AzureBareMetalInstances_shutdown operation.
AzureBareMetalInstancesShutdownOptionalParams	Optional parameters.
AzureBareMetalInstancesStartHeaders	Defines headers for AzureBareMetalInstances_start operation.
AzureBareMetalInstancesStartOptionalParams	Optional parameters.
AzureBareMetalInstancesUpdateOptionalParams	Optional parameters.
AzureBareMetalStorageInstance	AzureBareMetalStorageInstance info on Azure (ARM properties and AzureBareMetalStorage properties)
AzureBareMetalStorageInstances	Interface representing a AzureBareMetalStorageInstances.
AzureBareMetalStorageInstancesCreateOptionalParams	Optional parameters.
AzureBareMetalStorageInstancesDeleteOptionalParams	Optional parameters.
AzureBareMetalStorageInstancesGetOptionalParams	Optional parameters.
AzureBareMetalStorageInstancesListByResourceGroupNextOptionalParams	Optional parameters.
AzureBareMetalStorageInstancesListByResourceGroupOptionalParams	Optional parameters.
AzureBareMetalStorageInstancesListBySubscriptionNextOptionalParams	Optional parameters.
AzureBareMetalStorageInstancesListBySubscriptionOptionalParams	Optional parameters.
AzureBareMetalStorageInstancesListResult	The response from the Get AzureBareMetalStorageInstances operation.
AzureBareMetalStorageInstancesUpdateOptionalParams	Optional parameters.
BareMetalInfrastructureClientOptionalParams	Optional parameters.
Disk	Specifies the disk information fo the Azure Bare Metal Instance
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
ForceState	The active state empowers the server with the ability to forcefully terminate and halt any existing processes that may be running on the server
HardwareProfile	Specifies the hardware settings for the Azure Bare Metal Instance.
NetworkInterface	Specifies the network interfaces of a bare metal resource.
NetworkProfile	Specifies the network settings for the Azure Bare Metal Instance disks.
OSProfile	Specifies the operating system settings for the Azure Bare Metal instance.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for this particular operation.
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
OperationStatus	The OperationStatus object returns the state of an asynchronous operation.
OperationStatusError	An error from the Azure Bare Metal Infrastructure service.
Operations	Interface representing a Operations.
OperationsListOptionalParams	Optional parameters.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
StorageBillingProperties	Describes the billing related details of the AzureBareMetalStorageInstance.
StorageProfile	Specifies the storage settings for the Azure Bare Metal instance disks.
StorageProperties	described the storage properties of the azure bare metal storage instance
SystemData	Metadata pertaining to creation and last modification of the resource.
Tags	Tags field of the AzureBareMetal/AzureBareMetaStorage instance.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal
AsyncOperationStatus	Defines values for AsyncOperationStatus. KnownAsyncOperationStatus can be used interchangeably with AsyncOperationStatus, this enum contains the known values that the service supports. Known values supported by the service Requesting Executing Succeeded Failed
AzureBareMetalHardwareTypeNamesEnum	Defines values for AzureBareMetalHardwareTypeNamesEnum. KnownAzureBareMetalHardwareTypeNamesEnum can be used interchangeably with AzureBareMetalHardwareTypeNamesEnum, this enum contains the known values that the service supports. Known values supported by the service Cisco_UCS HPE SDFLEX
AzureBareMetalInstanceForcePowerState	Defines values for AzureBareMetalInstanceForcePowerState. KnownAzureBareMetalInstanceForcePowerState can be used interchangeably with AzureBareMetalInstanceForcePowerState, this enum contains the known values that the service supports. Known values supported by the service active inactive
AzureBareMetalInstancePowerStateEnum	Defines values for AzureBareMetalInstancePowerStateEnum. KnownAzureBareMetalInstancePowerStateEnum can be used interchangeably with AzureBareMetalInstancePowerStateEnum, this enum contains the known values that the service supports. Known values supported by the service starting started stopping stopped restarting unknown
AzureBareMetalInstanceSizeNamesEnum	Defines values for AzureBareMetalInstanceSizeNamesEnum. KnownAzureBareMetalInstanceSizeNamesEnum can be used interchangeably with AzureBareMetalInstanceSizeNamesEnum, this enum contains the known values that the service supports. Known values supported by the service S72m S144m S72 S144 S192 S192m S192xm S96 S112 S224 S224m S224om S224oo S224oom S224ooo S384 S384m S384xm S384xxm S448 S448m S448om S448oo S448oom S448ooo S448se S576m S576xm S672 S672m S672om S672oo S672oom S672ooo S768 S768m S768xm S896 S896m S896om S896oo S896oom S896ooo S960m
AzureBareMetalInstancesGetResponse	Contains response data for the get operation.
AzureBareMetalInstancesListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
AzureBareMetalInstancesListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
AzureBareMetalInstancesListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
AzureBareMetalInstancesListBySubscriptionResponse	Contains response data for the listBySubscription operation.
AzureBareMetalInstancesRestartResponse	Contains response data for the restart operation.
AzureBareMetalInstancesShutdownResponse	Contains response data for the shutdown operation.
AzureBareMetalInstancesStartResponse	Contains response data for the start operation.
AzureBareMetalInstancesUpdateResponse	Contains response data for the update operation.
AzureBareMetalProvisioningStatesEnum	Defines values for AzureBareMetalProvisioningStatesEnum. KnownAzureBareMetalProvisioningStatesEnum can be used interchangeably with AzureBareMetalProvisioningStatesEnum, this enum contains the known values that the service supports. Known values supported by the service Accepted Creating Updating Failed Succeeded Deleting Migrating
AzureBareMetalStorageInstancesCreateResponse	Contains response data for the create operation.
AzureBareMetalStorageInstancesGetResponse	Contains response data for the get operation.
AzureBareMetalStorageInstancesListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
AzureBareMetalStorageInstancesListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
AzureBareMetalStorageInstancesListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
AzureBareMetalStorageInstancesListBySubscriptionResponse	Contains response data for the listBySubscription operation.
AzureBareMetalStorageInstancesUpdateResponse	Contains response data for the update operation.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user system user,system
ProvisioningState	Defines values for ProvisioningState. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Accepted Creating Updating Failed Succeeded Deleting Canceled Migrating

Enums

KnownActionType	Known values of ActionType that the service accepts.
KnownAsyncOperationStatus	Known values of AsyncOperationStatus that the service accepts.
KnownAzureBareMetalHardwareTypeNamesEnum	Known values of AzureBareMetalHardwareTypeNamesEnum that the service accepts.
KnownAzureBareMetalInstanceForcePowerState	Known values of AzureBareMetalInstanceForcePowerState that the service accepts.
KnownAzureBareMetalInstancePowerStateEnum	Known values of AzureBareMetalInstancePowerStateEnum that the service accepts.
KnownAzureBareMetalInstanceSizeNamesEnum	Known values of AzureBareMetalInstanceSizeNamesEnum that the service accepts.
KnownAzureBareMetalProvisioningStatesEnum	Known values of AzureBareMetalProvisioningStatesEnum that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.