Clusters interface
Interface representing a Clusters.
Methods
Method Details
beginCreateIdentity(string, string, ClustersCreateIdentityOptionalParams)
Create cluster identity.
function beginCreateIdentity(resourceGroupName: string, clusterName: string, options?: ClustersCreateIdentityOptionalParams): Promise<PollerLike<PollOperationState<ClusterIdentityResponse>, ClusterIdentityResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<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.
The options parameters.
Returns
Promise<ClusterIdentityResponse>
beginDelete(string, string, ClustersDeleteOptionalParams)
Delete an HCI cluster.
function beginDelete(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<PollerLike<PollOperationState<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<PollerLike<@azure/core-lro.PollOperationState<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>
beginUploadCertificate(string, string, UploadCertificateRequest, ClustersUploadCertificateOptionalParams)
Upload certificate.
function beginUploadCertificate(resourceGroupName: string, clusterName: string, uploadCertificateRequest: UploadCertificateRequest, options?: ClustersUploadCertificateOptionalParams): Promise<PollerLike<PollOperationState<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.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<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.
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.
The options parameters.
Returns
listBySubscription(ClustersListBySubscriptionOptionalParams)
List all HCI clusters in a subscription.
function listBySubscription(options?: ClustersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>Parameters
The options parameters.
Returns
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>