Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-09-19
Use the Get-ThrottlingPolicy cmdlet to view the user throttling settings for one or more throttling policies.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-ThrottlingPolicy [-Identity
<ThrottlingPolicyIdParameter>] [-Diagnostics
<SwitchParameter>] [-DomainController <Fqdn>]
[-Explicit <SwitchParameter>] [-IgnoreDehydratedFlag
<SwitchParameter>] [-Organization
<OrganizationIdParameter>] [-ThrottlingPolicyScope
<Regular | Organization | Global>]
|
Examples
EXAMPLE 1
This example returns the settings for all throttling policies.
 Copy Code |
|
|---|---|
Get-ThrottlingPolicy | Format-List |
|
EXAMPLE 2
This example displays the parameters and values for throttling policy ThrottlingPolicy2.
| Copy Code |
|
|---|---|
Get-ThrottlingPolicy -Identity ThrottlingPolicy2 | Format-List |
|
Detailed Description
The Get-ThrottlingPolicy cmdlet returns the client throttling settings for one or more throttling policies. If you use the Identity parameter, the cmdlet returns the settings for the identified throttling policy. If you don't use the Identity parameter, the cmdlet returns the settings for all throttling policies.
For more information about how to control the resources consumed by individual users, see Exchange Workload Management.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "User throttling" entry in the Server Health and Performance Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Diagnostics |
Optional |
System.Management.Automation.SwitchParameter |
The Diagnostics switch specifies whether you want the
output to include the diagnostics string. To return diagnostics
information, use the syntax |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory. |
|
Explicit |
Optional |
System.Management.Automation.SwitchParameter |
The Explicit switch specifies whether you only want to
return the policy settings that have been directly assigned using
this policy. By default, this parameter is set to
|
|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.ThrottlingPolicyIdParameter |
The Identity parameter identifies the name of the throttling policy that you want to return settings for. |
|
IgnoreDehydratedFlag |
Optional |
System.Management.Automation.SwitchParameter |
This parameter is reserved for internal Microsoft use. |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
This parameter is reserved for internal Microsoft use. |
|
ThrottlingPolicyScope |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.ThrottlingPolicyScopeType |
The ThrottlingPolicyScope parameter specifies the scope of the throttling policy. You can use the following values:
For information about each of these policy scopes, see Exchange Workload Management. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.