Share via

az sf managed-service

  • Reference

Manage services running on an Azure Service Fabric managed cluster. Only support ARM deployed services.

Commands

Name Description Type Status
az sf managed-service correlation-scheme

Manage correlation schemes of services running on an Azure Service Fabric managed cluster. Only support ARM deployed services.

 Core GA
az sf managed-service correlation-scheme create

Create a new managed service correlation scheme on an Azure Service Fabric managed cluster.

 Core GA
az sf managed-service correlation-scheme delete

Delete a managed service correlation scheme.

 Core GA
az sf managed-service correlation-scheme update

Update a managed service correlation scheme.

 Core GA
az sf managed-service create

Create a new managed service on an Azure Service Fabric managed cluster.

 Core GA
az sf managed-service delete

Delete a managed service.

 Core GA
az sf managed-service list

List managed services of a given managed application.

 Core GA
az sf managed-service load-metrics

Manage service load metrics running on an Azure Service Fabric managed cluster. Only support ARM deployed services.

 Core GA
az sf managed-service load-metrics create

Create a new managed service load metric on an Azure Service Fabric managed cluster.

 Core GA
az sf managed-service load-metrics delete

Delete a managed service.

 Core GA
az sf managed-service load-metrics update

Update a managed service.

 Core GA
az sf managed-service show

Get a service.

 Core GA
az sf managed-service update

Update a managed service.

 Core GA

az sf managed-service create

Create a new managed service on an Azure Service Fabric managed cluster.

az sf managed-service create --application
                             --cluster-name
                             --name
                             --resource-group
                             --service-type
                             --state {Stateful, Stateless}
                             [--activation-mode]
                             [--default-move-cost {High, Low, Medium, Zero}]
                             [--has-persisted-state {false, true}]
                             [--high-key]
                             [--instance-count]
                             [--keep-duration]
                             [--low-key]
                             [--min-inst-pct]
                             [--min-instance-count]
                             [--min-replica]
                             [--partition-count]
                             [--partition-names]
                             [--partition-scheme {Named, Singleton, UniformInt64Range}]
                             [--placement-constraints]
                             [--plcmt-time-limit]
                             [--quorum-loss-wait]
                             [--replica-restart-wait]
                             [--tags]
                             [--target-replica]

Examples

Create a new stateless managed service "testService1" with instance count -1 (on all the nodes).

az sf managed-service create -g testRG -c testCluster --application-name testApp --state stateless --service-name testService \
  --service-type testStateless --instance-count -1 --partition-scheme singleton

Create a new stateful service "testService2" with a target of 5 nodes.

az sf managed-service create -g testRG -c testCluster --application-name testApp --state stateful --service-name testService2 --has-persisted-state \
  --service-type testStatefulType --min-replica-set-size 3 --target-replica-set-size 5 --partition-scheme uniformint64range --partition-count 1 --low-key 0 --high-key 25

Required Parameters

--application --application-name

Specify the name of the service.

--cluster-name -c

Specify the name of the cluster, if not given it will be same as resource group name.

--name --service-name

Specify the name of the service.

--resource-group -g

Specify the resource group name. You can configure the default group using az configure --defaults group=<name>.

--service-type --type

Specify the service type name of the application, it should exist in the application manifest.

--state

Specify if the service is stateless or stateful.

Accepted values: Stateful, Stateless

Optional Parameters

--activation-mode --package-activation-mode --service-package-activation-mode

Specify the activation mode of the service package.

--default-move-cost

Specify the default cost for a move. Higher costs make it less likely that the Cluster Resource Manager will move the replica when trying to balance the cluster.

Accepted values: High, Low, Medium, Zero
--has-persisted-state

Determines whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false.

Accepted values: false, true
--high-key

Specify the upper bound of the partition key range that should be split between the partition ‘Count’ This is only used with UniformInt64 partition scheme.

--instance-count

Specify the instance count for the stateless service. If -1 is used, it means it will run on all the nodes.

--keep-duration --stand-by-keep-duration --stand-by-replica-keep-duration

Specify the definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss".

--low-key

Specify the lower bound of the partition key range that should be split between the partition ‘Count’ This is only used with UniformInt64 partition scheme.

--min-inst-pct --min-instance-percentage

Specify the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. Allowed values are from 0 to 100.

--min-instance-count

Specify the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.

--min-replica --min-replica-set-size

Specify the min replica set size for the stateful service.

--partition-count

Specify the number of partitions. This is only used with UniformInt64 partition scheme.

--partition-names

Specify the array for the names of the partitions. This is only used with Named partition scheme.

--partition-scheme

Specify what partition scheme to use. Singleton partitions are typically used when the service does not require any additional routing. UniformInt64 means that each partition owns a range of int64 keys. Named is usually for services with data that can be bucketed, within a bounded set. Some common examples of data fields used as named partition keys would be regions, postal codes, customer groups, or other business boundaries.

Accepted values: Named, Singleton, UniformInt64Range
Default value: singleton
--placement-constraints

Specify the placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".

--plcmt-time-limit --service-placement-time-limit

Specify the duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss".

--quorum-loss-wait --quorum-loss-wait-duration

Specify the maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format "hh:mm:ss".

--replica-restart-wait --replica-restart-wait-duration

Specify the duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss".

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--target-replica --target-replica-set-size

Specify the target replica set size for the stateful service.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sf managed-service delete

Delete a managed service.

az sf managed-service delete --application
                             --cluster-name
                             --name
                             --resource-group

Examples

Delete managed service.

az sf managed-service delete -g testRG -c testCluster --application-name testApp --service-name testService

Required Parameters

--application --application-name

Specify the name of the service.

--cluster-name -c

Specify the name of the cluster, if not given it will be same as resource group name.

--name --service-name

Specify the name of the service.

--resource-group -g

Specify the resource group name. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sf managed-service list

List managed services of a given managed application.

az sf managed-service list --application
                           --cluster-name
                           --resource-group

Examples

List managed services.

az sf managed-service list -g testRG -c testCluster --application-name testApp

Required Parameters

--application --application-name

Specify the name of the service.

--cluster-name -c

Specify the name of the cluster, if not given it will be same as resource group name.

--resource-group -g

Specify the resource group name. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sf managed-service show

Get a service.

az sf managed-service show --application
                           --cluster-name
                           --name
                           --resource-group

Examples

Show the properties of a managed service on an Azure Service Fabric managed cluster.

az sf managed-service show -g testRG -c testCluster --application-name testApp --service-name testService

Required Parameters

--application --application-name

Specify the name of the service.

--cluster-name -c

Specify the name of the cluster, if not given it will be same as resource group name.

--name --service-name

Specify the name of the service.

--resource-group -g

Specify the resource group name. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sf managed-service update

Update a managed service.

az sf managed-service update --application
                             --cluster-name
                             --name
                             --resource-group
                             [--default-move-cost {High, Low, Medium, Zero}]
                             [--instance-count]
                             [--keep-duration]
                             [--min-inst-pct]
                             [--min-instance-count]
                             [--min-replica]
                             [--placement-constraints]
                             [--plcmt-time-limit]
                             [--quorum-loss-wait]
                             [--replica-restart-wait]
                             [--tags]
                             [--target-replica]

Examples

Update managed stateless service.

az sf managed-service update -g testRG -c testCluster --application-name testApp --service-name testService --min-instance-count 2 \
  --min-instance-percentage 20

Update managed stateful service.

az sf managed-service update -g testRG -c testCluster --application-name testApp --service-name testService2 --service-placement-time-limit '00:11:00' \
  --stand-by-replica-keep-duration '00:11:00' --replica-restart-wait-duration '00:11:00' --quorum-loss-wait-duration '00:11:00'

Required Parameters

--application --application-name

Specify the name of the service.

--cluster-name -c

Specify the name of the cluster, if not given it will be same as resource group name.

--name --service-name

Specify the name of the service.

--resource-group -g

Specify the resource group name. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--default-move-cost

Specify the default cost for a move. Higher costs make it less likely that the Cluster Resource Manager will move the replica when trying to balance the cluster.

Accepted values: High, Low, Medium, Zero
--instance-count

Specify the instance count for the stateless service. If -1 is used, it means it will run on all the nodes.

--keep-duration --stand-by-keep-duration --stand-by-replica-keep-duration

Specify the definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss".

--min-inst-pct --min-instance-percentage

Specify the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. Allowed values are from 0 to 100.

--min-instance-count

Specify the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.

--min-replica --min-replica-set-size

Specify the min replica set size for the stateful service.

--placement-constraints

Specify the placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".

--plcmt-time-limit --service-placement-time-limit

Specify the duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss".

--quorum-loss-wait --quorum-loss-wait-duration

Specify the maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format "hh:mm:ss".

--replica-restart-wait --replica-restart-wait-duration

Specify the duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss".

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--target-replica --target-replica-set-size

Specify the target replica set size for the stateful service.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.