Managed Instances - List

Referencia

Servicio:: SQL Database

Versión de la API:: 2021-11-01

Obtiene una lista de todas las instancias administradas de la suscripción.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a usar para la solicitud.
$expand	query		string	Los recursos secundarios que se van a incluir en la respuesta.

Respuestas

Nombre	Tipo	Description
200 OK	ManagedInstanceListResult	Se recuperó correctamente la lista de instancias administradas.
Other Status Codes		Respuestas de error: ***

Ejemplos

List managed instances

List managed instances with $expand=administrators/activedirectory

List managed instances

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


/**
 * Samples for ManagedInstances List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedInstanceList.json
     */
    /**
     * Sample code: List managed instances.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listManagedInstances(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstances().list(null, com.azure.core.util.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

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "location": "japaneast",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance1",
      "name": "testinstance1",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "GP_Gen4",
        "tier": "GeneralPurpose",
        "capacity": 8,
        "family": "Gen4"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance1.1b4e2caff2530.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/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,
        "proxyOverride": "Default",
        "minimalTlsVersion": "1.2",
        "dnsZone": "1b4e2caff2530",
        "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
        "currentBackupStorageRedundancy": "Geo",
        "requestedBackupStorageRedundancy": "Geo"
      }
    },
    {
      "location": "japaneast",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance2",
      "name": "testinstance2",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "BC_Gen5",
        "tier": "BusinessCritical",
        "capacity": 16,
        "family": "Gen4"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance2.2c3d1bdae3412.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2",
        "state": "Ready",
        "provisioningState": "Succeeded",
        "vCores": 16,
        "storageSizeInGB": 1024,
        "licenseType": "Full",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "publicDataEndpointEnabled": false,
        "proxyOverride": "Default",
        "minimalTlsVersion": "1.2",
        "dnsZone": "2c3d1bdae3412",
        "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
        "currentBackupStorageRedundancy": "Geo",
        "requestedBackupStorageRedundancy": "Geo"
      }
    }
  ]
}

List managed instances with $expand=administrators/activedirectory

Solicitud de ejemplo

HTTP
Java

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


/**
 * Samples for ManagedInstances List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ManagedInstanceListWithExpandEqualsAdministrators.json
     */
    /**
     * Sample code: List managed instances with $expand=administrators/activedirectory.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listManagedInstancesWithExpandAdministratorsActivedirectory(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstances().list(null, com.azure.core.util.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

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "location": "japaneast",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance1",
      "name": "testinstance1",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "GP_Gen4",
        "tier": "GeneralPurpose",
        "capacity": 8,
        "family": "Gen4"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance1.1b4e2caff2530.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/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,
        "proxyOverride": "Default",
        "minimalTlsVersion": "1.2",
        "dnsZone": "1b4e2caff2530",
        "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_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": "japaneast",
      "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance2",
      "name": "testinstance2",
      "type": "Microsoft.Sql/managedInstances",
      "sku": {
        "name": "BC_Gen5",
        "tier": "BusinessCritical",
        "capacity": 16,
        "family": "Gen4"
      },
      "properties": {
        "fullyQualifiedDomainName": "testinstance2.2c3d1bdae3412.database.windows.net",
        "administratorLogin": "dummylogin",
        "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2",
        "state": "Ready",
        "provisioningState": "Succeeded",
        "vCores": 16,
        "storageSizeInGB": 1024,
        "licenseType": "Full",
        "collation": "SQL_Latin1_General_CP1_CI_AS",
        "publicDataEndpointEnabled": false,
        "proxyOverride": "Default",
        "minimalTlsVersion": "1.2",
        "dnsZone": "2c3d1bdae3412",
        "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_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
        }
      }
    }
  ]
}

Definiciones

Nombre	Description
AdministratorType	Tipo del administrador del servidor.
BackupStorageRedundancy	Tipo de cuenta de almacenamiento que se usa para almacenar copias de seguridad para esta instancia. Las opciones son Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) y GeoZone(GeoZoneRedundantStorage)
IdentityType	Tipo de identidad. Establézcalo en "SystemAssigned" para crear y asignar automáticamente una entidad de seguridad de Azure Active Directory para el recurso.
ManagedInstance	Una instancia administrada de Azure SQL.
ManagedInstanceExternalAdministrator	Propiedades de un administrador de Active Directory.
ManagedInstanceLicenseType	Tipo de licencia. Los valores posibles son "LicenseIncluded" (precio normal incluido de una nueva licencia de SQL) y "BasePrice" (precio de AHB con descuento para traer sus propias licencias sql).
ManagedInstanceListResult	Lista de instancias administradas.
ManagedInstancePecProperty	Una conexión de punto de conexión privado en una instancia administrada
ManagedInstancePrivateEndpointConnectionProperties	Propiedades de una conexión de punto de conexión privado.
ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride	Tipo de conexión que se usa para conectarse a la instancia.
ManagedServerCreateMode	Especifica el modo de creación de la base de datos. Valor predeterminado: creación de instancias normales. Restaurar: crea una instancia restaurando un conjunto de copias de seguridad a un momento dado específico. Se debe especificar RestorePointInTime y SourceManagedInstanceId.
PrincipalType	Tipo de entidad de seguridad del administrador del servidor.
ResourceIdentity	Configuración de identidad de Azure Active Directory para un recurso.
ServicePrincipal	Configuración de la entidad de servicio de la instancia administrada para un recurso.
ServicePrincipalType	Tipo de entidad de servicio.
Sku	Una SKU de recursos de ARM.
UserIdentity	Configuración de identidad de Azure Active Directory para un recurso.

AdministratorType

Enumeración

Tipo del administrador del servidor.

Valor	Description
ActiveDirectory

BackupStorageRedundancy

Enumeración

Tipo de cuenta de almacenamiento que se usa para almacenar copias de seguridad para esta instancia. Las opciones son Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) y GeoZone(GeoZoneRedundantStorage)

Valor	Description
Geo
GeoZone
Local
Zone

IdentityType

Enumeración

Tipo de identidad. Establézcalo en "SystemAssigned" para crear y asignar automáticamente una entidad de seguridad de Azure Active Directory para el recurso.

Valor	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

ManagedInstance

Object

Una instancia administrada de Azure SQL.

Nombre	Tipo	Description
id	string	Identificador de recurso.
identity	ResourceIdentity	Identidad de Azure Active Directory de la instancia administrada.
location	string	Ubicación del recurso.
name	string	Nombre del recurso.
properties.administratorLogin	string	Nombre de usuario del administrador para la instancia administrada. Solo se puede especificar cuando se crea la instancia administrada (y es necesaria para la creación).
properties.administratorLoginPassword	string	La contraseña de inicio de sesión del administrador (necesaria para la creación de la instancia administrada).
properties.administrators	ManagedInstanceExternalAdministrator	Administrador de Azure Active Directory del servidor.
properties.collation	string	Intercalación de la instancia administrada.
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	Tipo de cuenta de almacenamiento que se usa para almacenar copias de seguridad para esta instancia. Las opciones son Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) y GeoZone(GeoZoneRedundantStorage)
properties.dnsZone	string	Zona DNS en la que se encuentra la instancia administrada.
properties.dnsZonePartner	string (arm-id)	Identificador de recurso de otra instancia administrada cuya zona DNS compartirá esta instancia administrada después de la creación.
properties.fullyQualifiedDomainName	string	Nombre de dominio completo de la instancia administrada.
properties.instancePoolId	string	Identificador del grupo de instancias al que pertenece este servidor administrado.
properties.keyId	string	URI de CMK de la clave que se va a usar para el cifrado.
properties.licenseType	ManagedInstanceLicenseType	Tipo de licencia. Los valores posibles son "LicenseIncluded" (precio normal incluido de una nueva licencia de SQL) y "BasePrice" (precio de AHB con descuento para traer sus propias licencias sql).
properties.maintenanceConfigurationId	string	Especifica el identificador de configuración de mantenimiento que se aplicará a esta instancia administrada.
properties.managedInstanceCreateMode	ManagedServerCreateMode	Especifica el modo de creación de la base de datos. Valor predeterminado: creación de instancias normales. Restaurar: crea una instancia restaurando un conjunto de copias de seguridad a un momento dado específico. Se debe especificar RestorePointInTime y SourceManagedInstanceId.
properties.minimalTlsVersion	string	Versión mínima de TLS. Valores permitidos: 'None', '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string (arm-id)	Identificador de recurso de una identidad asignada por el usuario que se va a usar de forma predeterminada.
properties.privateEndpointConnections	ManagedInstancePecProperty[]	Lista de conexiones de punto de conexión privado en una instancia administrada.
properties.provisioningState	enum: Accepted Canceled Created Creating Deleted Deleting Failed NotSpecified Registering Running Succeeded TimedOut Unknown Unrecognized Updating
properties.proxyOverride	ManagedInstanceProxyOverride	Tipo de conexión que se usa para conectarse a la instancia.
properties.publicDataEndpointEnabled	boolean	Si el punto de conexión de datos público está habilitado o no.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	Tipo de cuenta de almacenamiento que se va a usar para almacenar copias de seguridad para esta instancia. Las opciones son Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) y GeoZone(GeoZoneRedundantStorage)
properties.restorePointInTime	string (date-time)	Especifica el momento dado (ISO8601 formato) de la base de datos de origen que se restaurará para crear la nueva base de datos.
properties.servicePrincipal	ServicePrincipal	La entidad de servicio de la instancia administrada.
properties.sourceManagedInstanceId	string (arm-id)	Identificador de recurso de la instancia administrada de origen asociada a la operación de creación de esta instancia.
properties.state	string	Estado de la instancia administrada.
properties.storageSizeInGB	integer (int32)	Tamaño de almacenamiento en GB. Valor mínimo: 32. Valor máximo: 16384. Solo se permiten incrementos de 32 GB. El valor máximo depende de la familia de hardware seleccionada y del número de núcleos virtuales.
properties.subnetId	string (arm-id)	Identificador de recurso de subred para la instancia administrada.
properties.timezoneId	string	Id. de la zona horaria. Los valores permitidos son zonas horarias compatibles con Windows. Windows mantiene detalles sobre las zonas horarias admitidas, incluido el identificador, en el Registro en KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. Para obtener esos valores del Registro a través de SQL Server, consulte SELECT name AS timezone_id FROM sys.time_zone_info. También se puede obtener la lista de identificadores ejecutando [System.TimeZoneInfo]::GetSystemTimeZones() en PowerShell. Un ejemplo de identificador de zona horaria válido es "Hora estándar del Pacífico" o "W. Hora estándar de Europa".
properties.vCores	integer (int32)	Número de núcleos virtuales. Valores permitidos: 8, 16, 24, 32, 40, 64, 80.
properties.zoneRedundant	boolean	Indica si el multi-az está habilitado o no.
sku	Sku	SKU de instancia administrada. Valores permitidos para sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

ManagedInstanceExternalAdministrator

Object

Propiedades de un administrador de Active Directory.

Nombre	Tipo	Description
administratorType	AdministratorType	Tipo del administrador del servidor.
azureADOnlyAuthentication	boolean	Autenticación solo de Azure Active Directory habilitada.
login	string	Nombre de inicio de sesión del administrador del servidor.
principalType	PrincipalType	Tipo de entidad de seguridad del administrador del servidor.
sid	string (uuid)	SID (id. de objeto) del administrador del servidor.
tenantId	string (uuid)	Identificador de inquilino del administrador.

ManagedInstanceLicenseType

Enumeración

Tipo de licencia. Los valores posibles son "LicenseIncluded" (precio normal incluido de una nueva licencia de SQL) y "BasePrice" (precio de AHB con descuento para traer sus propias licencias sql).

Valor	Description
BasePrice
LicenseIncluded

ManagedInstanceListResult

Object

Lista de instancias administradas.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la siguiente página de resultados.
value	ManagedInstance[]	Matriz de resultados.

ManagedInstancePecProperty

Object

Una conexión de punto de conexión privado en una instancia administrada

Nombre	Tipo	Description
id	string	Identificador de recurso.
properties	ManagedInstancePrivateEndpointConnectionProperties	Propiedades de conexión de punto de conexión privado

ManagedInstancePrivateEndpointConnectionProperties

Object

Propiedades de una conexión de punto de conexión privado.

Nombre	Tipo	Description
privateEndpoint	ManagedInstancePrivateEndpointProperty	Punto de conexión privado al que pertenece la conexión.
privateLinkServiceConnectionState	ManagedInstancePrivateLinkServiceConnectionStateProperty	Estado de conexión de la conexión de punto de conexión privado.
provisioningState	string	Estado de la conexión de punto de conexión privado.

ManagedInstancePrivateEndpointProperty

Object

Nombre	Tipo	Description
id	string	Identificador de recurso del punto de conexión privado.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Object

Nombre	Tipo	Description
actionsRequired	string	Descripción de la conexión del servicio private link.
description	string	Descripción de la conexión del servicio private link.
status	string	Estado de conexión del servicio private link.

ManagedInstanceProxyOverride

Enumeración

Tipo de conexión que se usa para conectarse a la instancia.

Valor	Description
Default
Proxy
Redirect

ManagedServerCreateMode

Enumeración

Especifica el modo de creación de la base de datos.

Valor predeterminado: creación de instancias normales.

Restaurar: crea una instancia restaurando un conjunto de copias de seguridad a un momento dado específico. Se debe especificar RestorePointInTime y SourceManagedInstanceId.

Valor	Description
Default
PointInTimeRestore

PrincipalType

Enumeración

Tipo de entidad de seguridad del administrador del servidor.

Valor	Description
Application
Group
User

ResourceIdentity

Object

Configuración de identidad de Azure Active Directory para un recurso.

Nombre	Tipo	Description
principalId	string (uuid)	Identificador de entidad de seguridad de Azure Active Directory.
tenantId	string (uuid)	Identificador de inquilino de Azure Active Directory.
type	IdentityType	Tipo de identidad. Establézcalo en "SystemAssigned" para crear y asignar automáticamente una entidad de seguridad de Azure Active Directory para el recurso.
userAssignedIdentities	<string, UserIdentity>	Identificadores de recursos de las identidades asignadas por el usuario que se van a usar

ServicePrincipal

Object

Configuración de la entidad de servicio de la instancia administrada para un recurso.

Nombre	Tipo	Description
clientId	string	Identificador de cliente de la aplicación de Azure Active Directory.
principalId	string	Identificador del objeto de aplicación de Azure Active Directory.
tenantId	string	Identificador de inquilino de Azure Active Directory.
type	ServicePrincipalType	Tipo de entidad de servicio.

ServicePrincipalType

Enumeración

Tipo de entidad de servicio.

Valor	Description
None
SystemAssigned

Sku

Object

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.

UserIdentity

Object

Configuración de identidad de Azure Active Directory para un recurso.

Nombre	Tipo	Description
clientId	string (uuid)	Identificador de cliente de Azure Active Directory.
principalId	string (uuid)	Identificador de entidad de seguridad de Azure Active Directory.

Compartir a través de

Managed Instances - List

Parámetros de identificador URI

Respuestas

Ejemplos

List managed instances

Solicitud de ejemplo

Respuesta de muestra

List managed instances with $expand=administrators/activedirectory

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AdministratorType

BackupStorageRedundancy

IdentityType

ManagedInstance

ManagedInstanceExternalAdministrator

ManagedInstanceLicenseType

ManagedInstanceListResult

ManagedInstancePecProperty

ManagedInstancePrivateEndpointConnectionProperties

ManagedInstancePrivateEndpointProperty

ManagedInstancePrivateLinkServiceConnectionStateProperty

ManagedInstanceProxyOverride

ManagedServerCreateMode

PrincipalType

ResourceIdentity

ServicePrincipal

ServicePrincipalType

Sku

UserIdentity

Recursos adicionales