New-MgmtSvcSqlResourcePoolTemplate
New-MgmtSvcSqlResourcePoolTemplate
Creates a SQL resource pool template.
Syntax
Parameter Set: ByObject
New-MgmtSvcSqlResourcePoolTemplate [-AdminUri] <Uri> [-Token] <String> [[-ResourcePoolTemplate] <SqlResourcePoolTemplate> ] [-DisableCertificateValidation] [ <CommonParameters>]
Parameter Set: ByProperties
New-MgmtSvcSqlResourcePoolTemplate [-AdminUri] <Uri> [-Token] <String> [-TemplateName] <String> -CapCpuCores <Decimal> -MaxCpuCores <Decimal> -MaxIopsPerVolume <Int32> -MaxMemoryMB <Int32> -MaxSubscriptionsPerPool <Int32> -MinCpuCores <Decimal> -MinIopsPerVolume <Int32> -MinMemoryMB <Int32> -WorkloadGroupMaxRequests <Int32> -WorkloadMaxDegreeOfParallelism <Int32> -WorkloadRequestMaxCpuTimeSec <Int32> -WorkloadRequestMaxMemoryGrantMB <Int32> -WorkloadRequestMemoryGrantTimeoutSec <Int32> [-DisableCertificateValidation] [ <CommonParameters>]
Detailed Description
The New-MgmtSvcSqlResourcePoolTemplate cmdlet creates a SQL resource pool template with the specified values. You can pass this object to the Add-MgmtSvcSqlResourcePoolTemplate cmdlet to add a new resource pool template.
Parameters
-AdminUri<Uri>
Specifies the URI of the Windows Azure Pack administrator API. Use the following format: https://< computer>:<port>, where <computer> is the computer on which the administrator API is installed.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-CapCpuCores<Decimal>
Specifies the hard cap limit to the number of CPU cores to reserve for a resource pool. The combined value of hard cap CPU cores for all resource pools on a server can exceed the total number of CPU cores on the server.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-DisableCertificateValidation
Disables certificate validation for the Windows Azure Pack installation. If you specify this parameter, you can use self-signed certificates.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MaxCpuCores<Decimal>
Specifies the maximum number of CPU cores to reserve for a resource pool. The combined value of maximum CPU cores for all resource pools on a server can exceed the total number of CPU cores on the server.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-MaxIopsPerVolume<Int32>
Specifies the maximum physical I/O operations per second (IOPS) per disk volume to reserve for a resource pool. The combined value of minimum IOPS per volume for all resource pools on a server can exceed the supported number of IOPS per volume on the server.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-MaxMemoryMB<Int32>
Specifies the maximum amount of memory to reserve for a resource pool. The combined value of maximum memory for all resource pools on a server can exceed the total amount of memory on the server.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-MaxSubscriptionsPerPool<Int32>
Specifies the maximum number of subscriptions that can be associated with a resource pool. A value of 1 indicates a dedicated resource pool for every subscription. A dedicated resource pool can be used to define a service level agreement which guarantee the minimum CPU, memory, and I/O for a subscription. A value greater than 1 indicates a shared resource pool where multiple subscriptions share the same resource limits. A shared resource pool can help control a scenario where single tenant might try to monopolize all the resources on server instance.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-MinCpuCores<Decimal>
Specifies the minimum number of CPU cores to reserve for a resource pool. The combined value of minimum CPU cores for all resource pools on a server cannot exceed the total number of CPU cores on the server.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-MinIopsPerVolume<Int32>
Specifies the minimum physical IOPS per disk volume to reserve for a resource pool. The combined value of minimum IOPS per volume for all resource pools on a server cannot exceed the supported number of IOPS per volume on the server.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-MinMemoryMB<Int32>
Specfies the minimum amount of memory to reserve for a created resource pool. The combined value of minimum memory for all created resource pools on a server cannot exceed the total amount of memory set on the server.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-ResourcePoolTemplate<SqlResourcePoolTemplate>
Specifies the resource pool template to add to Windows Azure Pack.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
true(ByValue) |
Accept Wildcard Characters? |
false |
-TemplateName<String>
Specifies a friendly name for the resource pool template.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-Token<String>
Specifies an identity token. To create a token, use the Get-MgmtSvcToken cmdlet.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-WorkloadGroupMaxRequests<Int32>
Specifies the maximum number of simultaneous requests that are allowed to run in the workload group. Specify a value of zero (0) to allow unlimited requests.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-WorkloadMaxDegreeOfParallelism<Int32>
Specifies the maximum number of simultaneous requests that are allowed to run in the workload group. Specify a value of zero (0) to allow unlimited requests.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-WorkloadRequestMaxCpuTimeSec<Int32>
Specifies the maximum CPU time, in seconds, that a request can use. Specify a value of zero (0) for an unlimited amount.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-WorkloadRequestMaxMemoryGrantMB<Int32>
Specifies the maximum amount of memory that a request can take from the resource pool.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-WorkloadRequestMemoryGrantTimeoutSec<Int32>
Specifies the maximum time, in seconds, that a query can wait for a memory grant to become available. Specify a value of zero (0) to allow SQL Server to determine the maximum time.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
SqlResourcePoolTemplate
This cmdlet emits a SqlResourcePoolTemplate object.
Examples
Create a resource pool template
The first command creates a resource pool template named SqlRpTemplate1, and then stores it in the $Template variable.
The second command uses the Add-MgmtSvcSqlResourcePoolTemplate cmdlet to add $Template to the specified resource pool.
PS C:\> $Template = New-MgmtSvcSqlResourcePoolTemplate -AdminUri "https://wapmachine01:30004" -Token $Token -TemplateName "SqlRpTemplate1" -MinCpuCores 1 -MaxCpuCores 4 -CapCpuCores 2 -MinMemoryMB 200 -MaxMemoryMB 400 -MinIopsPerVolume 300 -MaxIopsPerVolume 500 -MaxSubscriptionsPerPool 10 -WorkloadRequestMaxCpuTimeSec 20 -WorkloadRequestMaxMemoryGrantMB 100 -WorkloadRequestMemoryGrantTimeoutSec 40 -WorkloadGroupMaxRequests 50 -WorkloadMaxDegreeOfParallelism 10
PS C:\> Add-MgmtSvcSqlResourcePoolTemplate -ResourcePoolTemplate $Template -AdminUri "https://wapmachine01:30004" -Token $Token
Related topics
Add-MgmtSvcSqlResourcePoolTemplate
Get-MgmtSvcSqlResourcePoolTemplate