Managed Instances - List By Instance Pool

Service:

SQL Database

API Version:

2021-11-01

Obtient la liste de toutes les instances managées d’un pool instance.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}/managedInstances?api-version=2021-11-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}/managedInstances?$expand={$expand}&api-version=2021-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
instancePoolName	path	True	string	Nom du pool instance.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.
$expand	query		string	Ressources enfants à inclure dans la réponse.

Réponses

Nom	Type	Description
200 OK	ManagedInstanceListResult	La liste des instances managées a été récupérée.
Other Status Codes		Réponses d’erreur : *** 404 InstancePoolNotFound : un pool instance est introuvable

Exemples

List managed instances by instance pool

List managed instances by instance pool with $expand=administrators/activedirectory

List managed instances by instance pool

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/instancePools/pool1/managedInstances?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for ManagedInstances ListByInstancePool. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedInstanceListByInstancePool.
     * json
     */
    /**
     * Sample code: List managed instances by instance pool.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listManagedInstancesByInstancePool(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstances().listByInstancePool("Test1", "pool1", null,
            Context.NONE);
    }
}

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

Sample Response

Status code:

200

{
  "value": [
    {
      "location": "canadacentral",
      "id": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance1",
      "name": "testinstance1",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "GP_Gen5",
        "tier": "GeneralPurpose",
        "capacity": 8,
        "family": "Gen5"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance1.1b4e2caff2530.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "state": "Ready",
        "provisioningState": "Succeeded",
        "vCores": 8,
        "storageSizeInGB": 1024,
        "licenseType": "LicenseIncluded",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "publicDataEndpointEnabled": false,
        "dnsZone": "1b4e2caff2530",
        "proxyOverride": "Redirect",
        "minimalTlsVersion": "1.2",
        "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/instancePools/pool1",
        "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_CanadaCentral_MI_1",
        "currentBackupStorageRedundancy": "Geo",
        "requestedBackupStorageRedundancy": "Geo"
      }
    },
    {
      "location": "canadacentral",
      "id": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance2",
      "name": "testinstance2",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "GP_Gen5",
        "tier": "GeneralPurpose",
        "capacity": 16,
        "family": "Gen5"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance2.2c3d1bdae3412.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "state": "Ready",
        "provisioningState": "Succeeded",
        "vCores": 16,
        "storageSizeInGB": 1024,
        "licenseType": "Full",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "publicDataEndpointEnabled": false,
        "dnsZone": "2c3d1bdae3412",
        "proxyOverride": "Redirect",
        "minimalTlsVersion": "1.2",
        "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/instancePools/pool1",
        "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_CanadaCentral_MI_1",
        "currentBackupStorageRedundancy": "Geo",
        "requestedBackupStorageRedundancy": "Geo"
      }
    }
  ]
}

List managed instances by instance pool with $expand=administrators/activedirectory

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/instancePools/pool1/managedInstances?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for ManagedInstances ListByInstancePool. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ManagedInstanceListByInstancePoolWithExpandEqualsAdministrators.json
     */
    /**
     * Sample code: List managed instances by instance pool with $expand=administrators/activedirectory.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listManagedInstancesByInstancePoolWithExpandAdministratorsActivedirectory(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstances().listByInstancePool("Test1", "pool1", null,
            Context.NONE);
    }
}

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

Sample Response

Status code:

200

{
  "value": [
    {
      "location": "canadacentral",
      "id": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance1",
      "name": "testinstance1",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "GP_Gen5",
        "tier": "GeneralPurpose",
        "capacity": 8,
        "family": "Gen5"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance1.1b4e2caff2530.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "state": "Ready",
        "provisioningState": "Succeeded",
        "vCores": 8,
        "storageSizeInGB": 1024,
        "licenseType": "LicenseIncluded",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "publicDataEndpointEnabled": false,
        "dnsZone": "1b4e2caff2530",
        "proxyOverride": "Redirect",
        "minimalTlsVersion": "1.2",
        "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/instancePools/pool1",
        "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_CanadaCentral_MI_1",
        "currentBackupStorageRedundancy": "Geo",
        "requestedBackupStorageRedundancy": "Geo",
        "administrators": {
          "principalType": "User",
          "login": "bob@contoso.com",
          "sid": "00000011-1111-2222-2222-123456789111",
          "tenantId": "00000011-1111-2222-2222-123456789111",
          "azureADOnlyAuthentication": true
        }
      }
    },
    {
      "location": "canadacentral",
      "id": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance2",
      "name": "testinstance2",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "GP_Gen5",
        "tier": "GeneralPurpose",
        "capacity": 16,
        "family": "Gen5"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance2.2c3d1bdae3412.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "state": "Ready",
        "provisioningState": "Succeeded",
        "vCores": 16,
        "storageSizeInGB": 1024,
        "licenseType": "Full",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "publicDataEndpointEnabled": false,
        "dnsZone": "2c3d1bdae3412",
        "proxyOverride": "Redirect",
        "minimalTlsVersion": "1.2",
        "instancePoolId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/Test1/providers/Microsoft.Sql/instancePools/pool1",
        "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_CanadaCentral_MI_2",
        "currentBackupStorageRedundancy": "Geo",
        "requestedBackupStorageRedundancy": "Geo",
        "administrators": {
          "principalType": "User",
          "login": "bob@contoso.com",
          "sid": "00000011-1111-2222-2222-123456789111",
          "tenantId": "00000011-1111-2222-2222-123456789111",
          "azureADOnlyAuthentication": true
        }
      }
    }
  ]
}

Définitions

Nom	Description
AdministratorType	Type de l’administrateur de serveur.
BackupStorageRedundancy	Type de compte de stockage utilisé pour stocker les sauvegardes pour cette instance. Les options sont Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) et GeoZone (GeoZoneRedundantStorage).
IdentityType	Type d’identité. Définissez cette valeur sur « SystemAssigned » afin de créer et d’affecter automatiquement un principal Azure Active Directory pour la ressource.
ManagedInstance	Une instance managée Azure SQL.
ManagedInstanceExternalAdministrator	Propriétés d’un administrateur Active Directory.
ManagedInstanceLicenseType	Type de licence. Les valeurs possibles sont « LicenseIncluded » (prix normal inclus d’une nouvelle licence SQL) et « BasePrice » (prix AHB réduit pour apporter vos propres licences SQL).
ManagedInstanceListResult	Liste des instances managées.
ManagedInstancePecProperty	Connexion de point de terminaison privé sous un instance managé
ManagedInstancePrivateEndpointConnectionProperties	Propriétés d’une connexion de point de terminaison privé.
ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride	Type de connexion utilisé pour la connexion au instance.
ManagedServerCreateMode	Spécifie le mode de création de la base de données. Par défaut : création de instance standard. Restaurer : crée une instance en restaurant un ensemble de sauvegardes à un moment spécifique dans le temps. RestorePointInTime et SourceManagedInstanceId doivent être spécifiés.
PrincipalType	Type de principal de l’administrateur de serveur.
ResourceIdentity	Configuration de l’identité Azure Active Directory pour une ressource.
ServicePrincipal	Configuration du principal de service du instance managé pour une ressource.
ServicePrincipalType	Type de principal de service.
Sku	Référence SKU de ressource ARM.
UserIdentity	Configuration de l’identité Azure Active Directory pour une ressource.

AdministratorType

Type de l’administrateur de serveur.

Nom	Type	Description
ActiveDirectory	string

BackupStorageRedundancy

Type de compte de stockage utilisé pour stocker les sauvegardes pour cette instance. Les options sont Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) et GeoZone (GeoZoneRedundantStorage).

Nom	Type	Description
Geo	string
GeoZone	string
Local	string
Zone	string

IdentityType

Type d’identité. Définissez cette valeur sur « SystemAssigned » afin de créer et d’affecter automatiquement un principal Azure Active Directory pour la ressource.

Nom	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ManagedInstance

Une instance managée Azure SQL.

Nom	Type	Description
id	string	ID de la ressource
identity	ResourceIdentity	Identité Azure Active Directory du instance managé.
location	string	Emplacement de la ressource.
name	string	Nom de la ressource.
properties.administratorLogin	string	Nom d’utilisateur administrateur pour le instance managé. Ne peut être spécifié que lorsque le instance managé est en cours de création (et est requis pour la création).
properties.administratorLoginPassword	string	Mot de passe de connexion administrateur (requis pour la création de instance managés).
properties.administrators	ManagedInstanceExternalAdministrator	Administrateur Azure Active Directory du serveur.
properties.collation	string	Classement des instance managés.
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Type de compte de stockage utilisé pour stocker les sauvegardes pour cette instance. Les options sont Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) et GeoZone (GeoZoneRedundantStorage).
properties.dnsZone	string	Zone DNS dans laquelle se trouve le instance managé.
properties.dnsZonePartner	string	ID de ressource d’une autre instance managée dont cette instance managée partagera la zone DNS après sa création.
properties.fullyQualifiedDomainName	string	Nom de domaine complet du instance managé.
properties.instancePoolId	string	ID du pool de instance auquel appartient ce serveur managé.
properties.keyId	string	URI CMK de la clé à utiliser pour le chiffrement.
properties.licenseType	ManagedInstanceLicenseType	Type de licence. Les valeurs possibles sont « LicenseIncluded » (prix normal inclus d’une nouvelle licence SQL) et « BasePrice » (prix AHB réduit pour apporter vos propres licences SQL).
properties.maintenanceConfigurationId	string	Spécifie l’ID de configuration de maintenance à appliquer à cette instance managée.
properties.managedInstanceCreateMode	ManagedServerCreateMode	Spécifie le mode de création de la base de données. Par défaut : création de instance standard. Restaurer : crée une instance en restaurant un ensemble de sauvegardes à un moment spécifique dans le temps. RestorePointInTime et SourceManagedInstanceId doivent être spécifiés.
properties.minimalTlsVersion	string	Version tls minimale. Valeurs autorisées : 'None', '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string	ID de ressource d’une identité affectée par l’utilisateur à utiliser par défaut.
properties.privateEndpointConnections	ManagedInstancePecProperty[]	Liste des connexions de point de terminaison privé sur un instance managé.
properties.provisioningState	enum: Accepted Canceled Created Creating Deleted Deleting Failed NotSpecified Registering Running Succeeded TimedOut Unknown Unrecognized Updating
properties.proxyOverride	ManagedInstanceProxyOverride	Type de connexion utilisé pour la connexion au instance.
properties.publicDataEndpointEnabled	boolean	Indique si le point de terminaison de données public est activé ou non.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Type de compte de stockage à utiliser pour stocker les sauvegardes pour cette instance. Les options sont Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) et GeoZone (GeoZoneRedundantStorage).
properties.restorePointInTime	string	Spécifie le point dans le temps (format ISO8601) de la base de données source qui sera restaurée pour créer la nouvelle base de données.
properties.servicePrincipal	ServicePrincipal	Principal de service du instance managé.
properties.sourceManagedInstanceId	string	Identificateur de ressource du instance managé source associé à l’opération de création de ce instance.
properties.state	string	État du instance managé.
properties.storageSizeInGB	integer	Taille de stockage en Go. Valeur minimale : 32. Valeur maximale : 16384. Incréments de 32 Go autorisés uniquement. La valeur maximale dépend de la famille de matériel sélectionnée et du nombre de vCores.
properties.subnetId	string	ID de ressource de sous-réseau pour le instance managé.
properties.timezoneId	string	ID du fuseau horaire. Les valeurs autorisées sont des fuseaux horaires pris en charge par Windows. Windows conserve les détails des fuseaux horaires pris en charge, y compris l’ID, dans le Registre sous KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Fuseaux horaires. Vous pouvez obtenir ces valeurs de Registre via SQL Server en interrogeant SELECT name AS timezone_id FROM sys.time_zone_info. La liste des ID peut également être obtenue en exécutant [System.TimeZoneInfo] ::GetSystemTimeZones() dans PowerShell. Un exemple d’ID de fuseau horaire valide est « Pacific Standard Time » ou « W. Heure standard de l’Europe ».
properties.vCores	integer	Nombre de vCores. Valeurs autorisées : 8, 16, 24, 32, 40, 64, 80.
properties.zoneRedundant	boolean	Indique si le multi-az est activé ou non.
sku	Sku	Référence SKU instance managée. Valeurs autorisées pour les sku.name : GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
tags	object	Balises de ressource.
type	string	Type de ressource.

ManagedInstanceExternalAdministrator

Propriétés d’un administrateur Active Directory.

Nom	Type	Description
administratorType	AdministratorType	Type de l’administrateur de serveur.
azureADOnlyAuthentication	boolean	Azure Active Directory uniquement Authentification activée.
login	string	Nom de connexion de l’administrateur du serveur.
principalType	PrincipalType	Type principal de l’administrateur de serveur.
sid	string	SID (ID d’objet) de l’administrateur du serveur.
tenantId	string	ID de locataire de l’administrateur.

ManagedInstanceLicenseType

Type de licence. Les valeurs possibles sont « LicenseIncluded » (prix normal inclus d’une nouvelle licence SQL) et « BasePrice » (prix AHB réduit pour apporter vos propres licences SQL).

Nom	Type	Description
BasePrice	string
LicenseIncluded	string

ManagedInstanceListResult

Liste des instances managées.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page de résultats suivante.
value	ManagedInstance[]	Tableau de résultats.

ManagedInstancePecProperty

Connexion de point de terminaison privé sous un instance managé

Nom	Type	Description
id	string	ID de la ressource
properties	ManagedInstancePrivateEndpointConnectionProperties	Propriétés de connexion de point de terminaison privé

ManagedInstancePrivateEndpointConnectionProperties

Propriétés d’une connexion de point de terminaison privé.

Nom	Type	Description
privateEndpoint	ManagedInstancePrivateEndpointProperty	Point de terminaison privé auquel appartient la connexion.
privateLinkServiceConnectionState	ManagedInstancePrivateLinkServiceConnectionStateProperty	État de la connexion de la connexion de point de terminaison privé.
provisioningState	string	État de la connexion de point de terminaison privé.

ManagedInstancePrivateEndpointProperty

Nom	Type	Description
id	string	ID de ressource du point de terminaison privé.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Nom	Type	Description
actionsRequired	string	Description de la connexion au service private link.
description	string	Description de la connexion au service private link.
status	string	La connexion au service de liaison privée status.

ManagedInstanceProxyOverride

Type de connexion utilisé pour la connexion au instance.

Nom	Type	Description
Default	string
Proxy	string
Redirect	string

ManagedServerCreateMode

Spécifie le mode de création de la base de données.

Par défaut : création de instance standard.

Restaurer : crée une instance en restaurant un ensemble de sauvegardes à un moment spécifique dans le temps. RestorePointInTime et SourceManagedInstanceId doivent être spécifiés.

Nom	Type	Description
Default	string
PointInTimeRestore	string

PrincipalType

Type de principal de l’administrateur de serveur.

Nom	Type	Description
Application	string
Group	string
User	string

ResourceIdentity

Configuration de l’identité Azure Active Directory pour une ressource.

Nom	Type	Description
principalId	string	ID du principal Azure Active Directory.
tenantId	string	ID de locataire Azure Active Directory.
type	IdentityType	Type d’identité. Définissez ce paramètre sur « SystemAssigned » afin de créer et d’affecter automatiquement un principal Azure Active Directory pour la ressource.
userAssignedIdentities	<string,  UserIdentity>	ID de ressource des identités affectées par l’utilisateur à utiliser

ServicePrincipal

Configuration du principal de service du instance managé pour une ressource.

Nom	Type	Description
clientId	string	ID client de l’application Azure Active Directory.
principalId	string	ID d’objet de l’application Azure Active Directory.
tenantId	string	ID de locataire Azure Active Directory.
type	ServicePrincipalType	Type de principal de service.

ServicePrincipalType

Type de principal de service.

Nom	Type	Description
None	string
SystemAssigned	string

Sku

Référence SKU de ressource ARM.

Nom	Type	Description
capacity	integer	Capacité de la référence SKU particulière.
family	string	Si le service a différentes générations de matériel, pour la même référence SKU, cela peut être capturé ici.
name	string	Nom de la référence SKU, généralement une lettre + un code numérique, par exemple P3.
size	string	Taille de la référence SKU particulière
tier	string	Niveau ou édition de la référence SKU particulière, par exemple De base, Premium.

UserIdentity

Configuration de l’identité Azure Active Directory pour une ressource.

Nom	Type	Description
clientId	string	ID client Azure Active Directory.
principalId	string	ID du principal Azure Active Directory.