Clusters interface
Interface representing a Clusters.
Methods
| begin |
Create or update a Service Fabric cluster resource with the specified name. |
| begin |
Create or update a Service Fabric cluster resource with the specified name. |
| begin |
Update the configuration of a Service Fabric cluster resource with the specified name. |
| begin |
Update the configuration of a Service Fabric cluster resource with the specified name. |
| delete(string, string, Clusters |
Delete a Service Fabric cluster resource with the specified name. |
| get(string, string, Clusters |
Get a Service Fabric cluster resource created or in the process of being created in the specified resource group. |
| list(Clusters |
Gets all Service Fabric cluster resources created or in the process of being created in the subscription. |
| list |
Gets all Service Fabric cluster resources created or in the process of being created in the resource group. |
| list |
If a target is not provided, it will get the minimum and maximum versions available from the current cluster version. If a target is given, it will provide the required path to get from the current cluster version to the target version. |
Method Details
beginCreateOrUpdate(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)
Create or update a Service Fabric cluster resource with the specified name.
function beginCreateOrUpdate(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- clusterName
-
string
The name of the cluster resource.
- parameters
- Cluster
The cluster resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>
beginCreateOrUpdateAndWait(string, string, Cluster, ClustersCreateOrUpdateOptionalParams)
Create or update a Service Fabric cluster resource with the specified name.
function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOrUpdateOptionalParams): Promise<Cluster>Parameters
- resourceGroupName
-
string
The name of the resource group.
- clusterName
-
string
The name of the cluster resource.
- parameters
- Cluster
The cluster resource.
The options parameters.
Returns
Promise<Cluster>
beginUpdate(string, string, ClusterUpdateParameters, ClustersUpdateOptionalParams)
Update the configuration of a Service Fabric cluster resource with the specified name.
function beginUpdate(resourceGroupName: string, clusterName: string, parameters: ClusterUpdateParameters, options?: ClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- clusterName
-
string
The name of the cluster resource.
- parameters
- ClusterUpdateParameters
The parameters which contains the property value and property name which used to update the cluster configuration.
- options
- ClustersUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>
beginUpdateAndWait(string, string, ClusterUpdateParameters, ClustersUpdateOptionalParams)
Update the configuration of a Service Fabric cluster resource with the specified name.
function beginUpdateAndWait(resourceGroupName: string, clusterName: string, parameters: ClusterUpdateParameters, options?: ClustersUpdateOptionalParams): Promise<Cluster>Parameters
- resourceGroupName
-
string
The name of the resource group.
- clusterName
-
string
The name of the cluster resource.
- parameters
- ClusterUpdateParameters
The parameters which contains the property value and property name which used to update the cluster configuration.
- options
- ClustersUpdateOptionalParams
The options parameters.
Returns
Promise<Cluster>
delete(string, string, ClustersDeleteOptionalParams)
Delete a Service Fabric cluster resource with the specified name.
function delete(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- clusterName
-
string
The name of the cluster resource.
- options
- ClustersDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, ClustersGetOptionalParams)
Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.
function get(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<Cluster>Parameters
- resourceGroupName
-
string
The name of the resource group.
- clusterName
-
string
The name of the cluster resource.
- options
- ClustersGetOptionalParams
The options parameters.
Returns
Promise<Cluster>
list(ClustersListOptionalParams)
Gets all Service Fabric cluster resources created or in the process of being created in the subscription.
function list(options?: ClustersListOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>Parameters
- options
- ClustersListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)
Gets all Service Fabric cluster resources created or in the process of being created in the resource group.
function listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
The options parameters.
Returns
listUpgradableVersions(string, string, ClustersListUpgradableVersionsOptionalParams)
If a target is not provided, it will get the minimum and maximum versions available from the current cluster version. If a target is given, it will provide the required path to get from the current cluster version to the target version.
function listUpgradableVersions(resourceGroupName: string, clusterName: string, options?: ClustersListUpgradableVersionsOptionalParams): Promise<UpgradableVersionPathResult>Parameters
- resourceGroupName
-
string
The name of the resource group.
- clusterName
-
string
The name of the cluster resource.
The options parameters.
Returns
Promise<UpgradableVersionPathResult>