Get-AzSqlInstancePool

Reference

Module:: Az.Sql

Returns information about the Azure SQL Instance pool.

Syntax

Get-AzSqlInstancePool
   [-ResourceGroupName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSqlInstancePool
   -ResourceGroupName <String>
   [-Name] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

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.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The instance pool name.

Type:	String
Aliases:	InstancePoolName
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The resource group name.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

The instance pool resource identifier.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

None

Outputs

AzureSqlInstancePoolModel