Managed Instances - List

Referência

Serviço:: SQL Database

Versão da API:: 2021-11-01

Obtém uma lista de todas as instâncias gerenciadas na assinatura.

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

Com parâmetros opcionais:

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	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.
$expand	query		string	Os recursos da criança para incluir na resposta.

Respostas

Name	Tipo	Description
200 OK	ManagedInstanceListResult	Recuperada com êxito a lista de instâncias gerenciadas.
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


/**
 * 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

Resposta da amostra

Código de estado:: 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

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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 corte.
BackupStorageRedundancy	O tipo de conta de armazenamento usado para armazenar backups para esta instância. As opções são Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) e GeoZone(GeoZoneRedundantStorage)
IdentityType	O tipo de identidade. Defina isso como 'SystemAssigned' para criar e atribuir automaticamente uma entidade do Azure Ative Directory para o recurso.
ManagedInstance	Uma instância gerenciada SQL do Azure.
ManagedInstanceExternalAdministrator	Propriedades de um administrador do Ative Directory.
ManagedInstanceLicenseType	O tipo de licença. Os valores possíveis são 'LicenseIncluded' (preço normal incluindo uma nova licença SQL) e 'BasePrice' (preço AHB com desconto para trazer suas próprias licenças SQL).
ManagedInstanceListResult	Uma lista de instâncias gerenciadas.
ManagedInstancePecProperty	Uma conexão de ponto de extremidade privada em uma instância gerenciada
ManagedInstancePrivateEndpointConnectionProperties	Propriedades de uma conexão de ponto de extremidade privada.
ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride	Tipo de conexão usado para se conectar à instância.
ManagedServerCreateMode	Especifica o modo de criação do banco de dados. Padrão: criação de instância regular. Restauração: cria uma instância restaurando um conjunto de backups para um point-in-time específico. RestorePointInTime e SourceManagedInstanceId devem ser especificados.
PrincipalType	Tipo principal do administrador de corte.
ResourceIdentity	Configuração de identidade do Azure Ative Directory para um recurso.
ServicePrincipal	A configuração da entidade de serviço da instância gerenciada para um recurso.
ServicePrincipalType	Tipo de entidade de serviço.
Sku	Um SKU de recurso ARM.
UserIdentity	Configuração de identidade do Azure Ative Directory para um recurso.

AdministratorType

Enumeração

Tipo de administrador de corte.

Valor	Description
ActiveDirectory

BackupStorageRedundancy

Enumeração

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

Valor	Description
Geo
GeoZone
Local
Zone

IdentityType

Enumeração

O tipo de identidade. Defina isso como 'SystemAssigned' para criar e atribuir automaticamente uma entidade do Azure Ative Directory para o recurso.

Valor	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

ManagedInstance

Object

Uma instância gerenciada SQL do Azure.

Name	Tipo	Description
id	string	ID do recurso.
identity	ResourceIdentity	A identidade do Azure Ative Directory da instância gerenciada.
location	string	Localização do recurso.
name	string	Nome do recurso.
properties.administratorLogin	string	Nome de usuário do administrador para a instância gerenciada. Só pode ser especificado quando a instância gerenciada está sendo criada (e é necessária para a criação).
properties.administratorLoginPassword	string	A senha de login do administrador (necessária para a criação da instância gerenciada).
properties.administrators	ManagedInstanceExternalAdministrator	O administrador do Azure Ative Directory do servidor.
properties.collation	string	Agrupamento da instância gerenciada.
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	O tipo de conta de armazenamento usado para armazenar backups para esta instância. As opções são Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) e GeoZone(GeoZoneRedundantStorage)
properties.dnsZone	string	A zona Dns em que a instância gerenciada está.
properties.dnsZonePartner	string (arm-id)	A ID de recurso de outra instância gerenciada cuja zona DNS essa instância gerenciada compartilhará após a criação.
properties.fullyQualifiedDomainName	string	O nome de domínio totalmente qualificado da instância gerenciada.
properties.instancePoolId	string	A Id do pool de instâncias ao qual esse servidor gerenciado pertence.
properties.keyId	string	Um URI CMK da chave a ser usada para criptografia.
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 'BasePrice' (preço AHB com desconto para trazer suas próprias licenças SQL).
properties.maintenanceConfigurationId	string	Especifica a ID de configuração de manutenção a ser aplicada a essa instância gerenciada.
properties.managedInstanceCreateMode	ManagedServerCreateMode	Especifica o modo de criação do banco de dados. Padrão: criação de instância regular. Restauração: cria uma instância restaurando um conjunto de backups para um point-in-time específico. RestorePointInTime e SourceManagedInstanceId devem ser especificados.
properties.minimalTlsVersion	string	Versão TLS mínima. Valores permitidos: 'Nenhum', '1.0', '1.1', '1.2'
properties.primaryUserAssignedIdentityId	string (arm-id)	A id de recurso de uma identidade atribuída ao usuário a ser usada por padrão.
properties.privateEndpointConnections	ManagedInstancePecProperty[]	Lista de conexões de ponto de extremidade privado em uma instância gerenciada.
properties.provisioningState	enum: Accepted Canceled Created Creating Deleted Deleting Failed NotSpecified Registering Running Succeeded TimedOut Unknown Unrecognized Updating
properties.proxyOverride	ManagedInstanceProxyOverride	Tipo de conexão usado para se conectar à instância.
properties.publicDataEndpointEnabled	boolean	Se o ponto de extremidade de dados públicos está habilitado ou não.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	O tipo de conta de armazenamento a ser usado para armazenar backups para esta instância. As opções são Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) e GeoZone(GeoZoneRedundantStorage)
properties.restorePointInTime	string (date-time)	Especifica o ponto no tempo (formato ISO8601) do banco de dados de origem que será restaurado para criar o novo banco de dados.
properties.servicePrincipal	ServicePrincipal	A entidade de serviço da instância gerenciada.
properties.sourceManagedInstanceId	string (arm-id)	O identificador de recurso da instância gerenciada de origem associada à operação de criação dessa instância.
properties.state	string	O estado da instância gerenciada.
properties.storageSizeInGB	integer (int32)	Tamanho de armazenamento em GB. Valor mínimo: 32. Valor máximo: 16384. Apenas são permitidos incrementos de 32 GB. O valor máximo depende da família de hardware selecionada e do número de vCores.
properties.subnetId	string (arm-id)	ID do recurso de sub-rede para a instância gerenciada.
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 fusos horários suportados, incluindo a id, no registro em KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. Você pode obter esses valores do Registro via SQL Server consultando SELECT name AS timezone_id FROM sys.time_zone_info. A lista de Ids também pode ser obtida executando [System.TimeZoneInfo]::GetSystemTimeZones() no PowerShell. Um exemplo de id de fuso horário válido é "Pacific Standard Time" ou "W. Hora Padrão da Europa".
properties.vCores	integer (int32)	O número de vCores. Valores permitidos: 8, 16, 24, 32, 40, 64, 80.
properties.zoneRedundant	boolean	Se o multi-az está habilitado ou não.
sku	Sku	SKU de instância gerenciada. Valores permitidos para sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM BC_G8IH
tags	object	Tags de recursos.
type	string	Tipo de recurso.

ManagedInstanceExternalAdministrator

Object

Propriedades de um administrador do Ative Directory.

Name	Tipo	Description
administratorType	AdministratorType	Tipo de administrador de corte.
azureADOnlyAuthentication	boolean	Somente Autenticação do Ative Directory do Azure habilitada.
login	string	Nome de login do administrador do servidor.
principalType	PrincipalType	Tipo principal do administrador de corte.
sid	string (uuid)	SID (ID do objeto) do administrador do servidor.
tenantId	string (uuid)	ID do locatário do administrador.

ManagedInstanceLicenseType

Enumeração

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

Valor	Description
BasePrice
LicenseIncluded

ManagedInstanceListResult

Object

Uma lista de instâncias gerenciadas.

Name	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	ManagedInstance[]	Matriz de resultados.

ManagedInstancePecProperty

Object

Uma conexão de ponto de extremidade privada em uma instância gerenciada

Name	Tipo	Description
id	string	ID do recurso.
properties	ManagedInstancePrivateEndpointConnectionProperties	Propriedades de conexão de ponto de extremidade privado

ManagedInstancePrivateEndpointConnectionProperties

Object

Propriedades de uma conexão de ponto de extremidade privada.

Name	Tipo	Description
privateEndpoint	ManagedInstancePrivateEndpointProperty	Ponto de extremidade privado ao qual a conexão pertence.
privateLinkServiceConnectionState	ManagedInstancePrivateLinkServiceConnectionStateProperty	Estado da Conexão da Conexão de Ponto Final Privado.
provisioningState	string	Estado da Conexão de Ponto Final Privado.

ManagedInstancePrivateEndpointProperty

Object

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

ManagedInstancePrivateLinkServiceConnectionStateProperty

Object

Name	Tipo	Description
actionsRequired	string	A descrição da conexão do serviço de link privado.
description	string	A descrição da conexão do serviço de link privado.
status	string	O status da conexão do serviço de link privado.

ManagedInstanceProxyOverride

Enumeração

Tipo de conexão usado para se conectar à instância.

Valor	Description
Default
Proxy
Redirect

ManagedServerCreateMode

Enumeração

Especifica o modo de criação do banco de dados.

Padrão: criação de instância regular.

Restauração: cria uma instância restaurando um conjunto de backups para um point-in-time específico. RestorePointInTime e SourceManagedInstanceId devem ser especificados.

Valor	Description
Default
PointInTimeRestore

PrincipalType

Enumeração

Tipo principal do administrador de corte.

Valor	Description
Application
Group
User

ResourceIdentity

Object

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

Name	Tipo	Description
principalId	string (uuid)	A ID principal do Azure Ative Directory.
tenantId	string (uuid)	A ID de locatário do Azure Ative Directory.
type	IdentityType	O tipo de identidade. Defina isso como 'SystemAssigned' para criar e atribuir automaticamente uma entidade do Azure Ative Directory para o recurso.
userAssignedIdentities	<string, UserIdentity>	As ids de recurso das identidades atribuídas ao usuário a serem usadas

ServicePrincipal

Object

A configuração da entidade de serviço da instância gerenciada para um recurso.

Name	Tipo	Description
clientId	string	A ID do cliente do aplicativo Azure Ative Directory.
principalId	string	A ID do objeto do aplicativo Azure Ative Directory.
tenantId	string	A ID de locatário do Azure Ative Directory.
type	ServicePrincipalType	Tipo de entidade de serviço.

ServicePrincipalType

Enumeração

Tipo de entidade de serviço.

Valor	Description
None
SystemAssigned

Sku

Object

Um SKU de recurso ARM.

Name	Tipo	Description
capacity	integer (int32)	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 numérico, por exemplo, P3.
size	string	Tamanho do SKU específico
tier	string	O nível ou edição do SKU específico, por exemplo, Basic, Premium.

UserIdentity

Object

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

Name	Tipo	Description
clientId	string (uuid)	A ID do cliente do Azure Ative Directory.
principalId	string (uuid)	A ID principal do Azure Ative Directory.

Partilhar via

Managed Instances - List

Parâmetros do URI

Respostas

Exemplos

List managed instances

Pedido de amostra

Resposta da amostra

List managed instances with $expand=administrators/activedirectory

Pedido de amostra

Resposta da amostra

Definições

AdministratorType

BackupStorageRedundancy

IdentityType

ManagedInstance

ManagedInstanceExternalAdministrator

ManagedInstanceLicenseType

ManagedInstanceListResult

ManagedInstancePecProperty

ManagedInstancePrivateEndpointConnectionProperties

ManagedInstancePrivateEndpointProperty

ManagedInstancePrivateLinkServiceConnectionStateProperty

ManagedInstanceProxyOverride

ManagedServerCreateMode

PrincipalType

ResourceIdentity

ServicePrincipal

ServicePrincipalType

Sku

UserIdentity

Recursos adicionais