az sf node

Manage the nodes that create a Service Fabric cluster.

Commands

az sf node code-package Gets the list of code packages deployed on a Service Fabric node.
az sf node list Gets the list of nodes in the Service Fabric cluster.
az sf node load Gets the load information of a Service Fabric node.
az sf node remove-state Notifies Service Fabric that the persisted state on a node has been permanently removed or lost.
az sf node replica-list Gets the list of replicas deployed on a Service Fabric node.
az sf node report-health Sends a health report on the Service Fabric node.
az sf node restart Restarts a Service Fabric cluster node.
az sf node service-package Gets the list of service packages deployed on a Service Fabric node matching exactly the specified name.
az sf node service-package-list Gets the list of service packages deployed on a Service Fabric node.
az sf node service-package-upload Downloads packages associated with specified service manifest to the image cache on specified node.
az sf node service-type Gets the information about a specified service type of the application deployed on a node in a Service Fabric cluster.
az sf node service-type-list Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster.
az sf node start Starts a Service Fabric cluster node.
az sf node stop Stops a Service Fabric cluster node.

az sf node code-package

Gets the list of code packages deployed on a Service Fabric node for the given application.

az sf node code-package --application-id
--node-name
[--code-package-name]
[--service-manifest-name]
[--timeout]

Required Parameters

--application-id

The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.

--node-name

The name of the node.

Optional Parameters

--code-package-name

The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster.

--service-manifest-name

The name of a service manifest registered as part of an application type in a Service Fabric cluster.

--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf node list

The Nodes endpoint returns information about the nodes in the Service Fabric Cluster. The respons include the name, status, id, health, uptime and other details about the node.

az sf node list [--continuation-token]
[--node-status-filter]
[--timeout]

Optional Parameters

--continuation-token

The continuation token parameter is used to obtain next set of results. A continuation token with a non empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token does not contain a value. The value of this parameter should not be URL encoded.

--node-status-filter

Allows filtering the nodes based on the NodeStatus. Only the nodes that are matching the specified filter value will be returned. The filter value can be one of the following. - default - This filter value will match all of the nodes excepts the ones with with status as Unknown or Removed. - all - This filter value will match all of the nodes. - up - This filter value will match nodes that are Up. - down - This filter value will match nodes that are Down. - enabling - This filter value will match nodes that are in the process of being enabled with status as Enabling. - disabling - This filter value will match nodes that are in the process of being disabled with status as Disabling. - disabled - This filter value will match nodes that are Disabled. - unknown - This filter value will match nodes whose status is Unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime. - removed - This filter value will match nodes whose status is Removed. These are the nodes that are removed from the cluster using the RemoveNodeState API. .

default value: default
--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf node load

Gets the load information of a Service Fabric node.

az sf node load --node-name
[--timeout]

Required Parameters

--node-name

The name of the node.

Optional Parameters

--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf node remove-state

Notifies Service Fabric that the persisted state on a node has been permanently removed or lost. This implies that it is not possible to recover the persisted state of that node. This generally happens if a hard disk has been wiped clean, or if a hard disk crashes. The node has to be down for this operation to be successful. This operation lets Service Fabric know that the replicas on that node no longer exist, and that Service Fabric should stop waiting for those replicas to come back up. Do not run this cmdlet if the state on the node has not been removed and the node can comes back up with its state intact.

az sf node remove-state --node-name
[--timeout]

Required Parameters

--node-name

The name of the node.

Optional Parameters

--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf node replica-list

Gets the list containing the information about replicas deployed on a Service Fabric node. The information include partition id, replica id, status of the replica, name of the service, name of the service type and other information. Use PartitionId or ServiceManifestName query parameters to return information about the deployed replicas matching the specified values for those parameters.

az sf node replica-list --application-id
--node-name
[--partition-id]
[--service-manifest-name]
[--timeout]

Required Parameters

--application-id

The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.

--node-name

The name of the node.

Optional Parameters

--partition-id

The identity of the partition.

--service-manifest-name

The name of a service manifest registered as part of an application type in a Service Fabric cluster.

--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf node report-health

Reports health state of the specified Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway node, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, check that the report appears in the events section.

az sf node report-health --health-property
--health-state
--node-name
--source-id
[--description]
[--remove-when-expired]
[--sequence-number]
[--timeout]
[--ttl]

Required Parameters

--health-property

The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information.

--health-state

Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'.

--node-name

The name of the node.

--source-id

The source name which identifies the client/watchdog/system component which generated the health information.

Optional Parameters

--description

The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string.

--remove-when-expired

Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set this value to false (default). This way, is the reporter has issues (eg. deadlock) and can't report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state.

--sequence-number

The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added.

--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60
--ttl

The duration, in milliseconds, for which this health report is valid. When clients report periodically, they should send reports with higher frequency than time to live. If not specified, time to live defaults to infinite value.

az sf node restart

Restarts a Service Fabric cluster node that is already started.

az sf node restart --node-name
[--create-fabric-dump]
[--node-instance-id]
[--timeout]

Required Parameters

--node-name

The name of the node.

Optional Parameters

--create-fabric-dump

Specify True to create a dump of the fabric node process. This is case sensitive.

default value: False
--node-instance-id

The instance id of the target node. If instance id is specified the node is restarted only if it matches with the current instance of the node. A default value of "0" would match any instance id. The instance id can be obtained using get node query.

default value: 0
--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf node service-package

Returns the information about the service packages deployed on a Service Fabric node for the given application. These results are of service packages whose name match exactly the service package name specified as the parameter.

az sf node service-package --application-id
--node-name
--service-package-name
[--timeout]

Required Parameters

--application-id

The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.

--node-name

The name of the node.

--service-package-name

The name of the service package.

Optional Parameters

--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf node service-package-list

Returns the information about the service packages deployed on a Service Fabric node for the given application.

az sf node service-package-list --application-id
--node-name
[--timeout]

Required Parameters

--application-id

The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.

--node-name

The name of the node.

Optional Parameters

--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf node service-package-upload

Downloads packages associated with specified service manifest to the image cache on specified node.

az sf node service-package-upload --app-type-name
--app-type-version
--node-name
--service-manifest-name
[--share-policy]
[--timeout]

Required Parameters

--app-type-name

The name of the application manifest for the corresponding requested service manifest.

--app-type-version

The version of the application manifest for the corresponding requested service manifest.

--node-name

The name of the node.

--service-manifest-name

The name of service manifest associated with the packages that will be downloaded.

Optional Parameters

--share-policy

JSON encoded list of sharing policies. Each sharing policy element is composed of a 'name' and 'scope'. The name corresponds to the name of the code, configuration, or data package that is to be shared. The scope can either 'None', 'All', 'Code', 'Config' or 'Data'.

--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf node service-type

Gets the information about a specified service type of the application deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation id of the service package.

az sf node service-type --application-id
--node-name
--service-type-name
[--service-manifest-name]
[--timeout]

Required Parameters

--application-id

The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.

--node-name

The name of the node.

--service-type-name

Specifies the name of a Service Fabric service type.

Optional Parameters

--service-manifest-name

The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest.

--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf node service-type-list

Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation id of the service package.

az sf node service-type-list --application-id
--node-name
[--service-manifest-name]
[--timeout]

Required Parameters

--application-id

The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.

--node-name

The name of the node.

Optional Parameters

--service-manifest-name

The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest.

--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf node start

Starts a Service Fabric cluster node that is already stopped.

az sf node start --node-name
[--node-instance-id]
[--timeout]

Required Parameters

--node-name

The name of the node.

Optional Parameters

--node-instance-id

The instance id of the node that is stopped. If instance id is specified the node is started only if it matches with the current instance of the stopped node. A default value of "0" would match any instance id. The instance id can be obtained using get node query.

default value: 0
--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60

az sf node stop

Stops a Service Fabric cluster node that is in a started state. The node will stay down until start node is called.

az sf node stop --node-name
[--node-instance-id]
[--timeout]

Required Parameters

--node-name

The name of the node.

Optional Parameters

--node-instance-id

The instance id of the target node. If instance id is specified the node is stopped only if it matches with the current instance of the node. A default value of "0" would match any instance id. The instance id can be obtained using get node query.

default value: 0
--timeout -t

The server timeout for performing the operation, specified in seconds. This is the maximum time a client can wait.

default value: 60