Get-AzSqlInstancePoolUsage
Returns information about an Azure SQL Instance pool's usage.
Syntax
InstancePoolUsageDefaultParameterSet (Default)
Get-AzSqlInstancePoolUsage
[-ResourceGroupName] <String>
[-Name] <String>
[-ExpandChildren]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
InstancePoolUsageParentObjectParameterSet
Get-AzSqlInstancePoolUsage
[-InstancePool] <AzureSqlInstancePoolModel>
[-ExpandChildren]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
InstancePoolUsageResourceIdParameterSet
Get-AzSqlInstancePoolUsage
[-ResourceId] <String>
[-ExpandChildren]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzSqlInstancePoolUsage cmdlet returns information an Azure SQL Instance pool's usage.
Examples
Example 1 : Gets the usage of an Azure SQL Instance pool
Get-AzSqlInstancePoolUsage -ResourceGroupName resourcegroup01 -Name instancepool0
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/vcore_utilization
CurrentValue : 2
Limit : 8
RequestedLimit :
Unit : VCores
Name : VCore utilization
Type : Microsoft.Sql/instancePools/usages
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/storage_utilization
CurrentValue : 32
Limit : 8192
RequestedLimit :
Unit : Gigabytes
Name : Storage utilization
Type : Microsoft.Sql/instancePools/usages
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/database_utilization
CurrentValue : 0
Limit : 100
RequestedLimit :
Unit : Number Of Databases
Name : Database utilization
Type : Microsoft.Sql/instancePools/usages
Gets the usage for the Azure SQL Instance pool instancepool0.
Example 2: Gets the usage of an Azure SQL Instance pool using an instance pool object
$instancePool = Get-AzSqlInstancePool -ResourceGroupName resourcegroup01 -Name instancepool0
Get-AzSqlInstancePoolUsage -InstancePool $instancePool
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/vcore_utilization
CurrentValue : 2
Limit : 8
RequestedLimit :
Unit : VCores
Name : VCore utilization
Type : Microsoft.Sql/instancePools/usages
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/storage_utilization
CurrentValue : 32
Limit : 8192
RequestedLimit :
Unit : Gigabytes
Name : Storage utilization
Type : Microsoft.Sql/instancePools/usages
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/database_utilization
CurrentValue : 0
Limit : 100
RequestedLimit :
Unit : Number Of Databases
Name : Database utilization
Type : Microsoft.Sql/instancePools/usages
Gets the usage for the Azure SQL Instance pool instancepool0 using an instance pool object.
Example 3: Gets the usage of an Azure SQL Instance pool using an instance pool resource id
Get-AzSqlInstancePoolUsage -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0"
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/vcore_utilization
CurrentValue : 2
Limit : 8
RequestedLimit :
Unit : VCores
Name : VCore utilization
Type : Microsoft.Sql/instancePools/usages
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/storage_utilization
CurrentValue : 32
Limit : 8192
RequestedLimit :
Unit : Gigabytes
Name : Storage utilization
Type : Microsoft.Sql/instancePools/usages
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/database_utilization
CurrentValue : 0
Limit : 100
RequestedLimit :
Unit : Number Of Databases
Name : Database utilization
Type : Microsoft.Sql/instancePools/usages
Gets the usage for the Azure SQL Instance pool instancepool0 using an instance pool resource identifier.
Example 3: Gets the usage of an Azure SQL Instance pool with a breakdown of the managed instance usages within the pool.
Get-AzSqlInstancePoolUsage -ResourceGroupName resourcegroup01 -Name instancepool0 -ExpandChildren
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/vcore_utilization
CurrentValue : 2
Limit : 8
RequestedLimit :
Unit : VCores
Name : VCore utilization
Type : Microsoft.Sql/instancePools/usages
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/storage_utilization
CurrentValue : 32
Limit : 8192
RequestedLimit :
Unit : Gigabytes
Name : Storage utilization
Type : Microsoft.Sql/instancePools/usages
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancepool0/usages/database_utilization
CurrentValue : 0
Limit : 100
RequestedLimit :
Unit : Number Of Databases
Name : Database utilization
Type : Microsoft.Sql/instancePools/usages
Id : /subscriptions/2e7fe4bd-90c7-454e-8bb6-dc44649f27b2/resourceGroups/poolsPS/providers/Microsoft.Sql/instancePools/instancepool0/managedInstances/managedinstance0/usages/vcore_utilization
CurrentValue :
Limit : 2
RequestedLimit :
Unit : VCores
Name : VCore utilization
Type : Microsoft.Sql/instancePools/managedInstances/usages
Id : /subscriptions/2e7fe4bd-90c7-454e-8bb6-dc44649f27b2/resourceGroups/poolsPS/providers/Microsoft.Sql/instancePools/instancepool0/managedInstances/managedinstance0/usages/storage_utilization
CurrentValue :
Limit : 32
RequestedLimit :
Unit : Gigabytes
Name : Storage utilization
Type : Microsoft.Sql/instancePools/managedInstances/usages
Id : /subscriptions/2e7fe4bd-90c7-454e-8bb6-dc44649f27b2/resourceGroups/poolsPS/providers/Microsoft.Sql/instancePools/instancepool0/managedInstances/managedinstance0/usages/database_utilization
CurrentValue : 0
Limit : 100
RequestedLimit :
Unit : Number Of Databases
Name : Database utilization
Type : Microsoft.Sql/instancePools/managedInstances/usages
Gets the usage for the Azure SQL Instance pool instancepool0 along with the usages of the managed instances within instancepool0.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ExpandChildren
Flag indicating whether to expand this instance pool's usage with its children's usage.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InstancePool
The parent instance pool object.
Parameter properties
| Type: | AzureSqlInstancePoolModel |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InstancePoolUsageParentObjectParameterSet
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The managed instance pool name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | InstancePoolName |
Parameter sets
InstancePoolUsageDefaultParameterSet
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
The resource group name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InstancePoolUsageDefaultParameterSet
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceId
The parent resource id.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | InstancePoolResourceId |
Parameter sets
InstancePoolUsageResourceIdParameterSet
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
