Clusters interface
Interface representing a Clusters.
Methods
| begin |
Create Or Update cluster. |
| begin |
Create Or Update cluster. |
| begin |
Implements cluster DELETE method. |
| begin |
Implements cluster DELETE method. |
| get(string, string, Clusters |
Implements cluster GET method. |
| list(Clusters |
List of clusters in a subscription. |
| list |
List of clusters in a resource group. |
| update(string, string, Clusters |
API to update certain properties of the cluster resource. |
Method Details
beginCreate(string, string, ClustersCreateOptionalParams)
Create Or Update cluster.
function beginCreate(resourceGroupName: string, clusterName: string, options?: ClustersCreateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>Parameters
- resourceGroupName
-
string
The Resource Group Name.
- clusterName
-
string
Name of the cluster.
- options
- ClustersCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>
beginCreateAndWait(string, string, ClustersCreateOptionalParams)
Create Or Update cluster.
function beginCreateAndWait(resourceGroupName: string, clusterName: string, options?: ClustersCreateOptionalParams): Promise<Cluster>Parameters
- resourceGroupName
-
string
The Resource Group Name.
- clusterName
-
string
Name of the cluster.
- options
- ClustersCreateOptionalParams
The options parameters.
Returns
Promise<Cluster>
beginDelete(string, string, ClustersDeleteOptionalParams)
Implements cluster DELETE method.
function beginDelete(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The Resource Group Name.
- clusterName
-
string
Name of the cluster.
- options
- ClustersDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)
Implements cluster DELETE method.
function beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The Resource Group Name.
- clusterName
-
string
Name of the cluster.
- options
- ClustersDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, ClustersGetOptionalParams)
Implements cluster GET method.
function get(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<Cluster>Parameters
- resourceGroupName
-
string
The Resource Group Name.
- clusterName
-
string
Name of the cluster.
- options
- ClustersGetOptionalParams
The options parameters.
Returns
Promise<Cluster>
list(ClustersListOptionalParams)
List of clusters in a subscription.
function list(options?: ClustersListOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>Parameters
- options
- ClustersListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)
List of clusters in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>Parameters
- resourceGroupName
-
string
The Resource Group Name.
The options parameters.
Returns
update(string, string, ClustersUpdateOptionalParams)
API to update certain properties of the cluster resource.
function update(resourceGroupName: string, clusterName: string, options?: ClustersUpdateOptionalParams): Promise<Cluster>Parameters
- resourceGroupName
-
string
The Resource Group Name.
- clusterName
-
string
Name of the cluster.
- options
- ClustersUpdateOptionalParams
The options parameters.
Returns
Promise<Cluster>