Clusters interface

Package:

@azure/arm-azurestackhci

Interface representing a Clusters.

Methods

beginConfigureRemoteSupport(string, string, RemoteSupportRequest, ClustersConfigureRemoteSupportOptionalParams)	Configure RemoteSupport on a cluster
beginConfigureRemoteSupportAndWait(string, string, RemoteSupportRequest, ClustersConfigureRemoteSupportOptionalParams)	Configure RemoteSupport on a cluster
beginCreateIdentity(string, string, ClustersCreateIdentityOptionalParams)	Create cluster identity.
beginCreateIdentityAndWait(string, string, ClustersCreateIdentityOptionalParams)	Create cluster identity.
beginDelete(string, string, ClustersDeleteOptionalParams)	Delete an HCI cluster.
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	Delete an HCI cluster.
beginExtendSoftwareAssuranceBenefit(string, string, SoftwareAssuranceChangeRequest, ClustersExtendSoftwareAssuranceBenefitOptionalParams)	Extends Software Assurance Benefit to a cluster
beginExtendSoftwareAssuranceBenefitAndWait(string, string, SoftwareAssuranceChangeRequest, ClustersExtendSoftwareAssuranceBenefitOptionalParams)	Extends Software Assurance Benefit to a cluster
beginTriggerLogCollection(string, string, LogCollectionRequest, ClustersTriggerLogCollectionOptionalParams)	Trigger Log Collection on a cluster
beginTriggerLogCollectionAndWait(string, string, LogCollectionRequest, ClustersTriggerLogCollectionOptionalParams)	Trigger Log Collection on a cluster
beginUploadCertificate(string, string, UploadCertificateRequest, ClustersUploadCertificateOptionalParams)	Upload certificate.
beginUploadCertificateAndWait(string, string, UploadCertificateRequest, ClustersUploadCertificateOptionalParams)	Upload certificate.
create(string, string, Cluster, ClustersCreateOptionalParams)	Create an HCI cluster.
get(string, string, ClustersGetOptionalParams)	Get HCI cluster.
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	List all HCI clusters in a resource group.
listBySubscription(ClustersListBySubscriptionOptionalParams)	List all HCI clusters in a subscription.
update(string, string, ClusterPatch, ClustersUpdateOptionalParams)	Update an HCI cluster.

Method Details

beginConfigureRemoteSupport(string, string, RemoteSupportRequest, ClustersConfigureRemoteSupportOptionalParams)

Configure RemoteSupport on a cluster

function beginConfigureRemoteSupport(resourceGroupName: string, clusterName: string, remoteSupportRequest: RemoteSupportRequest, options?: ClustersConfigureRemoteSupportOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

remoteSupportRequest

RemoteSupportRequest

Configure Remote Support Request Payload

options

ClustersConfigureRemoteSupportOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginConfigureRemoteSupportAndWait(string, string, RemoteSupportRequest, ClustersConfigureRemoteSupportOptionalParams)

Configure RemoteSupport on a cluster

function beginConfigureRemoteSupportAndWait(resourceGroupName: string, clusterName: string, remoteSupportRequest: RemoteSupportRequest, options?: ClustersConfigureRemoteSupportOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

remoteSupportRequest

RemoteSupportRequest

Configure Remote Support Request Payload

options

ClustersConfigureRemoteSupportOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginCreateIdentity(string, string, ClustersCreateIdentityOptionalParams)

Create cluster identity.

function beginCreateIdentity(resourceGroupName: string, clusterName: string, options?: ClustersCreateIdentityOptionalParams): Promise<SimplePollerLike<OperationState<ClusterIdentityResponse>, ClusterIdentityResponse>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

options

ClustersCreateIdentityOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ClusterIdentityResponse>, ClusterIdentityResponse>>

beginCreateIdentityAndWait(string, string, ClustersCreateIdentityOptionalParams)

Create cluster identity.

function beginCreateIdentityAndWait(resourceGroupName: string, clusterName: string, options?: ClustersCreateIdentityOptionalParams): Promise<ClusterIdentityResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

options

ClustersCreateIdentityOptionalParams

The options parameters.

Returns

Promise<ClusterIdentityResponse>

beginDelete(string, string, ClustersDeleteOptionalParams)

Delete an HCI cluster.

function beginDelete(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

options

ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Delete an HCI cluster.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

options

ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginExtendSoftwareAssuranceBenefit(string, string, SoftwareAssuranceChangeRequest, ClustersExtendSoftwareAssuranceBenefitOptionalParams)

Extends Software Assurance Benefit to a cluster

function beginExtendSoftwareAssuranceBenefit(resourceGroupName: string, clusterName: string, softwareAssuranceChangeRequest: SoftwareAssuranceChangeRequest, options?: ClustersExtendSoftwareAssuranceBenefitOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

softwareAssuranceChangeRequest

SoftwareAssuranceChangeRequest

Software Assurance Change Request Payload

options

ClustersExtendSoftwareAssuranceBenefitOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginExtendSoftwareAssuranceBenefitAndWait(string, string, SoftwareAssuranceChangeRequest, ClustersExtendSoftwareAssuranceBenefitOptionalParams)

Extends Software Assurance Benefit to a cluster

function beginExtendSoftwareAssuranceBenefitAndWait(resourceGroupName: string, clusterName: string, softwareAssuranceChangeRequest: SoftwareAssuranceChangeRequest, options?: ClustersExtendSoftwareAssuranceBenefitOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

softwareAssuranceChangeRequest

SoftwareAssuranceChangeRequest

Software Assurance Change Request Payload

options

ClustersExtendSoftwareAssuranceBenefitOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginTriggerLogCollection(string, string, LogCollectionRequest, ClustersTriggerLogCollectionOptionalParams)

Trigger Log Collection on a cluster

function beginTriggerLogCollection(resourceGroupName: string, clusterName: string, logCollectionRequest: LogCollectionRequest, options?: ClustersTriggerLogCollectionOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

logCollectionRequest

LogCollectionRequest

Trigger Log Collection Request Payload

options

ClustersTriggerLogCollectionOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginTriggerLogCollectionAndWait(string, string, LogCollectionRequest, ClustersTriggerLogCollectionOptionalParams)

Trigger Log Collection on a cluster

function beginTriggerLogCollectionAndWait(resourceGroupName: string, clusterName: string, logCollectionRequest: LogCollectionRequest, options?: ClustersTriggerLogCollectionOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

logCollectionRequest

LogCollectionRequest

Trigger Log Collection Request Payload

options

ClustersTriggerLogCollectionOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginUploadCertificate(string, string, UploadCertificateRequest, ClustersUploadCertificateOptionalParams)

Upload certificate.

function beginUploadCertificate(resourceGroupName: string, clusterName: string, uploadCertificateRequest: UploadCertificateRequest, options?: ClustersUploadCertificateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

uploadCertificateRequest

UploadCertificateRequest

Upload certificate request.

options

ClustersUploadCertificateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginUploadCertificateAndWait(string, string, UploadCertificateRequest, ClustersUploadCertificateOptionalParams)

Upload certificate.

function beginUploadCertificateAndWait(resourceGroupName: string, clusterName: string, uploadCertificateRequest: UploadCertificateRequest, options?: ClustersUploadCertificateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

uploadCertificateRequest

UploadCertificateRequest

Upload certificate request.

options

ClustersUploadCertificateOptionalParams

The options parameters.

Returns

Promise<void>

create(string, string, Cluster, ClustersCreateOptionalParams)

Create an HCI cluster.

function create(resourceGroupName: string, clusterName: string, cluster: Cluster, options?: ClustersCreateOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

cluster

Cluster

Details of the HCI cluster.

options

ClustersCreateOptionalParams

The options parameters.

Returns

Promise<Cluster>

get(string, string, ClustersGetOptionalParams)

Get HCI cluster.

function get(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

options

ClustersGetOptionalParams

The options parameters.

Returns

Promise<Cluster>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

List all HCI clusters in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

ClustersListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listBySubscription(ClustersListBySubscriptionOptionalParams)

List all HCI clusters in a subscription.

function listBySubscription(options?: ClustersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameters

options

ClustersListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

update(string, string, ClusterPatch, ClustersUpdateOptionalParams)

Update an HCI cluster.

function update(resourceGroupName: string, clusterName: string, cluster: ClusterPatch, options?: ClustersUpdateOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterName

string

The name of the cluster.

cluster

ClusterPatch

Details of the HCI cluster.

options

ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>