az sf cluster

Select and manage a Service Fabric cluster.

Commands

az sf cluster code-version Gets a list of fabric code versions that are provisioned in a Service Fabric cluster.
az sf cluster config-version Gets a list of fabric config versions that are provisioned in a Service Fabric cluster.
az sf cluster health Gets the health of a Service Fabric cluster.
az sf cluster manifest Get the Service Fabric cluster manifest.
az sf cluster select Connects to a Service Fabric cluster endpoint.

az sf cluster code-version

Gets a list of information about fabric code versions that are provisioned in the cluster. The parameter CodeVersion can be used to optionally filter the output to only that particular version.

az sf cluster code-version [--code-version]
[--timeout]

Optional Parameters

--code-version

The product version of Service Fabric.

--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 cluster config-version

Gets a list of information about fabric config versions that are provisioned in the cluster. The parameter ConfigVersion can be used to optionally filter the output to only that particular version.

az sf cluster config-version [--config-version]
[--timeout]

Optional Parameters

--config-version

The config version of Service Fabric.

--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 cluster health

Gets the health of a Service Fabric cluster. Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Similarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state. .

az sf cluster health [--applications-health-state-filter]
[--events-health-state-filter]
[--nodes-health-state-filter]
[--timeout]

Optional Parameters

--applications-health-state-filter

Allows filtering of the application health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value obtained from members or bitwise operations on members of HealthStateFilter enumeration. Only applications that match the filter are returned. All applications are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.

--events-health-state-filter

Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag based enumeration, so the value could be a combination of these value obtained using bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.

--nodes-health-state-filter

Allows filtering of the node health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.

--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 cluster manifest

Get the Service Fabric cluster manifest. The cluster manifest contains properties of the cluster that include different node types on the cluster, security configurations, fault and upgrade domain topologies etc. These properties are specified as part of the ClusterConfig.JSON file while deploying a stand alone cluster. However, most of the information in the cluster manifest is generated internally by service fabric during cluster deployment in other deployment scenarios (for e.g when using azuer portal). The contents of the cluster manifest are for informational purposes only and users are not expected to take a dependency on the format of the file contents or its interpretation. .

az sf cluster manifest [--timeout]

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 cluster select

If connecting to secure cluster specify a cert (.crt) and key file (.key) or a single file with both (.pem). Do not specify both. Optionally, if connecting to a secure cluster, specify also a path to a CA bundle file or directory of trusted CA certs.

az sf cluster select --endpoint
[--ca]
[--cert]
[--key]
[--no-verify]
[--pem]

Required Parameters

--endpoint

Cluster endpoint URL, including port and HTTP or HTTPS prefix.

Optional Parameters

--ca

Path to CA certs directory to treat as valid or CA bundle file.

--cert

Path to a client certificate file.

--key

Path to client certificate key file.

--no-verify

Disable verification for certificates when using HTTPS, note: this is an insecure option and should not be used for production environments.

--pem

Path to client certificate, as a .pem file.