Set-​AC​SFarm

Changes the settings of the service configuration on an ACS Farm.

Syntax

Set-ACSFarm
   [[-SubscriptionId] <String>]
   [[-Token] <String>]
   [[-AdminUri] <Uri>]
   [-ResourceGroupName] <String>
   [-FarmName] <String>
   [-BandwidthThrottleIsEnabled <Boolean>]
   [-CorsAllowedOriginsList <String>]
   [-DataCenterUriHostSuffixes <String>]
   [-DefaultEgressThresholdInGbps <Double>]
   [-DefaultIngressThresholdInGbps <Double>]
   [-DefaultIntranetEgressThresholdInGbps <Double>]
   [-DefaultIntranetIngressThresholdInGbps <Double>]
   [-DefaultRequestThresholdInTps <Double>]
   [-DefaultThrottleProbabilityDecayIntervalInSeconds <Int32>]
   [-DefaultTotalEgressThresholdInGbps <Double>]
   [-DefaultTotalIngressThresholdInGbps <Double>]
   [-FeedbackRefreshIntervalInSeconds <Int32>]
   [-GracePeriodForFullThrottlingInRefreshIntervals <Int32>]
   [-GracePeriodMaxThrottleProbability <Double>]
   [-HostStyleHttpPort <Int32>]
   [-HostStyleHttpsPort <Int32>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-MinimumEgressThresholdInGbps <Double>]
   [-MinimumIngressThresholdInGbps <Double>]
   [-MinimumIntranetEgressThresholdInGbps <Double>]
   [-MinimumIntranetIngressThresholdInGbps <Double>]
   [-MinimumRequestThresholdInTps <Double>]
   [-MinimumTotalEgressThresholdInGbps <Double>]
   [-MinimumTotalIngressThresholdInGbps <Double>]
   [-NumberOfAccountsToSync <Int32>]
   [-OverallEgressThresholdInGbps <Double>]
   [-OverallIngressThresholdInGbps <Double>]
   [-OverallIntranetEgressThresholdInGbps <Double>]
   [-OverallIntranetIngressThresholdInGbps <Double>]
   [-OverallRequestThresholdInTps <Double>]
   [-OverallTotalEgressThresholdInGbps <Double>]
   [-OverallTotalIngressThresholdInGbps <Double>]
   [-RetentionPeriodForDeletedStorageAccountsInDays <Int32>]
   [-SettingsPollingIntervalInSecond <Int32>]
   [-SkipCertificateValidation]
   [-ToleranceFactorForEgress <Double>]
   [-ToleranceFactorForIngress <Double>]
   [-ToleranceFactorForIntranetEgress <Double>]
   [-ToleranceFactorForIntranetIngress <Double>]
   [-ToleranceFactorForTotalEgress <Double>]
   [-ToleranceFactorForTotalIngress <Double>]
   [-ToleranceFactorForTps <Double>]
   [-UsageCollectionIntervalInSeconds <Int32>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-ACSFarm cmdlet changes the settings of the service configuration on an Azure Consistent Storage (ACS) Farm.

Examples

Example 1: Modify the settings of an existing farm

$ResourceGroup = "System"

$Farm = Get-ACSFarm -ResourceGroupName $ResourceGroup

Set-ACSFarm -ResourceGroupName $ResourceGroup -FarmName $Farm.Name -SettingPollingIntervalInSeconds 45

The first command stores the value named System in the variable named $ResourceGroup.

The second command uses the Get-ACSFarm cmdlet to get the farm that is contained in the resource group specified in the $ResourceGroup variable. The command stores the result in the variable named $Farm.

The third command uses the Set-ACSFarm cmdlet to modify the Farm stored in the $Farm variable.

Required Parameters

-FarmName

Specifies the name of the ACS farm that this cmdlet modifies.

Type:String
Position:5
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of the resource group that contains the ACS farm.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-AdminUri

Specifies the link, as a URI, to the service administrator.

Type:Uri
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-BandwidthThrottleIsEnabled
Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CorsAllowedOriginsList
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DataCenterUriHostSuffixes
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultEgressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultIngressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultIntranetEgressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultIntranetIngressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultRequestThresholdInTps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultThrottleProbabilityDecayIntervalInSeconds
Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultTotalEgressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultTotalIngressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-FeedbackRefreshIntervalInSeconds
Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-GracePeriodForFullThrottlingInRefreshIntervals
Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-GracePeriodMaxThrottleProbability
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-HostStyleHttpPort
Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-HostStyleHttpsPort
Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MinimumEgressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MinimumIngressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MinimumIntranetEgressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MinimumIntranetIngressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MinimumRequestThresholdInTps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MinimumTotalEgressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MinimumTotalIngressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NumberOfAccountsToSync
Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OverallEgressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OverallIngressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OverallIntranetEgressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OverallIntranetIngressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OverallRequestThresholdInTps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OverallTotalEgressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OverallTotalIngressThresholdInGbps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RetentionPeriodForDeletedStorageAccountsInDays

Specifies the retention period in days for which deleted accounts are not garbage collected, i.e. can be recovered. This can range from 0 to 9999, where zero meaning to delete the storage accounts on the next garbage collection

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SettingsPollingIntervalInSecond
Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SkipCertificateValidation

Indicates that the cmdlet does not validate the certificate.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SubscriptionId

Specifies the subscription ID.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Token
Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ToleranceFactorForEgress
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ToleranceFactorForIngress
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ToleranceFactorForIntranetEgress
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ToleranceFactorForIntranetIngress
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ToleranceFactorForTotalEgress
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ToleranceFactorForTotalIngress
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ToleranceFactorForTps
Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UsageCollectionIntervalInSeconds
Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.AzureStack.AzureConsistentStorage.Commands.FarmResponse

Outputs

Microsoft.AzureStack.AzureConsistentStorage.Commands.FarmResponse