Instance Pools - List

Servicio:: SQL Database

Versión de la API:: 2025-01-01

Obtiene una lista de todos los grupos de instancias de la suscripción.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/instancePools?api-version=2025-01-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	InstancePoolListResult	Operación de Azure completada con éxito.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

List instance pools in the subscription

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/instancePools?api-version=2025-01-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/ListInstancePoolsBySubscriptionId.json
// this example is just showing the usage of "InstancePools_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (InstancePoolResource item in subscriptionResource.GetInstancePoolsAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    InstancePoolData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "name": "testIP",
      "type": "Microsoft.Sql/instancePools",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/instancePools/testIP",
      "location": "japaneast",
      "properties": {
        "dnsZone": "1234567890",
        "licenseType": "LicenseIncluded",
        "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
        "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Network/virtualNetwork/myvnet/subnets/mysubnet1",
        "vCores": 8
      },
      "sku": {
        "name": "GP_Gen5",
        "family": "Gen5",
        "tier": "GeneralPurpose"
      },
      "tags": {
        "a": "b"
      }
    },
    {
      "name": "testIP2",
      "type": "Microsoft.Sql/instancePools",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group2/providers/Microsoft.Sql/instancePools/testIP2",
      "location": "japaneast",
      "properties": {
        "dnsZone": "1234567890",
        "licenseType": "LicenseIncluded",
        "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
        "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group2/providers/Microsoft.Network/virtualNetwork/myvnet/subnets/mysubnet1",
        "vCores": 8
      },
      "sku": {
        "name": "GP_Gen5",
        "family": "Gen5",
        "tier": "GeneralPurpose"
      },
      "tags": {
        "a": "b"
      }
    }
  ]
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
InstancePool	Un pool de instancias de Azure SQL.
InstancePoolLicenseType	Tipo de licencia. Los valores posibles son "LicenseIncluded" (se incluye el precio de la licencia de SQL) y "BasePrice" (sin precio de licencia de SQL).
InstancePoolListResult	La respuesta de una operación de lista de InstancePool.
Sku	Una SKU de recursos de ARM.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

InstancePool

Objeto

Un pool de instancias de Azure SQL.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.dnsZone	string	Zona DNS en la que se encuentra el grupo de instancias administradas.
properties.licenseType	InstancePoolLicenseType	Tipo de licencia. Los valores posibles son "LicenseIncluded" (se incluye el precio de la licencia de SQL) y "BasePrice" (sin precio de licencia de SQL).
properties.maintenanceConfigurationId	string (arm-id)	Especifica el identificador de configuración de mantenimiento que se aplicará a esta instancia administrada.
properties.subnetId	string	Identificador de recurso de la subred en el que se va a colocar este grupo de instancias.
properties.vCores	integer (int32)	Recuento de núcleos virtuales que pertenecen a este grupo de instancias.
sku	Sku	Nombre y nivel de la SKU.
systemData	systemData	Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso. Por ejemplo, "Microsoft. Compute/virtualMachines" o "Microsoft. CuentasAlmacenamiento/Almacenamiento"

InstancePoolLicenseType

Enumeración

Tipo de licencia. Los valores posibles son "LicenseIncluded" (se incluye el precio de la licencia de SQL) y "BasePrice" (sin precio de licencia de SQL).

Valor	Description
LicenseIncluded	LicenciaIncluido
BasePrice	BasePrice

InstancePoolListResult

Objeto

La respuesta de una operación de lista de InstancePool.

Nombre	Tipo	Description
nextLink	string (uri)	El enlace a la siguiente página de artículos
value	InstancePool[]	Los elementos de InstancePool en esta página

Sku

Objeto

Una SKU de recursos de ARM.

Nombre	Tipo	Description
capacity	integer (int32)	Capacidad de la SKU determinada.
family	string	Si el servicio tiene diferentes generaciones de hardware, para la misma SKU, se puede capturar aquí.
name	string	El nombre de la SKU, normalmente, una letra + código de número, por ejemplo, P3.
size	string	Tamaño de la SKU determinada
tier	string	Nivel o edición de la SKU concreta, por ejemplo, Básico, Premium.

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	La marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.