Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2013-01-11
Use the Get-WorkloadPolicy cmdlet to retrieve and view properties of a workload policy.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-WorkloadPolicy [-Identity
<WorkloadPolicyIdParameter>] [-DomainController <Fqdn>]
[-WorkloadClassification <Unknown | Discretionary |
InternalMaintenance | CustomerExpectation | Urgent>]
[-WorkloadType <Unknown | MailboxReplicationService |
ELCAssistant | JunkEmailOptionsCommitterAssistant |
CalendarRepairAssistant | SharingPolicyAssistant | TopNAssistant |
CalendarSyncAssistant | UMReportingAssistant |
InferenceTrainingAssistant | StoreMaintenanceAssistant |
PublicFolderAssistant | DirectoryProcessorAssistant | PowerShell |
PowerShellForwardSync | PowerShellBackSync | PowerShellGalSync |
PowerShellLowPriorityWorkFlow | PowerShellDiscretionaryWorkFlow |
OABGeneratorAssistant | Ews | Eas | Domt | Owa | TeamMailboxSync |
Pop | Imap | Momt | Transport | TransportSync | OwaVoice |
OrgContactsSyncAssistant | PublicFolderMailboxSync |
InferenceDataCollectionAssistant | PeopleRelevanceAssistant |
SiteMailboxAssistant | PushNotificationService |
MailboxReplicationServiceHighPriority>]
|
Examples
EXAMPLE 1
This example returns information about the custom workload policy DublinImapWorkloadPolicy. This command returns the workload type, workload classification, and workload management policy to which it's associated.
Copy Code | |
---|---|
Get-WorkloadPolicy -Identity DublinImapWorkloadPolicy |
EXAMPLE 2
This example returns detailed information about the workload policy DublinImapPolicy. The full details of a workload policy includes the date and time that a policy was created, when the policy was last changed, and other important details.
Copy Code | |
---|---|
Get-WorkloadPolicy -Identity DublinImapPolicy | Format-List |
EXAMPLE 3
This example returns a list of the workloads assigned the CustomerExpectation classification.
Copy Code | |
---|---|
Get-WorkloadPolicy -WorkloadClassification CustomerExpectation |
Detailed Description
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 "Exchange workload throttling" entry in the Server Health and Performance Permissions topic.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
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. |
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.WorkloadPolicyIdParameter |
The Identity parameter specifies the name of the workload policy object to retrieve. |
WorkloadClassification |
Optional |
Microsoft.Exchange.WorkloadManagement.WorkloadClassification |
The WorkloadClassification parameter specifies the
classification of the workloads to retrieve. You can use one of the
following values: |
WorkloadType |
Optional |
Microsoft.Exchange.WorkloadManagement.WorkloadType |
The WorkloadType specifies the workload being retrieved. For a list of Exchange workload values, see the "Syntax" section of this topic. For detailed information about each Exchange workload, see Workload Management Reference. |
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.