Database interface
Um recurso de banco de dados.
- Extends
Propriedades
auto |
Tempo em minutos após o qual o banco de dados é pausado automaticamente. Um valor de -1 significa que a pausa automática está desativada |
availability |
Especifica a zona de disponibilidade na qual o banco de dados está fixado. |
catalog |
Agrupamento do catálogo de metadados. |
collation | O agrupamento do banco de dados. |
create |
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 uma réplica secundária 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 point-in-time de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID de 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 o ID de recurso de banco de dados recuperável a ser restaurado. Restaurar: cria um banco de dados restaurando um backup de um banco de dados excluído. sourceDatabaseId deve ser especificado. Se sourceDatabaseId for o ID de recurso original do banco de dados, sourceDatabaseDeletionDate deverá ser especificado. Caso contrário, sourceDatabaseId deve ser o ID de recurso de banco de dados descartado restaurável e sourceDatabaseDeletionDate é ignorado. restorePointInTime também pode ser especificado para restaurar a partir de um point-in-time anterior. RestoreLongTermRetentionBackup: cria um banco de dados restaurando a partir de um cofre de retenção de longo prazo. recoveryServicesRecoveryPointResourceId deve ser especificado como o ID do recurso do ponto de recuperação. Copy, Secondary e RestoreLongTermRetentionBackup não são suportados para a edição DataWarehouse. |
creation |
A data de criação da base de dados (formato ISO8601). Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
current |
O tipo de conta de armazenamento usado para armazenar backups para esse banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
current |
O nome atual do objetivo de nível de serviço do banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
current |
O nome e a camada da SKU. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
database |
A ID do banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
default |
A região secundária padrão para esse banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
earliest |
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). Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
elastic |
O identificador de recurso do pool elástico que contém esse banco de dados. |
encryption |
O URI do cofre de chaves azure do banco de dados se estiver configurado com chaves gerenciadas pelo cliente do banco de dados. |
failover |
Identificador de recurso do Grupo de Failover ao qual esse banco de dados pertence. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
federated |
A ID do cliente usada para o cenário de CMK entre locatários por banco de dados |
high |
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 Hyperscale dentro de um pool elástico. |
identity | A identidade do Azure Ative Directory do banco de dados. |
is |
A criptografia de infra está habilitada para esse banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
is |
Se esse banco de dados é ou não um banco de dados contábil, o que significa que todas as tabelas no banco de dados são tabelas contábeis. Nota: o valor desta propriedade não pode ser alterado após a criação do banco de dados. |
keys | As ids de recurso das identidades atribuídas ao usuário a serem usadas |
kind | Tipo de base de dados. Esses são metadados usados para a experiência do portal do Azure. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
license |
O tipo de licença a ser aplicado para este banco de dados.
|
long |
O identificador de recurso do backup de retenção de longo prazo associado à operação de criação desse banco de dados. |
maintenance |
ID de configuração de manutenção atribuído ao banco de dados. Essa configuração define o período em que as atualizações de manutenção ocorrerão. |
managed |
Recurso que gerencia o banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
manual |
Se a substituição manual controlada pelo cliente precisa ou não ser feita durante a operação do Update Database para a camada Hyperscale. Essa propriedade só é aplicável ao dimensionar o banco de dados da camada Business Critical/General Purpose/Premium/Standard para a camada Hyperscale. Quando manualCutover é especificado, a operação de dimensionamento aguardará a entrada do usuário para acionar a substituição para o banco de dados Hyperscale. Para acionar a substituição, forneça o parâmetro 'performCutover' quando a operação Scaling estiver no estado de espera. |
max |
O tamanho máximo do log para este banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
max |
O tamanho máximo do banco de dados expresso em bytes. |
min |
Capacidade mínima que o banco de dados sempre terá alocado, se não pausado |
paused |
A data em que o banco de dados foi pausado por configuração do usuário ou formato action(ISO8601). Nulo se o banco de dados estiver pronto. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
perform |
Para acionar a substituição manual controlada pelo cliente durante o estado de espera enquanto a operação de dimensionamento está em andamento. Este parâmetro de propriedade só é aplicável para operações de dimensionamento que são iniciadas junto com o parâmetro 'manualCutover'. Essa propriedade só é aplicável quando o dimensionamento do banco de dados da camada Business Critical/General Purpose/Premium/Standard para a camada Hyperscale já estiver em andamento. Quando performCutover for especificado, a operação de dimensionamento acionará a substituição e executará a alteração de função no banco de dados Hyperscale. |
preferred |
Tipo de enclave solicitado no banco de dados, ou seja, enclaves padrão ou VBS. |
read |
O estado do roteamento somente leitura. Se habilitadas, as conexões que têm a intenção do aplicativo definida como somente leitura em sua cadeia de conexão podem ser roteadas para uma réplica secundária somente leitura na mesma região. Não aplicável a um banco de dados Hyperscale dentro de um pool elástico. |
recoverable |
O identificador de recurso do banco de dados recuperável associado à operação de criação desse banco de dados. |
recovery |
O identificador de recurso do ponto de recuperação associado à operação de criação desse banco de dados. |
requested |
O tipo de conta de armazenamento a ser usado para armazenar backups para esse banco de dados. |
requested |
O nome do objetivo de nível de serviço solicitado do banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
restorable |
O identificador de recurso do banco de dados descartado restaurável associado à operação de criação desse banco de dados. |
restore |
Especifica o ponto no tempo (formato ISO8601) do banco de dados de origem que será restaurado para criar o novo banco de dados. |
resumed |
A data em que o banco de dados foi retomado pela ação do usuário ou login do banco de dados (formato ISO8601). Nulo se o banco de dados estiver pausado. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
sample |
O nome do esquema de exemplo a ser aplicado ao criar esse banco de dados. |
secondary |
O tipo secundário do banco de dados, se for secundário. Os valores válidos são Geo, Named e Standby. |
sku | O banco de dados SKU. A lista de SKUs pode variar de acordo com a região e a oferta de suporte. Para determinar as SKUs (incluindo o nome, a camada/edição, a família e a capacidade da SKU) que estão disponíveis para sua assinatura em uma região do Azure, use a API REST
|
source |
Especifica a hora em que o banco de dados foi excluído. |
source |
O identificador de recurso do banco de dados de origem associado à operação de criação desse banco de dados. |
source |
O identificador de recurso da fonte associada à operação de criação desse banco de dados. Esta propriedade só é suportada para a edição DataWarehouse e permite restaurar entre subscrições. 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 sql existente, e restorePointInTime deve ser especificado. Quando createMode é Restore, sourceResourceId deve ser a ID de recurso do banco de dados descartado restaurável ou do pool sql descartado restaurável. Quando createMode é Recover, sourceResourceId deve ser o ID de recurso do banco de dados recuperável ou do pool 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 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 |
status | O status do banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
zone |
Se esse banco de dados é ou não redundante de zona, o que significa que as réplicas desse banco de dados serão espalhadas por várias zonas de disponibilidade. |
Propriedades Herdadas
id | ID do recurso. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
location | Localização do recurso. |
name | Nome do recurso. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
tags | Tags de recursos. |
type | Tipo de recurso. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
Detalhes de Propriedade
autoPauseDelay
Tempo em minutos após o qual o banco de dados é pausado automaticamente. Um valor de -1 significa que a pausa automática está desativada
autoPauseDelay?: number
Valor de Propriedade
number
availabilityZone
Especifica a zona de disponibilidade na qual o banco de dados está fixado.
availabilityZone?: string
Valor de Propriedade
string
catalogCollation
Agrupamento do catálogo de metadados.
catalogCollation?: string
Valor de Propriedade
string
collation
O agrupamento do banco de dados.
collation?: string
Valor de Propriedade
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 uma réplica secundária 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 point-in-time de um banco de dados existente. sourceDatabaseId deve ser especificado como a ID de 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 o ID de recurso de banco de dados recuperável a ser restaurado.
Restaurar: cria um banco de dados restaurando um backup de um banco de dados excluído. sourceDatabaseId deve ser especificado. Se sourceDatabaseId for o ID de recurso original do banco de dados, sourceDatabaseDeletionDate deverá ser especificado. Caso contrário, sourceDatabaseId deve ser o ID de recurso de banco de dados descartado restaurável e sourceDatabaseDeletionDate é ignorado. restorePointInTime também pode ser especificado para restaurar a partir de um point-in-time anterior.
RestoreLongTermRetentionBackup: cria um banco de dados restaurando a partir de um cofre de retenção de longo prazo. recoveryServicesRecoveryPointResourceId deve ser especificado como o ID do recurso do ponto de recuperação.
Copy, Secondary e RestoreLongTermRetentionBackup não são suportados para a edição DataWarehouse.
createMode?: string
Valor de Propriedade
string
creationDate
A data de criação da base de dados (formato ISO8601). Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
creationDate?: Date
Valor de Propriedade
Date
currentBackupStorageRedundancy
O tipo de conta de armazenamento usado para armazenar backups para esse banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
currentBackupStorageRedundancy?: string
Valor de Propriedade
string
currentServiceObjectiveName
O nome atual do objetivo de nível de serviço do banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
currentServiceObjectiveName?: string
Valor de Propriedade
string
currentSku
O nome e a camada da SKU. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
currentSku?: Sku
Valor de Propriedade
databaseId
A ID do banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
databaseId?: string
Valor de Propriedade
string
defaultSecondaryLocation
A região secundária padrão para esse banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
defaultSecondaryLocation?: string
Valor de Propriedade
string
earliestRestoreDate
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). Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
earliestRestoreDate?: Date
Valor de Propriedade
Date
elasticPoolId
O identificador de recurso do pool elástico que contém esse banco de dados.
elasticPoolId?: string
Valor de Propriedade
string
encryptionProtector
O URI do cofre de chaves azure do banco de dados se estiver configurado com chaves gerenciadas pelo cliente do banco de dados.
encryptionProtector?: string
Valor de Propriedade
string
failoverGroupId
Identificador de recurso do Grupo de Failover ao qual esse banco de dados pertence. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
failoverGroupId?: string
Valor de Propriedade
string
federatedClientId
A ID do cliente usada para o cenário de CMK entre locatários por banco de dados
federatedClientId?: string
Valor de Propriedade
string
highAvailabilityReplicaCount
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 Hyperscale dentro de um pool elástico.
highAvailabilityReplicaCount?: number
Valor de Propriedade
number
identity
A identidade do Azure Ative Directory do banco de dados.
identity?: DatabaseIdentity
Valor de Propriedade
isInfraEncryptionEnabled
A criptografia de infra está habilitada para esse banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
isInfraEncryptionEnabled?: boolean
Valor de Propriedade
boolean
isLedgerOn
Se esse banco de dados é ou não um banco de dados contábil, o que significa que todas as tabelas no banco de dados são tabelas contábeis. Nota: o valor desta propriedade não pode ser alterado após a criação do banco de dados.
isLedgerOn?: boolean
Valor de Propriedade
boolean
keys
As ids de recurso das identidades atribuídas ao usuário a serem usadas
keys?: {[propertyName: string]: DatabaseKey}
Valor de Propriedade
{[propertyName: string]: DatabaseKey}
kind
Tipo de base de dados. Esses são metadados usados para a experiência do portal do Azure. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
kind?: string
Valor de Propriedade
string
licenseType
O tipo de licença a ser aplicado para este banco de dados.
LicenseIncluded
se precisar de uma licença ou BasePrice
se tiver uma licença e estiver qualificado para o Benefício Híbrido do Azure.
licenseType?: string
Valor de Propriedade
string
longTermRetentionBackupResourceId
O identificador de recurso do backup de retenção de longo prazo associado à operação de criação desse banco de dados.
longTermRetentionBackupResourceId?: string
Valor de Propriedade
string
maintenanceConfigurationId
ID de configuração de manutenção atribuído ao banco de dados. Essa configuração define o período em que as atualizações de manutenção ocorrerão.
maintenanceConfigurationId?: string
Valor de Propriedade
string
managedBy
Recurso que gerencia o banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
managedBy?: string
Valor de Propriedade
string
manualCutover
Se a substituição manual controlada pelo cliente precisa ou não ser feita durante a operação do Update Database para a camada Hyperscale.
Essa propriedade só é aplicável ao dimensionar o banco de dados da camada Business Critical/General Purpose/Premium/Standard para a camada Hyperscale.
Quando manualCutover é especificado, a operação de dimensionamento aguardará a entrada do usuário para acionar a substituição para o banco de dados Hyperscale.
Para acionar a substituição, forneça o parâmetro 'performCutover' quando a operação Scaling estiver no estado de espera.
manualCutover?: boolean
Valor de Propriedade
boolean
maxLogSizeBytes
O tamanho máximo do log para este banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
maxLogSizeBytes?: number
Valor de Propriedade
number
maxSizeBytes
O tamanho máximo do banco de dados expresso em bytes.
maxSizeBytes?: number
Valor de Propriedade
number
minCapacity
Capacidade mínima que o banco de dados sempre terá alocado, se não pausado
minCapacity?: number
Valor de Propriedade
number
pausedDate
A data em que o banco de dados foi pausado por configuração do usuário ou formato action(ISO8601). Nulo se o banco de dados estiver pronto. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
pausedDate?: Date
Valor de Propriedade
Date
performCutover
Para acionar a substituição manual controlada pelo cliente durante o estado de espera enquanto a operação de dimensionamento está em andamento.
Este parâmetro de propriedade só é aplicável para operações de dimensionamento que são iniciadas junto com o parâmetro 'manualCutover'.
Essa propriedade só é aplicável quando o dimensionamento do banco de dados da camada Business Critical/General Purpose/Premium/Standard para a camada Hyperscale já estiver em andamento.
Quando performCutover for especificado, a operação de dimensionamento acionará a substituição e executará a alteração de função no banco de dados Hyperscale.
performCutover?: boolean
Valor de Propriedade
boolean
preferredEnclaveType
Tipo de enclave solicitado no banco de dados, ou seja, enclaves padrão ou VBS.
preferredEnclaveType?: string
Valor de Propriedade
string
readScale
O estado do roteamento somente leitura. Se habilitadas, as conexões que têm a intenção do aplicativo definida como somente leitura em sua cadeia de conexão podem ser roteadas para uma réplica secundária somente leitura na mesma região. Não aplicável a um banco de dados Hyperscale dentro de um pool elástico.
readScale?: string
Valor de Propriedade
string
recoverableDatabaseId
O identificador de recurso do banco de dados recuperável associado à operação de criação desse banco de dados.
recoverableDatabaseId?: string
Valor de Propriedade
string
recoveryServicesRecoveryPointId
O identificador de recurso do ponto de recuperação associado à operação de criação desse banco de dados.
recoveryServicesRecoveryPointId?: string
Valor de Propriedade
string
requestedBackupStorageRedundancy
O tipo de conta de armazenamento a ser usado para armazenar backups para esse banco de dados.
requestedBackupStorageRedundancy?: string
Valor de Propriedade
string
requestedServiceObjectiveName
O nome do objetivo de nível de serviço solicitado do banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
requestedServiceObjectiveName?: string
Valor de Propriedade
string
restorableDroppedDatabaseId
O identificador de recurso do banco de dados descartado restaurável associado à operação de criação desse banco de dados.
restorableDroppedDatabaseId?: string
Valor de Propriedade
string
restorePointInTime
Especifica o ponto no tempo (formato ISO8601) do banco de dados de origem que será restaurado para criar o novo banco de dados.
restorePointInTime?: Date
Valor de Propriedade
Date
resumedDate
A data em que o banco de dados foi retomado pela ação do usuário ou login do banco de dados (formato ISO8601). Nulo se o banco de dados estiver pausado. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
resumedDate?: Date
Valor de Propriedade
Date
sampleName
O nome do esquema de exemplo a ser aplicado ao criar esse banco de dados.
sampleName?: string
Valor de Propriedade
string
secondaryType
O tipo secundário do banco de dados, se for secundário. Os valores válidos são Geo, Named e Standby.
secondaryType?: string
Valor de Propriedade
string
sku
O banco de dados SKU.
A lista de SKUs pode variar de acordo com a região e a oferta de suporte. Para determinar as SKUs (incluindo o nome, a camada/edição, a família e a capacidade da SKU) que estão disponíveis para sua assinatura em uma região do Azure, use a API REST Capabilities_ListByLocation
ou um dos seguintes comandos:
az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
sku?: Sku
Valor de Propriedade
sourceDatabaseDeletionDate
Especifica a hora em que o banco de dados foi excluído.
sourceDatabaseDeletionDate?: Date
Valor de Propriedade
Date
sourceDatabaseId
O identificador de recurso do banco de dados de origem associado à operação de criação desse banco de dados.
sourceDatabaseId?: string
Valor de Propriedade
string
sourceResourceId
O identificador de recurso da fonte associada à operação de criação desse banco de dados.
Esta propriedade só é suportada para a edição DataWarehouse e permite restaurar entre subscrições.
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 sql existente, e restorePointInTime deve ser especificado.
Quando createMode é Restore, sourceResourceId deve ser a ID de recurso do banco de dados descartado restaurável ou do pool sql descartado restaurável.
Quando createMode é Recover, sourceResourceId deve ser o ID de recurso do banco de dados recuperável ou do pool 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 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
sourceResourceId?: string
Valor de Propriedade
string
status
O status do banco de dados. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
status?: string
Valor de Propriedade
string
zoneRedundant
Se esse banco de dados é ou não redundante de zona, o que significa que as réplicas desse banco de dados serão espalhadas por várias zonas de disponibilidade.
zoneRedundant?: boolean
Valor de Propriedade
boolean
Detalhes da Propriedade Herdada
id
ID do recurso. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
id?: string
Valor de Propriedade
string
herdado deTrackedResource.id
location
Localização do recurso.
location: string
Valor de Propriedade
string
name
Nome do recurso. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name?: string
Valor de Propriedade
string
herdado deTrackedResource.name
tags
Tags de recursos.
tags?: {[propertyName: string]: string}
Valor de Propriedade
{[propertyName: string]: string}
herdado deTrackedResource.tags