ClusterManagers interface
Interface representing a ClusterManagers.
Methods
Method Details
beginCreateOrUpdate(string, string, ClusterManager, ClusterManagersCreateOrUpdateOptionalParams)
Create a new cluster manager or update properties of the cluster manager if it exists.
function beginCreateOrUpdate(resourceGroupName: string, clusterManagerName: string, clusterManagerParameters: ClusterManager, options?: ClusterManagersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ClusterManager>, ClusterManager>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterManagerName
-
string
The name of the cluster manager.
- clusterManagerParameters
- ClusterManager
The request body.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ClusterManager>, ClusterManager>>
beginCreateOrUpdateAndWait(string, string, ClusterManager, ClusterManagersCreateOrUpdateOptionalParams)
Create a new cluster manager or update properties of the cluster manager if it exists.
function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterManagerName: string, clusterManagerParameters: ClusterManager, options?: ClusterManagersCreateOrUpdateOptionalParams): Promise<ClusterManager>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterManagerName
-
string
The name of the cluster manager.
- clusterManagerParameters
- ClusterManager
The request body.
The options parameters.
Returns
Promise<ClusterManager>
beginDelete(string, string, ClusterManagersDeleteOptionalParams)
Delete the provided cluster manager.
function beginDelete(resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterManagerName
-
string
The name of the cluster manager.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, ClusterManagersDeleteOptionalParams)
Delete the provided cluster manager.
function beginDeleteAndWait(resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersDeleteOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterManagerName
-
string
The name of the cluster manager.
The options parameters.
Returns
Promise<void>
get(string, string, ClusterManagersGetOptionalParams)
Get the properties of the provided cluster manager.
function get(resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersGetOptionalParams): Promise<ClusterManager>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterManagerName
-
string
The name of the cluster manager.
- options
- ClusterManagersGetOptionalParams
The options parameters.
Returns
Promise<ClusterManager>
listByResourceGroup(string, ClusterManagersListByResourceGroupOptionalParams)
Get a list of cluster managers in the provided resource group.
function listByResourceGroup(resourceGroupName: string, options?: ClusterManagersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ClusterManager, ClusterManager[], PageSettings>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(ClusterManagersListBySubscriptionOptionalParams)
Get a list of cluster managers in the provided subscription.
function listBySubscription(options?: ClusterManagersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ClusterManager, ClusterManager[], PageSettings>
Parameters
The options parameters.
Returns
update(string, string, ClusterManagersUpdateOptionalParams)
Patch properties of the provided cluster manager, or update the tags assigned to the cluster manager. Properties and tag updates can be done independently.
function update(resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersUpdateOptionalParams): Promise<ClusterManager>
Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterManagerName
-
string
The name of the cluster manager.
The options parameters.
Returns
Promise<ClusterManager>