@azure/arm-baremetalinfrastructure 1.0.0-beta.1 → 1.0.0-beta.3

package/review/arm-baremetalinfrastructure-node.api.md

@@ -0,0 +1,550 @@
+## API Report File for "@azure/arm-baremetalinfrastructure"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { OperationState } from '@azure/core-lro';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { SimplePollerLike } from '@azure/core-lro';
+
+// @public
+export type ActionType = string;
+
+// @public
+export type AsyncOperationStatus = string;
+
+// @public
+export type AzureBareMetalHardwareTypeNamesEnum = string;
+
+// @public
+export interface AzureBareMetalInstance extends TrackedResource {
+    readonly azureBareMetalInstanceId?: string;
+    hardwareProfile?: HardwareProfile;
+    readonly hwRevision?: string;
+    networkProfile?: NetworkProfile;
+    osProfile?: OSProfile;
+    partnerNodeId?: string;
+    readonly powerState?: AzureBareMetalInstancePowerStateEnum;
+    readonly provisioningState?: AzureBareMetalProvisioningStatesEnum;
+    readonly proximityPlacementGroup?: string;
+    storageProfile?: StorageProfile;
+}
+
+// @public
+export type AzureBareMetalInstanceForcePowerState = string;
+
+// @public
+export type AzureBareMetalInstancePowerStateEnum = string;
+
+// @public
+export interface AzureBareMetalInstances {
+    beginRestart(resourceGroupName: string, azureBareMetalInstanceName: string, options?: AzureBareMetalInstancesRestartOptionalParams): Promise<SimplePollerLike<OperationState<AzureBareMetalInstancesRestartResponse>, AzureBareMetalInstancesRestartResponse>>;
+    beginRestartAndWait(resourceGroupName: string, azureBareMetalInstanceName: string, options?: AzureBareMetalInstancesRestartOptionalParams): Promise<AzureBareMetalInstancesRestartResponse>;
+    beginShutdown(resourceGroupName: string, azureBareMetalInstanceName: string, options?: AzureBareMetalInstancesShutdownOptionalParams): Promise<SimplePollerLike<OperationState<AzureBareMetalInstancesShutdownResponse>, AzureBareMetalInstancesShutdownResponse>>;
+    beginShutdownAndWait(resourceGroupName: string, azureBareMetalInstanceName: string, options?: AzureBareMetalInstancesShutdownOptionalParams): Promise<AzureBareMetalInstancesShutdownResponse>;
+    beginStart(resourceGroupName: string, azureBareMetalInstanceName: string, options?: AzureBareMetalInstancesStartOptionalParams): Promise<SimplePollerLike<OperationState<AzureBareMetalInstancesStartResponse>, AzureBareMetalInstancesStartResponse>>;
+    beginStartAndWait(resourceGroupName: string, azureBareMetalInstanceName: string, options?: AzureBareMetalInstancesStartOptionalParams): Promise<AzureBareMetalInstancesStartResponse>;
+    get(resourceGroupName: string, azureBareMetalInstanceName: string, options?: AzureBareMetalInstancesGetOptionalParams): Promise<AzureBareMetalInstancesGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: AzureBareMetalInstancesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<AzureBareMetalInstance>;
+    listBySubscription(options?: AzureBareMetalInstancesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<AzureBareMetalInstance>;
+    update(resourceGroupName: string, azureBareMetalInstanceName: string, tagsParameter: Tags, options?: AzureBareMetalInstancesUpdateOptionalParams): Promise<AzureBareMetalInstancesUpdateResponse>;
+}
+
+// @public
+export interface AzureBareMetalInstancesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AzureBareMetalInstancesGetResponse = AzureBareMetalInstance;
+
+// @public
+export type AzureBareMetalInstanceSizeNamesEnum = string;
+
+// @public
+export interface AzureBareMetalInstancesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AzureBareMetalInstancesListByResourceGroupNextResponse = AzureBareMetalInstancesListResult;
+
+// @public
+export interface AzureBareMetalInstancesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AzureBareMetalInstancesListByResourceGroupResponse = AzureBareMetalInstancesListResult;
+
+// @public
+export interface AzureBareMetalInstancesListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AzureBareMetalInstancesListBySubscriptionNextResponse = AzureBareMetalInstancesListResult;
+
+// @public
+export interface AzureBareMetalInstancesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AzureBareMetalInstancesListBySubscriptionResponse = AzureBareMetalInstancesListResult;
+
+// @public
+export interface AzureBareMetalInstancesListResult {
+    nextLink?: string;
+    value?: AzureBareMetalInstance[];
+}
+
+// @public
+export interface AzureBareMetalInstancesRestartHeaders {
+    location?: string;
+}
+
+// @public
+export interface AzureBareMetalInstancesRestartOptionalParams extends coreClient.OperationOptions {
+    forceParameter?: ForceState;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type AzureBareMetalInstancesRestartResponse = OperationStatus;
+
+// @public
+export interface AzureBareMetalInstancesShutdownHeaders {
+    location?: string;
+}
+
+// @public
+export interface AzureBareMetalInstancesShutdownOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type AzureBareMetalInstancesShutdownResponse = OperationStatus;
+
+// @public
+export interface AzureBareMetalInstancesStartHeaders {
+    location?: string;
+}
+
+// @public
+export interface AzureBareMetalInstancesStartOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type AzureBareMetalInstancesStartResponse = OperationStatus;
+
+// @public
+export interface AzureBareMetalInstancesUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AzureBareMetalInstancesUpdateResponse = AzureBareMetalInstance;
+
+// @public
+export type AzureBareMetalProvisioningStatesEnum = string;
+
+// @public
+export interface AzureBareMetalStorageInstance extends TrackedResource {
+    azureBareMetalStorageInstanceUniqueIdentifier?: string;
+    storageProperties?: StorageProperties;
+}
+
+// @public
+export interface AzureBareMetalStorageInstances {
+    create(resourceGroupName: string, azureBareMetalStorageInstanceName: string, requestBodyParameters: AzureBareMetalStorageInstance, options?: AzureBareMetalStorageInstancesCreateOptionalParams): Promise<AzureBareMetalStorageInstancesCreateResponse>;
+    delete(resourceGroupName: string, azureBareMetalStorageInstanceName: string, options?: AzureBareMetalStorageInstancesDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, azureBareMetalStorageInstanceName: string, options?: AzureBareMetalStorageInstancesGetOptionalParams): Promise<AzureBareMetalStorageInstancesGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: AzureBareMetalStorageInstancesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<AzureBareMetalStorageInstance>;
+    listBySubscription(options?: AzureBareMetalStorageInstancesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<AzureBareMetalStorageInstance>;
+    update(resourceGroupName: string, azureBareMetalStorageInstanceName: string, tagsParameter: Tags, options?: AzureBareMetalStorageInstancesUpdateOptionalParams): Promise<AzureBareMetalStorageInstancesUpdateResponse>;
+}
+
+// @public
+export interface AzureBareMetalStorageInstancesCreateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AzureBareMetalStorageInstancesCreateResponse = AzureBareMetalStorageInstance;
+
+// @public
+export interface AzureBareMetalStorageInstancesDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface AzureBareMetalStorageInstancesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AzureBareMetalStorageInstancesGetResponse = AzureBareMetalStorageInstance;
+
+// @public
+export interface AzureBareMetalStorageInstancesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AzureBareMetalStorageInstancesListByResourceGroupNextResponse = AzureBareMetalStorageInstancesListResult;
+
+// @public
+export interface AzureBareMetalStorageInstancesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AzureBareMetalStorageInstancesListByResourceGroupResponse = AzureBareMetalStorageInstancesListResult;
+
+// @public
+export interface AzureBareMetalStorageInstancesListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AzureBareMetalStorageInstancesListBySubscriptionNextResponse = AzureBareMetalStorageInstancesListResult;
+
+// @public
+export interface AzureBareMetalStorageInstancesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AzureBareMetalStorageInstancesListBySubscriptionResponse = AzureBareMetalStorageInstancesListResult;
+
+// @public
+export interface AzureBareMetalStorageInstancesListResult {
+    nextLink?: string;
+    value?: AzureBareMetalStorageInstance[];
+}
+
+// @public
+export interface AzureBareMetalStorageInstancesUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AzureBareMetalStorageInstancesUpdateResponse = AzureBareMetalStorageInstance;
+
+// @public (undocumented)
+export class BareMetalInfrastructureClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: BareMetalInfrastructureClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    azureBareMetalInstances: AzureBareMetalInstances;
+    // (undocumented)
+    azureBareMetalStorageInstances: AzureBareMetalStorageInstances;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface BareMetalInfrastructureClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface Disk {
+    diskSizeGB?: number;
+    readonly lun?: number;
+    name?: string;
+}
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetail {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorDetail[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+export interface ForceState {
+    forceState?: AzureBareMetalInstanceForcePowerState;
+}
+
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export interface HardwareProfile {
+    readonly azureBareMetalInstanceSize?: AzureBareMetalInstanceSizeNamesEnum;
+    readonly hardwareType?: AzureBareMetalHardwareTypeNamesEnum;
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownAsyncOperationStatus {
+    Executing = "Executing",
+    Failed = "Failed",
+    Requesting = "Requesting",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownAzureBareMetalHardwareTypeNamesEnum {
+    CiscoUCS = "Cisco_UCS",
+    HPE = "HPE",
+    Sdflex = "SDFLEX"
+}
+
+// @public
+export enum KnownAzureBareMetalInstanceForcePowerState {
+    Active = "active",
+    Inactive = "inactive"
+}
+
+// @public
+export enum KnownAzureBareMetalInstancePowerStateEnum {
+    Restarting = "restarting",
+    Started = "started",
+    Starting = "starting",
+    Stopped = "stopped",
+    Stopping = "stopping",
+    Unknown = "unknown"
+}
+
+// @public
+export enum KnownAzureBareMetalInstanceSizeNamesEnum {
+    S112 = "S112",
+    S144 = "S144",
+    S144M = "S144m",
+    S192 = "S192",
+    S192M = "S192m",
+    S192Xm = "S192xm",
+    S224 = "S224",
+    S224M = "S224m",
+    S224Om = "S224om",
+    S224Oo = "S224oo",
+    S224Oom = "S224oom",
+    S224Ooo = "S224ooo",
+    S384 = "S384",
+    S384M = "S384m",
+    S384Xm = "S384xm",
+    S384Xxm = "S384xxm",
+    S448 = "S448",
+    S448M = "S448m",
+    S448Om = "S448om",
+    S448Oo = "S448oo",
+    S448Oom = "S448oom",
+    S448Ooo = "S448ooo",
+    S448Se = "S448se",
+    S576M = "S576m",
+    S576Xm = "S576xm",
+    S672 = "S672",
+    S672M = "S672m",
+    S672Om = "S672om",
+    S672Oo = "S672oo",
+    S672Oom = "S672oom",
+    S672Ooo = "S672ooo",
+    S72 = "S72",
+    S72M = "S72m",
+    S768 = "S768",
+    S768M = "S768m",
+    S768Xm = "S768xm",
+    S896 = "S896",
+    S896M = "S896m",
+    S896Om = "S896om",
+    S896Oo = "S896oo",
+    S896Oom = "S896oom",
+    S896Ooo = "S896ooo",
+    S96 = "S96",
+    S960M = "S960m"
+}
+
+// @public
+export enum KnownAzureBareMetalProvisioningStatesEnum {
+    Accepted = "Accepted",
+    Creating = "Creating",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Migrating = "Migrating",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Accepted = "Accepted",
+    Canceled = "Canceled",
+    Creating = "Creating",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Migrating = "Migrating",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
+// @public
+export interface NetworkInterface {
+    ipAddress?: string;
+}
+
+// @public
+export interface NetworkProfile {
+    readonly circuitId?: string;
+    networkInterfaces?: NetworkInterface[];
+}
+
+// @public
+export interface Operation {
+    readonly actionType?: ActionType;
+    display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: Origin;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    readonly nextLink?: string;
+    readonly value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationListResult;
+
+// @public
+export interface OperationStatus {
+    error?: OperationStatusError;
+    name?: string;
+    startTime?: string;
+    status?: AsyncOperationStatus;
+}
+
+// @public
+export interface OperationStatusError {
+    code?: string;
+    message?: string;
+}
+
+// @public
+export type Origin = string;
+
+// @public
+export interface OSProfile {
+    computerName?: string;
+    readonly osType?: string;
+    sshPublicKey?: string;
+    readonly version?: string;
+}
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface StorageBillingProperties {
+    azureBareMetalStorageInstanceSize?: string;
+    billingMode?: string;
+}
+
+// @public
+export interface StorageProfile {
+    readonly nfsIpAddress?: string;
+    osDisks?: Disk[];
+}
+
+// @public
+export interface StorageProperties {
+    generation?: string;
+    hardwareType?: string;
+    offeringType?: string;
+    provisioningState?: ProvisioningState;
+    storageBillingProperties?: StorageBillingProperties;
+    storageType?: string;
+    workloadType?: string;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface Tags {
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface TrackedResource extends Resource {
+    location: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// (No @packageDocumentation comment for this package)
+
+```