Get-ThrottlingPolicyAssociation

 

Applies to: Exchange Server 2016

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Get-ThrottlingPolicyAssociation cmdlet to view existing throttling policy associations in your organization. Throttling policies can be associated with mailboxes, user accounts, mail contacts, mail users, and Exchange server computer accounts.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-ThrottlingPolicyAssociation [-Identity <ThrottlingPolicyAssociationIdParameter>] <COMMON PARAMETERS>

Get-ThrottlingPolicyAssociation [-Anr <String>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-DomainController <Fqdn>] [-ResultSize <Unlimited>] [-SortBy <String>] [-ThrottlingPolicy <ThrottlingPolicyIdParameter>]

This example retrieves a summary list of all throttling policy associations in your organization.

Get-ThrottlingPolicyAssociation -ResultSize unlimited

This example returns detailed information for the throttling policy association named Courtney Sweet that's associated with the user's mailbox.

Get-Group -Identity "Courtney Sweet" | Format-List

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.

 

Parameter Required Type Description

Anr

Optional

System.String

The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:

  • CommonName (CN)

  • DisplayName

  • FirstName

  • LastName

  • Alias

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.ThrottlingPolicyAssociationIdParameter

The Identity parameter specifies the throttling policy association that you want to view. You can use any value that uniquely identifies the throttling policy association. For example:

  • Name

  • Distinguished name (DN)

  • GUID

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

SortBy

Optional

System.String

This parameter is reserved for internal Microsoft use.

ThrottlingPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.ThrottlingPolicyIdParameter

The ThrottlingPolicy parameter filters the results by throttling policy. You can use any value that uniquely identifies the throttling policy. For example:

  • Name

  • Distinguished name (DN)

  • GUID

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.

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.

 
Show: