Get-SCUserRoleQuota
Get-SCUserRoleQuota
Gets a user role quota object.
Syntax
Parameter Set: Default
Get-SCUserRoleQuota [[-UserRole] <UserRole> ] [-Cloud <Cloud> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-QuotaPerUser <Boolean]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Get-SCUserRoleQuota cmdlet gets a Virtual Machine Manager (VMM) user role quota object. Two user role quota objects are returned for a self-service user role per private cloud: one object contains information about the role-level quota, and the other object contains information about member-level quota. The QuotaPerUser parameter allows you to return just one of the objects. When QuotaPerUser is $True, only the member-level quota object is returned. When set to $False, only the role-level quota object is returned.
Parameters
-Cloud<Cloud>
Specifies a private cloud object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OnBehalfOfUser<System.String>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-QuotaPerUser<Boolean]>
Indicates whether the cmdlet sets or retrieves user level quotas or member level quotas. Specifying $True indicates member level quotas. Specifying $False indicates role level quotas. If the parameter is not used, both quotas are set or returned.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UserRole<UserRole>
Specifies a user role object.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
- UserRoleQuota
Examples
Example 1: Get per-user virtual machine count quota for a specific private cloud
The first command gets the private cloud object named Cloud01, and then stores the object in the $Cloud variable.
The second command gets the user role object named ContosoSelfServiceUsers, and then stores the object in the $Role variable.
The third command gets the user role quota for the private cloud stored in $Cloud and user role stored in $Role. The QuotaPerUser parameter set to $True indicates that the quota for members will be returned.
The last command displays the virtual machine count quota.
PS C:\> $Cloud = Get-SCCloud -Name "Cloud01"
PS C:\> $Role = Get-SCUserRole -Name "ContosoSelfServiceUsers"
PS C:\> $Quota = Get-SCUserRoleQuota -Cloud $Cloud -UserRole $Role -QuotaPerUser $True
PS C:\> Write-Output $Quota.VMCount