Managed Instances - List

Referência

Service:: SQL Database

API Version:: 2021-11-01

Obtém uma lista de todas as instâncias geridas na subscrição.

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

With optional parameters:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string	O ID da subscrição que identifica uma subscrição do Azure.
api-version	query	True	string	A versão da API a utilizar para o pedido.
$expand	query		string	Os recursos subordinados a incluir na resposta.

Respostas

Name	Tipo	Description
200 OK	ManagedInstanceListResult	Obteve com êxito a lista de instâncias geridas.
Other Status Codes		Respostas de Erro: ***

Exemplos

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


import com.azure.core.util.Context;

/** 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, 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": "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

Sample Request

HTTP
Java

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


import com.azure.core.util.Context;

/** 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, 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": "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
        }
      }
    }
  ]
}

Definições

Name	Description
AdministratorType	Tipo de administrador de gravidade.
BackupStorageRedundancy	O tipo de conta de armazenamento utilizado para armazenar cópias de segurança para esta instância. As opções são Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) e GeoZone(GeoZoneRedundantStorage)
IdentityType	O tipo de identidade. Defina esta opção como "SystemAssigned" para criar e atribuir automaticamente um principal do Azure Active Directory para o recurso.
ManagedInstance	Uma instância gerida SQL do Azure.
ManagedInstanceExternalAdministrator	Propriedades de um administrador do Active Directory.
ManagedInstanceLicenseType	O tipo de licença. Os valores possíveis são "LicenseIncluded" (preço normal, incluindo uma nova licença SQL) e "Preço Base" (preço AHB com desconto para trazer as suas próprias licenças SQL).
ManagedInstanceListResult	Uma lista de instâncias geridas.
ManagedInstancePecProperty	Uma ligação de ponto final privado numa instância gerida
ManagedInstancePrivateEndpointConnectionProperties	Propriedades de uma ligação de ponto final privado.
ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride	Tipo de ligação utilizado para ligar à instância.
ManagedServerCreateMode	Especifica o modo de criação da base de dados. Predefinição: criação de instâncias regulares. Restauro: cria uma instância ao restaurar um conjunto de cópias de segurança para um ponto específico no tempo. RestorePointInTime e SourceManagedInstanceId têm de ser especificados.
PrincipalType	Tipo principal do administrador de gravidade.
ResourceIdentity	Configuração de identidade do Azure Active Directory para um recurso.
ServicePrincipal	A configuração do principal de serviço da instância gerida para um recurso.
ServicePrincipalType	Tipo de principal de serviço.
Sku	Um SKU de Recurso do ARM.
UserIdentity	Configuração de identidade do Azure Active Directory para um recurso.

AdministratorType

Tipo de administrador de gravidade.

Name	Tipo	Description
ActiveDirectory	string

BackupStorageRedundancy

O tipo de conta de armazenamento utilizado para armazenar cópias de segurança para esta instância. As opções são Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) e GeoZone(GeoZoneRedundantStorage)

Name	Tipo	Description
Geo	string
GeoZone	string
Local	string
Zone	string

IdentityType

O tipo de identidade. Defina esta opção como "SystemAssigned" para criar e atribuir automaticamente um principal do Azure Active Directory para o recurso.

Name	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ManagedInstance

Uma instância gerida SQL do Azure.

Name	Tipo	Description
id	string	ID do Recurso.
identity	ResourceIdentity	A identidade do Azure Active Directory da instância gerida.
location	string	Localização do recurso.
name	string	Nome do recurso.
properties.administratorLogin	string	Nome de utilizador administrador da instância gerida. Só pode ser especificado quando a instância gerida está a ser criada (e é necessária para a criação).
properties.administratorLoginPassword	string	A palavra-passe de início de sessão do administrador (necessária para a criação da instância gerida).
properties.administrators	ManagedInstanceExternalAdministrator	O administrador do Azure Active Directory do servidor.
properties.collation	string	Agrupamento da instância gerida.
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	O tipo de conta de armazenamento utilizado para armazenar cópias de segurança para esta instância. As opções são Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) e GeoZone(GeoZoneRedundantStorage)
properties.dnsZone	string	A Zona DNS na qual se encontra a instância gerida.
properties.dnsZonePartner	string	O ID de recurso de outra instância gerida cuja zona DNS esta instância gerida irá partilhar após a criação.
properties.fullyQualifiedDomainName	string	O nome de domínio completamente qualificado da instância gerida.
properties.instancePoolId	string	O ID do conjunto de instâncias a que este servidor gerido pertence.
properties.keyId	string	Um URI CMK da chave a utilizar para encriptação.
properties.licenseType	ManagedInstanceLicenseType	O tipo de licença. Os valores possíveis são "LicenseIncluded" (preço normal, incluindo uma nova licença SQL) e "Preço Base" (preço AHB com desconto para trazer as suas próprias licenças SQL).
properties.maintenanceConfigurationId	string	Especifica o ID de configuração de manutenção a aplicar a esta instância gerida.
properties.managedInstanceCreateMode	ManagedServerCreateMode	Especifica o modo de criação da base de dados. Predefinição: criação de instâncias regulares. Restauro: cria uma instância ao restaurar um conjunto de cópias de segurança para um ponto específico no tempo. RestorePointInTime e SourceManagedInstanceId têm de ser especificados.
properties.minimalTlsVersion	string	Versão mínima do TLS. Valores permitidos: "None", "1.0", "1.1", "1.2"
properties.primaryUserAssignedIdentityId	string	O ID de recurso de uma identidade atribuída pelo utilizador a utilizar por predefinição.
properties.privateEndpointConnections	ManagedInstancePecProperty[]	Lista de ligações de ponto final privado numa instância gerida.
properties.provisioningState	enum: Accepted Canceled Created Creating Deleted Deleting Failed NotSpecified Registering Running Succeeded TimedOut Unknown Unrecognized Updating
properties.proxyOverride	ManagedInstanceProxyOverride	Tipo de ligação utilizado para ligar à instância.
properties.publicDataEndpointEnabled	boolean	Se o ponto final de dados públicos está ou não ativado.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	O tipo de conta de armazenamento a ser utilizado para armazenar cópias de segurança para esta instância. As opções são Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) e GeoZone(GeoZoneRedundantStorage)
properties.restorePointInTime	string	Especifica o ponto anterior no tempo (ISO8601 formato) da base de dados de origem que será restaurada para criar a nova base de dados.
properties.servicePrincipal	ServicePrincipal	O principal de serviço da instância gerida.
properties.sourceManagedInstanceId	string	O identificador de recurso da instância gerida de origem associada à operação de criação desta instância.
properties.state	string	O estado da instância gerida.
properties.storageSizeInGB	integer	Tamanho do armazenamento em GB. Valor mínimo: 32. Valor máximo: 16384. Incrementos de 32 GB permitidos apenas. O valor máximo depende da família de hardware selecionada e do número de vCores.
properties.subnetId	string	ID de recurso da sub-rede para a instância gerida.
properties.timezoneId	string	ID do fuso horário. Os valores permitidos são fusos horários suportados pelo Windows. O Windows mantém detalhes sobre os fusos horários suportados, incluindo o ID, no registo em KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. Pode obter esses valores de registo através de SQL Server consultando SELECT name AS timezone_id FROM sys.time_zone_info. A lista de IDs também pode ser obtida ao executar [System.TimeZoneInfo]::GetSystemTimeZones() no PowerShell. Um exemplo de id de fuso horário válido é "Hora Padrão do Pacífico" ou "W. Hora Padrão da Europa".
properties.vCores	integer	O número de vCores. Valores permitidos: 8, 16, 24, 32, 40, 64, 80.
properties.zoneRedundant	boolean	Se o multi-az está ou não ativado.
sku	Sku	SKU da instância gerida. 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

Propriedades de um administrador do Active Directory.

Name	Tipo	Description
administratorType	AdministratorType	Tipo de administrador de gravidade.
azureADOnlyAuthentication	boolean	Apenas a Autenticação do Azure Active Directory está ativada.
login	string	Nome de início de sessão do administrador do servidor.
principalType	PrincipalType	Tipo de Principal do administrador de gravidade.
sid	string	SID (ID de objeto) do administrador do servidor.
tenantId	string	ID do inquilino do administrador.

ManagedInstanceLicenseType

O tipo de licença. Os valores possíveis são "LicenseIncluded" (preço normal, incluindo uma nova licença SQL) e "Preço Base" (preço AHB com desconto para trazer as suas próprias licenças SQL).

Name	Tipo	Description
BasePrice	string
LicenseIncluded	string

ManagedInstanceListResult

Uma lista de instâncias geridas.

Name	Tipo	Description
nextLink	string	Ligação para obter a página seguinte dos resultados.
value	ManagedInstance[]	Matriz de resultados.

ManagedInstancePecProperty

Uma ligação de ponto final privado numa instância gerida

Name	Tipo	Description
id	string	ID do Recurso.
properties	ManagedInstancePrivateEndpointConnectionProperties	Propriedades de ligação de ponto final privado

ManagedInstancePrivateEndpointConnectionProperties

Propriedades de uma ligação de ponto final privado.

Name	Tipo	Description
privateEndpoint	ManagedInstancePrivateEndpointProperty	Ponto final privado ao qual a ligação pertence.
privateLinkServiceConnectionState	ManagedInstancePrivateLinkServiceConnectionStateProperty	Estado de Ligação da Ligação de Ponto Final Privado.
provisioningState	string	Estado da Ligação de Ponto Final Privado.

ManagedInstancePrivateEndpointProperty

Name	Tipo	Description
id	string	ID de recurso do ponto final privado.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Name	Tipo	Description
actionsRequired	string	A descrição da ligação do serviço de ligação privada.
description	string	A descrição da ligação do serviço de ligação privada.
status	string	O estado da ligação do serviço de ligação privada.

ManagedInstanceProxyOverride

Tipo de ligação utilizado para ligar à instância.

Name	Tipo	Description
Default	string
Proxy	string
Redirect	string

ManagedServerCreateMode

Especifica o modo de criação da base de dados.

Predefinição: criação de instâncias regulares.

Restauro: cria uma instância ao restaurar um conjunto de cópias de segurança para um ponto específico no tempo. RestorePointInTime e SourceManagedInstanceId têm de ser especificados.

Name	Tipo	Description
Default	string
PointInTimeRestore	string

PrincipalType

Tipo principal do administrador de gravidade.

Name	Tipo	Description
Application	string
Group	string
User	string

ResourceIdentity

Configuração de identidade do Azure Active Directory para um recurso.

Name	Tipo	Description
principalId	string	O ID principal do Azure Active Directory.
tenantId	string	O ID de inquilino do Azure Active Directory.
type	IdentityType	O tipo de identidade. Defina esta opção como "SystemAssigned" para criar e atribuir automaticamente um principal do Azure Active Directory para o recurso.
userAssignedIdentities	<string, UserIdentity>	Os IDs de recursos das identidades atribuídas pelo utilizador a utilizar

ServicePrincipal

A configuração do principal de serviço da instância gerida para um recurso.

Name	Tipo	Description
clientId	string	O ID de cliente da aplicação do Azure Active Directory.
principalId	string	O ID de objeto da aplicação do Azure Active Directory.
tenantId	string	O ID de inquilino do Azure Active Directory.
type	ServicePrincipalType	Tipo de principal de serviço.

ServicePrincipalType

Tipo de principal de serviço.

Name	Tipo	Description
None	string
SystemAssigned	string

Sku

Um SKU de Recurso do ARM.

Name	Tipo	Description
capacity	integer	Capacidade do SKU específico.
family	string	Se o serviço tiver diferentes gerações de hardware, para o mesmo SKU, isso pode ser capturado aqui.
name	string	O nome do SKU, normalmente, uma letra + Código de número, por exemplo, P3.
size	string	Tamanho do SKU específico
tier	string	O escalão ou edição do SKU específico, por exemplo, Básico, Premium.

UserIdentity

Configuração de identidade do Azure Active Directory para um recurso.

Name	Tipo	Description
clientId	string	O ID de cliente do Azure Active Directory.
principalId	string	O ID principal do Azure Active Directory.

Share via

Managed Instances - List

Parâmetros do URI

Respostas

Exemplos

List managed instances

Sample Request

Sample Response

List managed instances with $expand=administrators/activedirectory

Sample Request

Sample Response

Definições

AdministratorType

BackupStorageRedundancy

IdentityType

ManagedInstance

ManagedInstanceExternalAdministrator

ManagedInstanceLicenseType

ManagedInstanceListResult

ManagedInstancePecProperty

ManagedInstancePrivateEndpointConnectionProperties

ManagedInstancePrivateEndpointProperty

ManagedInstancePrivateLinkServiceConnectionStateProperty

ManagedInstanceProxyOverride

ManagedServerCreateMode

PrincipalType

ResourceIdentity

ServicePrincipal

ServicePrincipalType

Sku

UserIdentity

Recursos adicionais