arm-azurestackhci.api.md

API Report File for "@azure/arm-azurestackhci"

Do not edit this file. It is a report generated by API Extractor.

import * as coreAuth from '@azure/core-auth';
import * as coreClient from '@azure/core-client';
import { PagedAsyncIterableIterator } from '@azure/core-paging';
import { PollerLike } from '@azure/core-lro';
import { PollOperationState } from '@azure/core-lro';

// @public
export type ActionType = string;

// @public
export interface ArcConnectivityProperties {
    enabled?: boolean;
}

// @public
export interface ArcIdentityResponse {
    // (undocumented)
    arcApplicationClientId?: string;
    // (undocumented)
    arcApplicationObjectId?: string;
    // (undocumented)
    arcApplicationTenantId?: string;
    // (undocumented)
    arcServicePrincipalObjectId?: string;
}

// @public
export type ArcSetting = ProxyResource & {
    readonly provisioningState?: ProvisioningState;
    arcInstanceResourceGroup?: string;
    arcApplicationClientId?: string;
    arcApplicationTenantId?: string;
    arcServicePrincipalObjectId?: string;
    arcApplicationObjectId?: string;
    readonly aggregateState?: ArcSettingAggregateState;
    readonly perNodeDetails?: PerNodeState[];
    connectivityProperties?: Record<string, unknown>;
    createdBy?: string;
    createdByType?: CreatedByType;
    createdAt?: Date;
    lastModifiedBy?: string;
    lastModifiedByType?: CreatedByType;
    lastModifiedAt?: Date;
};

// @public
export type ArcSettingAggregateState = string;

// @public
export interface ArcSettingList {
    readonly nextLink?: string;
    readonly value?: ArcSetting[];
}

// @public
export interface ArcSettings {
    beginCreateIdentity(resourceGroupName: string, clusterName: string, arcSettingName: string, options?: ArcSettingsCreateIdentityOptionalParams): Promise<PollerLike<PollOperationState<ArcSettingsCreateIdentityResponse>, ArcSettingsCreateIdentityResponse>>;
    beginCreateIdentityAndWait(resourceGroupName: string, clusterName: string, arcSettingName: string, options?: ArcSettingsCreateIdentityOptionalParams): Promise<ArcSettingsCreateIdentityResponse>;
    beginDelete(resourceGroupName: string, clusterName: string, arcSettingName: string, options?: ArcSettingsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, clusterName: string, arcSettingName: string, options?: ArcSettingsDeleteOptionalParams): Promise<void>;
    create(resourceGroupName: string, clusterName: string, arcSettingName: string, arcSetting: ArcSetting, options?: ArcSettingsCreateOptionalParams): Promise<ArcSettingsCreateResponse>;
    generatePassword(resourceGroupName: string, clusterName: string, arcSettingName: string, options?: ArcSettingsGeneratePasswordOptionalParams): Promise<ArcSettingsGeneratePasswordResponse>;
    get(resourceGroupName: string, clusterName: string, arcSettingName: string, options?: ArcSettingsGetOptionalParams): Promise<ArcSettingsGetResponse>;
    listByCluster(resourceGroupName: string, clusterName: string, options?: ArcSettingsListByClusterOptionalParams): PagedAsyncIterableIterator<ArcSetting>;
    update(resourceGroupName: string, clusterName: string, arcSettingName: string, arcSetting: ArcSettingsPatch, options?: ArcSettingsUpdateOptionalParams): Promise<ArcSettingsUpdateResponse>;
}

// @public
export interface ArcSettingsCreateIdentityOptionalParams extends coreClient.OperationOptions {
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export type ArcSettingsCreateIdentityResponse = ArcIdentityResponse;

// @public
export interface ArcSettingsCreateOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ArcSettingsCreateResponse = ArcSetting;

// @public
export interface ArcSettingsDeleteOptionalParams extends coreClient.OperationOptions {
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export interface ArcSettingsGeneratePasswordOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ArcSettingsGeneratePasswordResponse = PasswordCredential;

// @public
export interface ArcSettingsGetOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ArcSettingsGetResponse = ArcSetting;

// @public
export interface ArcSettingsListByClusterNextOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ArcSettingsListByClusterNextResponse = ArcSettingList;

// @public
export interface ArcSettingsListByClusterOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ArcSettingsListByClusterResponse = ArcSettingList;

// @public
export interface ArcSettingsPatch {
    connectivityProperties?: Record<string, unknown>;
    tags?: {
        [propertyName: string]: string;
    };
}

// @public
export interface ArcSettingsUpdateOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ArcSettingsUpdateResponse = ArcSetting;

// @public (undocumented)
export class AzureStackHCIClient extends coreClient.ServiceClient {
    // (undocumented)
    $host: string;
    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureStackHCIClientOptionalParams);
    // (undocumented)
    apiVersion: string;
    // (undocumented)
    arcSettings: ArcSettings;
    // (undocumented)
    clusters: Clusters;
    // (undocumented)
    extensions: Extensions;
    // (undocumented)
    operations: Operations;
    // (undocumented)
    subscriptionId: string;
}

// @public
export interface AzureStackHCIClientOptionalParams extends coreClient.ServiceClientOptions {
    $host?: string;
    apiVersion?: string;
    endpoint?: string;
}

// @public
export type Cluster = TrackedResource & {
    readonly provisioningState?: ProvisioningState;
    readonly status?: Status;
    readonly cloudId?: string;
    cloudManagementEndpoint?: string;
    aadClientId?: string;
    aadTenantId?: string;
    aadApplicationObjectId?: string;
    aadServicePrincipalObjectId?: string;
    desiredProperties?: ClusterDesiredProperties;
    readonly reportedProperties?: ClusterReportedProperties;
    readonly trialDaysRemaining?: number;
    readonly billingModel?: string;
    readonly registrationTimestamp?: Date;
    readonly lastSyncTimestamp?: Date;
    readonly lastBillingTimestamp?: Date;
    readonly serviceEndpoint?: string;
    createdBy?: string;
    createdByType?: CreatedByType;
    createdAt?: Date;
    lastModifiedBy?: string;
    lastModifiedByType?: CreatedByType;
    lastModifiedAt?: Date;
};

// @public
export interface ClusterDesiredProperties {
    diagnosticLevel?: DiagnosticLevel;
    windowsServerSubscription?: WindowsServerSubscription;
}

// @public
export interface ClusterIdentityResponse {
    // (undocumented)
    aadApplicationObjectId?: string;
    // (undocumented)
    aadClientId?: string;
    // (undocumented)
    aadServicePrincipalObjectId?: string;
    // (undocumented)
    aadTenantId?: string;
}

// @public
export interface ClusterList {
    readonly nextLink?: string;
    value?: Cluster[];
}

// @public
export interface ClusterNode {
    readonly coreCount?: number;
    readonly id?: number;
    readonly manufacturer?: string;
    readonly memoryInGiB?: number;
    readonly model?: string;
    readonly name?: string;
    readonly osName?: string;
    readonly osVersion?: string;
    readonly serialNumber?: string;
    readonly windowsServerSubscription?: WindowsServerSubscription;
}

// @public
export interface ClusterPatch {
    aadClientId?: string;
    aadTenantId?: string;
    cloudManagementEndpoint?: string;
    desiredProperties?: ClusterDesiredProperties;
    tags?: {
        [propertyName: string]: string;
    };
}

// @public
export interface ClusterReportedProperties {
    readonly clusterId?: string;
    readonly clusterName?: string;
    readonly clusterVersion?: string;
    diagnosticLevel?: DiagnosticLevel;
    readonly imdsAttestation?: ImdsAttestation;
    readonly lastUpdated?: Date;
    readonly nodes?: ClusterNode[];
}

// @public
export interface Clusters {
    beginCreateIdentity(resourceGroupName: string, clusterName: string, options?: ClustersCreateIdentityOptionalParams): Promise<PollerLike<PollOperationState<ClustersCreateIdentityResponse>, ClustersCreateIdentityResponse>>;
    beginCreateIdentityAndWait(resourceGroupName: string, clusterName: string, options?: ClustersCreateIdentityOptionalParams): Promise<ClustersCreateIdentityResponse>;
    beginDelete(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<void>;
    beginUploadCertificate(resourceGroupName: string, clusterName: string, uploadCertificateRequest: UploadCertificateRequest, options?: ClustersUploadCertificateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
    beginUploadCertificateAndWait(resourceGroupName: string, clusterName: string, uploadCertificateRequest: UploadCertificateRequest, options?: ClustersUploadCertificateOptionalParams): Promise<void>;
    create(resourceGroupName: string, clusterName: string, cluster: Cluster, options?: ClustersCreateOptionalParams): Promise<ClustersCreateResponse>;
    get(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<ClustersGetResponse>;
    listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster>;
    listBySubscription(options?: ClustersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Cluster>;
    update(resourceGroupName: string, clusterName: string, cluster: ClusterPatch, options?: ClustersUpdateOptionalParams): Promise<ClustersUpdateResponse>;
}

// @public
export interface ClustersCreateIdentityOptionalParams extends coreClient.OperationOptions {
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export type ClustersCreateIdentityResponse = ClusterIdentityResponse;

// @public
export interface ClustersCreateOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ClustersCreateResponse = Cluster;

// @public
export interface ClustersDeleteOptionalParams extends coreClient.OperationOptions {
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export interface ClustersGetOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ClustersGetResponse = Cluster;

// @public
export interface ClustersListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ClustersListByResourceGroupNextResponse = ClusterList;

// @public
export interface ClustersListByResourceGroupOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ClustersListByResourceGroupResponse = ClusterList;

// @public
export interface ClustersListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ClustersListBySubscriptionNextResponse = ClusterList;

// @public
export interface ClustersListBySubscriptionOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ClustersListBySubscriptionResponse = ClusterList;

// @public
export interface ClustersUpdateOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ClustersUpdateResponse = Cluster;

// @public
export interface ClustersUploadCertificateOptionalParams extends coreClient.OperationOptions {
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export type CreatedByType = string;

// @public
export type DiagnosticLevel = 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 type Extension = ProxyResource & {
    readonly provisioningState?: ProvisioningState;
    readonly aggregateState?: ExtensionAggregateState;
    readonly perNodeExtensionDetails?: PerNodeExtensionState[];
    forceUpdateTag?: string;
    publisher?: string;
    typePropertiesExtensionParametersType?: string;
    typeHandlerVersion?: string;
    autoUpgradeMinorVersion?: boolean;
    settings?: Record<string, unknown>;
    protectedSettings?: Record<string, unknown>;
    createdBy?: string;
    createdByType?: CreatedByType;
    createdAt?: Date;
    lastModifiedBy?: string;
    lastModifiedByType?: CreatedByType;
    lastModifiedAt?: Date;
};

// @public
export type ExtensionAggregateState = string;

// @public
export interface ExtensionList {
    readonly nextLink?: string;
    readonly value?: Extension[];
}

// @public
export interface Extensions {
    beginCreate(resourceGroupName: string, clusterName: string, arcSettingName: string, extensionName: string, extension: Extension, options?: ExtensionsCreateOptionalParams): Promise<PollerLike<PollOperationState<ExtensionsCreateResponse>, ExtensionsCreateResponse>>;
    beginCreateAndWait(resourceGroupName: string, clusterName: string, arcSettingName: string, extensionName: string, extension: Extension, options?: ExtensionsCreateOptionalParams): Promise<ExtensionsCreateResponse>;
    beginDelete(resourceGroupName: string, clusterName: string, arcSettingName: string, extensionName: string, options?: ExtensionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, clusterName: string, arcSettingName: string, extensionName: string, options?: ExtensionsDeleteOptionalParams): Promise<void>;
    beginUpdate(resourceGroupName: string, clusterName: string, arcSettingName: string, extensionName: string, extension: Extension, options?: ExtensionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<ExtensionsUpdateResponse>, ExtensionsUpdateResponse>>;
    beginUpdateAndWait(resourceGroupName: string, clusterName: string, arcSettingName: string, extensionName: string, extension: Extension, options?: ExtensionsUpdateOptionalParams): Promise<ExtensionsUpdateResponse>;
    get(resourceGroupName: string, clusterName: string, arcSettingName: string, extensionName: string, options?: ExtensionsGetOptionalParams): Promise<ExtensionsGetResponse>;
    listByArcSetting(resourceGroupName: string, clusterName: string, arcSettingName: string, options?: ExtensionsListByArcSettingOptionalParams): PagedAsyncIterableIterator<Extension>;
}

// @public
export interface ExtensionsCreateOptionalParams extends coreClient.OperationOptions {
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export type ExtensionsCreateResponse = Extension;

// @public
export interface ExtensionsDeleteOptionalParams extends coreClient.OperationOptions {
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export interface ExtensionsGetOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ExtensionsGetResponse = Extension;

// @public
export interface ExtensionsListByArcSettingNextOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ExtensionsListByArcSettingNextResponse = ExtensionList;

// @public
export interface ExtensionsListByArcSettingOptionalParams extends coreClient.OperationOptions {
}

// @public
export type ExtensionsListByArcSettingResponse = ExtensionList;

// @public
export interface ExtensionsUpdateOptionalParams extends coreClient.OperationOptions {
    resumeFrom?: string;
    updateIntervalInMs?: number;
}

// @public
export type ExtensionsUpdateResponse = Extension;

// @public
export type ImdsAttestation = string;

// @public
export enum KnownActionType {
    // (undocumented)
    Internal = "Internal"
}

// @public
export enum KnownArcSettingAggregateState {
    // (undocumented)
    Canceled = "Canceled",
    // (undocumented)
    Connected = "Connected",
    // (undocumented)
    Creating = "Creating",
    // (undocumented)
    Deleted = "Deleted",
    // (undocumented)
    Deleting = "Deleting",
    // (undocumented)
    Disconnected = "Disconnected",
    // (undocumented)
    Error = "Error",
    // (undocumented)
    Failed = "Failed",
    // (undocumented)
    InProgress = "InProgress",
    // (undocumented)
    Moving = "Moving",
    // (undocumented)
    NotSpecified = "NotSpecified",
    // (undocumented)
    PartiallyConnected = "PartiallyConnected",
    // (undocumented)
    PartiallySucceeded = "PartiallySucceeded",
    // (undocumented)
    Succeeded = "Succeeded",
    // (undocumented)
    Updating = "Updating"
}

// @public
export enum KnownCreatedByType {
    // (undocumented)
    Application = "Application",
    // (undocumented)
    Key = "Key",
    // (undocumented)
    ManagedIdentity = "ManagedIdentity",
    // (undocumented)
    User = "User"
}

// @public
export enum KnownDiagnosticLevel {
    // (undocumented)
    Basic = "Basic",
    // (undocumented)
    Enhanced = "Enhanced",
    // (undocumented)
    Off = "Off"
}

// @public
export enum KnownExtensionAggregateState {
    // (undocumented)
    Canceled = "Canceled",
    // (undocumented)
    Connected = "Connected",
    // (undocumented)
    Creating = "Creating",
    // (undocumented)
    Deleted = "Deleted",
    // (undocumented)
    Deleting = "Deleting",
    // (undocumented)
    Disconnected = "Disconnected",
    // (undocumented)
    Error = "Error",
    // (undocumented)
    Failed = "Failed",
    // (undocumented)
    InProgress = "InProgress",
    // (undocumented)
    Moving = "Moving",
    // (undocumented)
    NotSpecified = "NotSpecified",
    // (undocumented)
    PartiallyConnected = "PartiallyConnected",
    // (undocumented)
    PartiallySucceeded = "PartiallySucceeded",
    // (undocumented)
    Succeeded = "Succeeded",
    // (undocumented)
    Updating = "Updating"
}

// @public
export enum KnownImdsAttestation {
    // (undocumented)
    Disabled = "Disabled",
    // (undocumented)
    Enabled = "Enabled"
}

// @public
export enum KnownNodeArcState {
    // (undocumented)
    Canceled = "Canceled",
    // (undocumented)
    Connected = "Connected",
    // (undocumented)
    Creating = "Creating",
    // (undocumented)
    Deleted = "Deleted",
    // (undocumented)
    Deleting = "Deleting",
    // (undocumented)
    Disconnected = "Disconnected",
    // (undocumented)
    Error = "Error",
    // (undocumented)
    Failed = "Failed",
    // (undocumented)
    Moving = "Moving",
    // (undocumented)
    NotSpecified = "NotSpecified",
    // (undocumented)
    Succeeded = "Succeeded",
    // (undocumented)
    Updating = "Updating"
}

// @public
export enum KnownNodeExtensionState {
    // (undocumented)
    Canceled = "Canceled",
    // (undocumented)
    Connected = "Connected",
    // (undocumented)
    Creating = "Creating",
    // (undocumented)
    Deleted = "Deleted",
    // (undocumented)
    Deleting = "Deleting",
    // (undocumented)
    Disconnected = "Disconnected",
    // (undocumented)
    Error = "Error",
    // (undocumented)
    Failed = "Failed",
    // (undocumented)
    Moving = "Moving",
    // (undocumented)
    NotSpecified = "NotSpecified",
    // (undocumented)
    Succeeded = "Succeeded",
    // (undocumented)
    Updating = "Updating"
}

// @public
export enum KnownOrigin {
    // (undocumented)
    System = "system",
    // (undocumented)
    User = "user",
    // (undocumented)
    UserSystem = "user,system"
}

// @public
export enum KnownProvisioningState {
    // (undocumented)
    Accepted = "Accepted",
    // (undocumented)
    Canceled = "Canceled",
    // (undocumented)
    Failed = "Failed",
    // (undocumented)
    Provisioning = "Provisioning",
    // (undocumented)
    Succeeded = "Succeeded"
}

// @public
export enum KnownStatus {
    // (undocumented)
    ConnectedRecently = "ConnectedRecently",
    // (undocumented)
    Disconnected = "Disconnected",
    // (undocumented)
    Error = "Error",
    // (undocumented)
    NotConnectedRecently = "NotConnectedRecently",
    // (undocumented)
    NotYetRegistered = "NotYetRegistered"
}

// @public
export enum KnownWindowsServerSubscription {
    // (undocumented)
    Disabled = "Disabled",
    // (undocumented)
    Enabled = "Enabled"
}

// @public
export type NodeArcState = string;

// @public
export type NodeExtensionState = string;

// @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): Promise<OperationsListResponse>;
}

// @public
export interface OperationsListOptionalParams extends coreClient.OperationOptions {
}

// @public
export type OperationsListResponse = OperationListResult;

// @public
export type Origin = string;

// @public (undocumented)
export interface PasswordCredential {
    // (undocumented)
    endDateTime?: Date;
    // (undocumented)
    keyId?: string;
    // (undocumented)
    secretText?: string;
    // (undocumented)
    startDateTime?: Date;
}

// @public
export interface PerNodeExtensionState {
    readonly extension?: string;
    readonly name?: string;
    readonly state?: NodeExtensionState;
}

// @public
export interface PerNodeState {
    readonly arcInstance?: string;
    readonly name?: string;
    readonly state?: NodeArcState;
}

// @public
export type ProvisioningState = string;

// @public
export type ProxyResource = Resource & {};

// @public (undocumented)
export interface RawCertificateData {
    // (undocumented)
    certificates?: string[];
}

// @public
export interface Resource {
    readonly id?: string;
    readonly name?: string;
    readonly type?: string;
}

// @public
export type Status = string;

// @public
export type TrackedResource = Resource & {
    tags?: {
        [propertyName: string]: string;
    };
    location: string;
};

// @public (undocumented)
export interface UploadCertificateRequest {
    // (undocumented)
    properties?: RawCertificateData;
}

// @public
export type WindowsServerSubscription = string;

// (No @packageDocumentation comment for this package)