RampUpRule interface

Package:

@azure/arm-appservice-profile-2020-09-01-hybrid

Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.

Properties

actionHostName	Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.
changeDecisionCallbackUrl	Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/
changeIntervalInMinutes	Specifies interval in minutes to reevaluate ReroutePercentage.
changeStep	In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.
maxReroutePercentage	Specifies upper boundary below which ReroutePercentage will stay.
minReroutePercentage	Specifies lower boundary above which ReroutePercentage will stay.
name	Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.
reroutePercentage	Percentage of the traffic which will be redirected to ActionHostName.

Property Details

actionHostName

Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.

actionHostName?: string

Property Value

string

changeDecisionCallbackUrl

Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/

changeDecisionCallbackUrl?: string

Property Value

string

changeIntervalInMinutes

Specifies interval in minutes to reevaluate ReroutePercentage.

changeIntervalInMinutes?: number

Property Value

number

changeStep

In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.

changeStep?: number

Property Value

number

maxReroutePercentage

Specifies upper boundary below which ReroutePercentage will stay.

maxReroutePercentage?: number

Property Value

number

minReroutePercentage

Specifies lower boundary above which ReroutePercentage will stay.

minReroutePercentage?: number

Property Value

number

name

Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

name?: string

Property Value

string

reroutePercentage

Percentage of the traffic which will be redirected to ActionHostName.

reroutePercentage?: number

Property Value

number