Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Get-AzSqlInstancePool
- Module:
- Az.Sql Module
Returns information about the Azure SQL Instance pool.
Syntax
ListBySubOrResourceGroupParameterSet (Default)
Get-AzSqlInstancePool
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ListByInstancePoolDefaultsParameterSet
Get-AzSqlInstancePool
[-Name] <String>
-ResourceGroupName <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetInstancePoolByInstancePoolResourceIdentifierParameterSet
Get-AzSqlInstancePool
[-ResourceId] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzSqlInstancePool cmdlet returns information about one or more Azure SQL Instance pool. Specify the name of an instance pool to see information for only that instance pool.
Examples
Example 1: Get all instance pools across a customer subscription
Get-AzSqlInstancePool
ResourceGroupName : resourcegroup01
Type : Microsoft.Sql/instancePools
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0
InstancePoolName : instancePool0
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name
VCores : 8
ComputeGeneration : Gen5
Edition : GeneralPurpose
Tags :
Sku : Microsoft.Azure.Management.Sql.Models.Sku
Location : canadacentral
LicenseType : LicenseIncluded
MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_canadacentral_MI_1
ResourceGroupName : resourcegroup02
Type : Microsoft.Sql/instancePools
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup02/providers/Microsoft.Sql/instancePools/ps-instancepool-1
InstancePoolName : instancePool0
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup02/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name
VCores : 8
ComputeGeneration : Gen5
Edition : GeneralPurpose
Tags :
Sku : Microsoft.Azure.Management.Sql.Models.Sku
Location : canadacentral
LicenseType : LicenseIncluded
MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_canadacentral_MI_1
This command gets information about all instance pools within the customer subscription.
Example 2: Get all instance pools across a resource group
Get-AzSqlInstancePool -ResourceGroupName resourcegroup01
ResourceGroupName : resourcegroup01
Type : Microsoft.Sql/instancePools
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0
InstancePoolName : instancePool0
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name
VCores : 8
ComputeGeneration : Gen5
Edition : GeneralPurpose
Tags :
Sku : Microsoft.Azure.Management.Sql.Models.Sku
Location : canadacentral
LicenseType : LicenseIncluded
DnsZone : 1234567890
MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_canadacentral_MI_1
This command gets information about all instance pools within the resource group resourcegroup01.
Example 3: Get information about an instance pool
Get-AzSqlInstancePool -ResourceGroupName resourcegroup01 -Name instancePool0
ResourceGroupName : resourcegroup01
Type : Microsoft.Sql/instancePools
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0
InstancePoolName : instancePool0
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name
VCores : 8
ComputeGeneration : Gen5
Edition : GeneralPurpose
Tags :
Sku : Microsoft.Azure.Management.Sql.Models.Sku
Location : canadacentral
LicenseType : LicenseIncluded
DnsZone : 1234567890
MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_canadacentral_MI_1
This command gets information about the instance pool instancePool0.
Example 4: Get information about an instance pool using instance pool resource id
Get-AzSqlInstancePool -ResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0"
ResourceGroupName : resourcegroup01
Type : Microsoft.Sql/instancePools
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/instancePools/instancePool0
InstancePoolName : instancePool0
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name
VCores : 8
ComputeGeneration : Gen5
Edition : GeneralPurpose
Tags :
Sku : Microsoft.Azure.Management.Sql.Models.Sku
Location : canadacentral
LicenseType : LicenseIncluded
DnsZone : 1234567890
MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_canadacentral_MI_1
This command gets information about the instance pool with its resource identifier.
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
-Name
The instance pool name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | InstancePoolName |
Parameter sets
-ResourceGroupName
The resource group name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceId
The instance pool resource identifier.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
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.
Inputs
None
Outputs
AzureSqlInstancePoolModel
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure PowerShell
Feedback
Was this page helpful?