Clusters interface
Interface representing a Clusters.
Methods
| begin |
Create a Cluster |
| begin |
Create a Cluster |
| begin |
Delete a Cluster |
| begin |
Delete a Cluster |
| begin |
Update a Cluster |
| begin |
Update a Cluster |
| get(string, string, string, Clusters |
Get a Cluster |
| list(string, string, Clusters |
List Cluster resources by PrivateCloud |
| list |
List hosts by zone in a cluster |
Method Details
beginCreateOrUpdate(string, string, string, Cluster, ClustersCreateOrUpdateOptionalParams)
Create a Cluster
function beginCreateOrUpdate(resourceGroupName: string, privateCloudName: string, clusterName: string, cluster: Cluster, options?: ClustersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- privateCloudName
-
string
Name of the private cloud
- clusterName
-
string
Name of the cluster
- cluster
- Cluster
Resource create parameters.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>
beginCreateOrUpdateAndWait(string, string, string, Cluster, ClustersCreateOrUpdateOptionalParams)
Create a Cluster
function beginCreateOrUpdateAndWait(resourceGroupName: string, privateCloudName: string, clusterName: string, cluster: Cluster, options?: ClustersCreateOrUpdateOptionalParams): Promise<Cluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- privateCloudName
-
string
Name of the private cloud
- clusterName
-
string
Name of the cluster
- cluster
- Cluster
Resource create parameters.
The options parameters.
Returns
Promise<Cluster>
beginDelete(string, string, string, ClustersDeleteOptionalParams)
Delete a Cluster
function beginDelete(resourceGroupName: string, privateCloudName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- privateCloudName
-
string
Name of the private cloud
- clusterName
-
string
Name of the cluster
- options
- ClustersDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ClustersDeleteOptionalParams)
Delete a Cluster
function beginDeleteAndWait(resourceGroupName: string, privateCloudName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- privateCloudName
-
string
Name of the private cloud
- clusterName
-
string
Name of the cluster
- options
- ClustersDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, ClusterUpdate, ClustersUpdateOptionalParams)
Update a Cluster
function beginUpdate(resourceGroupName: string, privateCloudName: string, clusterName: string, clusterUpdate: ClusterUpdate, options?: ClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- privateCloudName
-
string
Name of the private cloud
- clusterName
-
string
Name of the cluster
- clusterUpdate
- ClusterUpdate
The cluster properties to be updated.
- options
- ClustersUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>
beginUpdateAndWait(string, string, string, ClusterUpdate, ClustersUpdateOptionalParams)
Update a Cluster
function beginUpdateAndWait(resourceGroupName: string, privateCloudName: string, clusterName: string, clusterUpdate: ClusterUpdate, options?: ClustersUpdateOptionalParams): Promise<Cluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- privateCloudName
-
string
Name of the private cloud
- clusterName
-
string
Name of the cluster
- clusterUpdate
- ClusterUpdate
The cluster properties to be updated.
- options
- ClustersUpdateOptionalParams
The options parameters.
Returns
Promise<Cluster>
get(string, string, string, ClustersGetOptionalParams)
Get a Cluster
function get(resourceGroupName: string, privateCloudName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<Cluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- privateCloudName
-
string
Name of the private cloud
- clusterName
-
string
Name of the cluster
- options
- ClustersGetOptionalParams
The options parameters.
Returns
Promise<Cluster>
list(string, string, ClustersListOptionalParams)
List Cluster resources by PrivateCloud
function list(resourceGroupName: string, privateCloudName: string, options?: ClustersListOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- privateCloudName
-
string
Name of the private cloud
- options
- ClustersListOptionalParams
The options parameters.
Returns
listZones(string, string, string, ClustersListZonesOptionalParams)
List hosts by zone in a cluster
function listZones(resourceGroupName: string, privateCloudName: string, clusterName: string, options?: ClustersListZonesOptionalParams): Promise<ClusterZoneList>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- privateCloudName
-
string
Name of the private cloud
- clusterName
-
string
Name of the cluster
- options
- ClustersListZonesOptionalParams
The options parameters.
Returns
Promise<ClusterZoneList>