@azure/arm-azurestackhci package

Classes

AzureStackHCIClient

Interfaces

ArcConnectivityProperties	Connectivity related configuration required by arc server.
ArcIdentityResponse	ArcIdentity details.
ArcSetting	ArcSetting details.
ArcSettingList	List of ArcSetting proxy resources for the HCI cluster.
ArcSettings	Interface representing a ArcSettings.
ArcSettingsCreateIdentityOptionalParams	Optional parameters.
ArcSettingsCreateOptionalParams	Optional parameters.
ArcSettingsDeleteOptionalParams	Optional parameters.
ArcSettingsGeneratePasswordOptionalParams	Optional parameters.
ArcSettingsGetOptionalParams	Optional parameters.
ArcSettingsListByClusterNextOptionalParams	Optional parameters.
ArcSettingsListByClusterOptionalParams	Optional parameters.
ArcSettingsPatch	ArcSetting details to update.
ArcSettingsUpdateOptionalParams	Optional parameters.
AzureStackHCIClientOptionalParams	Optional parameters.
Cluster	Cluster details.
ClusterDesiredProperties	Desired properties of the cluster.
ClusterIdentityResponse	Cluster Identity details.
ClusterList	List of clusters.
ClusterNode	Cluster node details.
ClusterPatch	Cluster details to update.
ClusterReportedProperties	Properties reported by cluster agent.
Clusters	Interface representing a Clusters.
ClustersCreateIdentityOptionalParams	Optional parameters.
ClustersCreateOptionalParams	Optional parameters.
ClustersDeleteOptionalParams	Optional parameters.
ClustersGetOptionalParams	Optional parameters.
ClustersListByResourceGroupNextOptionalParams	Optional parameters.
ClustersListByResourceGroupOptionalParams	Optional parameters.
ClustersListBySubscriptionNextOptionalParams	Optional parameters.
ClustersListBySubscriptionOptionalParams	Optional parameters.
ClustersUpdateOptionalParams	Optional parameters.
ClustersUploadCertificateOptionalParams	Optional parameters.
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.).
Extension	Details of a particular extension in HCI Cluster.
ExtensionList	List of Extensions in HCI cluster.
Extensions	Interface representing a Extensions.
ExtensionsCreateOptionalParams	Optional parameters.
ExtensionsDeleteOptionalParams	Optional parameters.
ExtensionsGetOptionalParams	Optional parameters.
ExtensionsListByArcSettingNextOptionalParams	Optional parameters.
ExtensionsListByArcSettingOptionalParams	Optional parameters.
ExtensionsUpdateOptionalParams	Optional parameters.
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.
Operations	Interface representing a Operations.
OperationsListOptionalParams	Optional parameters.
PasswordCredential
PerNodeExtensionState	Status of Arc Extension for a particular node in HCI Cluster.
PerNodeState	Status of Arc agent for a particular node in HCI Cluster.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RawCertificateData
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UploadCertificateRequest

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
ArcSettingAggregateState	Defines values for ArcSettingAggregateState. KnownArcSettingAggregateState can be used interchangeably with ArcSettingAggregateState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Error Succeeded Canceled Failed Connected Disconnected Deleted Creating Updating Deleting Moving PartiallySucceeded PartiallyConnected InProgress
ArcSettingsCreateIdentityResponse	Contains response data for the createIdentity operation.
ArcSettingsCreateResponse	Contains response data for the create operation.
ArcSettingsGeneratePasswordResponse	Contains response data for the generatePassword operation.
ArcSettingsGetResponse	Contains response data for the get operation.
ArcSettingsListByClusterNextResponse	Contains response data for the listByClusterNext operation.
ArcSettingsListByClusterResponse	Contains response data for the listByCluster operation.
ArcSettingsUpdateResponse	Contains response data for the update operation.
ClustersCreateIdentityResponse	Contains response data for the createIdentity operation.
ClustersCreateResponse	Contains response data for the create operation.
ClustersGetResponse	Contains response data for the get operation.
ClustersListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
ClustersListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ClustersListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
ClustersListBySubscriptionResponse	Contains response data for the listBySubscription operation.
ClustersUpdateResponse	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
DiagnosticLevel	Defines values for DiagnosticLevel. KnownDiagnosticLevel can be used interchangeably with DiagnosticLevel, this enum contains the known values that the service supports. Known values supported by the service Off Basic Enhanced
ExtensionAggregateState	Defines values for ExtensionAggregateState. KnownExtensionAggregateState can be used interchangeably with ExtensionAggregateState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Error Succeeded Canceled Failed Connected Disconnected Deleted Creating Updating Deleting Moving PartiallySucceeded PartiallyConnected InProgress
ExtensionsCreateResponse	Contains response data for the create operation.
ExtensionsGetResponse	Contains response data for the get operation.
ExtensionsListByArcSettingNextResponse	Contains response data for the listByArcSettingNext operation.
ExtensionsListByArcSettingResponse	Contains response data for the listByArcSetting operation.
ExtensionsUpdateResponse	Contains response data for the update operation.
ImdsAttestation	Defines values for ImdsAttestation. KnownImdsAttestation can be used interchangeably with ImdsAttestation, this enum contains the known values that the service supports. Known values supported by the service Disabled Enabled
NodeArcState	Defines values for NodeArcState. KnownNodeArcState can be used interchangeably with NodeArcState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Error Succeeded Canceled Failed Connected Disconnected Deleted Creating Updating Deleting Moving
NodeExtensionState	Defines values for NodeExtensionState. KnownNodeExtensionState can be used interchangeably with NodeExtensionState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Error Succeeded Canceled Failed Connected Disconnected Deleted Creating Updating Deleting Moving
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 Succeeded Failed Canceled Accepted Provisioning
Status	Defines values for Status. KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports. Known values supported by the service NotYetRegistered ConnectedRecently NotConnectedRecently Disconnected Error
WindowsServerSubscription	Defines values for WindowsServerSubscription. KnownWindowsServerSubscription can be used interchangeably with WindowsServerSubscription, this enum contains the known values that the service supports. Known values supported by the service Disabled Enabled

Enums

KnownActionType	Known values of ActionType that the service accepts.
KnownArcSettingAggregateState	Known values of ArcSettingAggregateState that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownDiagnosticLevel	Known values of DiagnosticLevel that the service accepts.
KnownExtensionAggregateState	Known values of ExtensionAggregateState that the service accepts.
KnownImdsAttestation	Known values of ImdsAttestation that the service accepts.
KnownNodeArcState	Known values of NodeArcState that the service accepts.
KnownNodeExtensionState	Known values of NodeExtensionState that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownStatus	Known values of Status that the service accepts.
KnownWindowsServerSubscription	Known values of WindowsServerSubscription that the service accepts.

Functions

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

A result object from calling .byPage() on a paged operation.

Returns

string | undefined

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