Managed Instances - Get

Obtém uma instância gerenciada.

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

Parâmetros de URI

Name In Required Type Description
managedInstanceName
path True
  • string

O nome da instância gerenciada.

resourceGroupName
path True
  • string

O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

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 filho a serem incluídos na resposta.

Respostas

Name Type Description
200 OK

Recuperou com êxito a instância gerenciada especificada.

Other Status Codes

Respostas de erro: ***

  • 400 MiGeoRestoreWithWrongBackupStorageRedundancy – Geo-Restore não é permitido para instâncias gerenciadas com redundância de armazenamento de backup LRS/ZRS.

  • 400 UpdateInstanceAndBackupRedundancy – Redundância de zona de instância e redundância de armazenamento de backup não podem ser atualizadas na mesma solicitação.

  • 400 ProvisioningDisabled – Exibe mensagem de erro do autorizador de operação de recursos como está, sem alterações

  • 400 AadOnlyAuthenticationIsEnabled – Autenticação Somente do Azure Active Directory está habilitada. Entre em contato com o administrador do sistema.

  • 400 ManagementServiceFeatureDisabled – O usuário tentou usar um recurso que está desabilitado.

  • 404 SubscriptionNotFound – A assinatura solicitada não foi encontrada.

  • 404 ServerNotInSubscription – O servidor especificado não existe na assinatura especificada.

  • 404 ManagedInstanceNotInSubscriptionResourceGroup – A instância gerenciada especificada não existe no grupo de recursos e na assinatura especificados.

  • 404 SubscriptionNotFound – A assinatura solicitada não foi encontrada.

  • 404 ResourceNotFound – O recurso solicitado não foi encontrado.

  • 409 ConflictingManagedInstanceOperation – Uma operação está em andamento para a instância gerenciada.

  • 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - A instância é multi-az, mas o armazenamento de backup está sendo atualizado de redundância de zona para não redundante de zona.

  • 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Não é possível atualizar a redundância de instância porque a atualização de redundância de armazenamento de backup está em andamento.

  • 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - O armazenamento de backup é redundante sem zona, mas a redundância de instância está sendo atualizada para redundância de zona.

  • 409 BackupRedundancyUpdateConflict - Não é possível atualizar a redundância de armazenamento de backup porque uma atualização de redundância de armazenamento de backup já está em andamento.

  • 409 MiDropFailedOnAuthLocks – O usuário tentou remover o último Instância Gerenciada na sub-rede que tem o Bloqueio aplicado aos recursos.

  • 409 MiCreateFailedNonDelegatedSubnet – o usuário tentou implantar Instância Gerenciada ou Instância Gerenciada pool na sub-rede que não é delegada para Microsoft.Sql/managedInstances.

  • 412 InstanceNotReadyForBackupRedundancyUpdate – não é possível atualizar a redundância de armazenamento de backup porque a instância não está pronta.

  • 429 SubscriptionTooManyCreateUpdateRequests – Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis.

  • 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

  • 429 SubscriptionTooManyCreateUpdateRequests – Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis.

  • 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

  • 429 ConflictingSubscriptionOperation – Uma operação está em andamento para a assinatura.

  • 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

  • 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

  • 504 RequestTimeout – A solicitação de serviço excedeu o tempo limite permitido.

  • 504 RequestTimeout – A solicitação de serviço excedeu o tempo limite permitido.

Exemplos

Get managed instance
Get managed instance with $expand=administrators/activedirectory

Get managed instance

Sample Request

GET https://management.azure.com/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2021-11-01

Sample Response

{
  "sku": {
    "name": "GP_Gen4",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen4"
  },
  "properties": {
    "fullyQualifiedDomainName": "testinstance.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",
    "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
    "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "servicePrincipal": {
      "principalId": "00000011-1111-2222-2222-123456789111",
      "clientId": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111",
      "type": "SystemAssigned"
    }
  },
  "location": "japaneast",
  "tags": {
    "key": "value"
  },
  "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances"
}

Get managed instance with $expand=administrators/activedirectory

Sample Request

GET https://management.azure.com/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2021-11-01

Sample Response

{
  "sku": {
    "name": "GP_Gen4",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen4"
  },
  "properties": {
    "fullyQualifiedDomainName": "testinstance.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",
    "instancePoolId": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
    "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",
  "tags": {
    "key": "value"
  },
  "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances"
}

Definições

AdministratorType

Tipo do administrador de sever.

BackupStorageRedundancy

O tipo de conta de armazenamento usado para armazenar backups para essa 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 de segurança do Azure Active Directory para o recurso.

ManagedInstance

Uma instância gerenciada 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 regular inclusive de uma nova licença sql) e 'BasePrice' (preço ahb com desconto para trazer suas próprias licenças SQL).

ManagedInstancePecProperty

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

ManagedInstancePrivateEndpointConnectionProperties

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

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 ponto específico no tempo. RestorePointInTime e SourceManagedInstanceId devem ser especificados.

PrincipalType

Tipo principal do administrador de sever.

ResourceIdentity

Configuração de identidade do Azure Active 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 do ARM.

UserIdentity

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

AdministratorType

Tipo do administrador de sever.

Name Type Description
ActiveDirectory
  • string

BackupStorageRedundancy

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

Name Type Description
Geo
  • string
GeoZone
  • string
Local
  • string
Zone
  • string

IdentityType

O tipo de identidade. Defina isso como "SystemAssigned" para criar e atribuir automaticamente uma entidade de segurança do Azure Active Directory para o recurso.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

ManagedInstance

Uma instância gerenciada SQL do Azure.

Name Type Description
id
  • string

ID do recurso.

identity

A identidade do Azure Active Directory da instância gerenciada.

location
  • string

Local 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 criação).

properties.administratorLoginPassword
  • string

A senha de logon do administrador (necessária para a criação da instância gerenciada).

properties.administrators

O administrador do Azure Active Directory do servidor.

properties.collation
  • string

Ordenação da instância gerenciada.

properties.currentBackupStorageRedundancy

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

properties.dnsZone
  • string

A Zona Dns na qual a instância gerenciada está.

properties.dnsZonePartner
  • string

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 à qual este servidor gerenciado pertence.

properties.keyId
  • string

Um URI do CMK da chave a ser usada para criptografia.

properties.licenseType

O tipo de licença. Os valores possíveis são 'LicenseIncluded' (preço regular inclusive de 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

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 ponto específico no tempo. RestorePointInTime e SourceManagedInstanceId devem ser especificados.

properties.minimalTlsVersion
  • string

Versão mínima do TLS. Valores permitidos: 'None', '1.0', '1.1', '1.2'

properties.primaryUserAssignedIdentityId
  • string

A ID de recurso de uma identidade atribuída pelo usuário a ser usada por padrão.

properties.privateEndpointConnections

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

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

properties.publicDataEndpointEnabled
  • boolean

Se o ponto de extremidade de dados público está habilitado ou não.

properties.requestedBackupStorageRedundancy

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

properties.restorePointInTime
  • string

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

A entidade de serviço da instância gerenciada.

properties.sourceManagedInstanceId
  • string

O identificador de recurso da instância gerenciada de origem associado à operação de criação dessa instância.

properties.state
  • string

O estado da instância gerenciada.

properties.storageSizeInGB
  • integer

Tamanho do armazenamento em GB. Valor mínimo: 32. Valor máximo: 16384. Incrementos de 32 GB somente permitidos. O valor máximo depende da família de hardware selecionada e do número de vCores.

properties.subnetId
  • string

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 compatíveis com o Windows. O Windows mantém detalhes sobre fusos horários com suporte, incluindo a ID, no Registro em KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Fusos Horários. Você pode obter esses valores do Registro por meio de SQL Server consultando o nome SELECT 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 é "Horário Padrão do Pacífico" ou "W. Horário 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á habilitado ou não.

sku

SKU da instância gerenciada. Valores permitidos para sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM BC_G8IH

tags
  • object

Marcas de recurso.

type
  • string

Tipo de recurso.

ManagedInstanceExternalAdministrator

Propriedades de um administrador do active directory.

Name Type Description
administratorType

Tipo do administrador de sever.

azureADOnlyAuthentication
  • boolean

Somente autenticação do Azure Active Directory habilitada.

login
  • string

Nome de logon do administrador do servidor.

principalType

Tipo principal do administrador de sever.

sid
  • string

SID (ID do objeto) do administrador do servidor.

tenantId
  • string

ID do locatário do administrador.

ManagedInstanceLicenseType

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

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

ManagedInstancePecProperty

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

Name Type Description
id
  • string

ID do recurso.

properties

Propriedades de conexão de ponto de extremidade privado

ManagedInstancePrivateEndpointConnectionProperties

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

Name Type Description
privateEndpoint

Ponto de extremidade privado ao qual a conexão pertence.

privateLinkServiceConnectionState

Estado de conexão da conexão de ponto de extremidade privado.

provisioningState
  • string

Estado da conexão de ponto de extremidade privado.

ManagedInstancePrivateEndpointProperty

Name Type Description
id
  • string

ID do recurso do ponto de extremidade privado.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Name Type 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 de conexão do serviço de link privado.

ManagedInstanceProxyOverride

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

Name Type Description
Default
  • string
Proxy
  • string
Redirect
  • string

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 ponto específico no tempo. RestorePointInTime e SourceManagedInstanceId devem ser especificados.

Name Type Description
Default
  • string
PointInTimeRestore
  • string

PrincipalType

Tipo principal do administrador de sever.

Name Type Description
Application
  • string
Group
  • string
User
  • string

ResourceIdentity

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

Name Type Description
principalId
  • string

A ID da entidade de segurança do Azure Active Directory.

tenantId
  • string

A ID de locatário do Azure Active Directory.

type

O tipo de identidade. Defina isso como "SystemAssigned" para criar e atribuir automaticamente uma entidade de segurança do Azure Active Directory para o recurso.

userAssignedIdentities

As IDs de recurso das identidades atribuídas pelo usuário a serem usadas

ServicePrincipal

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

Name Type Description
clientId
  • string

A ID do cliente do aplicativo Azure Active Directory.

principalId
  • string

A ID do objeto de aplicativo do Azure Active Directory.

tenantId
  • string

A ID de locatário do Azure Active Directory.

type

Tipo de entidade de serviço.

ServicePrincipalType

Tipo de entidade de serviço.

Name Type Description
None
  • string
SystemAssigned
  • string

Sku

Um SKU de Recurso do ARM.

Name Type Description
capacity
  • integer

Capacidade do SKU específico.

family
  • string

Se o serviço tiver diferentes gerações de hardware, para a mesma SKU, isso poderá ser capturado aqui.

name
  • string

O nome da SKU, normalmente, uma letra + código de número, por exemplo, P3.

size
  • string

Tamanho do SKU específico

tier
  • string

A camada 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 Type Description
clientId
  • string

A ID do cliente do Azure Active Directory.

principalId
  • string

A ID da entidade de segurança do Azure Active Directory.