Databases - Get

  • Referência
Serviço:
SQL Database
Versão da API:
2021-11-01

Obtém um banco de dados.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}?api-version=2021-11-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
databaseName
 path True

string

O nome do banco de dados.
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.
serverName
 path True

string

O nome do servidor.
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.

Respostas

Nome Tipo Description
200 OK

Database

Recuperou com êxito o banco de dados especificado.
Other Status Codes

Respostas de erro: ***

  • 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado

  • 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados.

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

Exemplos

Gets a database.

Solicitação de exemplo

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb?api-version=2021-11-01

Resposta de exemplo

Código de status:
200 
{
  "sku": {
    "name": "BC_Gen5",
    "tier": "BusinessCritical",
    "capacity": 2
  },
  "kind": "v12.0,user,vcore",
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 268435456000,
    "status": "Online",
    "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
    "creationDate": "2017-06-07T04:41:33.937Z",
    "currentServiceObjectiveName": "BC_Gen5_2",
    "requestedServiceObjectiveName": "BC_Gen5_2",
    "defaultSecondaryLocation": "North Europe",
    "catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
    "licenseType": "LicenseIncluded",
    "maxLogSizeBytes": 104857600,
    "isInfraEncryptionEnabled": false,
    "zoneRedundant": false,
    "readScale": "Enabled",
    "earliestRestoreDate": "2017-06-07T04:51:33.937Z",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_SouthEastAsia_1",
    "currentSku": {
      "name": "BC_Gen5",
      "tier": "BusinessCritical",
      "capacity": 2
    },
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "isLedgerOn": false
  },
  "location": "southeastasia",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
  "name": "testdb",
  "type": "Microsoft.Sql/servers/databases"
}

Definições

Nome Description
BackupStorageRedundancy

O tipo de conta de armazenamento usado para armazenar backups para esse banco de dados.
CatalogCollationType

Ordenação do catálogo de metadados.
CreateMode

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

Padrão: criação regular de banco de dados.

Copiar: cria um banco de dados como uma cópia de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados de origem.

Secundário: cria um banco de dados como um réplica secundário de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados primário existente.

PointInTimeRestore: cria um banco de dados restaurando um backup pontual de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados existente e restorePointInTime deve ser especificado.

Recuperação: cria um banco de dados restaurando um backup replicado geograficamente. sourceDatabaseId deve ser especificado como a ID do recurso de banco de dados recuperável a ser restaurada.

Restauração: cria um banco de dados restaurando um backup de um banco de dados excluído. sourceDatabaseId deve ser especificado. Se sourceDatabaseId for a ID de recurso original do banco de dados, sourceDatabaseDeletionDate deverá ser especificado. Caso contrário, sourceDatabaseId deve ser a ID do recurso de banco de dados descartado restaurável e sourceDatabaseDeletionDate será ignorado. restorePointInTime também pode ser especificado para restaurar de um ponto anterior no tempo.

RestoreLongTermRetentionBackup: cria um banco de dados restaurando de um cofre de retenção de longo prazo. recoveryServicesRecoveryPointResourceId deve ser especificado como a ID do recurso do ponto de recuperação.

Não há suporte para Copy, Secondary e RestoreLongTermRetentionBackup na edição DataWarehouse.
Database

Um recurso de banco de dados.
DatabaseIdentity

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

O tipo de identidade
DatabaseLicenseType

O tipo de licença a ser aplicado a esse banco de dados. LicenseIncludedse você precisar de uma licença ou BasePrice se tiver uma licença e estiver qualificado para o Benefício Híbrido do Azure.
DatabaseReadScale

O estado do roteamento somente leitura. Se habilitadas, as conexões que têm a intenção do aplicativo definida como somente leitura em seus cadeia de conexão podem ser roteadas para um réplica secundário somente leitura na mesma região. Não aplicável a um banco de dados de Hiperescala em um pool elástico.
DatabaseStatus

O status do banco de dados.
DatabaseUserIdentity

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

O nome do esquema de exemplo a ser aplicado ao criar esse banco de dados.
SecondaryType

O tipo secundário do banco de dados se ele for um secundário. Os valores válidos são Geo e Named.
Sku

Um SKU de recurso do ARM.

BackupStorageRedundancy

O tipo de conta de armazenamento usado para armazenar backups para esse banco de dados.

Nome Tipo Description
Geo

string

GeoZone

string

Local

string

Zone

string

CatalogCollationType

Ordenação do catálogo de metadados.

Nome Tipo Description
DATABASE_DEFAULT

string

SQL_Latin1_General_CP1_CI_AS

string

CreateMode

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

Padrão: criação regular de banco de dados.

Copiar: cria um banco de dados como uma cópia de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados de origem.

Secundário: cria um banco de dados como um réplica secundário de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados primário existente.

PointInTimeRestore: cria um banco de dados restaurando um backup pontual de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados existente e restorePointInTime deve ser especificado.

Recuperação: cria um banco de dados restaurando um backup replicado geograficamente. sourceDatabaseId deve ser especificado como a ID do recurso de banco de dados recuperável a ser restaurada.

Restauração: cria um banco de dados restaurando um backup de um banco de dados excluído. sourceDatabaseId deve ser especificado. Se sourceDatabaseId for a ID de recurso original do banco de dados, sourceDatabaseDeletionDate deverá ser especificado. Caso contrário, sourceDatabaseId deve ser a ID do recurso de banco de dados descartado restaurável e sourceDatabaseDeletionDate será ignorado. restorePointInTime também pode ser especificado para restaurar de um ponto anterior no tempo.

RestoreLongTermRetentionBackup: cria um banco de dados restaurando de um cofre de retenção de longo prazo. recoveryServicesRecoveryPointResourceId deve ser especificado como a ID do recurso do ponto de recuperação.

Não há suporte para Copy, Secondary e RestoreLongTermRetentionBackup na edição DataWarehouse.

Nome Tipo Description
Copy

string

Default

string

OnlineSecondary

string

PointInTimeRestore

string

Recovery

string

Restore

string

RestoreExternalBackup

string

RestoreExternalBackupSecondary

string

RestoreLongTermRetentionBackup

string

Secondary

string

Database

Um recurso de banco de dados.

Nome Tipo Description
id

string

ID do recurso.
identity

DatabaseIdentity

A identidade do Azure Active Directory do banco de dados.
kind

string

Tipo de banco de dados. Esses são os metadados usados para a experiência de portal do Azure.
location

string

Local do recurso.
managedBy

string

Recurso que gerencia o banco de dados.
name

string

Nome do recurso.
properties.autoPauseDelay

integer

Tempo em minutos após o qual o banco de dados é pausado automaticamente. Um valor de -1 significa que a pausa automática está desabilitada
properties.catalogCollation

CatalogCollationType

Ordenação do catálogo de metadados.
properties.collation

string

A ordenação do banco de dados.
properties.createMode

CreateMode

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

Padrão: criação regular de banco de dados.

Copiar: cria um banco de dados como uma cópia de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados de origem.

Secundário: cria um banco de dados como um réplica secundário de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados primário existente.

PointInTimeRestore: cria um banco de dados restaurando um backup pontual de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID do recurso do banco de dados existente e restorePointInTime deve ser especificado.

Recuperação: cria um banco de dados restaurando um backup replicado geograficamente. sourceDatabaseId deve ser especificado como a ID do recurso de banco de dados recuperável a ser restaurada.

Restauração: cria um banco de dados restaurando um backup de um banco de dados excluído. sourceDatabaseId deve ser especificado. Se sourceDatabaseId for a ID de recurso original do banco de dados, sourceDatabaseDeletionDate deverá ser especificado. Caso contrário, sourceDatabaseId deve ser a ID do recurso de banco de dados descartado restaurável e sourceDatabaseDeletionDate será ignorado. restorePointInTime também pode ser especificado para restaurar de um ponto anterior no tempo.

RestoreLongTermRetentionBackup: cria um banco de dados restaurando de um cofre de retenção de longo prazo. recoveryServicesRecoveryPointResourceId deve ser especificado como a ID do recurso do ponto de recuperação.

Não há suporte para Copy, Secondary e RestoreLongTermRetentionBackup na edição DataWarehouse.
properties.creationDate

string

A data de criação do banco de dados (formato ISO8601).
properties.currentBackupStorageRedundancy

BackupStorageRedundancy

O tipo de conta de armazenamento usado para armazenar backups para esse banco de dados.
properties.currentServiceObjectiveName

string

O nome do objetivo de nível de serviço atual do banco de dados.
properties.currentSku

Sku

O nome e a camada do SKU.
properties.databaseId

string

A ID do banco de dados.
properties.defaultSecondaryLocation

string

A região secundária padrão para esse banco de dados.
properties.earliestRestoreDate

string

Isso registra a data e a hora de início mais antigas em que a restauração está disponível para esse banco de dados (formato ISO8601).
properties.elasticPoolId

string

O identificador de recurso do pool elástico que contém esse banco de dados.
properties.failoverGroupId

string

Identificador de recurso do Grupo de Failover ao qual este banco de dados pertence.
properties.federatedClientId

string

A ID do cliente usada para o cenário de CMK entre locatários por banco de dados
properties.highAvailabilityReplicaCount

integer

O número de réplicas secundárias associadas ao banco de dados que são usadas para fornecer alta disponibilidade. Não aplicável a um banco de dados de Hiperescala em um pool elástico.
properties.isInfraEncryptionEnabled

boolean

A criptografia infra está habilitada para este banco de dados.
properties.isLedgerOn

boolean

Se esse banco de dados é ou não um banco de dados do razão, o que significa que todas as tabelas no banco de dados são tabelas do razão. Observação: o valor dessa propriedade não pode ser alterado após a criação do banco de dados.
properties.licenseType

DatabaseLicenseType

O tipo de licença a ser aplicado a esse banco de dados. LicenseIncludedse você precisar de uma licença ou BasePrice se tiver uma licença e estiver qualificado para o Benefício Híbrido do Azure.
properties.longTermRetentionBackupResourceId

string

O identificador de recurso do backup de retenção de longo prazo associado à operação de criação desse banco de dados.
properties.maintenanceConfigurationId

string

ID de configuração de manutenção atribuída ao banco de dados. Essa configuração define o período em que as atualizações de manutenção ocorrerão.
properties.maxLogSizeBytes

integer

O tamanho máximo do log para este banco de dados.
properties.maxSizeBytes

integer

O tamanho máximo do banco de dados expresso em bytes.
properties.minCapacity

number

Capacidade mínima que o banco de dados sempre terá alocado, se não estiver em pausa
properties.pausedDate

string

A data em que o banco de dados foi pausado pela configuração ou ação do usuário (formato ISO8601). Nulo se o banco de dados estiver pronto.
properties.readScale

DatabaseReadScale

O estado do roteamento somente leitura. Se habilitadas, as conexões que têm a intenção do aplicativo definida como somente leitura em seus cadeia de conexão podem ser roteadas para um réplica secundário somente leitura na mesma região. Não aplicável a um banco de dados de Hiperescala em um pool elástico.
properties.recoverableDatabaseId

string

O identificador de recurso do banco de dados recuperável associado à operação de criação desse banco de dados.
properties.recoveryServicesRecoveryPointId

string

O identificador de recurso do ponto de recuperação associado à operação de criação desse banco de dados.
properties.requestedBackupStorageRedundancy

BackupStorageRedundancy

O tipo de conta de armazenamento a ser usado para armazenar backups para esse banco de dados.
properties.requestedServiceObjectiveName

string

O nome do objetivo de nível de serviço solicitado do banco de dados.
properties.restorableDroppedDatabaseId

string

O identificador de recurso do banco de dados descartado restaurável associado à operação de criação desse banco de dados.
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.resumedDate

string

A data em que o banco de dados foi retomado pela ação do usuário ou pelo logon do banco de dados (formato ISO8601). Nulo se o banco de dados estiver em pausa.
properties.sampleName

SampleName

O nome do esquema de exemplo a ser aplicado ao criar esse banco de dados.
properties.secondaryType

SecondaryType

O tipo secundário do banco de dados se ele for um secundário. Os valores válidos são Geo e Named.
properties.sourceDatabaseDeletionDate

string

Especifica a hora em que o banco de dados foi excluído.
properties.sourceDatabaseId

string

O identificador de recurso do banco de dados de origem associado à operação de criação desse banco de dados.
properties.sourceResourceId

string

O identificador de recurso da origem associada à operação de criação desse banco de dados.

Essa propriedade só tem suporte para a edição DataWarehouse e permite a restauração entre assinaturas.

Quando sourceResourceId é especificado, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId e sourceDatabaseDeletionDate não devem ser especificados e CreateMode deve ser PointInTimeRestore, Restore ou Recover.

Quando createMode é PointInTimeRestore, sourceResourceId deve ser a ID do recurso do banco de dados existente ou do pool de sql existente e restorePointInTime deve ser especificado.

Quando createMode é Restore, sourceResourceId deve ser a ID do recurso do banco de dados descartado restaurável ou do pool de sql descartado restaurável.

Quando createMode é Recover, sourceResourceId deve ser a ID do recurso do banco de dados recuperável ou do pool de sql recuperável.

Quando a assinatura de origem pertence a um locatário diferente da assinatura de destino, o cabeçalho "x-ms-authorization-auxiliary" deve conter o token de autenticação para o locatário de origem. Para obter mais detalhes sobre o cabeçalho "x-ms-authorization-auxiliary", consulte https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
properties.status

DatabaseStatus

O status do banco de dados.
properties.zoneRedundant

boolean

Se esse banco de dados tem ou não redundância de zona, o que significa que as réplicas desse banco de dados serão distribuídas entre várias zonas de disponibilidade.
sku

Sku

O SKU do banco de dados.

A lista de SKUs pode variar de acordo com a região e a oferta de suporte. Para determinar os SKUs (incluindo o nome do SKU, a camada/edição, a família e a capacidade) que estão disponíveis para sua assinatura em uma região do Azure, use a Capabilities_ListByLocation API REST ou um dos seguintes comandos:

az sql db list-editions -l <location> -o table

Get-AzSqlServerServiceObjective -Location <location>
tags

object

Marcas de recurso.
type

string

Tipo de recurso.

DatabaseIdentity

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

Nome Tipo Description
tenantId

string

A ID do locatário do Azure Active Directory.
type

DatabaseIdentityType

O tipo de identidade
userAssignedIdentities

<string,  DatabaseUserIdentity>

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

DatabaseIdentityType

O tipo de identidade

Nome Tipo Description
None

string

UserAssigned

string

DatabaseLicenseType

O tipo de licença a ser aplicado a esse banco de dados. LicenseIncludedse você precisar de uma licença ou BasePrice se tiver uma licença e estiver qualificado para o Benefício Híbrido do Azure.

Nome Tipo Description
BasePrice

string

LicenseIncluded

string

DatabaseReadScale

O estado do roteamento somente leitura. Se habilitadas, as conexões que têm a intenção do aplicativo definida como somente leitura em seus cadeia de conexão podem ser roteadas para um réplica secundário somente leitura na mesma região. Não aplicável a um banco de dados de Hiperescala em um pool elástico.

Nome Tipo Description
Disabled

string

Enabled

string

DatabaseStatus

O status do banco de dados.

Nome Tipo Description
AutoClosed

string

Copying

string

Creating

string

Disabled

string

EmergencyMode

string

Inaccessible

string

Offline

string

OfflineChangingDwPerformanceTiers

string

OfflineSecondary

string

Online

string

OnlineChangingDwPerformanceTiers

string

Paused

string

Pausing

string

Recovering

string

RecoveryPending

string

Restoring

string

Resuming

string

Scaling

string

Shutdown

string

Standby

string

Starting

string

Stopped

string

Stopping

string

Suspect

string

DatabaseUserIdentity

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

Nome Tipo Description
clientId

string

A ID do cliente do Azure Active Directory.
principalId

string

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

SampleName

O nome do esquema de exemplo a ser aplicado ao criar esse banco de dados.

Nome Tipo Description
AdventureWorksLT

string

WideWorldImportersFull

string

WideWorldImportersStd

string

SecondaryType

O tipo secundário do banco de dados se ele for um secundário. Os valores válidos são Geo e Named.

Nome Tipo Description
Geo

string

Named

string

Sku

Um SKU de recurso do ARM.

Nome Tipo Description
capacity

integer

Capacidade do SKU específico.
family

string

Se o serviço tiver gerações diferentes 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.