Share via

NodeTypes interface

  • Reference
Package:
@azure/arm-servicefabricmanagedclusters

Interface representing a NodeTypes.

Methods

beginCreateOrUpdate(string, string, string, NodeType, NodeTypesCreateOrUpdateOptionalParams)

Create or update a Service Fabric node type of a given managed cluster.
beginCreateOrUpdateAndWait(string, string, string, NodeType, NodeTypesCreateOrUpdateOptionalParams)

Create or update a Service Fabric node type of a given managed cluster.
beginDelete(string, string, string, NodeTypesDeleteOptionalParams)

Delete a Service Fabric node type of a given managed cluster.
beginDeleteAndWait(string, string, string, NodeTypesDeleteOptionalParams)

Delete a Service Fabric node type of a given managed cluster.
beginDeleteNode(string, string, string, NodeTypeActionParameters, NodeTypesDeleteNodeOptionalParams)

Deletes one or more nodes on the node type. It will disable the fabric nodes, trigger a delete on the VMs and removes the state from the cluster.
beginDeleteNodeAndWait(string, string, string, NodeTypeActionParameters, NodeTypesDeleteNodeOptionalParams)

Deletes one or more nodes on the node type. It will disable the fabric nodes, trigger a delete on the VMs and removes the state from the cluster.
beginReimage(string, string, string, NodeTypeActionParameters, NodeTypesReimageOptionalParams)

Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.
beginReimageAndWait(string, string, string, NodeTypeActionParameters, NodeTypesReimageOptionalParams)

Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.
beginRestart(string, string, string, NodeTypeActionParameters, NodeTypesRestartOptionalParams)

Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.
beginRestartAndWait(string, string, string, NodeTypeActionParameters, NodeTypesRestartOptionalParams)

Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.
get(string, string, string, NodeTypesGetOptionalParams)

Get a Service Fabric node type of a given managed cluster.
listByManagedClusters(string, string, NodeTypesListByManagedClustersOptionalParams)

Gets all Node types of the specified managed cluster.
update(string, string, string, NodeTypeUpdateParameters, NodeTypesUpdateOptionalParams)

Update the configuration of a node type of a given managed cluster, only updating tags.

Method Details

beginCreateOrUpdate(string, string, string, NodeType, NodeTypesCreateOrUpdateOptionalParams)

Create or update a Service Fabric node type of a given managed cluster.

function beginCreateOrUpdate(resourceGroupName: string, clusterName: string, nodeTypeName: string, parameters: NodeType, options?: NodeTypesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NodeType>, NodeType>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster resource.

nodeTypeName

string

The name of the node type.

parameters
NodeType

The node type resource.

options
NodeTypesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<NodeType>, NodeType>>

beginCreateOrUpdateAndWait(string, string, string, NodeType, NodeTypesCreateOrUpdateOptionalParams)

Create or update a Service Fabric node type of a given managed cluster.

function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterName: string, nodeTypeName: string, parameters: NodeType, options?: NodeTypesCreateOrUpdateOptionalParams): Promise<NodeType>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster resource.

nodeTypeName

string

The name of the node type.

parameters
NodeType

The node type resource.

options
NodeTypesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<NodeType>

beginDelete(string, string, string, NodeTypesDeleteOptionalParams)

Delete a Service Fabric node type of a given managed cluster.

function beginDelete(resourceGroupName: string, clusterName: string, nodeTypeName: string, options?: NodeTypesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster resource.

nodeTypeName

string

The name of the node type.

options
NodeTypesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, NodeTypesDeleteOptionalParams)

Delete a Service Fabric node type of a given managed cluster.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, nodeTypeName: string, options?: NodeTypesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster resource.

nodeTypeName

string

The name of the node type.

options
NodeTypesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDeleteNode(string, string, string, NodeTypeActionParameters, NodeTypesDeleteNodeOptionalParams)

Deletes one or more nodes on the node type. It will disable the fabric nodes, trigger a delete on the VMs and removes the state from the cluster.

function beginDeleteNode(resourceGroupName: string, clusterName: string, nodeTypeName: string, parameters: NodeTypeActionParameters, options?: NodeTypesDeleteNodeOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster resource.

nodeTypeName

string

The name of the node type.

parameters
NodeTypeActionParameters

parameters for delete action.

options
NodeTypesDeleteNodeOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteNodeAndWait(string, string, string, NodeTypeActionParameters, NodeTypesDeleteNodeOptionalParams)

Deletes one or more nodes on the node type. It will disable the fabric nodes, trigger a delete on the VMs and removes the state from the cluster.

function beginDeleteNodeAndWait(resourceGroupName: string, clusterName: string, nodeTypeName: string, parameters: NodeTypeActionParameters, options?: NodeTypesDeleteNodeOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster resource.

nodeTypeName

string

The name of the node type.

parameters
NodeTypeActionParameters

parameters for delete action.

options
NodeTypesDeleteNodeOptionalParams

The options parameters.

Returns

Promise<void>

beginReimage(string, string, string, NodeTypeActionParameters, NodeTypesReimageOptionalParams)

Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.

function beginReimage(resourceGroupName: string, clusterName: string, nodeTypeName: string, parameters: NodeTypeActionParameters, options?: NodeTypesReimageOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster resource.

nodeTypeName

string

The name of the node type.

parameters
NodeTypeActionParameters

parameters for reimage action.

options
NodeTypesReimageOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginReimageAndWait(string, string, string, NodeTypeActionParameters, NodeTypesReimageOptionalParams)

Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.

function beginReimageAndWait(resourceGroupName: string, clusterName: string, nodeTypeName: string, parameters: NodeTypeActionParameters, options?: NodeTypesReimageOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster resource.

nodeTypeName

string

The name of the node type.

parameters
NodeTypeActionParameters

parameters for reimage action.

options
NodeTypesReimageOptionalParams

The options parameters.

Returns

Promise<void>

beginRestart(string, string, string, NodeTypeActionParameters, NodeTypesRestartOptionalParams)

Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.

function beginRestart(resourceGroupName: string, clusterName: string, nodeTypeName: string, parameters: NodeTypeActionParameters, options?: NodeTypesRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster resource.

nodeTypeName

string

The name of the node type.

parameters
NodeTypeActionParameters

parameters for restart action.

options
NodeTypesRestartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait(string, string, string, NodeTypeActionParameters, NodeTypesRestartOptionalParams)

Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.

function beginRestartAndWait(resourceGroupName: string, clusterName: string, nodeTypeName: string, parameters: NodeTypeActionParameters, options?: NodeTypesRestartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster resource.

nodeTypeName

string

The name of the node type.

parameters
NodeTypeActionParameters

parameters for restart action.

options
NodeTypesRestartOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, NodeTypesGetOptionalParams)

Get a Service Fabric node type of a given managed cluster.

function get(resourceGroupName: string, clusterName: string, nodeTypeName: string, options?: NodeTypesGetOptionalParams): Promise<NodeType>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster resource.

nodeTypeName

string

The name of the node type.

options
NodeTypesGetOptionalParams

The options parameters.

Returns

Promise<NodeType>

listByManagedClusters(string, string, NodeTypesListByManagedClustersOptionalParams)

Gets all Node types of the specified managed cluster.

function listByManagedClusters(resourceGroupName: string, clusterName: string, options?: NodeTypesListByManagedClustersOptionalParams): PagedAsyncIterableIterator<NodeType, NodeType[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster resource.

options
NodeTypesListByManagedClustersOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NodeType, NodeType[], PageSettings>

update(string, string, string, NodeTypeUpdateParameters, NodeTypesUpdateOptionalParams)

Update the configuration of a node type of a given managed cluster, only updating tags.

function update(resourceGroupName: string, clusterName: string, nodeTypeName: string, parameters: NodeTypeUpdateParameters, options?: NodeTypesUpdateOptionalParams): Promise<NodeType>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster resource.

nodeTypeName

string

The name of the node type.

parameters
NodeTypeUpdateParameters

The parameters to update the node type configuration.

options
NodeTypesUpdateOptionalParams

The options parameters.

Returns

Promise<NodeType>