Share via

ClustersOperations interface

Package:
@azure/arm-azurestackhci

Interface representing a Clusters operations.

Properties

beginConfigureRemoteSupport
beginConfigureRemoteSupportAndWait
beginCreateIdentity
beginCreateIdentityAndWait
beginDelete
beginDeleteAndWait
beginExtendSoftwareAssuranceBenefit
beginExtendSoftwareAssuranceBenefitAndWait
beginTriggerLogCollection
beginTriggerLogCollectionAndWait
beginUpdateSecretsLocations
beginUpdateSecretsLocationsAndWait
beginUploadCertificate
beginUploadCertificateAndWait
configureRemoteSupport

Configure RemoteSupport on a cluster
create

Create an HCI cluster.
createIdentity

Create cluster identity.
delete
extendSoftwareAssuranceBenefit

Extends Software Assurance Benefit to a cluster
get

Get HCI cluster.
listByResourceGroup

List all HCI clusters in a resource group.
listBySubscription

List all HCI clusters in a subscription.
triggerLogCollection

Trigger Log Collection on a cluster
update

Update an HCI cluster.
updateSecretsLocations

Update cluster secrets locations.
uploadCertificate

Upload certificate.

Property Details

beginConfigureRemoteSupport

Warning

This API is now deprecated.

use configureRemoteSupport instead

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

Property Value

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

beginConfigureRemoteSupportAndWait

Warning

This API is now deprecated.

use configureRemoteSupport instead

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

Property Value

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

beginCreateIdentity

Warning

This API is now deprecated.

use createIdentity instead

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

Property Value

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

beginCreateIdentityAndWait

Warning

This API is now deprecated.

use createIdentity instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginExtendSoftwareAssuranceBenefit

Warning

This API is now deprecated.

use extendSoftwareAssuranceBenefit instead

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

Property Value

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

beginExtendSoftwareAssuranceBenefitAndWait

Warning

This API is now deprecated.

use extendSoftwareAssuranceBenefit instead

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

Property Value

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

beginTriggerLogCollection

Warning

This API is now deprecated.

use triggerLogCollection instead

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

Property Value

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

beginTriggerLogCollectionAndWait

Warning

This API is now deprecated.

use triggerLogCollection instead

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

Property Value

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

beginUpdateSecretsLocations

Warning

This API is now deprecated.

use updateSecretsLocations instead

beginUpdateSecretsLocations: (resourceGroupName: string, clusterName: string, body: SecretsLocationsChangeRequest, options?: ClustersUpdateSecretsLocationsOptionalParams) => Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Property Value

(resourceGroupName: string, clusterName: string, body: SecretsLocationsChangeRequest, options?: ClustersUpdateSecretsLocationsOptionalParams) => Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpdateSecretsLocationsAndWait

Warning

This API is now deprecated.

use updateSecretsLocations instead

beginUpdateSecretsLocationsAndWait: (resourceGroupName: string, clusterName: string, body: SecretsLocationsChangeRequest, options?: ClustersUpdateSecretsLocationsOptionalParams) => Promise<Cluster>

Property Value

(resourceGroupName: string, clusterName: string, body: SecretsLocationsChangeRequest, options?: ClustersUpdateSecretsLocationsOptionalParams) => Promise<Cluster>

beginUploadCertificate

Warning

This API is now deprecated.

use uploadCertificate instead

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

Property Value

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

beginUploadCertificateAndWait

Warning

This API is now deprecated.

use uploadCertificate instead

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

Property Value

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

configureRemoteSupport

Configure RemoteSupport on a cluster

configureRemoteSupport: (resourceGroupName: string, clusterName: string, remoteSupportRequest: RemoteSupportRequest, options?: ClustersConfigureRemoteSupportOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, remoteSupportRequest: RemoteSupportRequest, options?: ClustersConfigureRemoteSupportOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

create

Create an HCI cluster.

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

Property Value

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

createIdentity

Create cluster identity.

createIdentity: (resourceGroupName: string, clusterName: string, options?: ClustersCreateIdentityOptionalParams) => PollerLike<OperationState<ClusterIdentityResponse>, ClusterIdentityResponse>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersCreateIdentityOptionalParams) => PollerLike<OperationState<ClusterIdentityResponse>, ClusterIdentityResponse>

delete 

delete: (resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

extendSoftwareAssuranceBenefit

Extends Software Assurance Benefit to a cluster

extendSoftwareAssuranceBenefit: (resourceGroupName: string, clusterName: string, softwareAssuranceChangeRequest: SoftwareAssuranceChangeRequest, options?: ClustersExtendSoftwareAssuranceBenefitOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, softwareAssuranceChangeRequest: SoftwareAssuranceChangeRequest, options?: ClustersExtendSoftwareAssuranceBenefitOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

get

Get HCI cluster.

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

Property Value

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

listByResourceGroup

List all HCI clusters in a resource group.

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

Property Value

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

listBySubscription

List all HCI clusters in a subscription.

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

Property Value

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

triggerLogCollection

Trigger Log Collection on a cluster

triggerLogCollection: (resourceGroupName: string, clusterName: string, logCollectionRequest: LogCollectionRequest, options?: ClustersTriggerLogCollectionOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, logCollectionRequest: LogCollectionRequest, options?: ClustersTriggerLogCollectionOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

update

Update an HCI cluster.

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

Property Value

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

updateSecretsLocations

Update cluster secrets locations.

updateSecretsLocations: (resourceGroupName: string, clusterName: string, body: SecretsLocationsChangeRequest, options?: ClustersUpdateSecretsLocationsOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, body: SecretsLocationsChangeRequest, options?: ClustersUpdateSecretsLocationsOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

uploadCertificate

Upload certificate.

uploadCertificate: (resourceGroupName: string, clusterName: string, uploadCertificateRequest: UploadCertificateRequest, options?: ClustersUploadCertificateOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, uploadCertificateRequest: UploadCertificateRequest, options?: ClustersUploadCertificateOptionalParams) => PollerLike<OperationState<void>, void>